Start Parameters - Utilities

Java loader of the utility

-F0

Suppresses the splash screen.

-IPath and file name

The path and name of the INI file for the Java loader.

-JParameter

The parameter of the utility.

You can also assign parameters to the utility via the Java loader (see below). These are added to the cmd section in the INI file. In doing so, you can specify a default setting for the INI file and control special options via the Java loader.

Note that:

• The parameter chain must be written in double quotations.
• Path indications that include blanks must also be written in double quotations (for example: -J"-I""C:\AUTOMIC\my utilities\UCYBDBAR.ini""").

Examples:
The required language should be specified via a shortcut.

INI file abstract:

cmd="javaw" -jar -cp .;.\UC4LAF.jar UCYBDBar.jar

The language is predetermined via a shortcut:

UCYBDBarg.exe -F0 -J"-LD"

If an INI file is specified for the utility, the parameter -I must be used twice. This is also necessary if the Java loader and the utility use the same INI file.

Examples:

Both use the same INI file:

ucybdbccg -IUCYBDBCC.ini -J"-IUCYBDBCC.ini"

Different INI files are used:

ucybdbccg -IUCYBDBCC.ini -J"-Iclientcopy.ini"

Utility for database archiving
UCYBDBAR.JAR

-V

Prints the Automation Engine version and hotfix number in the following format:

"UCYBDBar version Automation Engine version plus hotfix number"

-VPath and file name

Prints the Automation Engine version and hotfix number to the specified file in the following format:

"UCYBDBar version Automation Engine version plus hotfix number"

-IFile name

The path and the name of the INI file.

-LLanguage

Language

Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" = French

The language that is specified in the INI file is used if you do not specify this parameter.

-B

Batch mode.

Archiving mode

-Smmmm

The number of the client that should be archived.

This client must include a User object for the user who starts this utility in batch mode.

For example: There must be the User object "SMITH/departmentDepartment name to which the Automation Engine user belongs. name for the OS user Smith. Note that no other User object must start with "SMITH" (for example, SMITH/UC4 and SMITH/TEST is not possible).

-Dmmmm

The number of the client that should be archived (only Windows).

This client must include a User object for the user who starts this utility in batch mode.

For example: There must be the User object "SMITH/UC4" for the OS user SMITH of the domain UC4.

Report mode

-Smmmm
-Dmmmm

A client must always be specified in report mode (except for -Xreport). The same rules apply for the two parameters as in archiving mode.

Depending on the report mode that is used, the client specification can have a different meaning:

"-Xlist" - Client whose reports should be listed.

"-Xunload" and "-Xmark" - The client is used for checking login data. A User object must be available, as otherwise the utility cancels the process.

-XMode

The type of  report handling.

For Output Management systems:

"list" - Reports are listed.
"unload" - Report is unloaded.
"mark" - Report is marked archived and removed from the databaseA database is an organized collection of data including relevant data structures. table "XRO".

For the  combination of log and trace files:

"report" - Files are generated from the log entries of server processes.

Parameters for -Xlist

-OPath and file name

The path and the name of the CSV file.

The name "uc_XROlist.csv" is used if you do not specify a file name. If you do not specify a path, the file is stored in the folder in which the utility is stored.

-YNumber

The filter for the report selection.

Parameters for -Xunload

-OPath and file name

The path and the name of the text file.

A file with the additional prefix "_Report type" is created in the specified folder for each report of the task.

The name "uc_XROreport.txt_Report type" is used if you do not specify a file name. By default, the files are stored in the folder in which the utility is stored.

-YNumber

This sets a number for later filtering.

-RRunID

The RunID of the task.

-TTimeZone

The name of a TimeZone object.

By default, Universal Time (UTC) is used in unloaded reports. The parameter can be used to convert the time specifications to other time zones.

UTC is used if this TimeZone object does not exist in the specified client.

The type of the report (such as ACT).

All reports of the task are exported to a separate file if you do not specify a report type.

Parameters for -Xmark

-RRunID

The RunID of the task.

The type of the report (such as ACT).

All report types are archived if this parameter has not been specified. A separate file is created for each report type (names end with _report type, for example, _ACT).

Parameters for -Xreport

-NObject

The name of an object or filter using "*" for several objects.

Several specifications that should be separated with commas.

-T1yyyymmddhhmmss

The start date and the time for the Server reports that should be selected.

Standard value: current date and time 00:00:00

-T2yyyymmddhhmmss

The end date and the time for the Server reports that should be selected.

Standard value: Current date and time

-PPath and file prefix

The path and the file prefix for the target file.

By default, the target files obtain the prefix "unload". They are stored in the utility folder.

The file name is composed as follows:
Prefix.object name_date_time.txt

Examples:

Client 1 is archived.

UCYBDBar -B -S0001

The utility creates a report list and writes it to the file report01.csv.

UCYBDBar -B -Xlist -S1000 -OC:\AUTOMIC\REPORT\report01.csv

Report number 1791029 is unloaded to a text file and obtains status 123.

UCYBDBar -B -Xunload -S1000 -R1791029 -Y123

AE DB Archive marks the report as archived using the number 1791029 and removes it from the database table.

UCYBDBar -B -Xmark -S1000 -R1791029

All Server reports of March 15th, 2007 should be unloaded.

UCYBDBar -B -Xreport -N"UC4#CP*,UC4#WP*" -T120070315000000 -T220070315235959 -P"C:\AUTOMIC\report\server"

The utility should only unload reports of the work processes "WP001" and "WP002".

UCYBDBar -B -Xreport -N"UC4#WP001,UC4#WP002" -T120070315000000 -T220070315235959

Utility for the modification of exported data
UCYBCHNG.EXE

-V

Prints the Automation Engine version and the hotfix number in the following format:

"UCYBChng version Automation Engine version plus hotfix number"

-VPath and file name

Prints the Automation Engine version and the hotfix number to the specified file in the following format:

"UCYBChng version Automation Engine version plus hotfix number"

-B

Batch mode.

-1Script File

This file contains modification instructions (REPLACE).

-2Transport File

Contains the original export data (UC_DATA.TXT by default).

-3Output File

Modified data is written to this file.

-LLanguage

Language

Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" = French

The language that is specified in the INI file is used if you do not specify this parameter.

For example:

ucybchng -b -1c:\AUTOMIC\uc_change.txt -2c:\AUTOMIC\uc_transport.txt -3c:\AUTOMIC\uc_transport_new.txt

Utility for copying and deleting clients
UCYBDBCC.JAR

-V

Prints the Automation Engine version and the hotfix number in the following format:

"UCYBDBcc version Automation Engine version plus hotfix number"

-VPath and file name

Prints the Automation Engine version and hotfix number to the specified file in the following format:

"UCYBDBcc version Automation Engine version plus hotfix number"

-IFile name

The path and the name of the INI file.

-LLanguage

Language

Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" = French

The language that is specified in the INI file is used if you do not specify this parameter.

-B

Start in batch mode, single logon is used.

-V

Outputs the Automation Engine version and hotfix number.

Copy mode

-C

Copies the client; the OS user must exist as an AE user in both databases in system client 0000. Otherwise, the process aborts with an error message.

-Smmmm

The number of the source client.

The system client 0000 must include a User object for the user who starts this utility in batch mode.

For example: There must be the User object "SMITH/department name for the OS user Smith. Note that no other User object must start with "SMITH" (for example, SMITH/AE and SMITH/TEST is not possible).

-Dmmmm

The number of the source client (only Windows).

Note that the parameters -D and -S must not be used together.

The system client 0000 must include a User object for the user who starts this utility in batch mode.

For example: There must be the User object "SMITH/AE" for the OS user SMITH of the domain AE.

-Tmmmm

The number of the target client.

The same requirements apply to the user as described for the parameter -S.

-O

Copies objects.

-M

Copies messages.

-A

Copies statistics and reports.

-R

Resets passwordA secret combination of characters for a Automation Engine user..

-V

Copies version objects.

-W

Deletes the work files after a successful copying process.

Deletion mode

-E

Deletes a client; the OS user must exist as an AE user in both databases in the system client 0000. Otherwise, the process aborts with an error message.

-Smmmm
-Dmmmm
-Tmmmm

You can define different databases for the source and the target in the INI file. When you use the parameters -S or -D, the client in the source database will be deleted; -T deletes the target database.

The same requirements apply for these parameters as in copy mode.

Examples:

Copy client:

The objects, statistics and reports of client 38 are copied to the new client number 2:

UCYBDBcc -B -C -S0038 -T0002 -O -A

Delete client:

Client 2 is deleted in the target database.

UCYBDBcc -B -E -T0002

Utility for loading the database
UCYBDBLD.JAR

-V

Prints the Automation Engine version and the hotfix number in the following format:

"UCYBDBld version Automation Engine version plus hotfix number"

-VPath and file name

Prints the Automation Engine version and hotfix number to the specified file in the following format:

"UCYBDBld version Automation Engine version plus hotfix number"

-IFile name

The path and the name of the INI file.

Defines the behavior of DB Load regarding folders. When objects or linked objects are being replaced, the data of the home folder and the linked objects of the Transport Case are preserved.

Allowed value = "OT"

When this value is set, the data contained in the data file of the Transport Case will overwrite already existing objects in the Automation Engine database.

-LLanguage

Language

Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" = French

The language that is specified in the INI file is used if you do not specify this parameter.

-B

Batch mode

-Cmmmm

The number of the client for processing.

-C-1, retains clients, -Cmmmm loads the Transport Case to client mmmm

-EMode

Processing mode for objects that exist already.
Only in the batch mode

Allowed values: "IGNORE", "ABEND", "REPLACE"
"IGNORE" = The object is skipped (default).
"ABEND" = Processing is canceled.
"REPLACE" = The existing object is replaced.

Note that the setting "IGNORE" requires that the original object and the object to be loaded are of the same type, as otherwise processing will abort before the loading process has started.

-UName/Department

The name and the department of a default user.

If the user does not have access rights on object level, the default user can be used instead.  

-GName

The name of the default user group.

If the user does not have access rights on object level, the default group can be used instead.

-AAccess

Loads access authorizations on object level.

Allowed values: "Y", "N"
"Y" = Loads access authorizations on object level (default).
"N" = No loading of access authorizations on object level.

-MAccess

Ignores access authorizations that refer to missing users and user groups.

Allowed values: "Y", "N"
"Y" = Ignores access authorizations for missing users and user groups. They are not loaded.
"N" = Cancels the loading process for access authorization of missing users and user groups (default value).

-XFile name

The name of the file that should be loaded. Note that this start parameter is obligatory.

Authentication details.

Only call the utility with these start parameters if the new installation is made without using the UserInterface.

Both parameters should be used together.

Allowed values for -T: "NO", "LOCAL", "LOCAL_REMOTE" and "PACKAGE"

The authentication method is specified with "NO", "LOCAL" and "LOCAL_REMOTE". If you use "PACKAGE" you will obtain a file that includes the company key.

Allowed values for -K: any characters (maximum 32 characters)

The company key is composed of this string.

Always specify a string for the company key even if authentication (-TNO) is not used. Automic recommends using the AE system name as company key.

Note that using these start parameters results in an error when the initial data is loaded for the first time. Call the utility in order to create the schema and then restart it in order to set the authentication details.
For example: 

Step 1: java -jar ucybdbld -B -X/uc4/9.00A/Utility/db/general/9.00A/UC_UPD.TXT
Step 2: java -jar ucybdbld -B -TNO -Kabc

Alternately, you can also use the utility's graphical interface.

The string must be specified in inverted commas, if it contains special characters. If you intend to use an inverted comma within the string, set an additional inverted comma before it (under Windows) or a "\" (under Unix).

Examples:

The file UC_DATA.TXT is loaded to client 11 and the existing objects are replaced.

UCYBDBld -B -C0011 -XC:\AUTOMIC\UTILITY\temp\UC_DATA.TXT -EREPLACE

Authentication method "Server and Agent" should be specified in the AE system. 

UCYBDBld -B -TLOCAL_REMOTE -KUC4PROD

Utility for database reorganization
UCYBDBRE.JAR

-V

Prints the Automation Engine version and hotfix number in the following format:

"UCYBDBre version Automation Engine version plus hotfix number"

-VPath and file name

Prints the Automation Engine version and hotfix number to the specified file in the following format:

"UCYBDBre version Automation Engine version plus hotfix number"

-IFile name

The path and the name of the INI file.

-LLanguage

Language

Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" = French

The language that is specified in the INI file is used if you do not specify this parameter.

-B

Batch mode.

-Smmmm

The number of the client that should be reorganized.

This client must include a User object for the user who starts this utility in batch mode.

For example: There must be the User object "SMITH/department name for the OS user Smith. Note that no other User object must start with "SMITH" (for example, SMITH/AE and SMITH/TEST is not possible).

-Dmmmm

The number of the client that should be reorganized (only Windows).

This client must include a User object for the user who starts this utility in batch mode.

For example: There must be the User object "SMITH/AE" for the OS user SMITH of the domain AE.

Examples:

Client 98 is reorganized.

UCYBDBre -B -S0098

Utility for defining queries
UCYBDBRT.EXE

-Cmmmm

The client number for processing.

Overwrites the client specified in the query definition.

-XPath and file name

The path and the name of the XML file.

-IPath and file name

The path and the name of the INI file.

-LLanguage

Language

Allowed values: "D", "E", "F"
"D" = German, "E" = English, "F" = French

-Ryyyymmdd[hhmm]

The reference date for the analysis of statistics and forecasts.

Overwrites the query definition.

Note that the entries of the AE database are stored in UTC. Therefore, Automic recommends using this time zone also for specifying the reference time.

-S

This returns the number of output lines.

-OPath and file name

The path and the name of the output file.

-TFile type

The type of the output file.

Allowed values: "CSV" and "HTML"

For example:

The analysis defined in the file jobtop10.d.xml is created for client 100.

UCYBDBRT -C0100 -XC:\AUTOMIC\Utilities\analyses\jobtop10.d.xml

Utility for  creating a revision report
UCYBDBRR.EXE

-V

Prints the Automation Engine version and hotfix number in the following format:

"UCYBDBRR version Automation Engine version plus hotfix number"

-VPath and file name

Prints the Automation Engine version and hotfix number to the specified file in the following format:

"UCYBDBRR version Automation Engine version plus hotfix number"

-IPath and file name

The path and the name of the INI file.

-LLanguage

Language

Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" = French

The language that is specified in the INI file is used if you do not specify this parameter.

-B

Batch mode.

-Cmmmm

The client number for processing.

-OPath and file name

The path and the name of the revision report.

By default, the report is stored as UCYBDBRRoutput.txt in the utility folder.

-FType1,Type2,...

This handles the required contents of the auditing report. Indicate your preferred content types separated by commas.

Allowed values:

"ACCESS" - Unauthorized access
"CANCEL" - Aborts tasks
"CREATE" - Creates new objects
"DELETE" - Deletes objects
"IMPORT" - Imports objects
"MOVE" - Moves objects
"OBJ_MOD" - Object modifications
"RENAME" - Renames objects
"RESTART" - Restarts tasks
"RESTORE" - Restores objects
"RUN_MOD" - Modifies at runtime
"START" - Starts tasks
"TRNSPRT" -Transports objects
"USER" - Successful user logons and logoffs

The utility outputs all contents to the revision report if this parameter is omitted or if -F* is used.

-D1yyyymmddhhmmss

The start date and time for logging.

Note that by default, the selection is not limited by a start time. Automic strongly recommends specifying a start time, as otherwise the Revision Report becomes very voluminous.

The client's time zone is used. If there is no time zone specification, the time zone of system client 0000 is used. If there is also no time zone specification, UTC is used.

-D2yyyymmddhhmmss

The end date and the time for logging.

Default value: current date and time

The client's time zone is used. If there is no time zone specification, the time zone of system client 0000 is used. If there is also no time zone specification, UTC is used.

All modification data is written to the report if the two time parameters are not used. The filters -F and -X are taken into account.

-A

Archive flags are set when you use this parameter It is closely connected to the parameter -X.

Note that the start of tasks (see start parameter -FSTART) is retrieved from the statistical records. Therefore, the utility cannot set archive flags for these data records.

-X

You can use this parameter to have only modification entries that have never been output by the utility before (for example, because they have no archive flag) written to the report.

Examples:

All revision information of client 1 between 01.05 00:00 and the current date are output to a report.

UCYBDBRR -B -C0001 -O/uc4/reports/report01.txt -D120040501000000

All start and restart points between 01.10. 08:00 and 01.10. 12:00 are output in a report.

UCYBDBRR -B -LD -C0100 -FSTART,RESTART -D120041001080000 -D220041001200000

Utility  for unloading the database UCYBDBUN.JAR

-V

Prints the Automation Engine version and hotfix number in the following format:

"UCYBDBun version Automation Engine version plus hotfix number"

-VPath and file name

Prints the Automation Engine version and hotfix number to the specified file in the following format:

"UCYBDBun version Automation Engine version plus hotfix number"

-IFile name

The path and the name of the INI file.

-LLanguage

Language

Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" = French

The language that is specified in the INI file is used if you do not specify this parameter.

-BMode

Batch mode and processing mode.

AE system-wide:
"NORMAL" = All data from all database tables is unloaded.
"INITIAL" = Data is taken from client 0. However, not all of client 0 is unloaded, only the initial data, eg. XREQs.
"DEFAULT" = Default data of the system is unloaded, eg. client 0, initial User and User group.
"REPAIR" = The Explorer's folder structure is checked and repaired.

AE system-wide and client-wide:
"REORG" = The database is reorganized.
"TRANSPORT" = The Transport Case is unloaded.
"TRANSPORTALL" = All objects are transported. To remove objects from the Transport Case after the unloading process, use the -D option.
"RESETARCHIVE" = Archive flags are reset (AE DB Archive).
"RESETREORG" = Deletion flags are reset (AE DB Reorg).

-D

This start parameter removes all objects from the Transport Case after the unloading process.

-Cmmmm

The number of the client in order to unload the Transport Case.

All clients are unloaded if no client has been specified.

Specify value "1" in the INI file parameter suppress_output= and the parameter -C can also be used to reorganize individual clients.

You cannot unload client 0. When you specify the parameter -C0 despite of this fact, all clients will be unloaded except for client 0. 

-XFile name

The name of the file that should receive the data that should be unloaded.

The utility uses the name and path of the file specified in the INI file (output=) if this parameter is not specified.

Note that this parameter cannot be used with the mode -BREORG because these specific files are subject to a given naming convention.

Examples:

The AE database is reorganized.

UCYBDBun -BREORG

Client 100 is reorganized. The utility can process this call because the parameter suppress_output=1 has been specified in its INI file.

UCYBDBun -BREORG -C0100

The Transport Case of client 11 is unloaded and the utility uses the path and file names that have been specified in the OUTPUT= section of the utility's INI file. The Transport Case is cleared afterwards.

UCYBDBun -BTRANSPORT -D -C0011

With message U0021148, the utility reported an error in the folder structure of a client. Therefore, the correction function is called.

UCYBDBun -BREPAIR

Utility for  combining log and trace files UCYBLGMX

-V

Outputs the Automation Engine version including the hotfix number in the following format:

"UCYBLGMX version Automation Engine version plus hotfix number"

-VPath and file name

Prints the Automation Engine version and hotfix number to the specified file in the following format:

"UCYBLGMX version Automation Engine version plus hotfix number"

-B

Batch mode

-LPaths and names of log and trace file

The log files and the trace files that should be integrated in a target file.

The files can be specified in two ways:

"Path file1, file2, file3"

The path that is used for the first file is also used for the subsequent files.

"Path and file1, path and file2, path and file3"

You can also indicate the path for each individual file.

The wildcard character "*" can be used in file names.

The folder from which the utility is called (working directory) is used if no path has been specified.

-FPath and name of the target file

The path and the name of the target file.

The path can be omitted if the target file has been stored in the same folder as the utility.

Existing files of the same name are overwritten.

For example:

Log files with the prefix "server" are combined in the target file uc4.txt.

UCYBLGMX -B -L"C:\AUTOMIC\report\server*" -F"C:\AUTOMIC\report\uc4.txt"