Copying a File Request Type

Instead of creating a file request type from scratch, you can create a new file request type using an existing file request type. This is possible by copying a file request type. On copying a file request type, the details including the service also get copied to the new file request type. You can then edit the details, if required.

Procedure

To copy a file request type:

  1. Click the Admin link in the Application toolbar.
    A list appears.
  2. From the Admin menu, select F and then click File Request Type.
    A sub-menu appears.
  3. Click the Search option from the File Request Type sub-menu.
    The File Request Type screen appears.
  4. In the Search File Request Type zone, click the Copy (The Duplicate Icon) icon in the Duplicate column corresponding to the file request type whose details you want to copy.
    The File Request Type screen appears. It contains the following sections:

    • Main - Used to specify basic details about the file request type. This section contains the following fields:

    Field Name Field Description Mandatory (Yes or No)
    File Request Type Used to specify a unique identifier code of the file request type. Yes
    Description Used to specify the description for the file request type. Yes
    File Transformation Required Used to indicate the requirement for file transformation.
    Note: By selecting the file transformation required checkbox, fields like file format, root xml tag, file extension, and record transformation algorithm get enabled.
    		 Yes (Conditional)
    Note: This field is required when file transformation is required for the file request type.
    File Atomicity Used to indicate that a commit or rollback should take place for all the transactions in case of a single failure. No
    File Format Used to specify different file formats that are required for the file request type. The valid values are:

    • Comma Separated Values

    • Extensible Markup Language

    • Fixed Position

    • Javascript Object Notation

    • Pipe Separated Values

    • Tilde Separated Values

    Note: This field gets enabled when the file transformation required checkbox field is selected.
    		 Yes (Conditional)
    Note: This field is required when file transformation required checkbox is selected.
    File Extension Used to specify the extension for the file request type. No
    File Upload and Process Used to indicate file upload and process for the file request type.
    Note: This field gets pre-selected when file atomicity checkbox field is selected.
    		 No
    Root XML Tag Used to specify the root tag of the file request type in xml.
    Note: This field gets displayed when the file transformation required checkbox field is selected.
    		 No
    File Header Required Used to specify whether the file request type contains header information. No
    Header XML Tag Used to specify the header xml tag for the file request type.
    Note: This field is displayed when the file header required and file transformation required checkbox field is checked where the file format field option is selected as Extensible Markup Language.
    		 Yes (Conditional)
    Note: This field is required when file header required checkbox is checked and the file format is extensible markup language.
    File Footer Required Used to specify whether the file request type contains footer information. No
    Footer XML Tag Used to specify the footer xml tag for the file request type.
    Note: This field is displayed when the file footer required and file transformation required checkbox field is checked and the file format field option is selected as Extensible Markup Language.
    		 Yes (Conditional)
    Note: This field is required when file footer required checkbox is checked and the file format is extensible markup language.
    Service Log Required Used to specify whether the file request type contains service log information. No
    Skip Duplicates Used to indicate that duplicate entries must be skipped while defining the file request type.
    Note: Multiple entries in a file are identified using the Record Identifier field, configured in the Transformation Details section.
    		 No
    File Validation Algorithm Used to specify the file validation algorithm for header, footer, and checksum validation field.
    Note:

    The Search (The Search Icon) icon appears corresponding to the File Validation Algorithm field. On clicking the search icon, the Algorithm Search search window appears.

    		 Yes (Conditional)
    Note: This is required when either the file header required or file footer required checkbox field in the file request type or the validate checksum checkbox field in the File Upload Interface Master Configuration is checked.
    Record Transformation Algorithm Used to specify the algorithm, used to transform the uploaded file to the required ORMB compliance service schema. Yes (Conditional)
    Note: This field is required when the file transformation required checkbox field is checked.
    Error Record Maximum Retry Used to specify the number of retry attempts in case of an error occurrence. No
    Validate Record Payload Used to indicate the validate record payload for the file request type. No
    Display Profile ID Used to specify the display profile ID for file request type. The valid values are:

    • Europe

    • North America
    Record Size Greater Than 32KB Used to specify if the record size is greater than 32KB for the file request type.
    Note: If the record size is greater than 32KB, then REQUESTfield with CLOB data type will be used to capture file record payload, else record payload will be staged in BO_​DATA_​AREA field with VARCHAR2(32000) data type.
    		 No
    External System Used to specify an external system for a file request type.
    Note: This is an information based field.
    		 No

    • Services - Used to define service(s) for the file request type. This section contains the following fields:

    Field Name Field Description Mandatory (Yes or No)
    Sequence Used to specify the sequence of service execution. Yes
    Service Type Used to indicate the type of service. The valid values are:-

    • Business Object

    • Business Service

    • Service Script

    		 Yes
    Service Name Used to specify the service to be executed for file request type.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Service Name field. On clicking the search icon, the Schema Type / Schema Name Search window appears.

    		 Yes
    FK Reference Used to specify the navigational sequence to check the updated details of the file request type.
    Note:

    The Search (The Search Icon) icon appears corresponding to the FK Reference Code field. On clicking the search icon, the Foreign Key Search window appears.

    		 No
    Pre-Processing Algorithm Used to specify the algorithm used for pre-processing of the service used for file request type.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Pre-Processing Algorithm field. On clicking the search icon, the Algorithm Search window appears.

    		 No
    Post Processing Algorithm Used to specify the algorithm that is to be invoked after successful processing of a record.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Pre-Processing Algorithm field. On clicking the search icon, the Algorithm Search window appears.

    		 No
    Operation Used to indicate the operation for file request type. The valid values are:

    • Add

    • Update

    • Replace

    • Delete

    		 No
    Dependent Service Name Used to specify the payload nesting level and dependent service execution, signifying the parent-child relationship. No
    Defer Completion Used to indicate the completion of successfully processed request where the final status will be updated once corresponding BO Life cycle is completed.
    Note: An API is provided to update the final status of the respective request.
    		 No
    Note: One or more services can be easily configured. A service can be a child of another service. A service with no inter-dependency can also be configured. Moreover it is typical for a child service to be linked with the primary service in a file request type. It is also possible to link child services as child objects to other child services. This inter-linking process allows hierarchies of objects to be modeled in a file request type section.
    Note: If you want to define more than one service for the file request type, click the Add (The Add Icon) icon in the respective sections. Similarly, if you want to delete a service, click the Delete (The Delete Icon) icon in the respective sections.

    • Messages - Used to define message(s) for the file request type. This section contains the following fields:

    Field Name Field Description Mandatory (Yes or No)
    Message Category Used to specify the message category for the file request type.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Message Category field. On clicking the search icon, the Message Category Search window appears.

    		 Yes
    Message Number Used to specify the message number to handle approval status.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Message Number field. On clicking the search icon, the Fetch File Request Type Message Number window appears.

    		 Yes
    Message Text Displays the description of the message number.
    Note: This is read-only field. As the Message Number field is interdependent on Message Category, if you search only for Message Number, no text will appear in the Message Text field. You have to first enter the Message Category, and then choose the Message Number.
    		 No
    Record Status Used to indicate the status that will be updated with every request failure. Yes
    Note: If you want to define more than one message for the file request type, click the Add (The Add Icon) icon in the respective sections. Similarly, if you want to delete a message, click the Delete (The Delete Icon) icon in the respective sections.

    • Transformation Details - Used to define file transformation details for the file request type. This section contains the following fields:

    Field Name Field Description Mandatory (Yes or No)
    File Segment Type Used to specify the file segment type for the file request type. The valid values are:

    • Field Detail

    • File Footer

    • File Header

    Note: If File Footer or File Header option is selected, ensure that respective checkbox is checked from the Main section.
    		 Yes
    Sequence Used to specify the sequence of service execution. Yes
    Field Name Used to specify the field name for the file request type. No
    Map Field XPath Used to specify the map field xpath for the file request type.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Map Field XPath field. On clicking the search icon, the File Request Transform Map Field Zone window appears.

    		 No
    Start Position Used to define the start position for the file that is to be transformed in a particular format.
    Note: This field is visible when the file format is selected as Fixed Position.
    		 Yes
    End Position Used to define the end position for the file that is to be transformed in a particular format.
    Note: This field is visible when the file format is selected as Fixed Position.
    		 Yes
    Required Used to indicate that field level validations are mandatory for every record while uploading the data using the File Transform and Upload (C1-FTRAN) Batch. No
    Record Identifier Used to indicate that duplicate entries must be checked for each file record, before uploading the data in the ORMB system. No
    Default Value Used to specify the default values for the fields while the record payload is getting generated.
    Note: This is read-only field.
    		 No
    Note: If you want to define more than one transformation detail for the file request type, click the Add (The Add Icon) icon in the respective sections. Similarly, if you want to delete a transformation detail, click the Delete (The Delete Icon) icon in the respective sections.
    Note: The Transformation Details section is displayed when the file format is as follows,

    • Comma Separated Values

    • Fixed Position

    • Pipe Separated Values

    • Tilde Separated Values

  5. Modify the required details, if required.
    Tip: Alternatively, you can click on the Broadcast (The Broadcast Icon) icon in the Search zone, corresponding to the File Request Type, whose details you want to copy. The File Request Type zone appears. Click on Duplicate button in the Record Actions section.
  6. Click Save.
    The selected File Request Type gets copied.

Related Topics

For more information on... See...
File Request Type screen File Request Type (Used for Searching)
File Request Type zone Search File Request Type
How to define a file request type Defining a File Request Type