Using CNC requests

The tables in this section list all possible CNC requests grouped by object type. The command description gives a quick summary of what the CNC request does. The ID field identifies the request that is referenced later in the documentation.These commands are authorized. If the authorization fails the command returns 3300. In authorization mode, all commands are authorized. If a command is not routable (specifically, the object or subject name provided can not be found) it returns 3310.

**Table 2-1: Cluster commands**
ID	Command	Description
M3	disable	Request a cluster object to stop a child controller. Subject is cluster name Object is controller name No arguments Returns 1for success, 3310 if command is not routable
M4	enable	Request a cluster object to start a child controller. Subject is cluster name Object is controller name No arguments Returns 1for success, 3310 if command is not routable
M5	reload	Reloads a cluster object’s configuration data from its configuration file and restarts all of its controllers and application. Subject is cluster name No object No arguments Returns 1for success, 3310 if command is not routable
M6	shutdown	Request a cluster object to stop all of its SFM objects, controller objects, and applications managed by the controllers. Subject is cluster name No object No arguments Returns 1for success, 3310 if command is not routable
M7	getStatus	Request a cluster object to indicate the status of a child controller. Subject is cluster name. Object is child controller name or blank. No arguments. Returns 1 for enabled; 2 for disabled; 3 for enabling; 4 for disabling. When no object is specified, the cluster returns its own status: 1 for enabled; 2 for disabled; 3 for enabling; 4 for disabling; 5 for reloading.

Table 2-1: Cluster commands

Command

Description

disable

Request a cluster object to stop a child controller.

Subject is cluster name
Object is controller name
No arguments
Returns 1for success, 3310 if command is not routable

enable

Request a cluster object to start a child controller.

Subject is cluster name
Object is controller name
No arguments
Returns 1for success, 3310 if command is not routable

reload

Reloads a cluster object’s configuration data from its configuration file and restarts all of its controllers and application.

Subject is cluster name
No object
No arguments
Returns 1for success, 3310 if command is not routable

shutdown

Request a cluster object to stop all of its SFM objects, controller objects, and applications managed by the controllers.

Subject is cluster name
No object
No arguments
Returns 1for success, 3310 if command is not routable

getStatus

Request a cluster object to indicate the status of a child controller.

Subject is cluster name.
Object is child controller name or blank.
No arguments.
Returns 1 for enabled; 2 for disabled; 3 for enabling; 4 for disabling.

When no object is specified, the cluster returns its own status: 1 for enabled; 2 for disabled; 3 for enabling; 4 for disabling; 5 for reloading.

3310 is a generic error, which means the error is not an unauthorized or unrouteable action.

**Table 2-2: Controller commands**
ID	Command	Description
C3	disable	Request a controller object to disable a child application. Subject is controller name Object is child application name No arguments Returns 1for success, 3310 if command is not routable
C4	enable	Request a controller object to enable a child application. Subject is controller name Object is child application name No arguments Returns 1 for success, 3310 if command is not routable
C5	getStatus	Request a controller object to indicate the status of a child application. Subject is controller name. Object is child application name No arguments Returns 1 for enabled; 2 for disabled; 3 for enabling; 4 for disabling

Table 2-2: Controller commands

Command

Description

disable

Request a controller object to disable a child application.

Subject is controller name
Object is child application name
No arguments
Returns 1for success, 3310 if command is not routable

enable

Request a controller object to enable a child application.

Subject is controller name
Object is child application name
No arguments
Returns 1 for success, 3310 if command is not routable

getStatus

Request a controller object to indicate the status of a child application.

Subject is controller name.
Object is child application name
No arguments
Returns 1 for enabled; 2 for disabled; 3 for enabling; 4 for disabling

**Table 2-3: SFM commands**
ID	Command	Description
S1	acceptTransactions	Request an SFM object to resume dispatching transactions to all its destinations. Subject is the SFM’s name No object No arguments Returns 700 for success, -700 for failure
S4	cancelTransactionBySerial	Request an SFM object to cancel a pending transaction identified by a serial number and a destination name. Subject is SFM name No object argument[1] = serial number or Subject is SFM name No object Argument[1] = destination name Argument[2] = serial serial or serial1 serial2 for range Returns 400 for success, -400 for failure
S5	cancelUnprocessableTransaction	Request an SFM object to cancel an unprocessable transaction identified by a serial number. Subject is SFM name No object Argument[1] = serialnumber serialnumber Returns 400 for success, -400 for failure
S8	deleteUnroutableTransaction	Request an SFM object to delete an unrouteable transaction identified by a serial number. Subject is SFM name No object Argument[1] = serial number Returns 1100 for success, -1100 for failure
S9	getStatus	Request an SFM object to retrieve the status of a source or destination. Subject is SFM name Object is source or destination name Argument[1] = 0 for source, 1 for destination Returns (source) -1 for error, 0 for inactive (alive but not currently processing data), 1 for active, 2 for dynamic, 3 for pinging, and 4 for failed (ping DFC). Returns (destination) -1 for error, 0 for inactive, 1for active, 2 for paused, 3 for stuck, 4 for invalid, 5 for retrying, 6 for failed, and 7 for sleeping.
S10	getTransactionData	Request an SFM object to retrieve transaction data identified by a serial number. Subject is SFM name No object Argument[1] = log type (0 for unprocessable, 1 for unrouteable, 2 for pending (including unprocessable), 3 for cancelled) Argument[2]= serial number Returns 900 for success, -900 for failure Add the data in the argument list
S11	getTransactionList	Request an SFM object to build a list transactions, starting at a row number and for a specified number of rows. Specify a destination name to list transactions pending in a destination queue. Subject is SFM name No object Argument[1] = log type (0 for unprocessable, 1 for unrouteable, 2 for pending transactions (including unprocessable), 3 for cancelled) Argument[2] = start row index Argument[3] - number of rows to return Argument[4] = (optional) destination name Returns 900 for success, -900 for failure Add the list in the argument list
S12	pauseAllDest	Request an SFM object to stop dispatching transactions to all of its destinations. Subject is SFM name No object No arguments Returns 200 for success, -200 for failure
S13	pauseDest	Request an SFM object to stop dispatching transactions to a specified destination. Subject is SFM name Object is destination name Arguments[1] = destination name Returns 200 for success, -200 for failure
S14	pauseDestsbySerial	Request an SFM object to stop dispatching transactions to the destination for which the given serial number was destined. Subject is SFM name No object Argument[1] = serial number Returns 200 for success, -200 for failure
S15	refuseTransactions	Request an SFM object to stop dispatching transactions to all destinations. Subject is SFM name No object No arguments Returns 600 for success, -600 for failure
S16	repairInvalidDest The security databases in versions of e-Biz Impact prior to 5.4.5 contained the replaceInvalid command, which has been replaced by repairInvalidDest.	Request an SFM object to substitute an invalid destination with a valid destination. Subject is SFM name No object Argument[1] = invalid destination type (AIM, SFM, and so on) Argument[2] = invalid destination flavor Argument[3] = new destination type (AIM, SFM, and so on) Argument[4] = new destination flavor Returns 900 for success, -900 for failure
S17	resendTransactionBySerial	Request an SFM object to resend completed transactions specified by a serial number to either a single destination or all destinations. Subject is SFM name No object Argument[1] = serial serial or serial2 serial2 for range or Subject is SFM name No object Argument[1] = destination name Argument[2] = serial serial or serial2 serial2 for range Returns 500 for success, -500 for failure
S18	resubmitTransaction	Request an SFM object to resubmit a transaction specified by a serial number. Subject is SFM name No object Argument[1] = log type (0 for unprocessable, 1 for unrouteable, 2 for pending transactions (include unprocessable), 3 for cancelled) Argument[2] = transaction data Argument[3] = serial number Argument[4] = production object name (unprocessable only) Argument[5] = destination flavor (unprocessable only) Argument[6] = destination type (unprocessable only, for example, AIM, SFM, and so on) Returns 1000 for success, -1000 for failure
S19	resumeAllDest	Request an SFM object to resume dispatching transactions to all destinations. Subject is SFM name No object No arguments Returns 300 for success, -300 for failure
S20	resumeDest	Request an SFM object to resume dispatching transactions to a specific destination. Subject is SFM name Object is destination name Arguement[1] = destination name Returns 300 for success, -300 for failure
S21	resumeDestBySerial	Request an SFM object resume dispatching transactions to all destinations for which the specified serial number was destined. Subject is SFM name No object Arguement[1] = serial number returns 300 for success, -300 for failure
S22	skipTransactionBySerial	Request an SFM object to skip one or more transactions to either a single destination or all destinations. Subject is SFM name No object Argument[1] = serial serial or serial1 serial2 for range or Subject is SFM name No object Argument[1] = destination name Argument[2] = serial serial or serial1 serial2 for range Returns 400 for success, -400 for failure
S23	skipUnprocessableTransaction	Request an SFM object to skip an unprocessable transaction specified by a serial number. Subject is SFM name No object Argument[1] = serial serial Returns 400 for success, -400 for failure
S24	uncancelTransactionBySerial	Request an SFM object to uncancel one or several transactions to either a single destination or all destinations. Subject is SFM name No object Argument[1] = serial serial or serial1 serial2 for range or Subject is SFM name No object Argument[1] = destination name Argument[2] = serial serial or serial1 serial2 for range Returns 1200 for success, -1200 for failure
S25	reprocessUnprocessableTransaction	Request an SFM object to reprocess an unprocessable transaction identified by serial number. Subject is SFM name No object Argument[1] = serial serial Returns 400 for success, -400 for failure
S26	SendToSFM	Send a new transaction to an SFM. Subject is SFM name No object Argument[1] = source name used as reference Argument[2] = route Argument[3] = transaction data Argument[4] = route type Returns 1 for success Add the new transaction serial number in the argument list Add the return value of the route call in the argument list

Table 2-3: SFM commands

Command

Description

acceptTransactions

Request an SFM object to resume dispatching transactions to all its destinations.

Subject is the SFM’s name
No object
No arguments
Returns 700 for success, -700 for failure

cancelTransactionBySerial

Request an SFM object to cancel a pending transaction identified by a serial number and a destination name.

Subject is SFM name
No object
argument[1] = serial number

Subject is SFM name
No object
Argument[1] = destination name
Argument[2] = serial serial or serial1 serial2 for range
Returns 400 for success, -400 for failure

cancelUnprocessableTransaction

Request an SFM object to cancel an unprocessable transaction identified by a serial number.

Subject is SFM name
No object
Argument[1] = serialnumber serialnumber
Returns 400 for success, -400 for failure

deleteUnroutableTransaction

Request an SFM object to delete an unrouteable transaction identified by a serial number.

Subject is SFM name
No object
Argument[1] = serial number
Returns 1100 for success, -1100 for failure

getStatus

Request an SFM object to retrieve the status of a source or destination.

Subject is SFM name
Object is source or destination name
Argument[1] = 0 for source, 1 for destination
Returns (source) -1 for error, 0 for inactive (alive but not currently processing data), 1 for active, 2 for dynamic, 3 for pinging, and 4 for failed (ping DFC).
Returns (destination) -1 for error, 0 for inactive, 1for active, 2 for paused, 3 for stuck, 4 for invalid, 5 for retrying, 6 for failed, and 7 for sleeping.

S10

getTransactionData

Request an SFM object to retrieve transaction data identified by a serial number.

Subject is SFM name
No object
Argument[1] = log type (0 for unprocessable, 1 for unrouteable, 2 for pending (including unprocessable), 3 for cancelled)
Argument[2]= serial number
Returns 900 for success, -900 for failure
Add the data in the argument list

S11

getTransactionList

Request an SFM object to build a list transactions, starting at a row number and for a specified number of rows. Specify a destination name to list transactions pending in a destination queue.

Subject is SFM name
No object
Argument[1] = log type (0 for unprocessable, 1 for unrouteable, 2 for pending transactions (including unprocessable), 3 for cancelled)
Argument[2] = start row index
Argument[3] - number of rows to return
Argument[4] = (optional) destination name
Returns 900 for success, -900 for failure
Add the list in the argument list

S12

pauseAllDest

Request an SFM object to stop dispatching transactions to all of its destinations.

Subject is SFM name
No object
No arguments
Returns 200 for success, -200 for failure

S13

pauseDest

Request an SFM object to stop dispatching transactions to a specified destination.

Subject is SFM name
Object is destination name
Arguments[1] = destination name
Returns 200 for success, -200 for failure

S14

pauseDestsbySerial

Request an SFM object to stop dispatching transactions to the destination for which the given serial number was destined.

Subject is SFM name
No object
Argument[1] = serial number
Returns 200 for success, -200 for failure

S15

refuseTransactions

Request an SFM object to stop dispatching transactions to all destinations.

Subject is SFM name
No object
No arguments
Returns 600 for success, -600 for failure

S16

repairInvalidDest

The security databases in versions of e-Biz Impact prior to 5.4.5 contained the replaceInvalid command, which has been replaced by repairInvalidDest.

Request an SFM object to substitute an invalid destination with a valid destination.

Subject is SFM name
No object
Argument[1] = invalid destination type (AIM, SFM, and so on)
Argument[2] = invalid destination flavor
Argument[3] = new destination type (AIM, SFM, and so on)
Argument[4] = new destination flavor
Returns 900 for success, -900 for failure

S17

resendTransactionBySerial

Request an SFM object to resend completed transactions specified by a serial number to either a single destination or all destinations.

Subject is SFM name
No object
Argument[1] = serial serial or serial2 serial2 for range

Subject is SFM name
No object
Argument[1] = destination name

Argument[2] = serial serial or serial2 serial2 for range
Returns 500 for success, -500 for failure

S18

resubmitTransaction

Request an SFM object to resubmit a transaction specified by a serial number.

Subject is SFM name
No object
Argument[1] = log type (0 for unprocessable, 1 for unrouteable, 2 for pending transactions (include unprocessable), 3 for cancelled)
Argument[2] = transaction data
Argument[3] = serial number
Argument[4] = production object name (unprocessable only)
Argument[5] = destination flavor (unprocessable only)
Argument[6] = destination type (unprocessable only, for example, AIM, SFM, and so on)
Returns 1000 for success, -1000 for failure

S19

resumeAllDest

Request an SFM object to resume dispatching transactions to all destinations.

Subject is SFM name
No object
No arguments
Returns 300 for success, -300 for failure

S20

resumeDest

Request an SFM object to resume dispatching transactions to a specific destination.

Subject is SFM name
Object is destination name
Arguement[1] = destination name
Returns 300 for success, -300 for failure

S21

resumeDestBySerial

Request an SFM object resume dispatching transactions to all destinations for which the specified serial number was destined.

Subject is SFM name
No object
Arguement[1] = serial number
returns 300 for success, -300 for failure

S22

skipTransactionBySerial

Request an SFM object to skip one or more transactions to either a single destination or all destinations.

Subject is SFM name
No object
Argument[1] = serial serial or serial1 serial2 for range

Subject is SFM name
No object
Argument[1] = destination name
Argument[2] = serial serial or serial1 serial2 for range

Returns 400 for success, -400 for failure

S23

skipUnprocessableTransaction

Request an SFM object to skip an unprocessable transaction specified by a serial number.

Subject is SFM name
No object
Argument[1] = serial serial
Returns 400 for success, -400 for failure

S24

uncancelTransactionBySerial

Request an SFM object to uncancel one or several transactions to either a single destination or all destinations.

Subject is SFM name
No object
Argument[1] = serial serial or serial1 serial2 for range

Subject is SFM name
No object
Argument[1] = destination name
Argument[2] = serial serial or serial1 serial2 for range
Returns 1200 for success, -1200 for failure

S25

reprocessUnprocessableTransaction

Request an SFM object to reprocess an unprocessable transaction identified by serial number.

Subject is SFM name
No object
Argument[1] = serial serial
Returns 400 for success, -400 for failure

S26

SendToSFM

Send a new transaction to an SFM.

Subject is SFM name
No object
Argument[1] = source name used as reference
Argument[2] = route
Argument[3] = transaction data
Argument[4] = route type
Returns 1 for success
Add the new transaction serial number in the argument list
Add the return value of the route call in the argument list

The ims54cnc utility logs returned arguments to the cnc.xlog file. Therefore, do not use the command line tool for commands that accept an argument in the return; for example, getTransactionData (S9) and getTransactionList (S10), or any other unprocessable, unrouteable, and repair actions.