ConneX_Help.pdf - 第85页

A CommandRespons e wi l l be pub l i she d on the top i c machinemanan ger/commandre sponse/{hostna me] i nd i c ati ng the suc c e ss (o r fa i l ure ) o f the c o mm a nd .

100%1 / 86
Machine Manager
Below you will find the events and commands that are published/subscribed relating to the Machine Manager service.
Commands
Below are the commands that can be sent to a Machine Mangager instance:
Command Description
Launch DMS
Launches DMS for use with LumenX programming.
Launch TaskLink
Launches TaskLink for use with FlashCORE programming.
Launch DMS
Topic:
command/dms/launchdms/{hostname}
Instruct the Machine Manager service to launch DMS for use with LumenX programming.
Level Description
hostname
The hostname of the PC that should launch DMS.
A
CommandResponse
will be published on the topic
machinemananger/commandresponse/{hostname]
indicating the success (or failure) of
the command.
Fields
Name Description
JobName
(
string
) Set the selected job by name to run.
JobPath
(
string
) Set the selected job by file path to run.
Quantity
(
int
) Must be a whole, non-zero number. Sets the number of devices to process when this Job runs.
Note
Providing both
JobName
and
JobPath
fields is not supported and will result in an error.
Launch TaskLink
Topic:
command/tasklink/launchtasklink/{hostname}
Instruct the Machine Manager service to launch TaskLink for use with FlashCORE programming.
Level Description
hostname
The hostname of the PC that should launch TaskLink.
Fields
Name Description
TaskName
(
string
) Run the specified Task and exit TaskLink. The Task must be present in the current Task file.
AdministratorMode
(
bool
)
Run TaskLink in Administrator Mode.
BatchMode
(
bool
) Run TaskLink in Batch Mode.
Quantity
(
int
) Must be a whole, non-zero number. Sets the number of devices to process when this Job runs. This option
disables the prompt for pass quantity at run-time and is useful for Batch Mode operation.
Note
The
TaskName
field can also be used to launch with specific database such as
task_database::task_name
. See the TaskLink
documentation for more information.
A
CommandResponse
will be published on the topic
machinemananger/commandresponse/{hostname]
indicating the success (or failure) of
the command.
Common Types
The following types are shared across the different software components:
Types
Type Description
CommandResponse
Represents a result of a command message.
ErrorMessage
Represents an error message.
CommandResponse
Represents a result of a command message
Fields
Name Description
CommandTopic
string
The command topic that was sent.
ErrorMessage (
ErrorMessage
)If not successful, the accompanying error message.
Success (
bool
) Indicates if the command was successful or not.
ErrorMessage
Represents an error message.
Fields
Name Description
ErrorCode (
string
) The error code (if provided).
ErrorLevel (
ErrorLevel
)The error level.
Message (
string
) The error message.
Enumerations
EnumerationDescription
ErrorLevel
The severity level of error.
ErrorLevel
The severity level of error.
Value Description
0 - WarningThe error is a warning, but operation can continue.
1 - Error The error is an error, operation cannot continue.
2 - Fatal The error is a fatal error, operation cannot continue and software may be in an unstable state.