Ptburn sdk

4Client Commands

PTBurn clients can send commands to the PTBurn server.
To do this, the client should create a new file in the Job Request Shared Folder with the filename extension of .PTM with the same filename as the JRQ file you are referencing.

4.1Abort Command

The abort command will abort a particular job. The .ptm file must have the same filename as an existing Job Request File and the valid contents are shown below (note the filenames must match except for the filename extensions).
Message = ABORT

ClientID = XXX

Where XXX is the same ClientID that is specified in the corresponding Job Request File. You can abort any job by specifying “Administrator” for the ClientID.
For example, if the client submits a job with the Job Request Filename of:

MyJob1.JRQ

and then the client decides that this job should be aborted, the client must create a new file called:

MyJob1.PTM

Note that the ClientID must be specified and it MUST match the ClientID in the corresponding Job Request File – the abort request will be rejected if the ClientID does not match.

For the MyJob1 example (see above) the contents of MyJob1.PTM would be:

Message = ABORT

ClientID = Kevin

4.2Shutdown After Job Command

The “Shutdown After Job” command will shutdown the Server software after any in-process jobs are completed (have a .inp extension). This command will prevent any new jobs from being put into an “in process” state. The unit will finish all actions on the “in process” jobs and then shutdown. The .ptm file can have any name and should be formatted as follows:
Message=SHUTDOWN_AFTERJOB

ClientID=Administrator

The ClientID should ALWAYS be fixed to “Administrator”.

4.3Shutdown Immediate Command

The “Shutdown Immediate” command will shutdown the Server software immediately after the message is processed. Messages are processed approximately every 10 seconds. It is only advised to use this message in an emergency. Upon using this command the system will be left in an unknown state. There could be discs left on the picker, in the recorder, or in the printer. The .ptm file can have any name and should be formatted as follows:
Message=SHUTDOWN_IMMEDIATE

ClientID=Administrator

The ClientID should ALWAYS be fixed to “Administrator”.

4.4Align Printer Command

** This command is only valid on the Disc Publisher PRO, XRP, SE **

The Align Printer Command will align the printer when the system error is set to 22 or there are no jobs on the system. If the alignment fails, the system error will be set to 31 otherwise the system error will be set to 0. See Appendix C for system error codes.

Message= ALIGN_PRINTER

ClientID=Administrator

RobotName = zzzz
The ClientID should ALWAYS be fixed to “Administrator”.

RobotName zzzz specifies which printer/robot to align (e.g. Disc Publisher SE). If RobotName is not specified it will align the first robot found.

4.5Ignore Ink Low Command

** This command is only valid on the Disc Publisher PRO, XRP, SE **

The Ignore Ink Low command will ignore an ink low condition when the system error is set to 5, 6, or 7.

Message= IGNORE_INKLOW

ClientID=Administrator

The ClientID should ALWAYS be fixed to “Administrator”.

4.6Process Disc Command

The Process Disc Command will cause the unit to leave the wait state prior to recording the disc and continue processing the disc. This command is only valid when LoadUnloadOverride was set to YES in the .JRQ Job Request File.
Message= PROCESS_DISC

DiscID=X
The DiscID should contain the id of the disc that is being processed (ie. the X value from LoadDiscStateX = in the Status file). See Appendix D for an example of how to use this message with the load/unload override functionality.

4.7Reject Disc Command

The Reject Disc Command will cause the unit to leave one of the two wait states (prior to recording or once recording is finished) and reject the disc. This command is only valid when LoadUnloadOverride was set to YES in the jobs jrq file.
Message= PROCESS_DISC

DiscID=X
The DiscID should contain the id of the disc that is being processed (ie. the X value from LoadDiscStateX = in the Status file). See Appendix D for an example of how to use this message with the load/unload override functionality.

4.8Unload Command

The Unload Disc Command will cause the unit to leave one of the two wait states (prior to recording or once recording is finished) and unload the disc. This command is only valid when LoadUnloadOverride was set to YES in the jobs jrq file.
Message= PROCESS_DISC

DiscID=X
The DiscID should contain the id of the disc that is being processed(ie. the X value from LoadDiscStateX = in the Status file). See Appendix D for an example of how to use this message with the load/unload override functionality.

4.9Check Bins Command

The “Check Bins” command will cause the Disc Publisher to check each bin for the number of discs remaining. It will then update the DiscsInLeftBin and DiscsInRightBin values of the status file. The .ptm file can have any name and should be formatted as follows:
Message= CHECK_DISCSINBIN

ClientID=Administrator

RobotName = zzzz

The ClientID should ALWAYS be fixed to “Administrator”. This command will only work if there are no jobs in the system.

RobotName zzzz specifies which printer/robot to check bins (e.g. Disc Publisher SE). If RobotName is not specified it will check bins on the first robot found.

4.10Create Report Command

This command causes a tech support report to be created and place in the PTBurnJobs\Reports folder. This report can be sent to Primera’s technical support department if an issues arises.

Message= CREATE_REPORT