Introduction
This document supplements the ECRTP
Reference Guide with EDI Adapter information. The EDI Adapter supports
two data types: NDO and Buffer. Operations on NDO type data are
documented in the Reference Guide, but operations on Buffer type data are not.
This document addresses that problem by providing explanations and samples of
operations on Buffer type data.
The EDI Adapter supports the following operations or modes at run time:
Acquire, Deliver and Process. Acquire mode refers to inbound
data, Deliver mode refers to outbound data, while Process mode refers to the
combined operation of an outbound function followed by an inbound function.
This information is valid for EDI 2.9 and later releases.
Configuration File Options for Buffer Mode
The following table lists options and values used in the configuration file
when running the EDI adapter:
Table 1: Configuration Options
| Configuration Option |
Values |
Description |
| rtp.mapswitches |
A valid command line for calling ECRTP |
A valid inbound or outbound command line. This will contain
the various options necessary to call ECRTP. See Chapter 3 of the ECRTP
Reference Guide for more information. |
| rtp.acquire_dir |
I, i, O, o |
The I or i is used to indicate an inbound run of ECRTP. The
O or o is used to indicate an outbound run of ECRTP |
| rtp.outputData.format |
EDI
SEQUENCE |
This option tells the Adapter if the output format will be
an EDI file or a normal sequential/flat file. This option is valid in acquire
and/or process modes. |
| rtp.outputData.buffername |
A valid filename from ECMap |
This contains the name of the file to be output to the queue.
If the format specified is SEQUENCE, this value (file name) should be a
file marked as “queue file” in ECMap. The entry should have the full directory
path and filename (The case should match the definitions for the directory
and file in ECMap.). If the format specified is EDI, the value should be
equivalent to the EDI file specified in the rtp.mapswitches option.
This option is valid in acquire and/or process modes. |
| rtp.inputData.format |
EDI
SEQUENCE |
This option tells the Adapter if the input format will be
an EDI file or a normal sequential/flat file. This option is valid in deliver
and/or process modes. |
| rtp.inputData.buffername |
A valid filename from ECMap |
This contains the name of the input file from the queue. If
the format specified is SEQUENCE, this value (file name) should be marked
as a “queue file” in ECMap. The entry should have the full directory path
and filename (The case should match the definitions for the directory and
file in ECMap.). If the format specified is EDI, the value should be equivalent
to the EDI file specified in the rtp.mapswitches option. This option is
valid in deliver and/or process modes. |
| mode |
ACQUIRE
DELIVER
PROCESS |
Sets the mode of use. Valid values when using ECRTP are ACQUIRE,
DELIVER, and PROCESS. |
data |
Buffer
NDO |
Sets the data processing type: NDO (for tree) or Buffer. Schema
mode handles only NDO data and Schema Remove ignores data. Both NDO and
buffer data can be used in all other modes. |
Sample Configuration Files
The following sections contain sample configuration files for Acquire, Deliver,
and Process modes using the Buffer data type
Acquire Buffer Configuration File
Acquire Buffer is used for inbound data coming from the Adapter to the queue.
The adapter “acquires” an EDI file or a sequential flat file from the EDI adapter
and places this file on the queue. The comment symbol ("#") in front
of a line must be removed for the line to be processed. The following is a sample
Acquire Buffer configuration file:
Adapter
clash.avoid=TRUE
continue.format.exists=TRUE
adapter=EDIAdapter
mode=ACQUIRE
data=BUFFER
# The following is a sample configuration file.
# You must modify the settings to work for your instance.
#maximum_num_retries=2
#transport.out.name=OUTQ
#failurequeue.name=FAIL
#NCF Serializer
#Output.Serializer.Factory=NCFSerializer_Factory
#Output.Serializer.Library=adk39ncfsd
#prefix=<prefix>
#msg.type=<prefix>.IC.<schema name>
#transport.context.name=ADKContext
#OTContext.ADKContext
#NNOT_CTX_DEFAULT_TIL_ID=FAIL
#NNOT_CTX_TMID=MQSeriesTM
#NNOT_CTX_ENFORCE_TX=TRUE
#TransactionManager.MQSeriesTM
#NNOT_SHARED_LIBRARY=oti26mqstm
#NNOT_FACTORY_FUNCTION=NNOTMQSeriesTXManagerFactory
#NN_TM_MQS_QMGR=TEST_QMGR
#Session.ADKSession
#NNOT_SHARED_LIBRARY=dbt26mqs
#NNOT_FACTORY_FUNCTION=NNMQSSessionFactory
#NNMQS_SES_OPEN_QMGR=TEST_QMGR
#Transport.OUTQ
#NNOT_SHARED_LIBRARY=dbt26mqs
#NNOT_FACTORY_FUNCTION=NNMQSQueueFactory
#NNOT_TIL_OPEN_SESSION_ID=ADKSession
#NNOT_TIL_OPEN_TSI=TEST_OUT
#Transport.FAIL
#NNOT_SHARED_LIBRARY=dbt26mqs
#NNOT_FACTORY_FUNCTION=NNMQSQueueFactory
#NNOT_TIL_OPEN_SESSION_ID=ADKSession
#NNOT_TIL_OPEN_TSI=TEST_FAIL
#Session.FileSession
#NNOT_SHARED_LIBRARY=nnfile
#NNOT_FACTORY_FUNCTION=NNSesFileFactory
#NN_SES_MSG_SIZE=1000
#NN_SES_SERVER=bsmith1
EDIAdapter
rtp.mapswitches=E:\Test\EDIInput.txt -dg e:\maps\TestMap -dt e:\maps\TestMap -it -o -b -wx 1
rtp.acquire_dir=I
rtp.outputData.format=SEQUENCE
rtp.outputData.buffername=c:\Test\Input.txt
In this configuration file, the mode is set to ACQUIRE and the data tag is
set to BUFFER. The information after the rtp.mapswitches tag is a sample
command line. An inbound map is being processed. The output format is a sequential
file. The file name within ECMap is Input.txt.
Sample Deliver Buffer Configuration File
Deliver Buffer mode is used to deliver information from the queue to the Adapter;
that is, data is taken off the queue and passed to the EDI adapter for processing.
The adapter receives an EDI file or a sequential/flat file as input and processes
the data accordingly. The comment symbol ("#") in front of a line
must be removed for the line to be processed. The following is a sample Deliver
Buffer configuration file:
Adapter
clash.avoid=TRUE
continue.format.exists=TRUE
adapter=EDIAdapter
mode=DELIVER
data=BUFFER
# The following is a sample configuration file.
# You must modify the settings to work for your instance.
#transport.in.name=INQ
#transport.failure_store_name=FAIL
#maximum.transport.retries=2
#transport.exit_if_empty=true
#Input.Serializer.Factory=NCFSerializer_Factory
#Input.Serializer.Library=adk39ncfsd
#prefix=<prefix>
#msg.type=<prefix>.IC.<schema name>
#transport.context.name=ADKContext
#OTContext.ADKContext
#NNOT_CTX_DEFAULT_TIL_ID=FAIL
#NNOT_CTX_TMID=MQSeriesTM
#NNOT_CTX_ENFORCE_TX=TRUE
#TransactionManager.MQSeriesTM
#NNOT_SHARED_LIBRARY=oti26mqstm
#NNOT_FACTORY_FUNCTION=NNOTMQSeriesTXManagerFactory
#NN_TM_MQS_QMGR=TEST_QMGR
#Session.ADKSession
#NNOT_SHARED_LIBRARY=dbt26mqs
#NNOT_FACTORY_FUNCTION=NNMQSSessionFactory
#NNMQS_SES_OPEN_QMGR=TEST_QMGR
#Transport.INQ
#NNOT_SHARED_LIBRARY=dbt26mqs
#NNOT_FACTORY_FUNCTION=NNMQSQueueFactory
#NNOT_TIL_OPEN_SESSION_ID=ADKSession
#NNOT_TIL_OPEN_TSI=TEST_OUT
#Transport.FAIL
#NNOT_SHARED_LIBRARY=dbt26mqs
#NNOT_FACTORY_FUNCTION=NNMQSQueueFactory
#NNOT_TIL_OPEN_SESSION_ID=ADKSession
#NNOT_TIL_OPEN_TSI=TEST_FAIL
EDIAdapter
rtp.mapswitches=E:\Test\EDIInput.txt -dg e:\maps\TestMap DT e:\maps\TestMap -it -o -b -wx 1
rtp.acquire_dir=I
rtp.inputData.format=EDI
rtp.inputData.buffername=E:\Test\EDIInput.txt
In this sample, the mode is set to DELIVER and the data tag is set to BUFFER.
The information after the rtp.mapswitches tag is a sample command line.
An inbound map is being processed. The input format is an EDI file and the
file name is EDIInput.txt.The inbound EDI file name and the first parameter
in the rtp.mapswitches option match.
Sample Process Buffer Configuration File
Process Mode is a combination of Deliver and Acquire modes. In this mode, the
adapter receives an EDI or sequential file as input (Deliver Mode). The map
processes the data and than returns an EDI or sequential file as output (Acquire
Mode). The comment symbol ("#") in front of a line must be removed
for the line to be processed. The following is a sample Process Mode configuration
file:
Adapter
clash.avoid=TRUE
continue.format.exists=TRUE
adapter=EDIAdapter
mode=PROCESS
data=BUFFER
# The following is a sample configuration file.
# You must modify the settings to work for your instance.
#transport.in.name=INQ
#transport.out.name=OUTQ
#transport.failure_store_name=FAIL
#maximum.transport.retries=2
#transport.exit_if_empty=true
#NCF Serializer
#Output.Serializer.Factory=NCFSerializer_Factory
#Output.Serializer.Library=adk39ncfsd
#Input.Serializer.Factory=NCFSerializer_Factory
#Input.Serializer.Library=adk39ncfsd
#prefix=<prefix>
#msg.type=<prefix>.IC.<schema name>
#transport.context.name=ADKContext
#OTContext.ADKContext
#NNOT_CTX_DEFAULT_TIL_ID=FAIL
#NNOT_CTX_TMID=MQSeriesTM
#NNOT_CTX_ENFORCE_TX=TRUE
#TransactionManager.MQSeriesTM
#NNOT_SHARED_LIBRARY=oti26mqstm
#NNOT_FACTORY_FUNCTION=NNOTMQSeriesTXManagerFactory
#NN_TM_MQS_QMGR=TEST_QMGR
#Session.ADKSession
#NNOT_SHARED_LIBRARY=dbt26mqs
#NNOT_FACTORY_FUNCTION=NNMQSSessionFactory
#NNMQS_SES_OPEN_QMGR=TEST_QMGR
#Transport.INQ
#NNOT_SHARED_LIBRARY=dbt26mqs
#NNOT_FACTORY_FUNCTION=NNMQSQueueFactory
#NNOT_TIL_OPEN_SESSION_ID=ADKSession
#NNOT_TIL_OPEN_TSI=TEST_OUT
#Transport.OUTQ
#NNOT_SHARED_LIBRARY=dbt26mqs
#NNOT_FACTORY_FUNCTION=NNMQSQueueFactory
#NNOT_TIL_OPEN_SESSION_ID=ADKSession
#NNOT_TIL_OPEN_TSI=TEST_OUT
#Transport.FAIL
#NNOT_SHARED_LIBRARY=dbt26mqs
#NNOT_FACTORY_FUNCTION=NNMQSQueueFactory
#NNOT_TIL_OPEN_SESSION_ID=ADKSession
#NNOT_TIL_OPEN_TSI=TEST_FAIL
EDIAdapter
rtp.mapswitches=E:\Test\EDIInput.txt -dg e:\maps\TestMap DT e:\maps\TestMap -it -o -b -wx 1
rtp.acquire_dir=I
rtp.outputData.format=SEQUENCE
rtp.outputData.buffername=c:\Test\Output.txt
rtp.inputData.format=EDI
rtp.inputData.buffername=E:\Test\EDIInput.txt
In this sample, the mode is set to PROCESS and the data tag is set to BUFFER.
The information after the rtp.mapswitches tag is a sample command line.
An inbound map is being processed. The input format is an EDI file and the
file name is EDIInput.txt.The inbound EDI file name and the first parameter
in the rtp.mapswitches option match. In process mode there is also an
output. In this scenario the output is a sequential file named Output.txt.
