- Technical scope & concept
- Installation — install, update & uninstall
- Configuration — utility directories and OS settings
- Actions — all 11 actions with their parameters
- Upgrade & migration
- Release notes
- FAQ
Concept & technical scope
The Automation Utility Action Pack is a dedicated toolkit for managing and maintaining the database of Broadcom Automic Automation from within Automic workflows. It wraps the native Automic utilities as reusable actions and adds combined processes for backups and reorganisations of the whole system or of selected clients. Every action runs both interactively and in batch mode.
Why database maintenance matters
A lot of data accumulates during the daily operation of an Automation Engine system: statistics, reports, messages and the data for the AE DB Revision Report and for the interface to output management systems. The Automic utilities are the tools administrators use to keep the database small, to reorganise it with minimal loss of integrity and to keep the system fast.
Automic ships these utilities as programs with a frontend and a batch mode. The Automation Utility Action Pack integrates exactly these programs into Automic and combines them into ready-made maintenance processes.
What an Action Pack is
Action Packs are prebuilt integration modules for automation platforms such as Automic Automation. They bundle preconfigured, tested actions that can be reused in any workflow, so complex automation is built faster and with less troubleshooting. The Automation Utility Action Pack follows the same model: every database maintenance task is a parameterised action that can be started from the AWI or plugged into a workflow.
Main components & functions
The Automation Utility Action Pack covers three functional areas:
Single utilities
- DB Archive (ucybdbar)
- DB Change (ucybdbch)
- DB Client Copy (ucybdbcc)
- DB Load (ucybdbld)
- DB Reorg (ucybdbre)
- DB Unload (ucybdbun)
Combined processes
- Backup of the full system (DB Backup Full)
- Backup of selected clients (DB Backup Part)
- Reorganisation of the full system (DB Reorg Full)
- Reorganisation of selected clients (DB Reorg Part)
Setup
- One CONFIGURATION action that stores the utility directories and OS settings for all other actions
Benefits
- Standardised processes — archiving, reorganisation, backups and client copies run the same way on every Automic system.
- Improved usability — prompts with prefilled values replace hand-written command lines around the utility programs.
- Native Automic integration — the pack follows the Action Pack concept, so every action can be started from the AWI or as a step in a workflow.
Requirements & compatibility
Automic Automation
- Minimum version: Automic Automation V24
- Installation in any client except client 0
Automic utilities
- The Automic utilities installed on the host that runs the utility jobs, with a bin and a temp directory (for example /opt/automic/Utility/bin)
- An Automic agent on that host; the actions run as Windows or UNIX jobs
ITPA Shared Action Pack
- Optional: the dependent Action Pack PCK.ITPA_SHARED; install it first if it is not already present
Installation
The Automation Utility Action Pack is installed via the standard Automic Action Pack mechanism. It can be installed in any client of the Automic Automation system except client 0. The same procedure is used for the initial installation and for updates to a newer version.
Install or update
Uninstall
To remove the Automation Utility Action Pack from a client, follow these steps:
Configuration reference
After installation, the Automation Utility Action Pack needs to know where the Automic utilities are installed and how their jobs are started on the operating system. This is set once with the action CONFIGURATION; all other actions read the stored values.
Setup workflow
Configuration parameters
Parameters of the action PCK.TRICISE_AUT_UTILITY.PUB.ACTION.CONFIGURATION:
| Parameter | Variable | Description & example |
|---|---|---|
| Utility bin-directory | &AUT_UTILITY_BIN_DIR# | bin directory of the Automic utilities. Example: /opt/automic/Utility/bin |
| Utility temp-directory | &AUT_UTILITY_TEMP_DIR# | temp directory of the Automic utilities. Example: /opt/automic/Utility/temp |
| Unix shell (optional) | &AUT_UTILITY_UNIX_SHELL# | Shell for the utility jobs when the utilities run on UNIX. Example: ksh |
| Win logon as batch | &AUT_UTILITY_WIN_BATCHMODE# | Log-on-as-batch setting for the utility jobs when the utilities run on Windows. Example: N |
Actions reference
The Automation Utility Action Pack ships with 11 actions: the configuration action, six actions for the single Automic utilities and four combined processes. Every action has a fully qualified object name following the pattern PCK.TRICISE_AUT_UTILITY.PUB.ACTION.<NAME> and can be run interactively from the AWI or unattended as part of a workflow.
Overview
| Action | Object name | What it does |
|---|---|---|
| Configuration | CONFIGURATION | Stores the utility directories and OS settings for all other actions. |
| DB Archive | DBARCHIVE | Runs DB Archive (ucybdbar) for one client. |
| DB Change | DBCHANGE | Runs DB Change (ucybdbch) on a transport case. |
| DB Client Copy | DBCLIENTCOPY | Runs DB Client Copy (ucybdbcc) to copy or delete a client. |
| DB Load | DBLOAD | Runs DB Load (ucybdbld) to load a transport case or initial load file. |
| DB Reorg | DBREORG | Runs DB Reorg (ucybdbre) for one client. |
| DB Unload | DBUNLOAD | Runs DB Unload (ucybdbun) for one client. |
| DB Backup Full | DBBACKUPFULL | Backs up all clients except client 0 into one transport case. |
| DB Backup Part | DBBACKUPPART | Backs up a list of selected clients. |
| DB Reorg Full | DBREORGFULL | Archives, reorganises and unloads all clients, one client after the other. |
| DB Reorg Part | DBREORGPART | Archives, reorganises and unloads a list of selected clients. |
4.1 · Configuration
Creates the configuration that all other actions use to run the Automic utilities.
Object name: PCK.TRICISE_AUT_UTILITY.PUB.ACTION.CONFIGURATION
Parameters: see the configuration reference in section 3.
4.2 · DB Archive
Runs the Automic utility DB Archive (ucybdbar) for one client and sets the archive flags for its statistics, reports and messages.
Object name: PCK.TRICISE_AUT_UTILITY.PUB.ACTION.DBARCHIVE
| Parameter | Variable | Description & example |
|---|---|---|
| Client | &AUT_UTILITY_CLIENT# | Client for which the archive flags are set. Example: 0000 |
4.3 · DB Change
Runs the Automic utility DB Change (ucybdbch). It applies the rules of a change script to a transport case and writes the result to a new file, for example to rename hosts or to adapt objects to another environment.
Object name: PCK.TRICISE_AUT_UTILITY.PUB.ACTION.DBCHANGE
| Parameter | Variable | Description & example |
|---|---|---|
| Script file | &AUT_UTILITY_SCRIPTFILENAME# | Change script file with the change rules. Example: /opt/automic/Utility/db/uc_rules.txt |
| Transport file | &AUT_UTILITY_TRANSPORTFILENAME# | Transport case file used as input. Example: /opt/automic/Utility/db/uc_data.txt |
| Output file | &AUT_UTILITY_OUTPUTFILENAME# | Transport case file written as output. Example: /opt/automic/Utility/db/uc_changed.txt |
4.4 · DB Client Copy
Runs the Automic utility DB Client Copy (ucybdbcc) to copy a client or to delete one.
Object name: PCK.TRICISE_AUT_UTILITY.PUB.ACTION.DBCLIENTCOPY
| Parameter | Variable | Description & example |
|---|---|---|
| Mode | &AUT_UTILITY_MODE# | Client copy mode: COPY or DELETE. Example: COPY |
| Source client | &AUT_UTILITY_CLIENT_SRC# | Client to copy from, or the client to delete. Example: 0001 |
| Destination client | &AUT_UTILITY_CLIENT_DST# | Client to copy to. Example: 9999 |
| Copy messages | &AUT_UTILITY_COPY_MESSSAGES# | Include the messages in the copy. Values: true / false. Example: false |
| Copy statistics/reports | &AUT_UTILITY_COPY_STATISTICS# | Include statistics and reports in the copy. Values: true / false. Example: false |
| Reset passwords | &AUT_UTILITY_RESET_PASSWORD# | Reset the user passwords in the copied client. Values: true / false. Example: false |
| Copy version objects | &AUT_UTILITY_COPY_VERSIONS# | Include version objects in the copy. Values: true / false. Example: false |
| Delete work files | &AUT_UTILITY_DELETE_FILES# | Delete the work files after the run. Values: true / false. Example: true |
4.5 · DB Load
Runs the Automic utility DB Load (ucybdbld) to load a transport case or an initial load file into a client.
Object name: PCK.TRICISE_AUT_UTILITY.PUB.ACTION.DBLOAD
| Parameter | Variable | Description & example |
|---|---|---|
| Client | &AUT_UTILITY_CLIENT# | Client into which the transport case is loaded. Example: 0001 |
| File name | &AUT_UTILITY_FILENAME# | Transport case or initial load file. Example: /opt/automic/Utility/db/uc_data.txt |
| Mode | &AUT_UTILITY_MODE# | Load mode: IGNORE, REPLACE or ABEND. Example: IGNORE |
4.6 · DB Reorg
Runs the Automic utility DB Reorg (ucybdbre) for one client and sets the reorganisation flags for its data.
Object name: PCK.TRICISE_AUT_UTILITY.PUB.ACTION.DBREORG
| Parameter | Variable | Description & example |
|---|---|---|
| Client | &AUT_UTILITY_CLIENT# | Client for which the reorganisation flags are set. Example: 0000 |
4.7 · DB Unload
Runs the Automic utility DB Unload (ucybdbun) for one client and writes the result to a file. The mode determines what is unloaded.
Object name: PCK.TRICISE_AUT_UTILITY.PUB.ACTION.DBUNLOAD
| Parameter | Variable | Description & example |
|---|---|---|
| Client | &AUT_UTILITY_CLIENT# | Client to unload. Example: 0000 |
| File name | &AUT_UTILITY_FILENAME# | Output file for the transport case. Example: /opt/automic/Utility/db/uc_data.txt |
| Mode | &AUT_UTILITY_MODE# | Unload mode: DEFAULT, NORMAL, REORG, REPAIR, RESETARCHIVE, RESETREORG, TRANSPORT, TRANSPORTALL. Example: TRANSPORT |
4.8 · DB Backup Full
Backs up all clients of the Automic system except client 0 into one transport case.
Object name: PCK.TRICISE_AUT_UTILITY.PUB.ACTION.DBBACKUPFULL
Sub-processes:
- DBUNLOAD
| Parameter | Variable | Description & example |
|---|---|---|
| Backup path | &AUT_UTILITY_BACKUPPATH# | Directory for the backup transport cases. Example: /opt/automic/Utility/db |
4.9 · DB Backup Part
Backs up a list of selected clients and creates transport cases for them.
Object name: PCK.TRICISE_AUT_UTILITY.PUB.ACTION.DBBACKUPPART
Sub-processes:
- DBUNLOAD
| Parameter | Variable | Description & example |
|---|---|---|
| Clients | &AUT_UTILITY_CLIENTS# | Comma-separated list of the clients to back up. Example: 0001,0002 |
| Backup path | &AUT_UTILITY_BACKUPPATH# | Directory for the backup transport cases. Example: /opt/automic/Utility/db |
4.10 · DB Reorg Full
Reorganises all clients of the Automic system. Archive, reorg and unload run client by client, so each client is completely processed before the next one starts.
Object name: PCK.TRICISE_AUT_UTILITY.PUB.ACTION.DBREORGFULL
Sub-processes:
- DBARCHIVE
- DBREORG
- DBUNLOAD
| Parameter | Variable | Description & example |
|---|---|---|
| Archive | &AUT_UTILITY_ARCHIVE# | Run DB Archive as part of the reorganisation. Values: true / false. Example: false |
| Reorg | &AUT_UTILITY_REORG# | Run DB Reorg, which removes old statistics, reports and similar data. Values: true / false. Example: true |
4.11 · DB Reorg Part
Reorganises a list of selected clients, with the same client-by-client sequence as DB Reorg Full.
Object name: PCK.TRICISE_AUT_UTILITY.PUB.ACTION.DBREORGPART
Sub-processes:
- DBARCHIVE
- DBREORG
- DBUNLOAD
| Parameter | Variable | Description & example |
|---|---|---|
| Clients | &AUT_UTILITY_CLIENTS# | Comma-separated list of the clients to reorganise. Example: 0001,0002 |
| Archive | &AUT_UTILITY_ARCHIVE# | Run DB Archive as part of the reorganisation. Values: true / false. Example: false |
| Reorg | &AUT_UTILITY_REORG# | Run DB Reorg, which removes old statistics, reports and similar data. Values: true / false. Example: true |
Upgrade & migration
Upgrades of the Automation Utility Action Pack use the same procedure as the initial installation: Administration → Packs → Install From File, select the new file and confirm with Install. The Automic Action Pack mechanism replaces the installed version automatically.
Before upgrading
- Make sure that no backup or reorganisation process is running, and pause scheduled workflows that use the Action Pack
- If installed, check that the dependent PCK.ITPA_SHARED Action Pack is at a version compatible with the new release
- Take a backup of the client if your environment requires a rollback point
After upgrading
- The configuration stays in place; there is no need to run CONFIGURATION again
- Run a short action against a test client as a smoke test
- Resume the paused workflows
Release notes
All versions of the Automation Utility Action Pack and what changed in each.
v1.7.5 (current) · 2025-07-10
| Version | Type | Change |
|---|---|---|
| 1.7.5 2025-07-10 | Fixed | The PREPROCESS include no longer sets ARCHIVE_KEY1, because DB Change has no client variable |
Earlier versions
Versions 1.0.0 – 1.7.4
| Version | Type | Change |
|---|---|---|
| 1.7.4 2024-02-29 | Changed | Action Pack renamed to PCK.TRICISE_AUT_UTILITY |
| 1.7.3 2023-12-19 | Fixed | The options of the reorganisation and backup processes can be set up again |
| Fixed | ARCHIVE_KEY1 contains the client number on job level | |
| Fixed | Db2 statements added to the SQLI variables | |
| 1.7.2 2023-09-08 | Changed | Usability improvements with prefilled fields |
| 1.7.1 2023-08-28 | Changed | Prescript include added to the jobs |
| Changed | Windows jobs set the attribute WIN_LOGON_AS_BATCH | |
| 1.7.0 2023-04-03 | New | Action DB Change |
| 1.6.0 2023-02-15 | Changed | Action Pack renamed to PCK.CAPTURE_AUT_UTILITY |
| New | Action DB Revision Report | |
| 1.5.0 2022-11-24 | New | Action DB Backup Part: transport cases for several clients |
| New | Action DB Backup Full: one transport case for all clients except client 0 | |
| 1.4.3 | Fixed | JAR files removed from the store object of the libraries |
| 1.4.2 | Fixed | DB Reorg Full and DB Reorg Part: loop preconditions repeat instead of running once |
| 1.4.1 | Fixed | DB Reorg Full and DB Reorg Part: missing or wrong loop preconditions for the true/false check |
| 1.4.0 | Fixed | Reorg actions always pass the client with -S instead of -D |
| Changed | DB Reorg Full and DB Reorg Part run archive, reorg and unload client by client instead of step by step | |
| Changed | Actions stop on ENDED_NOT_OK | |
| Changed | Command includes with a rearranged parameter order | |
| New | Action CONFIGURATION for the initial setup of the Action Pack | |
| 1.3.2 | Fixed | Archive loop of DB Reorg Full uses &AUT_UTILITY_CLIENT# instead of &CLIENT# |
| Changed | Configuration object PCK.CUSTOM_AUT_UTILITY.PRV.VARA.CONFIG_DEFAULT.ORI is no longer overwritten by updates | |
| 1.3.1 | Fixed | Archive loop of DB Reorg Part uses &AUT_UTILITY_CLIENT# instead of &CLIENT# |
| 1.3.0 | New | Action DB Reorg Part |
| 1.2.0 | New | Action DB Reorg Full |
| 1.1.1 | Changed | Shell for UNIX jobs configurable (default -bash) |
| 1.1.0 | New | Action DB Client Copy |
| 1.0.0 | New | Initial version with DB Load, DB Unload, DB Archive and DB Reorg |
Frequently asked questions
Click any question to expand the answer.
What is the Automation Utility Action Pack and what does it do?
The Automation Utility Action Pack is a Tricise toolkit that runs the native Automic database utilities as reusable actions. It covers DB Archive, DB Change, DB Client Copy, DB Load, DB Reorg and DB Unload plus combined backup and reorganisation processes for the whole system or for selected clients, so database maintenance runs from Automic workflows instead of hand-written scripts.
Which Automic utilities are included?
Six utilities, each as its own action:
- DB Archive (ucybdbar) — action DBARCHIVE
- DB Change (ucybdbch) — action DBCHANGE
- DB Client Copy (ucybdbcc) — action DBCLIENTCOPY
- DB Load (ucybdbld) — action DBLOAD
- DB Reorg (ucybdbre) — action DBREORG
- DB Unload (ucybdbun) — action DBUNLOAD
The four combined processes DB Backup Full, DB Backup Part, DB Reorg Full and DB Reorg Part chain these utilities.
Which Automic versions and platforms are supported?
The Automation Utility Action Pack requires Automic Automation V24 or higher. The utility jobs run on the Windows or UNIX host where the Automic utilities are installed. For UNIX you can set the shell, for Windows the log-on-as-batch setting.
What is the difference between the Full and the Part processes?
The Full processes work on the whole system: DB Backup Full writes one transport case with all clients except client 0, and DB Reorg Full reorganises every client. The Part processes work on a comma-separated list of clients, for example 0001,0002.
In which order does a reorganisation run?
DB Reorg Full and DB Reorg Part process one client after the other. For each client they run DB Archive (if Archive is set to true), DB Reorg (if Reorg is set to true) and DB Unload. If a step ends with ENDED_NOT_OK, the process stops.
Where are the backups stored?
DB Backup Full and DB Backup Part write the transport cases created by DB Unload to the directory set in the Backup path parameter (&AUT_UTILITY_BACKUPPATH#), for example /opt/automic/Utility/db.
Can I copy or delete a client?
Yes. DB Client Copy runs in mode COPY or DELETE. For a copy you choose whether messages, statistics and reports and version objects are included, whether passwords are reset and whether the work files are deleted after the run.
Is my configuration kept when I update the Action Pack?
Yes. The configuration is stored in the customer-specific part of the pack (PCK.CUSTOM_AUT_UTILITY) and is not overwritten by an update. If you come from a version before 1.7.4, switch your workflows to the new object names PCK.TRICISE_AUT_UTILITY.*.
How is the Automation Utility Action Pack licensed?
The Automation Utility Action Pack is licensed as a one-time purchase of 3.200 € (excl. VAT) per Automic system — no recurring subscription, no expiry. The license includes Tricise product support and compatibility updates for the current Automic V24+ release line.