Start Parameters - Utilities

This topic lists the parameters that administrators can use to start the different AE utilities in batch mode. You can either use the Java loader or the utility to assign them.

This topic provides information on the following:

Overview

An authorization check for single login takes place when you call the utilities AE DB Client Copy, About AE DB Archive or AE DB Reorg in batch mode. Example: The utility aborts if there is no User object for the OS user that logged into the AE system. This check is always made even if the system variable UC_USER_LOGON includes all relevant entries. Single login provides increased security in batch mode. If a program starts with the Automic Web Interface, single login increases the ease of use.

Windows

By default, utilities start in batch mode when you use the corresponding *.EXE files. Files that end on *G.EXE start the utilities in normal mode. Despite this, you can assign parameters to *G.EXE files. Example: You want to call a specific INI file. The parameter -B must not be used in such a case.

Unix

By default, utilities start in batch mode when you use the corresponding *.sh files. Files without file ending can be used to assign start parameters for the batch calls.

Java Loader

Program: Java Loader

Start Parameter

Description
-F0File name Suppresses the splash screen
-IPath and File name Path and name of the INI file for the Java loader
-JParameter

Parameter of the utility

You can use the Java loader to assign parameters to the utility as shown below. These parameters are added to the cmd section in the INI file. This means that you can specify a default setting in the INI file and handle specific situations via the Java loader.

It is mandatory to use double quotations for

  • the parameter chain
  • path indications that include blanks.

    • Example:

    -J"-I""C:\AUTOMIC\my utilities\UCYBDBAR.ini"""

Examples

Set the language by using a shortcut :

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

Pre-determine the language by using a shortcut:

UCYBDBarg.exe -F0 -J"-LD"

If you define an INI file for the utility, you must use the parameter -I twice, even if the Java loader and the utility use the same INI file.

Java loader and utility use the same INI file:

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

Different INI files are used:

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

AE DB Archive

This utility archives messages, reports and statistics.

Syntax - Archiving Mode

UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm

Syntax - Report Mode

UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm -XMode

UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm -Xlist [-OPath and Filename] [-YNumber]

UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm -Xunload [-OPath and Filename] [-YNumber] -RRunID [-TTimezone] [-TYReport type]

UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm -Xmark -RRunID [-TYReport type]

UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Xreport -NObject [-T1yyyymmddhhmmss] [-T2yyyymmddhhmmss] [-PPath and file prefix]

Program: UCYBDBAR

Start Parameter

Description

-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

Path and the name of the INI file

-LLanguage

Language

Allowed values:
D = German, 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

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.

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. It is not possible to use SMITH/AE and SMITH/TEST.

-Dmmmm

Windows only: 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.

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

Report mode

 

-Smmmm
-Dmmmm

In report mode, you must always define a client, except for -Xreport. The same rules apply for the parameters -S and -D as in archiving mode.

Depending on the report mode that you use, the client specification can have different meanings:

-Xlist -The client whose reports should be listed.

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

-XMode

Type of  report handling

For Output Management systems:

list - Reports are listed.
unload - The report is unloaded.
mark - The report is flagged as archived and removed from the database table "XRO".

For combining log and trace files:

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

Parameters for -Xlist

 

-OPath and file name

Path and name of the CSV file

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

-YNumber

Filter for the report selection

Parameters for -Xunload

 

-OPath and file name

Path and name of the text file

The dot character (.) is used as a separator between the file name and the extension. If the name contains several dot symbols, the last one will be regarded as a separator between the file name and the extension. The text after the dot will be handled as the file extension.

A file with the additional suffix _Report type in the file-name part is created in the specified folder for each report of the task.

Examples:

-OOutputfile.txt -> Outputfile_ACT.txt

-OOutputfile.job.name.txt -> Outputfile.job.name_ACT.txt

-OOutputfile.job123456 -> Outputfile_ACT.job123456

or generic:

-OOutputfilename.extension (the last dot is used as extension separator) -> Outputfilename_ReportType.extension

The name uc_XROreport_Report type.txt 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

Sets a number for later filtering

-RRunID

RunID of the task

-TTimeZone

Name of a Time Zone object

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

UTC is used if this Time Zone object does not exist in the specified client.
-TYReport type

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

RunID of the task
-TYReport type

Type of the report (such as ACT)

All report types are archived if this parameter is not specified. A separate file is created for each report type. Names end with _report type (such as _ACT).

Parameters for -Xreport

 

-NObject

The name of an object or a filter that uses an asterisk symbol (*) for several objects.

Separate several specifications with commas

-T1yyyymmddhhmmss

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

Default: The current date and time 00:00:00

-T2yyyymmddhhmmss

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

Default: The current date and time

-PPath and file prefix

Path and 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 the status 123.

UCYBDBar -B -Xunload -S1000 -R1791029 -Y123

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

UCYBDBar -B -Xmark -S1000 -R1791029

All server reports of March 15th, 2018 should be unloaded.

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

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

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

AE DB Change

This utility changes objects that were transported with the Transport Case.

Syntax

UCYBCHNG [-V[Path and file name]] -B -1Script File -2Transport File [-3Output File] [-LLanguage]

Program: UCYBCHNG.EXE

Start Parameter

Description

-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 = German, E = English, F = French

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

Example

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

AE DB Client Copy

This utility copies and deletes clients.

Syntax (Copy Mode)

UCYBDBCC [-V[Path and file name]] [-IFile name] [-LLanguage] -B -C -Smmmm -Tmmmm -O [-M][-A][-R] [-V] [-W]

Syntax (Delete Mode)

UCYBDBCC [-V[Path and file name]] [-IFile name] [-LLanguage] -B -E -Smmmm

UCYBDBCC [-V[Path and file name]] [-IFile name] [-LLanguage] -B -E -Tmmmm

Program: UCYBDBCC

Start Parameter

Description

-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

Path and name of the INI file

-LLanguage

Language

Allowed values:
D = German, 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

Number of the source client

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

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. It is not possible to use SMITH/AE and SMITH/TEST.

-Dmmmm

(Windows only) The number of the source client

Important: 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.

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 password

-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

AE DB Load

This utility loads data to the database.

Syntax (Loading the Transport Case / Initial Data)

UCYBDBLD [-V[Path and file name]] [-IFile name] [-FFolder handling] [-LLanguage] -B -Cmmmm [-EMode] [-UName/Department] [-GName] [-AAccess] [-MAccess] -XFile name

Syntax (Setting the Authentication Method)

UCYBDBLD [-V[Path and file name]] [-IFile name] [-LLanguage] -B -TAuthentication method-KCompany key string

Program: UCYBDBLD

Start Parameter

Description

-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
-FFolder handling

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 kept.

Allowed value = OT

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

-LLanguage

Language

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

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

-B

Batch mode
-ILM

Install ILM

  • -N[X]

    Number of active partitions

  • -SAH_part1|AH_part2|AH_part3

    List AH partitions separated by |

  • -RRH_part1>RH_part2|RH_part3

    List RH partitions separated by |

  • -OMisc_part1|Misc_part2|Misc_part3

    List Misc partitions separated by |

  • -D

    Do switch in

Example

ucybdbld.exe -B -ILM -N3 "-SAH_1|AH_2|AH_3" "-RRH_1|RH_2|RH_3" "-OMisc_1|Misc_2|Misc_3" -D -X..\db\general\12.0\UC_UPD.TXT

-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 = The object is skipped (default).
ABEND = Processing is canceled.
REPLACE = The existing object is replaced.

Important: IGNORE requires that the original object and the object that should be loaded are of the same type. Otherwise, processing will abort before the loading process starts.

-UName/Department

The name and the department of a default user

The default user can be used if a specific user does not have access rights on object level

-GName

The name of the default user group

The default user group can be used if a specific user group does not have access rights on object level.

-AAccess

Loads access authorizations on object level. See Managing Authorizations at Object Level

Allowed values:
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 = 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).

-XFile name

The name of the file that should be loaded. This start parameter is obligatory.
-TAuthentication method
-KCompany key string

Authentication details

Only use the utility with these start parameters if you newly install without using the Automic Web Interface.

Use both parameters together.

Use -T to

  • set the authentication method by entering one of the following values:

    • NO
    • LOCAL
    • LOCAL_REMOTE
  • export a file that contains the authentication key. For this purpose, enter PACKAGE.

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 you do not use authentication (-TNO). We recommend using the AE system name as the company key.

Important: Using these start parameters results in an error when the initial data is loaded for the first time. Use the utility to create the schema and then restart it to set the authentication details.

Example:

Step 1: java -jar ucybdbld.jar -B -XC:\AE\Utility\db\general\12.1\UC_UPD.TXT
Step 2: java -jar ucybdbld.jar -B -TNO -Kabc

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

If the string includes special characters, you must specify it in inverted commas. 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

The authentication method Server and Agent should be specified in the AE system.

UCYBDBld -B -TLOCAL_REMOTE -KUC4PROD

AE DB Reorg

This utility reorganizes messages, reports, statistics and object versions.

Syntax

UCYBDBRE [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm

Program: UCYBDBRE

Start Parameter

Description

-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 = German, 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.

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". It is not possible to use SMITH/AE and SMITH/TEST.

-Dmmmm

(Windows only) 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.

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

Example

Client 98 is reorganized.

UCYBDBre -B -S0098

AE DB Reporting Tool

This utility facilitates user-defined AE queries.

Syntax

UCYBDBRT [-IFile name] [-LLanguage] [-Cmmmm]-XPath and filename [-Ryyyymmdd[hhmm]] [-S] [-OPath and filename] [-TFile type]

Program: UCYBDBRT.EXE

Start Parameter

Description

-Cmmmm

Client number for processing

Overwrites the client that is specified in the query definition.

-XPath and file name

Path and the name of the XML file

-IPath and file name

Path and the name of the INI file

-LLanguage

Language

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

-Ryyyymmdd[hhmm]

Reference date for the analysis of statistics and forecasts

Overwrites the query definition.

Tip: The entries of the AE database are stored in UTC. Therefore, use this time zone also for specifying the reference time.

-S

Returns the number of output lines

-OPath and file name

Path and name of the output file

-TFile type

Type of the output file

Allowed values: CSV and HTML

Example

The query that is defined in the file jobtop10.d.xml is used to create an analysis for client 100.

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

AE DB Revision Report

This utility creates revision reports.

Syntax

UCYBDBRR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Cmmmm [-OPath and filename] [-FType1,Type2,...] [-D1yyyymmddhhmmss] [-D2yyyymmddhhmmss] [-A] [-X]

Program: UCYBDBRR.EXE

Start Parameter

Description

-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 = German, 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

Client number for processing

-OPath and file name

Path and name of the revision report

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

-FType1,Type2,...

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

Allowed values:

ACCESS - Unauthorized access
CANCEL - Tasks aborted
CREATE - New objects created
DELETE - Objects deleted
IMPORT - Objects imported
MOVE - Objects moved
OBJ_MOD - Object modifications
RENAME - Objects renamed
RESTART - Tasks restarted
RESTORE - Objects restored
RUN_MOD - Objects modified at runtime
START - Tasks started
TRNSPRT -Objects transported
USER - Successful user logons and logoffs

The utility outputs all contents to the revision report if you do not use this parameter, or if you use -F*.

-D1yyyymmddhhmmss

Start date and time for logging

By default, the selection is not limited by a start time. We recommend that you specify a start time, as otherwise the Revision Report will be very large.

The time zone of the client is used. If the client does not include a time zone specification, the one of system client 0000 is used. If it does not include a time zone specification, UTC is used.

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

-D2yyyymmddhhmmss

The end date and the time for logging

Default value: current date and time

The time zone of the client is used. If the client does not include a time zone specification, the one of system client 0000 is used. If it does not include a time zone specification, UTC is used.

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

-A

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

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

-X

Use this parameter to have only modification entries that have never been output by the utility before written to the report such as entries that do not have archive flags.

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 -D120170501000000

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 -D120171001080000 -D220171001200000

AE DB Unload

This utility unloads data and licenses.

Syntax

UCYBDBUN [-V[Path and file name]] [-IFile name] [-LLanguage] -BMode [-D][-Cmmmm] [-XFile name] [-K]

Program: UCYBDBUN

Start Parameter

Description

-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

 

Path and name of the INI file

-LLanguage

Language

Allowed values:
D = German, 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. Only initial data such as XREQs is unloaded.
DEFAULT = Default data of the system is unloaded (such as 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 -D.
RESETARCHIVE = Archive flags are reset. See About AE DB Archive
RESETREORG = Deletion flags are reset. See AE DB Reorg

-D

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

-Cmmmm

Number of the client that is used to unload the Transport Case

All clients are unloaded if you do not define a client here

You cannot unload client 0. Even if you use -C0, all clients will be unloaded except for client 0.

-XFile name

The name of the file that should receive the unloaded data

If you do not use this parameter, the utility uses the name and path of the file that is specified in the INI file*s output= parameter.

You cannot use this parameter with the mode -BREORG because these specific files are subject to a given naming convention.
-K Setting this parameter has the effect that deleted objects are still available in the Recycle Bin after the unloading process.

Examples

The AE database is reorganized.

UCYBDBun -BREORG

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

UCYBDBun -BTRANSPORT -D -C0011

The utility has sent the message U0021148 which refers to error in the folder structure of a client. Therefore, you want to call the correction function.

UCYBDBun -BREPAIR

AE.LogMix

This utility combines log and trace files.

Syntax

UCYBLGMX [-V[Path and filename]] -B-LPaths and names of log and trace file -FPath and name of the target file

Program: UCYBLGMX

Start Parameter

Description

-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.

There are two options to define the files:

  • Path file1, file2, file3

    • In this case, the path that is used for the first file will also be used for the subsequent files.

  • Path and file1, path and file2, path and file3

You can use the wildcard character "*" in file names.

If you do not define a path, the folder is used from which you call the utility.

-FPath and name of the target file

The path and the name of the target file

No path definition is required if the target file should be created in the same folder as the utility.

Existing files of the same name are overwritten.

Example

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

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

See also: