Commands for managing analysis task

You can use commands to manage analysis task like getting status of analysis task and cancel the analysis tasks.

The basic syntax of a command to manage task is:

IAAdmin -user user_name -password password -url https://host:port option -[suboption]

Basic parameters

Table 1. 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)

-runTasks options

The command -runTasks runs an analysis, for example, column analysis, key analysis, rules, or metric analysis.

Table 2. -runTasks options
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.

Table 3. -cancelTask options
Option	Description
-scheduleID `taskScheduleID`	Specifies the schedule ID of the task.

Examples:

The following command runs the tasks specified by the input xml:

IAAdmin -user isadmin -password isadmin -url https://host:9443 -runTasks -content xmlFile

The response for runTasks:

ScheduledTaskId	TaskType
d70c6594.80cb2b5c.000kocnf1.4iavtdr.3mqnmp.0sov0mba9tcso94i7nia7 ColumnAnalysis

The following command gets the status of the task with the given scheduleID:

IAAdmin -user isadmin -password isadmin -url https://host:9443 -getStatus -scheduleID d70c6594.80cb2b5c.000kocnf1.4iavtdr.3mqnmp.0sov0mba9tcso94i7nia7

The response for getStatus:

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:

The following command cancels the task with the given scheduleID:

IAAdmin -user isadmin -password isadmin -url https://host:9443 -cancelTask -scheduleID d70c6594.80cb2b5c.000kocnf1.4iavtdr.3mqnmp.0sov0mba9tcso94i7nia7

The cancelTask has no response.

The following command gets the status of the task again with the given scheduleID to check the status that is cancelled:

IAAdmin.sh -user isadmin -password isadmin -url https://host:9443 -getStatus -scheduleID d70c6594.80cb2b5c.000kocnf1.4iavtdr.3mqnmp.0sov0mba9tcso94i7nia7

The response for getStatus after cancellation:

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: