Defining a File Request Type

Prerequisites

To define a file request type, you should have:

  • A Business Object defined in the application that is used for creating a file request type

  • A Business Service defined in the application that is used for creating a file request type

  • A Service Script defined in the application that is used for creating a file request type

Procedure

To define 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 Add option from the File Request Type sub-menu.
    The File Request Type screen appears.

    The File Request Type screens consists of 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 that file transformation must be made to XML.
    Note: By selecting the file transformation required checkbox, fields like file format, and file extension fields are enabled, whereas fields like root xml tag and record transformation algorithm become visible.
    		 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.
    Note: This field is enabled when the file transformation required checkbox is checked.
    		 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 indicate whether the file should be processed with header details.
    Note: If the file header required checkbox is checked then the first record in the file will always be considered as the file header.
    		 No
    Header XML Tag Used to specify the header tag element of the file in xml format. It is used to get the header element block from the corresponding XML file.
    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 indicate whether the file should be processed with footer details.
    Note: If file footer required checkbox is checked, the last record in the file will always be considered as the file footer.
    		 No
    Footer XML Tag Used to specify the footer tag element of the file in xml format. It is used to get the footer element block from the corresponding XML file.
    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 indicate whether we want to stage the service execution details for every individual record in a file. Same details will be used on File Request dashboard for navigating to its created or updated corresponding entity. No
    Skip Duplicates Used to indicate if we want to have delta check i.e. avoid re-processing of same record in multiple batch executions or record level duplicate check i.e. if we want to skip the execution of those records for which we have multiple entries in a single file. Multiple entries in a file are identified using Record Identifier configured in Transformation Details section.
    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 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 indicate if the record size is greater than 32KB for the file request type.
    Note: This field is ideally used for performance optimization. If the record size is greater than 32kb, then REQUEST field 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 configuring a file request type.
    Note: This is an information based field.
    		 No
    Tip: Alternatively, you can access the File Request Type screen by clicking the Add button in the Page Title area of File Request Type screen.

    • 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 invocation and execution. Yes
    Service Type Used to indicate the type of service. The valid values are:-

    • Business Object (BO)

    • Business Service (BS)

    • Service Script (SS)

    		 Yes
    Service Name Used to specify the service to be invoked and executed for every record that is processed.
    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 for its corresponding UI entity in order to check the created or 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 to carry out pre-processing of the service, before its actual execution.
    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 the service 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 lifecycle 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 the 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 after every record 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 the 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 (file header / file footer / field detail) 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. Also if the File Header option is selected, then File Footer has to be selected, and if File Footer is selected then File Header must be selected.
    		 Yes
    Sequence Used to specify the field values that are used for mapping in either CSV/PSV format files. The sequence will be proportionate to the fields in a file. For example, if a CSV file has a record like, ZZBBSS1,CA,94701,true,Alameda,USA,Berkeley, then there are 7 comma-separated field values that exist in the file record. It explains that we can configure the sequence starting from 1 to 7.
    Note:

    • We can map/configure same sequence number to multiple fields i.e. Number of fields can refer to same field value provided in an individual record.

    • Sequence Number "ZERO: 0" is reserved for capturing default values.

    		 Yes
    Field Name Used to specify a unique user defined field name that contains the mapped file sequence field value.
    Note: A map with these configured Field Names and the corresponding Field Values are provided as an input to the record transformation algorithm.
    		 No
    Map Field XPath Used to specify a unique valid xpath from any of the configured services in the Services section.
    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.

    This field is required if we want to use the File Request Transformation algorithm.

    		 No
    Start Position Used to define the start position of a field value for a record in 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.

    A Fixed Position file has a record like, ZZBBSS1CA94701trueAlamedaUSABerkeley.

    If a field value's Start Position is1 and the End Position is 7, then the value is supposed be ZZBBSS1. Now, If we say that field value's Start Position is 8 and End Position is also8 then the value is definitely C.

    		 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 (Conditional)
    Note: This is required when the file format is selected as Fixed Position in the file request type.
    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.
    		 Yes (Conditional)
    Note: This field is required when the Sequence is zero (0).
    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

  4. Enter the required details to define file request type.
  5. Click Save.
    The File Request Type is created.

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 view the details of the file request type Viewing the File Request Type Details