TXDOC_REGISTER
This activity registers an in-coming or out-going transaction document in the transaction document register. Normally this should be done as soon as the document becomes available to the process and before significant processing is done for it.
After registering the document, and as the processing sequence proceeds to process the transaction document, it records its progress and updates the status in the transaction document register using the TXDOC_STATUS activity.
INPUT Parameters:
TRADINGPARTNER : Optional
Specifies the identifier of the trading partner for which the transaction document is being registered. If not specified, the activity will use the value of the *TRADINGPARTNER built-in variable. Otherwise, you should specify a variable or literal that contains the required trading partner ID. The trading partner is required by this activity, so if you do not provide a valid trading partner identifier and the *TRADINGPARTNER built-in variable is not set, the activity will end in error.
DOCDIR : Optional
Specifies the direction (I/O) for the transaction document exchange.
DOCFILE : Required
This parameter specifies the path and name of the transaction document file.
DOCTYPE : Optional
This parameter may be used to specify the document type for the transaction document. If (as is frequently the case) the document type is not known at the time the transaction document is registered, it can be specified at a later point using the TXDOC_STATUS activity. If specified, the document type should be a document type identifier as defined in LANSA Composer's definitions, for example 'EDI'.
DOCCONTENTTYPE : Optional
This parameter may be used to specify the document content type for the transaction document. If (as is frequently the case) the document content type is not known at the time the transaction document is registered, it can be specified at a later point using the TXDOC_STATUS activity. If specified, 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.
DOCPARENT : Optional
If applicable, this parameter can specify an existing registered transaction document number that represents the parent of this transaction document. This is typically applied in cases where an in-coming compound transaction document is split into individual transaction documents before further processing.
DOCRESPONSETO : Optional
If applicable, this parameter can specify an existing registered transaction document number to which this transaction document is a response. For example, when generating an acknowledgement for an in-coming transaction.
DOCNUMBERPREASSIGNED : Optional
If a transaction document envelope number has already been assigned to the new transaction document (by some other process or activity), then it should be specified in this parameter. Otherwise the activity will assign a new transaction document envelope number.
OUTPUT Parameters:
DOCNUMBER :
Upon successful completion, this parameter will contain the transaction document envelope number assigned to the new transaction document. This number should be saved and specified on subsequent TXDOC_STATUS activity calls relating to this transaction document.