Zymonic Toolkit



=Introduction= The toolkit is a comprehensive suite of diagnostic tools and system actions. This has been designed to ensure a consistent structure to all diagnostic and updates tools for zymonic systems, run via the command line. In this way many functions are now easier to perform via the command line than previously.

All zymonic_toolkit.pl functions are formatted one of the following ways: zymonic_toolkit.pl [MODULE] [COMMAND] [COMMAND ARGUMENTS] zymonic_toolkit.pl [CONFIG FILE] The MODULE element of the format is the category of command to be used. A list of the current available MODULES can be found on the manual index

If zymonic_toolkit.pl [MODULE] is entered on the command line the COMMANDs which are available for use, within that category of the toolkit, are listed. For example, if 'zymonic_toolkit.pl System' was to be entered on the command line, amongst the list of available commands will be 'create_admin - the ability to create an admin users for your zymonic system.'

The COMMAND element of the format is the function. If zymonic_toolkit.pl [MODULE] [COMMAND] is entered on the command line the options that are available for use in conjunction with the chosen command are listed. The list of available COMMAND ARGUMENTS will be displayed together with a brief description and if they are required for the function to be carried out successfully. For example, if 'zymonic_toolkit.pl System create_admin' was to be entered on the command line, amongst the list of available COMMAND ARGUMENTS will be '--username - Username - The username of the user (defaults to admin).'

The COMMAND ARGUMENTS element of the tookit format encompasses all the options that can and should be used to carry out the required function. Each COMMAND ARGUMENT is separated with a space. For example to create an admin user, via the command line 'zymonic_toolkit.pl System create_admin --system SYSTEM --username USERNAME'

The CONFIG FILE variant can be used when there are a lot of COMMAND ARGUMENTS. All of the above; the MODULE and COMMAND, together with all the COMMAND ARGUMENTS can be put into an xml file using the following format:  MODDULE COMMAND ... ... ... ... 

=Data= For more detailed information on the Data module, please click here. If you have never used this before, it is advised that you read the full documentation.  

Check Database for Valid Characters
Checks tables and fields for invalid characters - if no table or field are specified the command will process the whole DB or table.  

Clean Database
Removes autocreated records, deleted records and handles orphan records from tables in system.  

Help
When using a terminal to run zymonic_toolkit.pl the user will see prompts that contain the same information that is found within this manual.  </ul>

=Debugs= For more detailed information on the Debugs module, please click here. If you have never used this before, it is advised that you read the full documentation. <ul> 

Convert to SQLite
Converts a debug log to an SQLite file usable by zymonicdebugs </li> 

Help
When using a terminal to run zymonic_toolkit.pl the user will see prompts that contain the same information that is found within this manual. </li> </ul>

=Decryptor= For more detailed information on the Decryptor module, please click here. If you have never used this before, it is advised that you read the full documentation. <ul> 

Import Ecommerce Keys
Imports keys from e-commerce and sets the keyversion to a </li> 

Ping
Pings the decryptor(s) </li> 

Help
When using a terminal to run zymonic_toolkit.pl the user will see prompts that contain the same information that is found within this manual. </li> </ul>

=Definition= For more detailed information on the Definition module, please click here. If you have never used this before, it is advised that you read the full documentation. <ul> 

Build
Builds the cache for a system definition </li> 

Export Definition
Gets the definition of a Zymonic object or objects including defs for any fields, keys or permissions referenced by zname </li> 

Get Definition
Gets the definition of a Zymonic object or objects </li> 

Import from Database
Imports from the database as XML </li> 

Help
When using a terminal to run zymonic_toolkit.pl the user will see prompts that contain the same information that is found within this manual. </li> </ul>

=Installer= For more detailed information on the Installer module, please click here. If you have never used this before, it is advised that you read the full documentation. <ul> 

Combine Stylesheets
Combines the stylesheets for Zymonic Blocks to load dynamically - this is usually automatically done by the installer, this command is primarily for testing the XSL combiner set-up. </li> 

Install
Installs the parts of Zymonic not installed by the perl Makefile.PL, i.e., Javascript, XSL stylesheets, configuration etc. </li> 

List Manifests
Lists the currently installed manifests - handy for replicating machine set-up. </li> 

Update
Updates the repositories associated with the selected manifests. </li> 

Update and Install
Updates the repositories associated with the selected manifests. </li> 

Help
When using a terminal to run zymonic_toolkit.pl the user will see prompts that contain the same information that is found within this manual. </li> </ul>

=Locking= For more detailed information on the Locking module, please click here. If you have never used this before, it is advised that you read the full documentation. <ul> <li>

Action Required Locks
Returns list of locks which would be required to run the action. </li> <li>

Process Required Locks
Returns list of locks which would be required to change this process at its current state. </li> <li>

Transition Required Locks
Returns list of locks which would be required to run the transition. </li> <li>

User Locks
Returns list of locks a user currently holds. </li> <li>

Help
When using a terminal to run zymonic_toolkit.pl the user will see prompts that contain the same information that is found within this manual. </li> </ul>