original_pages:production_terminal_and_jdf_messaging [Control]

Overview

Both Production Terminal and JDF Monitor use a hot-folder messaging system to communicate with the SSLIP. In this system, text files (usually XML based) are used to write message back and forth between the SSLIP and the external application.

Message Format

All messages are either Request or Response messages. Request messages are requests sent TO THE SSLIP. Response messages are sent FROM THE SSLIP after most request messages.

Request Messages

All request messages use an XML based structure with as the top node. Only one request message per file is allowed.

code_formatxml

??

???

code

The following elements are valid for Request messages:

Element Name	Data Type	Description
ID	String	An identifier for this message. The SSLIP will write this into the Response message so the generator can correlate the response with the request.
Request	Enum	One of the predefined types of message requests. Valid values are the following: RequestIDs - used to get the next IDs for certain tables. RefreshObjects - used to tell the SSLIP to have all copies of Control refresh any open copies of a particular record. This is important after any external changes have occurred since Control doesn't know any copy in memory may be obsolete. incomplete
NewID	none	Only valid when Request type is “RequestIDs”. This field provides the information describing what tables (TableName“??” attribute) and how many IDs are needed (CountRequest“??” attribute). A request may contain more than one NewID field covering different tables.
Object	none	Only valid when Request type is “RefreshObjects”. This field provides the information describing what objects should be refreshed by ID(ID“??” attribute) and class type (ClassTypeID“??” attribute). A request may contain more than one element.

Response Messages
All response messages use an XML based structure with as the top node.
code_formatxml
??

code
The following elements are valid for Request messages:
|| Element Name || Data Type || Description ||

Response (attribute)	Enum	The result of the operation. Valid values are the following: SUCCESS - the request was successfully handled. incomplete
ResponseID	String	The ID of the associated request message. Used so that the request generator can correlate the response with the request.
NewID	none	This field returns the IDs requested from a RequestIDs request message. The information describing the table (TableName“??” attribute), how many IDs were requested and are therefore returned (CountRequest“??” attribute), and what the starting and ending IDs to use are (FirstID“??” and LastID“??”, respectively). A response will contain one NewID element for each NewID in the request.