Versions Compared

Old Version 1

changes.mady.by.user Automation User

Saved on

compared with

New Version Current

changes.mady.by.user Elena Amandola (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Div
idProductTOC

On this page

P
Table of Contents
maxLevel1
typeflat
separatorpipe

Related information for 4.1.0

Actions

Parameter Tips

Parameters

P

csv

Action

outputwiki
sortColumn1
autoNumbertrue
sortIconfalse
Action, Category, Description, Required parameters, Optional parameters, Output formats
"[#bamboo] {anchor: bamboo}", , "Use the Bamboo CLI client to run an action.", "[#common]", , 
"[#confluence] {anchor: confluence}", , "Use the Confluence CLI client to run an action.", "[#common]", , 
"[#crucible] {anchor: crucible}", , "Use the Crucible CLI client to run an action.", "[#common]", , 
"[#fisheye] {anchor: fisheye}", , "Use the FishEye CLI client to run an action.", "[#common]", , 
"[#getClientInfo] {anchor: getClientInfo}", "Info", "Get information about the this client tool.", , , 
"[#jira] {anchor: jira}", , "Use the JIRA CLI client to run an action.", "[#common]", , 
"[#runFromCsv] {anchor: runFromCsv}", "Run", "Run actions generated from a CSV file.", "[#file]", "[#common], [#propertyFile], [#continue], [#quiet], [#simulate], [#encoding], [#findReplace], [#findReplaceRegex]", 
"[#runFromList] {anchor: runFromList}", "Run", "Run actions for each entry in a list. 	 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. 	 Available replacement variable is entry.", "[#list]", "[#file], [#common], [#continue], [#quiet], [#simulate], [#encoding], [#findReplace], [#findReplaceRegex]", 
"[#runFromSql] {anchor: runFromSql}", "Run", "Run actions generated by SQL provided by the sql parameter, a file, or standard input", "[#sql] or [#file] or standard input", "[#common], [#driver], [#database], [#host], [#port], [#url], [#dbUser], [#dbPassword], 	 [#propertyFile], [#continue], [#simulate], [#encoding], [#findReplace], [#findReplaceRegex]", 
"[#run] {anchor: run}", "Run", "Run actions from a file or standard input.", "[#file] or standard input", "[#common], [#continue], [#simulate], [#encoding], [#findReplace], [#findReplaceRegex]", 
"[#stash] {anchor: stash}", , "Use the Stash CLI client to run an action.", "[#common]", ,
Include Page
ACLI:Shared - tips for documentationACLI:Shared - tips for documentation
Csv
outputwiki
sortColumn1
columnTypesS,S,E,S
autoNumbertrue
sortIconfalse
Parameter, Short, Value, Description "action {anchor:action}", "a", "(/)", "columns {anchor:columns}", , "(/)", "Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns will be ignored." "common {anchor:common}", , "(/)", "Common parameter string added to all run actions." "connectionTimeout {anchor:connectionTimeout}", , "(/)", "Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite." "continue {anchor:continue}", , "(x)", "Continue processing even after errors are encountered." "database {anchor:database}", , "(/)", "Database name is required for SQL actions." "dateFormat {anchor:dateFormat}", , "(/)", "Format string for date in Java SimpleDateFormat, default is client date format." "dbPassword {anchor:dbPassword}", , "(/)", "Database user password. Defaults to password." "dbUser {anchor:dbUser}", , "(/)", "Database user name. Defaults to user." "debug {anchor:debug}", , "(x)", "Requests detail debug output. Optional for all actions." "driver {anchor:driver}", , "(/)", "JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions." "encoding {anchor:encoding}", , "(/)", "Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform." "file {anchor:file}", "f", "(/)", "Path to file based content or result output. Use - for standard input." "findReplace {anchor:findReplace}", , "(/)", "Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled." "findReplaceRegex {anchor:findReplaceRegex}", , "(/)", "Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled." "help {anchor:help}", , "(x)", "Prints this help message." "host {anchor:host}", , "(/)", "Database host server for SQL actions. Not used if url is provided. (default: localhost)" "list {anchor:list}", , "(/)", "Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled." "outputFormat {anchor:outputFormat}", , "(/)", "Specify output format for an action. (default: 1)" "parameters {anchor:parameters}", , "(/)", "Client specific parameters" "password {anchor:password}", "p", "(/)", "User password for remote access." "port {anchor:port}", , "(/)", "Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided." "propertyFile {anchor:propertyFile}", , "(/)", "Property file with mapping information." "quiet {anchor:quiet}", , "(x)", "Limit some output messages. Optional for all actions." "simulate {anchor:simulate}", , "(x)", "Simulate running actions. Log the action that would be taken." "special {anchor:special}", , "(/)", "Ordered list of alternate characters for comma ( , ), colon ( : ), at ( \@ ), quote ( ' ), and double quote ( "" ) characters used for specialized processing of some specific parameters." "sql {anchor:sql}", , "(/)", "SQL select statement used to generate a run script." "url {anchor:url}", , "(/)", "Action specific setting. Example: Database access url for SQL actions. Optional when host is provided." "user {anchor:user}", "u", "(/)", "User name for remote access." "verbose {anchor:verbose}", "v", "(x)", "Requests verbose output to help with problem determination. Optional for all actions."

Category

Description

Required parameters

Optional parameters

Output formats

1

bamboo

Anchor
bamboo
bamboo

 

Use the Bamboo CLI client to run an action.

common

 

 

2

confluence

Anchor
confluence
confluence

 

Use the Confluence CLI client to run an action.

common

 

 

3

crucible

Anchor
crucible
crucible

 

Use the Crucible CLI client to run an action.

common

 

 

4

fisheye

Anchor
fisheye
fisheye

 

Use the FishEye CLI client to run an action.

common

 

 

5

getClientInfo

Anchor
getClientInfo
getClientInfo

Info

Get information about the this client tool.

 

 

 

6

jira

Anchor
jira
jira

 

Use the JIRA CLI client to run an action.

common

 

 

7

runFromCsv

Anchor
runFromCsv
runFromCsv

Run

Run actions generated from a CSV file.

file

common, propertyFile, continue, quiet, simulate, encoding, findReplace, findReplaceRegex

 

8

runFromList

Anchor
runFromList
runFromList

Run

Run actions for each entry in a list. 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. Available replacement variable is entry.

list

file, common, continue, quiet, simulate, encoding, findReplace, findReplaceRegex

 

9

runFromSql

Anchor
runFromSql
runFromSql

Run

Run actions generated by SQL provided by the sql parameter, a file, or standard input

sql or file or standard input

common, driver, database, host, port, url, dbUser, dbPassword, propertyFile, continue, simulate, encoding, findReplace, findReplaceRegex

 

10

run

Anchor
run
run

Run

Run actions from a file or standard input.

file or standard input

common, continue, simulate, encoding, findReplace, findReplaceRegex

 

11

stash

Anchor
stash
stash

 

Use the Stash CLI client to run an action.

common

 

 

Parameter Tips

Include Page
Shared - tips for documentation
Shared - tips for documentation

Parameters

Parameter

Short

Value

Description

1

action

Anchor
action
action

a

(tick)

 

2

columns

Anchor
columns
columns

 

(tick)

Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns will be ignored.

3

common

Anchor
common
common

 

(tick)

Common parameter string added to all run actions.

4

connectionTimeout

Anchor
connectionTimeout
connectionTimeout

 

(tick)

Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.

5

continue

Anchor
continue
continue

 

(error)

Continue processing even after errors are encountered.

6

database

Anchor
database
database

 

(tick)

Database name is required for SQL actions.

7

dateFormat

Anchor
dateFormat
dateFormat

 

(tick)

Format string for date in Java SimpleDateFormat, default is client date format.

8

dbPassword

Anchor
dbPassword
dbPassword

 

(tick)

Database user password. Defaults to password.

9

dbUser

Anchor
dbUser
dbUser

 

(tick)

Database user name. Defaults to user.

10

debug

Anchor
debug
debug

 

(error)

Requests detail debug output. Optional for all actions.

11

driver

Anchor
driver
driver

 

(tick)

JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.

12

encoding

Anchor
encoding
encoding

 

(tick)

Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.

13

file

Anchor
file
file

f

(tick)

Path to file based content or result output. Use - for standard input.

14

findReplace

Anchor
findReplace
findReplace

 

(tick)

Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled.

15

findReplaceRegex

Anchor
findReplaceRegex
findReplaceRegex

 

(tick)

Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled.

16

help

Anchor
help
help

 

(error)

Prints this help message.

17

host

Anchor
host
host

 

(tick)

Database host server for SQL actions. Not used if url is provided. (default: localhost)

18

list

Anchor
list
list

 

(tick)

Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled.

19

outputFormat

Anchor
outputFormat
outputFormat

 

(tick)

Specify output format for an action. (default: 1)

20

parameters

Anchor
parameters
parameters

 

(tick)

Client specific parameters

21

password

Anchor
password
password

p

(tick)

User password for remote access.

22

port

Anchor
port
port

 

(tick)

Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.

23

propertyFile

Anchor
propertyFile
propertyFile

 

(tick)

Property file with mapping information.

24

quiet

Anchor
quiet
quiet

 

(error)

Limit some output messages. Optional for all actions.

25

simulate

Anchor
simulate
simulate

 

(error)

Simulate running actions. Log the action that would be taken.

26

special

Anchor
special
special

 

(tick)

Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters.

27

sql

Anchor
sql
sql

 

(tick)

SQL select statement used to generate a run script.

28

url

Anchor
url
url

 

(tick)

Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.

29

user

Anchor
user
user

u

(tick)

User name for remote access.

30

verbose

Anchor
verbose
verbose

v

(error)

Requests verbose output to help with problem determination. Optional for all actions.

P