TXDOC_REGOUTX12
This activity is a specialised extension of the TXDOC_REGOUTBND activity that provides additional parameters to facilitate registering pending outbound EDI X12 transaction documents. It registers the pending outbound transaction document for later processing by an outbound process such as the supplied TXDOC_OUTBOUND process.
Note that this registers the necessity for the outbound document - the application typically uses this activity (or one of the functionally equivalent APIs) upon an event occurring that will require an outbound transaction document to be generated.
To put this another way, the outbound document is typically not existing when this activity is run, but, rather, it is created by the subsequent outbound transaction document process. (The activity FOR_EACH_TXDOCO is provided for use in the outbound transaction document process for identifying the pending outbound transaction documents).
INPUT Parameters:
TRADINGPARTNER : Required
Specifies the trading partner for which the pending outbound transaction document is registered. This parameter is required.
DOCTYPE : Required
This parameter specifies the document type for the pending outbound transaction document. The document type must be a document type identifier as defined in LANSA Composer's Document types definitions, for example 'EDI'.
DOCSTD : Required
This parameter specifies the transaction document standard for the pending outbound transaction document. The document standard must be a document standard identifier as defined in LANSA Composer's Document standards definitions, for example 'X12'.
DOCSTDVER : Required
This parameter specifies the transaction document standard version for the pending outbound transaction document. The document standard version must be a document standard version identifier as defined in LANSA Composer's Document standards definitions, for example '004020'.
DOCPRODTEST : Optional
This parameter specifies whether the transaction document will be for production (P) or test (T) use. It is up to the specific export processor implementation how it makes use of this value - for EDI X12 transactions, it would typically be used to fill the ISA15 (use) field of the interchange header.
DOCCONTENTTYPE : Required
This parameter specifies the document content type for the pending outbound transaction document. The content type can be any string that identifies the content type - for example, you might use the EDI transaction type (eg: '850') for an EDI document or the XML document root element name for an XML document.
DOCCTY DOCISA11
DOCISA12
DOCISA14
DOCGS01
DOCISA01
DOCISA02
DOCISA03
DOCISA04 : Optional
These parameters may be used to specify values for selected EDI X12 interchange header (ISA) and group header (GS) segments. These values, if specified, will be written to LANSA Composer's document register in the files DXX2IN and DXX3GP and can subsequently be accessed in the Transformation Map for the outbound document to write the values directly to the resulting EDI document. It is not mandatory that you provide all these values - depending on the particulars of your implementation, you may derive some or all of these values in an export processor and/or outbound Transformation Map before or in the course of preparing the outbound EDI document.
DOCDATAKEY01
DOCDATAKEY02
DOCDATAKEY03
DOCDATAKEY04
DOCDATAKEY05
DOCDATAKEY06 : Optional
These parameters may be used to specify application-defined "key" information that will allow the export processor and/or outbound Transformation Map to identify the application data associated with the pending outbound transaction document.
OUTPUT Parameters:
DOCNUMBER :
Upon successful completion, this parameter will contain the transaction document envelope number assigned to the new pending outbound transaction document.