This page contains all of the options for:

sudo zymonic_toolkit.pl Definition

Build

Builds the cache for a system definition

sudo zymonic_toolkit.pl Definition build

System Definition

The name of the sub-directory in which the definition is stored. This is required for the command to work.
```
sudo zymonic_toolkit.pl Definition build --definition FOLDERPATH
```
Configuration Directory

A direct to be used for retrieving/storing configuration for this application server - defaults to /etc/zymonic
```
sudo zymonic_toolkit.pl Definition build --configdir FOLDERPATH
```
Full Update

Runs the definition building from an empty cache, i.e., does not attempt an incremental build.
```
sudo zymonic_toolkit.pl Definition build --full yes
```

Export Definition

Gets the definition of a Zymonic object or objects including defs for any fields, keys or permissions referenced by zname. Can be used for in conjunction with import_from_db, to create zymonic xml and tables, from normal database tables, click here to see a worked example of this.

sudo zymonic_toolkit.pl Definition export_def --definition [system] --zname [zname]

System Definition

The name of the sub-directory in which the definition is stored. This is required for the command to work.
```
sudo zymonic_toolkit.pl Definition export_def --definition FOLDERPATH
```
Configuration Directory

A direct to be used for retrieving/storing configuration for this application server - defaults to /etc/zymonic
```
sudo zymonic_toolkit.pl Definition export_def --configdir FOLDERPATH
```
Cache File

Absolute path of specific cache file to use, if not set will use the most recent.
```
sudo zymonic_toolkit.pl Definition export_def --cache_file FILEPATH
```
Zymonic Object Type

The name of the object type, e.g., "Field".
```
sudo zymonic_toolkit.pl Definition export_def --type TYPE
```

Zymonic Object ZName

The ZName of the object.

sudo zymonic_toolkit.pl Definition export_def --zname ZNAME

Export Type

Used to specify the format of the export, defaults to XML.
```
sudo zymonic_toolkit.pl Definition export_def --export_type FORMAT
```
User Definitions Only

Set true to only export user definitions, as opposed to auto-added ones.
```
sudo zymonic_toolkit.pl Definition export_def --user_definitions_only yes
```

Get Definition

Gets the definition of a Zymonic object or objects

sudo zymonic_toolkit.pl Definition get_def

System Definition

The name of the sub-directory in which the definition is stored. This is required for the command to work.
```
sudo zymonic_toolkit.pl Definition get_def --definition FOLDERPATH
```

Strip Metadata

Removes the metadata from the output.

sudo zymonic_toolkit.pl Definition get_def -stripmeta yes

Perl Mode

This outputs the results as a Perl hash instead of XML - particularly useful when coding definitions.
```
sudo zymonic_toolkit.pl Definition get_def --perlmode yes
```
Configuration Directory

A direct to be used for retrieving/storing configuration for this application server - defaults to /etc/zymonic
```
sudo zymonic_toolkit.pl Definition get_def --configdir FOLDERPATH
```
Cache File

Absolute path of specific cache file to use, if not set will use the most recent.
```
sudo zymonic_toolkit.pl Definition get_def --cache_file FILEPATH
```
Zymonic Object Type

The name of the object type, e.g., "Field".
```
sudo zymonic_toolkit.pl Definition get_def --type TYPE
```

Zymonic Object ZName

The ZName of the object.

sudo zymonic_toolkit.pl Definition get_def --zname ZNAME

Import from Database

Imports from the database as XML

sudo zymonic_toolkit.pl Definition import_from_db

Permissions

List of permissions.

sudo zymonic_toolkit.pl Definition import_from_db --permissions

Auto Create Maintenance Process

Flag for if to autocreate maintenance process.

sudo zymonic_toolkit.pl Definition import_from_db --AutoCreateMaintenanceProcess

Auto Create Form

Flag for if to autocreate form.

sudo zymonic_toolkit.pl Definition import_from_db --AutoCreateForm

Auto Create Filter

Flag for if to autocreate filter.

sudo zymonic_toolkit.pl Definition import_from_db --AutoCreateFilter

Add Missing Primary

Flag so if there is no primary key on the table, add an autocreated one.
```
sudo zymonic_toolkit.pl Definition import_from_db --addmissingprimary
```

DB Name

Name of the database to import tables from.

sudo zymonic_toolkit.pl Definition import_from_db --dbname NAME

ODBC Connect String

Used by Zymonic::DB::odbc.

sudo zymonic_toolkit.pl Definition import_from_db --odbcconnectstring STRING

DB Username

Database username.

sudo zymonic_toolkit.pl Definition import_from_db --dbusername USERNAME

DB Password

Database password.

sudo zymonic_toolkit.pl Definition import_from_db --dbpassword PASSWORD

System Definition

The name of the sub-directory in which the definition is stored. This is required for the command to work.
```
sudo zymonic_toolkit.pl Definition import_from_db --definition FOLDERPATH
```
Configuration Directory

The name of the directory in which Zymonic definitions are stored; defaults to "/etc/zymonic".
```
sudo zymonic_toolkit.pl Definition import_from_db --configdir FOLDERPATH
```
ZName Prefix

User specified prefix to be added before znames, defaults to empty, automatically adds _
```
sudo zymonic_toolkit.pl Definition import_from_db --znameprefix STRING
```
Field Zname Prefix

User specified prefix to be added to field znames. Defaults to f_, automatically adds _ .
```
sudo zymonic_toolkit.pl Definition import_from_db --fieldznameprefix STRING
```
Table ZName Prefix

User specified prefix to be added to table znames. Defaults to t_, automatically adds _ .
```
sudo zymonic_toolkit.pl Definition import_from_db --tableznameprefix STRING
```
Table Name

Used to specify a table to import from the DB, rather that importing the entire DB.
```
sudo zymonic_toolkit.pl Definition import_from_db --tablename TABLE
```

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.

sudo zymonic_toolkit.pl Definition help

Command

The specific command to show help for. If not set then shows help for all commands.
```
sudo zymonic_toolkit.pl Definition help --command COMMAND
```

Build

System Definition

Configuration Directory

Full Update

Export Definition

System Definition

Configuration Directory

Cache File

Zymonic Object Type

Zymonic Object ZName

Export Type

User Definitions Only

Get Definition

System Definition

Strip Metadata

Perl Mode

Configuration Directory

Cache File

Zymonic Object Type

Zymonic Object ZName

Import from Database

Permissions

Auto Create Maintenance Process

Auto Create Form

Auto Create Filter

Add Missing Primary

DB Name

ODBC Connect String

DB Username

DB Password

System Definition

Configuration Directory

ZName Prefix

Field Zname Prefix

Table ZName Prefix

Table Name

Help

Command