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 page includes the following:

Overview

An authorization check for single login takes place when you call the utilities AE DB Client Copy, AE DB Archive, or AE DB Reorg in batch mode. For more information, see AE DB Client Copy, AE DB Archive, or AE DB Reorg.

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. For more information, see UC_USER_LOGON - Single Logon

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. The *.jar files should not be used in batch mode.

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

The following start parameters are available:

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

AEDB Archive

This utility archives messages, reports and statistics. For more information, see AE DB Archive.

Syntax

Program: UCYBDBAR

The following start parameters are available:

In Archive Mode:

In Report Mode:

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. For more information, see AE DB Change.

Syntax

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

Program: UCYBCHNG.EXE

The following start parameters are available:

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. For more information, see AE DB Client Copy.

Syntax

Program: UCYBDBCC

The following start parameters are available:

In Copy Mode:

In Delete 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. For more information, see AE DB Load.

Note: To load the database for Rapid Automation solutions, you must use the .jar Loader (ucybdbld.jar). Loading with the utility using the binary executables (ucybdbld.exe for Windows or ucybdbld for Unix) in batch mode is not possible.

Syntax

Program: UCYBDBLD

The following start parameters are available:

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

The database is upgraded in batch (UNIX):

./ucybdbld -B -X/opt/automic/Automation.Platform/Utility/db/general/21.0/UC_UPD.TXT

The database is loaded for a Rapid Automation solution:

java -jar ucybdbld.jar -B -C0000 -X/tmp/WebService_SOAP_solution.jar

AEDB Reorg

This utility reorganizes messages, reports, statistics, and object versions. For more information, see AE DB Reorg

Syntax

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

Program: UCYBDBRE

The following start parameters are available:

Example

Client 98 is reorganized.

UCYBDBre -B -S0098

AE DB Reporting Tool

This utility facilitates user-defined AE queries. For more information, see AE DB Reporting Tool.

Syntax

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

Program: UCYBDBRT.EXE

The following start parameters are available:

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

AEDB Revision Report

This utility creates revision reports. For more information, see AE DB Revision Report.

Syntax

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

Program: UCYBDBRR.EXE

The following start parameters are available:

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. For more information, see AE DB Unload.

Syntax

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

Program: UCYBDBUN

The following start parameters are available:

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 reports, logs and trace files. For more information, see AE.LogMix - Combining Report, 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

The following start parameters are available:

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: