TXDOC_ALLOCCTRL
This activity allocates one or more control numbers for outbound transaction documents. It can allocate:
- zero, one or more interchange control numbers
- zero, one or more group control numbers
- zero, one or more transaction set (message) control numbers
The control number(s) are allocated from the series that apply to the specified trading partner, as can be seen on the tab of the Trading Partner definition, and the "next" numbers for the series are incremented accordingly.
If the outbound numbering domain for the trading partner specifies that outbound control numbers are allocated by transaction id, then the DOCCONTENTTYPE parameter must specify the transaction type of the series from which the control numbers are to be allocated.
NOTE (1) - When using the API supplied with LANSA Composer for registering pending outbound documents, the necessary interchange, group and transaction set control numbers are automatically allocated by LANSA Composer. You do not need to use this activity in that event. The same usually applies when using an export processor associated with a transformation map for an outbound transaction document process (although this will depend on the specific implementation of the export processor).
NOTE (2) - There is no means to de-allocate or free control numbers once allocated. If your trading environment or trading agreements requires sequential control numbering or auditability of allocated control numbers, then it is your responsibility to satisfy those requirements when using this activity to allocate control numbers.
INPUT Parameters:
TRADINGPARTNER : Required
Specifies the trading partner for which the control numbers are allocated. This parameter is required.
DOCCONTENTTYPE : Optional
This parameter may be used to specify the document content type for which the control numbers are allocated. It is required if the outbound numbering domain for the trading partner specifies that outbound control numbers are allocated by transaction id. However, if the outbound numbering domain for the trading partner specifies that outbound control numbers are allocated across all transaction ids, then the value of the DOCCONTENTTYPE parameter will be ignored.
ALLOCATE_IC : Optional
Specifies how many interchange control numbers to allocate. The allocated interchange control numbers will be placed in the CTRLNUMBER_IC output list parameter.
ALLOCATE_GP : Optional
Specifies how many group control numbers to allocate. The allocated group control numbers will be placed in the CTRLNUMBER_GP output list parameter.
ALLOCATE_MS : Optional
Specifies how many transaction set (message) control numbers to allocate. The allocated transaction set control numbers will be placed in the CTRLNUMBER_MS output list parameter.
OUTPUT Parameters:
CTRLNUMBER_IC :
Upon successful completion, this parameter will contain a list of zero, one or more allocated interchange control numbers, according to the value specified in the ALLOCATE_IC parameter.
CTRLNUMBER_GP :
Upon successful completion, this parameter will contain a list of zero, one or more allocated group control numbers, according to the value specified in the ALLOCATE_GP parameter.
CTRLNUMBER_MS :
Upon successful completion, this parameter will contain a list of zero, one or more allocated transaction set (message) control numbers, according to the value specified in the ALLOCATE_MS parameter.