BCGDocumentConstants

This class sets constants.

Constants

This section describes the following types of constants:

Constants used in protocol unpackaging and protocol packaging steps

The following general constants are used in the protocol unpackaging and protocol packaging steps:

public static final String BCG_FRPACKAGINGCD = "FromPackagingName";
The attribute to which the received packaging name is set when WebSphere Partner Gateway receives a document. Define the receiving packaging name in the Community Console. This constant is set in the transport unpackaging step in the workflow.
public static final String BCG_FRPACKAGINGVER = "FromPackagingVersion";
The attribute to which the received content packaging version is set when WebSphere Partner Gateway receives a document. The received packaging version must be defined in the Community Console. This constant is set in the transport unpackaging step in the workflow.
public static final String BCG_TOPACKAGINGCD = "ToPackagingName";
The "To" packaging code that is associated with the document flow.
public static final String BCG_TOPACKAGINGVER = "ToPackagingVersion";
The "To" packaging version that is associated with the document flow.
public static final String BCG_PKG_INITBUSINESSID = "PackageInitPartnerBusinessId";
The initiating business ID at the packaging level. This is set in the transport protocol unpackaging step in the workflow.
public static final String BCG_PKG_FRBUSINESSID = "PackageFromPartnerBusinessId";
The "From" business ID at the package level. For example, for AS2 the "From" business ID is available in the AS2-From HTTP header. This constant is set in the transport protocol unpackaging step in the fixed inbound workflow
public static final String BCG_PKG_TOBUSINESSID = "PackageToPartnerBusinessId";
The "To" business ID at the package level. For example, for AS2 the "To" business ID is available in the AS2-To HTTP header. This constant is set in the transport protocol unpackaging step in the fixed inbound workflow.

Constants used in protocol processing and protocol packaging steps

The following constants are used in the protocol processing and protocol packaging steps:

public static final String BCG_FRBUSINESSID = "FromPartnerBusinessId";
The "From" business ID obtained from the protocol message and set onto BusinessDocument in the protocol parsing step.
public static final String BCG_INITBUSINESSID = "InitiatingPartnerBusinessId";
The initiating-partner business ID that is obtained from the protocol.
public static final String BCG_TOBUSINESSID = "ToPartnerBusinessId";
The "To" business ID that is obtained from the protocol message and set onto BusinessDocument in the protocol parsing step.
public static final String BCG_FRPROTOCOLCD = "FromProtocolName";
The received protocol namecode that is obtained from the document, for example, XML/EDI. Define this namecode in the Community Console. This constant is set in the protocol processing step in the workflow.
public static final String BCG_FRPROTOCOLVER = "FromProtocolVersion";
The received protocol version. Define this version in the Community Console. This constant is set in the protocol processing step in the workflow.
public static final String BCG_FRPROCESSCD = "FromProcessCode";
The "From" process code name. For example, in RNIF this value is set to 3A4, and the version is set to V02.02. Set this constant in the protocol processing step in the workflow. Define this constant in the Community Console in the Document Flow Definitions column of the Manage Document Flow Definitions page by clicking Package > Protocol > DocumentFlow.
public static final String BCG_FRPROCESSVER = "FromProcessVersion";
The "From" process version, which is set in the protocol processing step in the workflow. Define this constant in the Community Console in the Document Flow Definitions column of the Manage Document Flow Definitions page by clicking Package > Protocol > DocumentFlow.
public static final String BCG_TOPROTOCOLCD = "ToProtocolName";
The target protocol name. This channel is set by CheckChannel fixed inbound workflow after it identifies the participant connection and is used by the handlers protocol packaging step.
public static final String BCG_TOPROTOCOLVER = "ToProtocolVersion";
The "To" protocol version.
public static final String BCG_TOPROCESSCD = "ToProcessCode";
The "To" process code name. For example, in RNIF this value is set to 3A4 and the version is set to V02.02. Define this constant in the Community Console in the Document Flow Definitions column of the Manage Document Flow Definitions page by clicking Package > Protocol > DocumentFlow.
public static final String BCG_TOPROCESSVER = "ToProcessVersion";
The "To" process code version. For example, in RNIF this value is set to 3A4, and the version is set to V02.02. Define this constant in the Community Console in the Document Flow Definitions column of the Manage Document Flow Definitions page by clicking Package > Protocol > DocumentFlow.
public static final String BCG_DESTINATION = "DestinationType";
The destination type that will be used in the workflow and in senders.
public static final String BCG_OUTBOUNDTRANSPORTHEADERS = "OutboundTransportHeaders";
The outbound transport headers attribute that is used by the sender to set the transport headers when it transfers the document over a specified transport. The value for this attribute is a HashMap object that contains the list of transport headers. For example, an HTTP sender uses this attribute to set the HTTP headers. This attribute is set in the handlers that are configured for the protocol packaging step in the fixed outbound workflow.

Sender status constants

The following constants handle sender status:

public static final String BCG_SENT_STATUS_SUCCESS = "sent";
The status that the sender sets in a SenderResult object when the sender successfully sends a document.
public static final String BCG_SENT_STATUS_FAILED = "failed";
The status that the sender sets in a SenderResult object when the sender fails while sending a document.

Document state constants

The following constants pertain to the document state:

public static final String BCG_DOCSTATE_FAILED = "Failed";
The document state, set to "failed", if any error occurs while the document is being processed by the handler in the workflow steps. The document state when an error occurs while the handler is processing the document in workflow steps or actions.
public static final String BCG_DOCSTATE_IN_PROCESS = "In Process";
The document state, set to "In Process", in BusinessDocumentInterface when the workflow handler or action is processing a document.
public static final String BCG_DOCSTATE_SENT = "Sent";
The document state, set to "Sent", in the BusinessDocumentInterface in the workflow steps. If a workflow step sets this state on a business document, further steps and workflows will not be performed and this business document will not be sent to Document Manager. Basically, this will end the flow of the business document and so this document will not be sent to the trading partner.

Receiver constants

If a sender is introducing a response file into the flow by setting a response document on SenderResult, the sender can optionally set the attributes described in this section. The following are receiver constants:

public static final String BCG_RCVD_DOC_TIMESTAMP = "ReceivedDocumentTimestamp";
The time stamp of the received document. When a receiver receives a business document, the receiver sets this attribute on the receiver document. The value of this attribute gives the time stamp of the received document.
public static final String BCG_RCVD_CONTENT_LENGTH = "content-length";
The content length of the received document. When a receiver receives a business document, the receiver sets this attribute on the receiver document. The sender also sets this on the business document when it receives the synchronous response. The value of this attribute gives the content size of the received document. This attribute is required for the Community Console to display the document size.
public static final String BCG_RCVD_MSG_LNGTH_INC_HDRS = "MsgLengthIncHeaders";
The message length of the received document. When a receiver receives a business document, the receiver sets this attribute on the received document. The sender also sets this on the business document when it receives the synchronous response. The value of this attribute gives the size of the content and headers from the received document. This attribute is required for the Community Console to display the document size.
public static final String BCG_RCVD_CONTENT_TYPE = "content-type";
The content type of the received document. When a receiver receives a business document, the receiver sets this attribute on the received document. The sender also sets this on the business document when it receives the synchronous response. This attribute is required for the Community Console to display the document size.
public static final String BCG_RCVR_DESTINATION = "ReceiverDestinationType";
The attribute that is set by receivers on a ReceiverDocumentInterface object when a document is received from a target. This target is associated with a destination type such as production and test. The destination type is configured for the target, and you can read it from the receiver configuration by using the BCGDocumentConstants.BCG_TARGET_DESTINATION attribute.

This attribute might be set by a sender if it is doing a synchronous request response. If the sender is introducing a response file into the flow by setting the response document on SenderResult, the sender is required to set the BCG_RCVR_DESTINATION attribute in SenderResult. If this attribute is not set, the flow of response document will fail in the Document Manager. This attribute can be set by copying the BCG_RCVR_DESTINATION attribute from the request business document that it is sending.

public static final String BCG_TARGET_STATUS = "ACTIVESTATUSCD";
The name of a reserved attribute that determines whether the target of a receiver is enabled or disabled. If enable equals 1, the target is enabled; otherwise, it is disabled. You can read the target status from the target configuration by using the BCGDocumentConstants.BCG_TARGET_STATUS attribute.
public static final String BCG_TARGET_DESTINATION = "DESTNAME";
The name of a reserved attribute that determines the target destination type from a targetConfig object such as production or test.
public static final String BCG_RCVD_IPADDRESS = "FromIPAddress";
The host IP address where a document is received. When a receiver receives a business document, it can set this attribute on the received document.
public static final String BCG_INBOUND_TRANSPORT_CHARSET = "InboundTransportCharset";
The character set that is obtained from the transport headers. This is set by the receiver when it receives the request. For example, the HTTP receiver checks for charset in the content-type header and sets it on the receiver document as the value of this attribute.
public static final String BCG_INBOUND_CHARSET = "InboundCharset";
The character set that is used for the inbound document.
public static final String BCG_REQUEST_URI = "requestURI";
The URI from which the receiver has received the request. When a receiver receives a business document, it set this attribute on the receiver document. Targets are configured with this URI in the Community Console and associated with a destination type such as production or test.

Other constants

Following are other constants:

public static final String BCG_GET_SYNC_RESPONSE = "GetSynchronousResponse";
A flag set by the handler in the protocol unpacking, protocol parsing, or protocol packaging step. If the handler determines that the received request requires a synchronous response from the target, it sets this attribute to true. The sender checks this flag; if it is set to true, the sender retrieves the synchronous response from the target.
public static final String BCG_RESPONSE_STATUS = "ResponseStatus";
If a response needs to be sent synchronously by the receiver to a trading partner, this contains the one-line response. It can be set by a sender on a response business document. For example, for an HTTP receiver, the value of this attribute can be a number such as 200, 404, or 500, which are HTTP transport status codes. Receivers can either use this response or specify another response.
public static final String BCG_REPLY_TO_DOC_ID = "ReplyToDocID";
The request document ID that is present in the response document. The response document is considered a response to this request document.
public static final String BCG_REPLY_TO_DOC_UUID = "ReplyToMessageId";
The attribute to which SenderFrameWork sets the UUID of the request business document in the response business document. This is used to correlate the request-response in the process engine.
public static final String BCG_DOCID = "DocumentId";
The document ID from the business document payload.
public static final String BCG_TARGET_TRANSPORTTYPE = "TargetTransportType";
This constant can be used to determine the target transport type from a target configuration object such as JMSReceiver or CustomReceiver.
public static final String BCG_TRUE = "true";
This constant can be used to set the value to true for any attribute that requires a boolean value. For example. the attribute BCG__TRUE can be used to set the value of BCG_GET_SYNC_RESPONSE to true.
public static final String BCG_FALSE = "false";
This constant can be used to set the value to false for any attribute that requires a boolean value. For example. the attribute BCG__FALSE can be used to set the value of BCG_GET_SYNC_RESPONSE to false.
public static final String BCG_OUT_DOC_FILENAME = "X-out-filename";
This constant can be used to set or access the output file name in the business document. For example, you can write a pre-process handler, set the output file name to user defined, and then configure it with the File Sender. When File Sender writes the document to the target location, it is written with the name that was set to the OUT_DOC_FILENAME attribute.

Copyright IBM Corp. 2003, 2005