Commands for managing analysis tasks
You can use commands to manage analysis tasks like getting the status of an analysis task or canceling the analysis tasks.
IAAdmin -user user_name -password password -url https://host:port option -[suboption]
Basic parameters
Parameter | Description |
---|---|
-user user_name | Name of the user (required) |
-password password | Password to use (required) |
-help or -h | Displays list of available IAAdmin parameters |
-v | Verbose. If specified, success or failure error codes are displayed on the console or are sent to the specified file. The success code is (200). Error code 400 indicates that the request was bad. Error code 500 indicates that there was a server error. Consult the application server log files for more details. |
-url https://host:port | Host name and port number of the server (required) |
-batchAnalysis option
The command -batchAnalysis runs an analysis on a large number of data sets without overloading the system. Without the -batchAnalysis command, analysis jobs are queued using the workload manager, and it takes awhile before the first job starts running. With the -batchAnalysis command, the large payload is split into one request per two tables (by default), which means that the analysis of the first job starts quickly, because the system is only busy preparing the first few jobs of the first tables, and starts preparing the next jobs while the first job runs. The command takes a text file (.txt) that contains a list of tables or files that you want to analyze and runs the column and data quality analyses through batch processing. The text file must be formatted correctly in order for the analyses to be run.
Option | Description |
---|---|
-projectName | The name of the InfoSphere® Information Analyzer project that you want to work with. |
-content | The name of the text file that contains a list of tables or files that you
want to run you want to run a column analysis or data quality analysis for. The text file must be in
the following format:
All
table and file names must be fully qualified. All files must have a header, be comma delimited, and
have line feed terminators. They must be in the following format:
The
following example shows how to specify a data quality analysis for the
customers.csv file. The text file RunDQForCustomerFile.txt
contains the following
parameters:
|
[-registerIfRequired] | Specify this parameter if you need to register tables or files to the workspace that is specified with the projectName option. |
[-nbOfConcurrentTables <number_of_tables>] | Specify this parameter if you want to analyze multiple tables or files at the same time. This parameter controls how many requests are processed concurrently. Specify the number of tables that you want to run concurrently. If you do not specify the number of tables, the default setting is 2. Tables and files are run sequentially (one at a time) if you do not specify this parameter. If you set this value too high, the workload manager will limit the number of jobs that are executed. Setting it too low reduces the efficiency of your system because the system will wait until the first jobs are processed before preparing the next job, even if the system has the capacity to run multiple jobs at the same time. |
[-noDataClasses] | Specify this parameter if you do not want to include data classes when running the analyses. |
-generateXML option
The command -generateXML takes a text file (.txt) that contains a list of tables that you want to analyze and generates the corresponding XML. You can use the XML to run a column or data quality analysis by using the -runTasks command. The text file must be formatted correctly in order for the XML to be generated. You can use this command if you want to generate XML in order to run other tasks from the command line interface.
Option | Description |
---|---|
-projectName | The name of the InfoSphere Information Analyzer project that you want to work with. |
-content | The name of the text file that you want to generate XML content for. The text
file must be in the following format:
For example, the RunBothCAandDQLWithSample.txt file contains the following
parameters:
|
[-noDataClasses] | Specify this parameter if you do not want to include data classes when generating the XML. |
-runTasks option
The command -runTasks runs analyses. For example, it runs column analyses, key analyses, rules, or metric analyses.
Option | Description |
---|---|
-content inputXMLFile | Path of the xml file specifying the analysis to be run. |
-cancelTask and -getStatus options
The scheduleID is an unique identifier used for running analysis. You get the Schedule ID from the return value of the -runTasks.
The commands, -cancelTask cancels or aborts a running analysis, and -getStatus, gets the status of an analysis that is previously submitted with -runTasks.
Option | Description |
---|---|
-scheduleID taskScheduleID | Specifies the schedule ID of the task. |
Examples:
IAAdmin -user isadmin -password isadmin -url https://host:9443 -generateXML -projectName IAProject1 -content tables.txt
IAAdmin -user isadmin -password isadmin -url https://host:9443 -runTasks -content xmlFile
ScheduledTaskId TaskType
d70c6594.80cb2b5c.000kocnf1.4iavtdr.3mqnmp.0sov0mba9tcso94i7nia7 ColumnAnalysis
IAAdmin -user isadmin -password isadmin -url https://host:9443 -getStatus -scheduleID d70c6594.80cb2b5c.000kocnf1.4iavtdr.3mqnmp.0sov0mba9tcso94i7nia7
ExecutionId = d70c6594.80cb2b5c.000kocnf1.4iavtdr.3mqnmp.0sov0mba9tcso94i7nia7-680a0afd-9144-48f8-8093-01925b20cfb2
ExecutionDate = 2015-03-19T17:47:48+01:00
ExecutionTime = 0
Status = running
Progress = 33
Jobs:
IAAdmin -user isadmin -password isadmin -url https://host:9443 -cancelTask -scheduleID d70c6594.80cb2b5c.000kocnf1.4iavtdr.3mqnmp.0sov0mba9tcso94i7nia7
The cancelTask has no response.
IAAdmin.sh -user isadmin -password isadmin -url https://host:9443 -getStatus -scheduleID d70c6594.80cb2b5c.000kocnf1.4iavtdr.3mqnmp.0sov0mba9tcso94i7nia7
ExecutionId = d70c6594.80cb2b5c.000kocnf1.4iavtdr.3mqnmp.0sov0mba9tcso94i7nia7-680a0afd-9144-48f8-8093-01925b20cfb2
ExecutionDate = 2015-03-19T17:47:48+01:00
ExecutionTime = 262939
Status = cancelled
Progress =
Jobs: