ztsm

Introduction

This is the manual for the ztsm . It contains information about all the functions available within the system, including how to use each function as an XML API.

General Usage Guide

Log in

On entering the ztsm's URL the user is taken to the login block. This requires the user to enter their username/password, and then to click on the 'login' button .

Entering an incorrect username or password will result in an error message which informs the user that their login has failed and what they need to do to achieve a login

Virtual Desktops (Pages)

The ztsm is divided into Virtual Desktops or pages and these are found at the top of the screen. Each Virtual Desktop is accessed by clicking on it's name.

Filters and Processes

Processes

Processes are the core of the ztsm, they are the mechanism by which information enters the system. Each process consists of a set of states that reflect the business process they are designed to monitor/inform and each state allows the recording of information. To move between states there are 'transitions', these appear as buttons at the bottom of the process, information is only recorded when one of the buttons is pressed. On the manual page for each process is diagram of states and transitions so the possible actions that a user can take at any point can be understood more easily.

Filters

Filters are used to report on information in the system, they allow searching and navigation of information in the system - they also allow you to find processes and open them to continue working with them.

Blocks

Blocks are the equivalent of 'windows' they contain the processes and filters and can be opened, closed and moved much like windows.

Opening a block from a Filter of Filters and Processes (FoFaP) Block

To open a block from this menu click on the process action word (written in capital letters) and the block will open on the desktop.

Opening a block from a Filter Block

To open a block from a Filter Block fill in any required search terms and click on the 'Show Results' button. To see specific examples see the detailed description of each block listed below. The results list will be displayed. To open one of the results click on the process action word (written in capital letters) and a block will open above the current one.

Closing a Block

To close a block click on the X in the top left hand corner of the block.

Moving Blocks

To move a block, with AJAX enabled, a user may drag and drop by placing their mouse over the block's title bar left clicking and dragging the block upwards or downwards to the desired location and releasing the mouse button.

To move a block, without AJAX enabled, a user may click on the up and down arrows, located in the block's title bar next to the closing X.

API Usage Guide

All of ztsm can be used as an API providing the user the API is called for has permissions to perform the requested action, in fact if you do 'view source' on a page of the web interface of ztsm you will see that the response from the server is always XML and is just transformed to a web page using XSL.

To use the API you simply post correct XML (see the page for the individual process or filter for instructions on creating the XML) to the root URL of your system in a parameter named 'xmldata'.

The root URL of your system will either be https://[hostname]/zymonicmp/ or https://[hostname]/cgi-bin/zymonic.pl.

The 'pure' API mode is slightly different from the XML in that it does not include the display attributes but does collate any errors into error elements in the root of the XML - but apart from this is identical, so viewing a block in the browser can tell you exactly what will be returned by the API.

The instructions for using each process or filter can be found by clicking on the API link next to the link for the main section of manual.

Pages

Processes

Not Categorized

Toolkits

Error Codes - API Only

Database Information

Setting up Encrypted Config Options

Zymonic Daemon Settings

Zymonic Cache Settings

Zymonic Messaging

Zymonic Logging Information