Please use y-ageclitool.bat for Windows® operating systems and y-ageclitool.sh for Unix operating systems. On Unix operating systems, only the aris10 user can start the command-line tools (sh files), except for the y-setenv.sh file. For example, enter: su -c y-ageclitool.sh aris10.
General usage
Options |
Description |
---|---|
-?, -h, --help |
Show help, default: false |
Commands |
Description |
Parameters |
---|---|---|
anonymize |
This command anonymizes the given user in Process Governance data, for example, in substitution logs or audit logs. All user names are replaced with anonymous. This is compliant to GDPR. The General Data Protection Regulation (GDPR) protects individuals’ personal data within the European Union. It also regulates the export of personal data outside the EU. GDPR is a regulation by the European Parliament, the Council of the European Union, and the European Commission. The Process Governance services can write user specific data to attributes. These attribute values can be anonymized with the help of customized reports in order to meet the requirements of the General Data Protection Regulation (GDPR). Please contact your local Software AG sales organization. |
Usage: y-ageclitool [command] [options] -apg, --apg-endpoint -du, --deleted user name User name of the deleted user Mandatory parameter -p, --password Password of executer Default: manager * -t, --tenant Tenant name -umc, --umc-endpoint -u, --user User name of executer Default: system The user name is replaced by the string anonymous. |
cancelHTOfCompletedInstance |
Cleans up pending human tasks belonging to process instances that are already completed. |
Usage: y-ageclitool [command] [options] -apg, --apg-endpoint -ht, --human-task-id -p, --password Password of executer Default: manager * -t, --tenant Tenant name -umc, --umc-endpoint -u, --user User name of executer Default: system |
findSubstitutees |
This command finds all users for whom a given user acts as a substitute. |
Usage: y-ageclitool [command] [options] -apg, --apg-endpoint -p, --password Password of executer Default: manager -su, --substitue the login name of the user login name of the substitute Mandatory parameter * -t, --tenant Tenant name -umc, --umc-endpoint -u, --user User name of executer Default: system |
getConfigProperty |
This command returns the value of a configuration property. You can retrieve both cross-tenant and tenant-specific properties. You can also retrieve hidden properties. The output of the command contains only the value of the property. If a property value is empty, the output is an empty string. |
Usage: y-ageclitool [command] [options] -apg, --apg-endpoint * -k, --config property key * -t, --tenant Tenant name -u, --user User name of executer Default: system -p, --password Password of executer Default: manager |
purgeAuditlogs |
The command deletes all audit logs from a start date, if specified, up to, and including, the specified end date. The start date and the end date must be in the format yyyy-MM-dd |
Usage: y-ageclitool [command] [options] -p, --password Password of executer Default: manager -t, --tenant Tenant name Mandatory parameter -u, --user User name of executer Default: system -sd, --startDate Start date -ed, --endDate End date Mandatory parameter -umc, --umc-endpoint |
rebalance |
This command distributes the process instances equally among the Process Governance nodes if the PROCESS_INSTANCE_BASED assignment strategy is configured. Users can perform this command on the infrastructure tenant (master) only. |
Usage: y-ageclitool [command] [options] -p, --password Password of executer Default: manager -u, --user User name of executer Default: system -umc, --umc-endpoint |
setConfigProperty |
This command sets the value of a configuration property. You can specify the configuration property value for a tenant-specific property. You can also specify hidden properties if they are tenant-specific. |
Usage: y-ageclitool [command] [options] -apg, --apg-endpoint * -k, --config property key * -v, --config property value * -t, --tenant Tenant name -u, --user User name of executer Default: system -p, --password Password of executer Default: manager |
Example
y-ageclitool.bat findSubstitutees -s http://myarishost.com:1080 -apg http://myarishost.com:1080 -umc http://myarishost.com:1080 -t default -u system -p manager -su substitutesname