Action Categories
CSV
Action | Description | Required Parameters | Optional Parameters | Type |
---|---|---|---|---|
convertCsv | Convert CSV file data from the source file. Use the file parameter to direct output to a file. Default behavior is to produce a simple HTML table. Customized HTML output is possible using a property file. Other output types are available with the outputType parameter. Valid values are: text, table, html, json, variables. Optionally provide subset and order columns using the columns parameter. Subset and order columns using the columns parameter. If requested, find and replace logic will be applied to the source data before processing. | columns, augments, headingAugments, select, options, outputType, findReplace, findReplaceRegex, findReplaceScope, propertyFile, input, file, append, encoding | ||
copyCsv | Copy csv data from the source file. Use the file parameter to direct output to a file. When append is used, only data rows (not the header row) will be copied. If provided, only columns identified by the columns parameter will be included in the order specified. If requested, find and replace logic will be applied to the source data before processing. Note that if database parameters are provided, the CSV data can be loaded into a database table just like support provided by list actions. | columns, augments, headingAugments, select, options, findReplace, findReplaceRegex, findReplaceScope, outputType, file, append, encoding |
Info
Action | Description | Required Parameters | Optional Parameters | Type |
---|---|---|---|---|
getClientInfo | Get information about this client. |
| outputFormat, file, limit, regex, append, encoding, columns, select, options | |
getUpgradeInfo | Get information about upgrades available for this client. |
| ||
help | Show general help information for the client including actions and parameters. When used on a partial action string, action specific help will be shown. |
|
| |
provideFeedback | Provide feedback, comments, and suggestions to ACLI developers based on your experience with the product. We appreciate all feedback in the spirit of continuous improvement in helping customers with their tasks. For specific product issues and immediate help, please submit a request to our support portal at https://bobswift.atlassian.net/servicedesk. |
|
Render
Action | Description | Required Parameters | Optional Parameters | Type |
---|---|---|---|---|
renderRequest | Render URL based request. URL can be a partial URL. The response data is returned optionally modified by findReplace processing. Use '--pretty' to format returned JSON data in a more readable form. Also, for JSON data, you can use '--options setReplacementVariables'. | requestType, data, contentType, acceptType, findReplace, findReplaceRegex, file, encoding, header |
Run
Action | Description | Required Parameters | Optional Parameters | Type |
---|---|---|---|---|
run | Run actions from a file, list of input parameters, or standard input (default). Use one or more field parameters to set replacement variables that can be used in run script actions. This makes it possible to parameterize the script so it can be applied to more general use cases. For example, '--field project=MYPROJECT'. This capability is available for all run type actions. |
| file, input, common, continue, simulate, field, file, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex | |
runFromCsv | Run actions generated from a CSV file. The default behavior is that each column name that matches a valid parameter for the client generates a parameter with value matching the column value for the row being process. Alternatively, use '--options setReplacementVariables' to change the behavior to set a replacement variable whose key (case sensitive) is the column name with blanks removed and whose valid is the value matching the column value for the row being processed. | propertyFile, common, input, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex | ||
runFromJson | Run actions based on JSON data used for replacement variables and list processing based on standard Json paths specified for list and list2 parameters. Valid JSON data must be provided using the data parameter or file parameter. Actions can be specified using input, common, or file (when not used for data) parameters. Replacement variables are defined from the JSON data using JsonPath naming convention with dot separators. See the JsonPath reference at https://github.com/json-path/JsonPath/blob/master/README.md. | list, list2, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | ||
runFromList | Run actions for each entry in a list with corresponding entry replacement variable. When file is provided, each action in the file augmented by the common parameter will be run for each entry. Otherwise, just the action specified by the common parameter will be run. When available, list2 entries provide values for the entry2 replacement variable. By default, the entry2 replacement variable is set in parallel with entry replacement variables for each action run. However, if '--options listProcessing=serial' is specified, each combination of entries from list and list2 will cause an action to run. Use one or more field parameters to set replacement variables that can be used in run script actions. This makes it possible to parameterize the script so it can be applied to more general use cases. For example, '--field project=MYPROJECT'. | list2, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | ||
runFromPropertyFile | Run actions for each entry from a (Java) property file. | continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | ||
runFromSql | Run actions generated by SQL provided by the sql parameter, a file, or standard input. The default behavior is that each column name that matches a valid parameter for the client generates a parameter with value matching the column value for the row being process. A special case is if the value of the first column starts with a '-', then the entire row will be treated as a single action. Alternatively, use '--options setReplacementVariables' to change the behavior to set a replacement variable whose key (case sensitive) is the column name, with blanks removed, and whose valid is the value matching the column value for the row being processed. | database, url, dbUser, dbPassword, propertyFile, common, input, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex | ||
runIf | Run actions only if a regex based condition is met. Other parameters and behavior are the same as the run action. By default the regex is used for a find of the value parameter. Options parameter can be set to one or more of the following to modify the default behavior: literal - to treat the regex string as a literal string, exact - to require an exact match of the value, negative - to reverse the condition so a match means do NOT run action. Use one or more field parameters to set replacement variables that can be used in run script actions. This makes it possible to parameterize the script so it can be applied to more general use cases. For example, '--field project=MYPROJECT'. | value, options, common, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex |
System
Action | Description | Required Parameters | Optional Parameters | Type |
---|---|---|---|---|
sleep | Sleep a number of seconds. Defaults to 1 second. Use in CLI scripts that may need to wait before proceeding to the next action. For instance, waiting for server to complete updating search indexes or polling type scenarios. |
|
Variables
Action | Description | Required Parameters | Optional Parameters | Type |
---|---|---|---|---|
getReplacementVariableList | Get a list of replacement variable names and values with regex filtering on name. This action is only useful within a run script where replacement variables are remembered. |
| ||
setReplacementVariables | Set one or more replacement variables specified using field parameters with name=value syntax or loaded from a property file. Value specified replaces any previously set variable with the same name including values set by other actions that set replacement variables. This is an example to save a previously set value: --field myIssue=@issue@. Find and replace logic is applied to the value before setting the variable providing a way to manipulate values in a script. Variables are available only within the scope of the run script they were set in. |
|