Ptburn sdk

2.2Programming Examples

2.2.1Simple Data Job

Test1. JRQ in the Job Request Folder has the contents:
Data = c:\MyBackup
This will burn one CD-R disc with all the files and subfolders within the c:\MyBackup folder. It will be a Joliet file system, Mode 1, Track-at-once, not-closed disc (see other defaults above).

2.2.2Simple Audio Job

Test2. JRQ in the Job Request Folder has the contents:
AudioFile = c:\MyMusic\MyTrack1.wav

AudioFile = c:\MyMusic\MyTrack2.mp3, Pregap75

AudioFile = c:\MyMusic\MyTrack3.wma, Pregap150

BurnSpeed = 8

CloseDisc = YES

Copies = 2

This will burn 2 CD-R audio discs with three tracks. The .wav, .mp3, and .wma will be converted and burned as CD-Audio automatically. MyTrack2 will have a 1 second pause before it and MyTrack3 will have a 2 second pause before it. The discs will be burned at 8x (or as close as possible) and the disc will be closed.

2.2.3Burn and Print job of 5 discs with many options specified

Test3. JRQ in the shared-folder location have the contents:
JobID = Kevin’s Photos

ClientID = COMPANYX-KEVIN1

Data = \\SERVER\PTBurnJobs\KevinsJob\Photos\Data

Data = c:\MyBackup\File1.jpg

DeleteFiles = YES

DataImageType = ISOLEVEL1, SAO, SETNOW

CloseDisc = YES

Copies = 5

PrintLabel = \\SERVER\PTBurnJobs\KevinsJob\Print\Photos.std

VolumeName = My Photos

VerifyDisc = YES

NotifyClient = Message

This will burn 5 CD-R discs with all the files and subfolders within the subfolder \\SERVER\PTBurnJobs\KevinsJob\Photos\Data and it will also burn the file C:\MyBackup\File1.jpg. The disc will be verified after burning. The SureThing label file \\SERVER\PTBurnJobs\KevinsJob\Print\Photos.std will be printed on each disc. The discs will be closed-session Disc-at-once with ISO 9660 Level 1 file system, and the time/date of the files will be set to the time at which each disc is burned. After completing the job, PTBurn will delete all the files and subfolders within and including the subfolder \\SERVER\PTBurnJobs\KevinsJob. Note that the file C:\MyBackup\File1.jpg will not be deleted.

Because the NotifyClient key is set to Message, when the job is completed a net message will be sent to the computer COMPANYX-KEVIN1.

2.2.4Print Only Job of 25 Discs

JobID = My Print Job

ClientID = MyWorkstation

PrintLabel = \\SERVER\PTBurnJobs\MyJob\MyImage.STD

Copies = 25

2.2.5Read Data Job of 3 Discs

ClientID=MyComputer

JobID=Job0

Importance=2

Copies=3

NotifyClient=Message

ReadDataTo=\\MyComputer\PTBurnJobs\ReadData

ReadDataFormat=ReadData

CreateSubFolders=YES

2.2.6Read Global Image Job of 3 Discs

ClientID=MyComputer

JobID=Job0

Importance=2

Copies=3

NotifyClient=Message

ReadDataTo=\\MyComputer\PTBurnJobs\ReadData

ReadDataFormat=ReadGI
This will create a GI global image file for each of the 3 discs at the following locations:
\\MyComputer\PTBurnJobs\ReadData_1.gi

\\MyComputer\PTBurnJobs\ReadData_2.gi

\\MyComputer\PTBurnJobs\ReadData_3.gi

3Status Information

PTBurn will provide status for each submitted job in several different ways.
First of all, the filename extension for the submitted Job Request File will have four different values: the “new job request” extension, the “job discovered” extension, the

“in process” extension, and the “job completed” extension. All four of these extensions can be specified in PTSETUP.INI. Using the default values here is an example description of the four filename extensions:

MyJob.JRQ  The client has submitted the job request

MyJob.QRJ  PTBurn has discovered and put the job in its list of jobs.

MyJob.INP  PTBurn is currently processing this job.

MyJob.DON  The job has been completed.

An additional filename extension is possible when a job has an error or has been aborted.

MyJob.ERR  The job has finished with errors or has been aborted.

Additional status can be retrieved from text files containing additional detailed status information.

3.1SystemStatus.txt File

PTBurn will provide status for the entire system via the SystemStatus.txt file. This file will reside in a subfolder called Status within the Job Request Folder location defined in PTSETUP.INI (the default is C:\PTBurnJobs).

SystemStatus.txt contains at least three sections; the structure of the file will be similar to an .INI file with two fixed Sections of [RobotList] and [System], and one or more sections [RobotName] where RobotName is the name of the Robot (e.g. Disc Publisher XRP).

For more detailed information, PTBurn also creates one or more status files called RobotName.txt, where RobotName is the name of the robot (e.g. Disc Publisher XRP.txt). See section 3.2 for more details on this.
Note: When processing SystemStatus.txt from a client application, the client application should NOT access SystemStatus.txt with exclusive access.

3.1.1Example of SystemStatus.txt

[RobotList]

Robot0=Disc Publisher XRP

[Disc Publisher XRP]

SysErrorString=No Errors

SysErrorNumber=0

SystemDrives=2

RobotType=5

NumJobs=0

DiscsInLeftBin=6

DiscsInRightBin=4

StatusFile=Disc Publisher XRP.txt

KioskModeEnabled=0

CartridgeType0=2

CartridgeFill0=96

CartridgeType1=1

CartridgeFill1=95

[System]

SysErrorString=No Errors

SysErrorNumber=0

PtburnSWVer=1.0.3.0

JobProcSWVer=3.0.9

PTRobotVer=1.3.5.0

PxsdkSWVer=4.2.62.500

PxengSWVer=4.2.62.500

PxDrvSWVer=1.02.16a

PxMasSWVer=4.2.62.500

PxWaveSWVer=4.2.62.500

PxHelp20SWVer=3.00.67a

ServerTime=06/05/2008 17:44:27

ServerTickCount=1749

DriveSpace=123849

Below is a description of each section and key available in SystemStatus.txt.

3.1.2Robot List

This section in SystemStatus.txt contains a list of each robot active in the system.

e.g.

[RobotList]

Robot0=Disc Publisher XRP

Robot1=Disc Publisher SE
Each robot entry point to a “Robot Section within the file.

3.1.3Robot Section

This section in SystemStatus.txt contains some basic status on a particular robot in the system. It also contains the file names where more status and can be found.

e.g.

[Disc Publisher XRP]

3.1.3.1SystemDrives

Number of drives on the robot.

3.1.3.2RobotType

Type of robot the possible values are defined below.
Disc Publisher = 0

Disc Publisher II = 1

Disc Publisher PRO = 2

Disc Publisher XR = 4

Disc Publisher XRP =5

Disc Publisher SE = 6

Disc Publisher Xi = 7

Disc Publisher 4100 = 8

Disc Publisher 4100 XRP = 9

Disc Publisher 4051 = 10

Disc Publisher SE-3 = 11

Disc Publisher 4200 = 12

Disc Publisher 4200 XRP = 13

Disc Publisher 4052 = 14

3.1.3.3NumJobs

Number of jobs currently running on the robot.

3.1.3.4Status

String containing the status of the robot (For display purposes)

3.1.3.5StatusFile

Filename of that status file for this particular robot.
This “Robot Status” file is located in the same folder as this file.

3.1.3.6DiscsInRightBin

Number that contains the number of discs in the Right Bin. If this value is -1 then the number is unknown. This value is updated each time a disc is picked from a bin. The user can also send the “Check Bins” command to force an update of this value.

3.1.3.7DiscsInLeftBin

Number that contains the number of discs in the Left Bin. If this value is -1 then the number is unknown. This value is updated each time a disc is picked from a bin. The user can also send the “Check Bins” command to force an update of this value.

3.1.3.8CartridgeTypeX

Contains the type of CartridgeX. The X will be replaced with a value. CartridgeType0 represents the leftmost cartridge. If the robot contains a second cartridge, CartridgeType1 represents the right cartridge.
The potential values for this key are listed below.

CARTRIDGE_NONE 0

CARTRIDGE_COLOR 1

CARTRIDGE_BLACK 2

CARTRIDGE_YELLOW 3

CARTRIDGE_CYAN 4

CARTRIDGE_MAGENTA 5

CARTRIDGE_COLORLOTUS 6

NOTES:

Values 3, 4, & 5 are for robots that have individual color ink cartridges (ie. Robots with 4 separate ink tanks). For better backward compatibility, robots with four ink cartridges will actually record five CartridgeType values like this:

CartridgeType0 = 2  Black

CartridgeType1 = 1  Color

CartridgeType2 = 3  Yellow

CartridgeType3 = 4  Cyan

CartridgeType4 = 5  Magenta

CartridgeType0 = 6  Color

3.1.3.9CartridgeFillX

Number that contains the percent fill of the cartridge. The X will be replaced with a value. CartridgeFill0 represents the leftmost cartridge. If the robot contains a second cartridge, CartridgeFill1 represents the right cartridge fill percent.
This value is a percent with values from 0-100%
NOTE: For better backward compatibility, robots with four ink cartridges will actually record five CartridgeFill values like this example:

CartridgeFill0 = 91  Black

CartridgeFill1 = 37  Color (this will be the lowest value of Yellow, Magenta, & Cyan)

CartridgeFill2 = 59  Yellow

CartridgeFill3 = 37  Cyan

CartridgeFill4 = 100  Magenta

CartridgeFill0 = 37  Color (this will be the lowest value of Yellow, Magenta, & Cyan)

3.1.3.10KioskModeEnabled

If kiosk mode is enabled on this robot.

1=enabled, 0=disabled

3.1.4System Section

This section in SystemStatus.txt contains general information about the system.

ie.

[System]

3.1.4.1SysErrorString

String corresponding to the SysErrorNumber. Please see Appendix C for details on system errors.

3.1.4.2SysErrorNumber

Integer value that details what error has occurred on the system. Please see Appendix C for more details on system errors.

3.1.4.3ServerTickCount

Current tick count obtained by the PTBurn application on the server (computer on which PTBurn is running). This can be used to determine if the PTBurn Service is still running and updating status.
1 tick count = 1 second

3.1.4.4ServerTime

Current time obtained by the PTBurn application on the server (computer on which PTBurn is running).
Format is:

MM/DD/YYYY hh:mm:ss

where:

MM is month (1-12)

DD is day (1-31)

YYYY is year (e.g. 2008)

hh is based on a 24-hour clock so the range is from 0 to 23 (e.g. 18:00:00 is 6PM)

mm is minutes (0-59)

ss is seconds (0-59)

3.1.4.5DriveSpace

Integer value that tells how much free hard drive space is available. This is the drive on which the Shared Folder resides. The value is given in MB (e.g. for 12GB of free space – DriveSpace=12000

3.1.4.6PtburnSWVer

String that contains the version of PTBurn.exe.

3.1.4.7JobProcSWVer

String that contains the version of JobProcessor.dll.

3.1.4.8PTRobotVer

String that contains the version of PTRobot.dll.

3.1.4.9PxengSWVer

String that contains the version of Px.dll.

3.1.4.10PxsdkSWVer

String that contains the version of PXSDKPLS.dll.

3.1.4.11PxDrvSWVer

String that contains the version of PxDrv.dll.

3.1.4.12PxMasSWVer

String that contains the version of PxMas.dll.

3.1.4.13PxWaveSWVer

String that contains the version of PxWave.dll.

3.1.4.14PxHelp20SWVer

String that contains the version of PxHelp20.sys.