Odette FTP Queue Handler Service

Configuring the Odette FTP Queue Handler Service in Queued Mode

There are no configurable service instance parameters for the Odette FTP Queue Handler service.

If Odette FTP version 2.0 is used, the OetteFTP Queue Handler service is optionally responsible for signing, encrypting and compressing files before queueing them.

Input XML Structures

To put files, EERPs or NERPs into the OFTP queue, the Odette FTP Queue Handler service requires the following XML input structures which have to be passed to the Service from a business process:

XML Input Structure for Message Type FILE:

<OFTPDataItem>
  <FILE>
      <properties>
        <LogicalPartnerContract>log_partner_name</LogicalPartnerContract>
        <!-- LogicalPartner Properties overriding defaults in partner 
             profile -->
         <OFTPVirtualFilename>virtual_filename</ OFTPVirtualFilename>
         <Date>date</Date>
        <Time>time</Time>
         <FileFormat>[U|T|V|F]</ FileFormat>
         <OFTPFileUserField>free_user_content</ OFTPFileUserField>
         <RecordLength>n<RecordLength>
        <RecordDelimiter>one_or_two_delimiters<RecordDelimiter>
     </properties>
      <document>
        <MessageID>message_id<MessageID      
        _OR_ 
         <PrimaryDocumentSCIObjectID="document_id_1"/>
      </document>
  <FILE> 
</OFTPDataItem>

Defining XML Node Name Parameters

XML Input Structure for Message Type EERP

The following is an example of the input structure for an EERP:

<OFTPDataItem>
  <EERP>
      <properties>
        <LogicalPartnerContract>log_partner_name</LogicalPartnerContract> 
        <OFTPVirtualFilename>virtual_filename</ OFTPVirtualFilename>
        <Date>date</Date>
         <Time>time</Time>     
      </properties>   
  <EERP> 
</OFTPDataItem>

XML Input Structure for Message Type NERP

The following is an example of the input structure for an NERP:

<OFTPDataItem>
  <NERP>
      <properties>
        <LogicalPartnerContract>log_partner_name</LogicalPartnerContract>
        <Creator>creator_of_nerp</Creator>
        <OFTPVirtualFilename>virtual_filename</ OFTPVirtualFilename>
        <Date>date</Date>
         <Time>time</Time>   
         <Reason>reasoncode</Reason>
     </properties>      
   <NERP> 
</OFTPDataItem>

Decipher Mode

To decrypt an encrypted OFTP file in a Primary Document or Mailbox (specified by Message Id) the Odette FTP Queue Handler has to be called in DECIPHER mode and compressed or signed. The following example shows the usage of the Queue Handler for this purpose:

<!-- 
   Adapter      : OdetteFTP Queue Handler - DECIPHER mode
   Description  : Example template process for decrypting a received encrypted
                  file.  This process can be used in the business process 
                  which is started for inbound files.   
   Prerequisites: - Read the OdetteFTP Queue Handler documentation                 
                      - Configure and enable the OdetteFTP Adapter instance 
                        "OFTPQueueHandler"
                      - Modify this template process as described in the 
                        comments below.
                      - Make sure OFTP Partner Profile has been imported 
                        into the database.
   Input :  Parameter
                  mode		     DECIPHER Either		   MessageId      <number> 
            Queue Handler searches for an file entry in the Odette FTP Queue 
            with Message ID <number>. If there is a file it is decrypted. or 
            PPrimaryDocument.   Pass PrimaryDocument which needs to be decrypted
            in the process data. -->
<process name="oftpdecrypt">
   <sequence name="decrypt">
     <!--
        Either pass parameters from an initiating process and remove the assign 
        statements _or_ enter the values in the following assign statements. 
        Note: If you use DocumentId, you must also use FileProcessing and 
        Response_DOC_ID. 
     -->
      <assign to="mode" from="'DECIPHER'" />

<!--
     <assign to="MessageId">number</assign> 
-->   
<!--
     <assign to="DocumentId">number</assign> 
     <assign to="FileProcessing">true</assign> 
     <assign to="Response_DOC_ID">docid_from_oftp_object</assign>     
--> 

      <!-- Decipher document  -->

      <operation name="DecryptFile">
        <participant name="OFTPQueueHandler" />
        <output message="OFTPOut">
          <assign to="." from="*"/>            
        </output>
        <input message="OFTPIn">
           <assign to="." from="*"/>            
        </input>
      </operation>
  </sequence> 
</process>

In Manual Mode the Odette FTP Queue Handler could be called in DECIPHER mode directly from the business process initiated for an encrypted inbound file.

In Queued Mode an Automated Mailbox rule could be used to initiate a business process for inbound files calling the Odette FTP Queue Handler in DECIPHER mode.

Error Messages (both Queued and Decipher modes)

Error Codes for Decipher Mode