8.1The ADM-Tools of cmsWorks

The ADM-Tools (Administration) are to be found within the cmsWorks desktop under the Menu "ExtWin". Only if your account you access the cmsWorks desktop with has granted administrative rights the ADM-Tools are available.

The ADM-Tools are a collection of tools to i.e. import / export content, for inspecting the configuration or even changing it.

Document model

The cmsWorks desktop has a section Administration where document types can be created/changed/removed where fields can be created/changed/removed already. So why is a document model configuring section also in the ADM-Tools?

This is more an import/export tool for the document model. Imagine creating a new feature for an existing project developing it in a development environment. This tool then enables you to simply export the current document model and import it when releasing the new feature on a productive installation.

Or if you have a large document model containing a lot of document types this tool enables a quick comparison to another model or another state of the model.

Export / Import documents

While developing a new feature for an existing project and new documents are created this tool helps to simply export these documents from a development instance and import it into a production installation.

The export tool allows to find documents by providing the ID or by simply browsing the folders. When a document is selected the linked documents from this document are examined and shown. So either linked documents are to be chosen for the export also or it's a linked document that exists in the target installation already.

In case such a linked document is not chosen and not existing in the target installation the link will not be set into the document when importing it. Finally put in a name for the file of the collection of document to be exported and execute the export. A download link appears to download the export-XML. This XML contains document references always as combination of folder path, document name and document type. Also all binary content is stored as base64 encoded text.

Using the import tool you first have to select an XML file to be imported. It verifies all document references and document contents against the document model:

• Does the document type exist?
• Do the fields in this document type exist and match?
• Is a document for the path already existing?
• Is the existing document of the same document type?

If all checks have passed successfully a list of documents (to be imported) appears with a button to start the import process.

Messaging and desktop sessions

A tool of the ADM-Tools Messaging allows to send a broadcast message for all currently loggedin users of the cmsWorks desktop. In most cases this is used to inform all users to stop the work and to leave the cmsWorks desktop for a short maintenance shutdown.

The desktop sessions tool lists the sessions of currently loggedin users of the cmsWorks desktop with the option to kill the session so the user is logged out.

Exceptions

The server collects exceptions from all services in the order of occurrence. This tool shows the exceptions in the order of the amount of occurrence. If there is a larger project with several different pages or even generators and many scripts sometimes an error appears at a never thought of possible combination of parameters and repeatedly the same Exception is logged.

So this tool shows you on top if such errors exists and how often they have occurred. After fixing the errors the Exception list could be cleared to see if the fix did the job. Because remember: An empty exception list is always an administrators delight ;-).

Precompile

This is a method to safely check - before their initial execution - if all JSPs / JSFs are valid after an update.

Every service based on an AbstractHttpServer (every Generator, WebUI, ScriptServer, Search) has defined a htdocs folder where JSP / JSF files exist. This tool request every JSP of these services to trigger a compilation of it rather than waiting for it's execution. If a compile fails, the stacktrace of this JSP / JSF file is listed.

Server instance

"Server instance" shows license information and enables you to either shutdown the complete server or restart the whole server instance.

Generators

The menu "Generators" lists all Generator services showing port, all remote ports, htdocs path, generation folder and the JSP assignment configuration from the generatorconfig-std.txt with the option to reload the generatorconfig-std.txt without restarting the service.

Additional CMS properties

Some special properties are used to describe the category implementation (if used), they may be edited here. Additional, all other stored values of the additional CMS Properties are shown and are made editable here.

It shows a list of all AbstractHTTPServer (except Generators) listing its ports and showing configured remote ports (also checking if they are available/active). The SearchCollector configurations for the internal and external big data search engines may be inspected here too.