IAAdmin

-user <user name>

-password <password>
-host <host name>
[-port <port number>]
[-xml | -csv | -xsl <XSL file name>]
[-output <output file name>]
(
-listProjects |
-getProject -projectName <project name> |
-listRuleDefinitions -projectName <project name> |
-listExecutableRules -projectName <project name> |
-listGlobalVariables |
-getRuleDefinition -projectName <project name> -ruleName <rule name 1> |
-getExecutableRule -projectName <project name> -ruleName <rule name 2> |
-create -projectContent <XML file name> |
-update -projectContent <XML file name> |
-deleteProject -projectName <project name> |
-deleteRuleDefinition -projectName <project name> -ruleName <rule name> |
-deleteExecutableRule -projectName <project name> -ruleName <rule name> |
-deleteGlobalVariables -variable <variable name>
-runTasks -content <XML file name> |
-getColumnAnalysisResult -projectName <project name>
-columnName <column name>
|
-getOutputTable -projectName <project name>
-ruleName <rule name>
-executionID <execution ID>
[-startIndex StartIndex
-nbOfRows <number of rows>] |
-getFrequencyDistribution -projectName <project name>
-columnName SingleColumn
Name
[-maxNbOfValues <maximum number of values>]
[-startIndex <start index>]
[-ordering <ordering>] |
-getExecutionHistory -projectName <project name>
-ruleName <rule name>
)
================================================================================
===============
Parameter
Description
-user
<user name>
Name of the user (required)
-password <password>
Password to use (required)
-host <host name>
Host name of the server (required)
-port <port number>
Port number of the server (optional)
-xml
Specifies an XML format. If this option is used, the com
mand line interface will return data in the same XML format as the REST API
-csv
Specifies a comma separated values (CSV) format. If this
option is used, the command line interface will return data in a comma-separate
d format
that can be easily imported in a spreadsheet.
-xsl <XSL file name>
Specifies that you want to use an XSLT style sheet. If t
his option is used, the command line interface will use an XSLT file to transfor
m the XML
documents returned by the HTTP API into a customized for
mat.
-output <output name> If this option is used, the data returned by the command
line interface is written into the file specified as parameter. If this option
is not used,

the output is generated on the output stream of the comm

and line interface.
================================================================================
==========================
Option Description
-listProjects Returns the list of the existing projects. This option is the eq
uivalent of the "GET projects" command in the HTTP API.
-getProject -projectName <project name>
R
eturns the content of a specific project. This option is the equivalent of the "
GET project" command in the HTTP API.
-listRuleDefinitions -projectName <project name>
R
eturns the list of the existing data rule definitions in the specified project.
This option is the equivalent of the "GET ruleDefinitions" command in the HTTP A
PI.
-listExecutableRules -projectName <project name>
R
eturns the list of the existing data rules in the specified project. This option
is the equivalent of the "GET executableRules command " in the HTTP API.
-listGlobalVariables
R
eturns the list of the global variables defined on the system. This option is th
e equivalent of the "GET globalVariables" command in the HTTP API.
-getRuleDefinition -projectName <project name> -ruleName <rule name>
R
eturns the content of a rule definition. This option is the equivalent of the "G
ET ruleDefinition" command in the HTTP API.
-getExecutableRule -projectName <project name> -ruleName <rule name>
R
eturns the content of a data rule. This option is the equivalent to the GET exec
utableRules command in the HTTP API.
-create -projectContent <XML file name>
C
reates new project artifacts defined in the XML file that is specified as a para
meter. This option is the equivalent of the "POST create" command in the HTTP AP
I.
-update -projectContent <XML file name>
U
pdates new project artifacts defined in the XML file that is specified as a para
meter. This option is the equivalent of the "POST update" command in the HTTP AP
I.
-deleteProject -projectName <project name>
D
elete one or several projects. This option is the equivalent of the "DELETE proj
ect" command in the HTTP API.
-deleteRuleDefinition -projectName <project name> -ruleName <rule name>
D
elete one or several rule definitions. This option is the equivalent of the "DEL
ETE ruleDefinition" command in the HTTP API.
-deleteExecutableRule -projectName <project name> -ruleName <rule name>
D
elete one or several executable rules. This option is the equivalent of the "DEL
ETE executableRule" command in the HTTP API.
-deleteGlobalVariables -variable <variable name>
D
elete one or several global variables. This option is the equivalent of the "DEL
ETE globalVariable" command in the HTTP API.
-runTasks -content <XML file name>
R
un the tasks defined in the XML. This option is the equivalent of the "POST runT
asks" command in the HTTP API.
-getColumnAnalysisResult -projectName <project name> -columnName <column name> G
ets the column analysis results for a column in a project. This option is the eq
uivalent of the "GET columnAnalysis/results" command in the HTTP API.
-getOutputTable -projectName <project name> -ruleName <rule name> -executionID <
execution ID> -startIndex <start index> -nbOfRows <number of rows>
Gets the
content of the output table of a rule. This option is the equivalent of the "GE
T executableRule/outputTable" command in the HTTP API.
-getFrequencyDistribution -projectName <project name> -columnName <column name>
-maxNbOfValues <maximum number of values> -startIndex <start index> -ordering <o
rdering>
Gets the frequency distribution of a column. This option is the
equivalent of the "GET columnAnalysis/frequencyDistribution" command in the HTTP

API.
-getExecutionHistory -projectName <project name> -ruleName <rule name> Gets the
execution history of a rule. This option is the equivalent of the "GET executio
nRule/executionHistory" command in the HTTP API
================================================================================
==================================================
full command
--------------Examples
Get the list of the existing projects:
IAAdmin -user admin -password admin -host localhost -listProjects
Get the list of the existing rules of the project 'Project1' as an XML file:
IAAdmin -user admin -password admin -host localhost -xml -output out.xml -list
RuleDefinitions -projectName Project1
Get the list of the execution history of the data rule 'nullCheck' in the projec
t 'Project1' as a CSV file:
IAAdmin -user admin -password admin -host localhost -csv -output out.csv -get
ExecutionHistory -projectName Project1 -ruleName nullCheck
Create a new project from a XML file:
IAAdmin -user admin -password admin -host localhost -create -projectContent in.x
ml