Defining a File Request Type

Prerequisites

To define a file request type, you should have:

  • File request type business objects defined in the application

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. It contains the following sections:

    • Main - Used to specify basic configuration details about the file request type.

    • Services - Used to add services in the file request type.

    • Messages - Used to specify the messages associated with the file request type.

    • Data Transformation - Used to specify the header, footer, and field transformation details in the file request type.

      Note: This section appears only when you select the Data Transformation Required field from the Main section.

    The Main section contains the following fields:

    Field Name Field Description Mandatory (Yes or No)
    File Request Type Used to specify the file request type. Yes
    Description Used to specify the description for the file request type.
    Tip: You need to specify the purpose of the file request type.
    		 No
    Data Transformation Required Used to indicate that the type of file or schema which you want to upload is incompatible and needs transformation as per the type of file or schema supported by the application.
    Note: The application supports file type or schema which is in the Extensible Markup Language (XML) format. Therefore, if you are uploading a file or schema in the Extensible Markup Language (XML), you need not select the Data Transformation Required field. However, if you are uploading a file or schema which is in a format other than the Extensible Markup Language (XML), you need to select the Data Transformation Required field.
    		 Yes (Conditional)
    Note: This field is required while transforming the data received from the external source (i.e. from the customer) as per the format provided in the application.
    File Atomicity Used to indicate whether the system should stop the file upload process and roll back the entire data if any error occurs in any single record of the uploaded file. No
    File Format Used to indicate the type of file that you want to upload using 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:

    By default, the Extensible Markup Language option is selected and the field is disabled. It is enabled only when you select the Data Transformation Required field.

    		 Yes
    File Extension Used to specify the extension of the file type selected from the File Format list.
    Note: This field is enabled only when you select the Data Transformation Required field.
    		 Yes
    Upload and Process File Simultaneously Used to indicate that you want to upload and process the file simultaneously in a single batch run.
    Note:

    On selecting this field, when the File Transform and Upload (C1-FTRAN) batch is run, the system will upload the files and create a staging table for the records available in the uploaded file. These records will then be assigned to the respective tables of the entity in the database.

    However, if you do not select this field, the File Transform and Upload (C1-FTRAN) batch will only upload the file and create a staging table for the records available in the uploaded file. To assign the data from the staging table to the respective tables of the entity in the database you need to run the File Request Process (C1-FREQP) batch.

    This field is selected automatically when the File Atomicity field is selected.

    		 No
    Root XML Tag Used to specify the root tag element in the file which you want to upload using the file request type.
    Note: This field is displayed only when the Data Transformation Required filed is selected and the File Format field is set to Extensible Markup Language.
    		 No
    File Header Required Used to indicate whether the file that you want to upload should have header details or not.
    Note:

    If you select this field, the first row data in the uploaded file will be considered as the file header string.

    If the Data Transformation Required filed is selected, you need to configure the header details in the Header Transformation sub-section of the Data Transformation section.

    The Static Header field is automatically deselected if you select the File Header Required field.

    		 No
    Header XML Tag Used to specify the header tag element in the file whose data you want to use as the header details.
    Note: This field is displayed only when the Data Transformation Required, File Header Required fields are selected and the File Format field is set to Extensible Markup Language.
    		 Yes (Conditional)
    Note: This field is required while uploading an Extensible Markup Language (XML) file for which data transformation is required.
    File Footer Required Used to indicate whether the file that you want to upload should have footer details or not.
    Note:

    If you select this field, the last row data in the uploaded file will be considered as the file footer string.

    If the Data Transformation Required filed is selected, you need to configure the footer details in the Footer Transformation sub-section of the Data Transformation section.

    The Static Footer field is automatically deselected if you select the File Footer Required field.

    		 No
    Footer XML Tag Used to specify the footer tag element in the file whose data you want to use as the footer details.
    Note: This field is displayed only when the Data Transformation Required, File Footer Required fields are selected and the File Format field is set to Extensible Markup Language.
    		 Yes (Conditional)
    Note: This field is required while uploading an Extensible Markup Language (XML) file for which data transformation and footer details is required.
    Static Header Used to indicate that the uploaded file contains a predefined, unchanging header row which does not need dynamic validation during processing.
    Note:

    If the Data Transformation Required filed is selected, you need to configure the static header details in the Header Transformation sub-section of the Data Transformation section.

    The File Header Required field is automatically deselected if you select the Static Header field.

    		 No
    Static Footer Used to indicate that the uploaded file contains a predefined, unchanging footer row typically used for summary or ending markers without requiring dynamic validation during processing.
    Note:

    If the Data Transformation Required filed is selected, you need to configure the static footer details in the Footer Transformation sub-section of the Data Transformation section.

    The File Footer Required field is automatically deselected if you select the Static Footer field.

    		 No
    Service Log Required Used to indicate whether you want to log details about the creation and updates made in every record of the entity corresponding to the services configured for the file request type.
    Note: The service log details are used on the File Request dashboard screen for navigating to the changes made in the corresponding entity.
    		 No
    Skip Duplicates Used to indicate whether you want to skip the execution of duplicate records in the uploaded file.
    Note:

    If you select this option, none of the duplicate records will be processed.

    For Example: If you have two duplicate records in the uploaded file and the Skip Duplicate field is selected, then, the system will skip both the records while processing the file.

    Duplicate entries are identified when you select the Record Identifier field corresponding to the Field Name configured in the Field Transformation sub-section of the Data Transformation section.

    		 No
    File Validation Algorithm Used to specify the algorithm which you want to use for validating the data in the uploaded file. The valid values are:

    • File Request Header Footer Validation (C1-FRHFVA) - Used to validate the header and footer provided in the file.

      If the File Header Required or Static Header field is selected, the algorithm checks whether the header line in the file is marked with the header marker H.

      If the File Footer Required or Static Footer field is selected, the algorithm checks whether the footer line in the file is marked with the footer marker T, followed by the count of records in the file.

      Note: If none of the above mentioned conditions are met, the system will stop processing the file.

    • Sample File Validation (C1-FRHVA) - Used to check whether the associated algorithm is invoked and logs the fields available in the header and footer while processing the file.

    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 where you can search for the respective algorithm.

    The above algorithms are shipped with the product. The implementation team can create custom algorithm type for this algorithm entity based on the customer requirements.

    		 Yes (Conditional)
    Note: This field is required for validating the header and footer information while processing the data provided in the file using the file request type.
    Data Transformation Algorithm Used to indicate the algorithm using which the data from the uploaded file is transformed into data which is compliant with the schema defined for the business service in the application.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Data Transformation Algorithm field. On clicking the search icon, the Algorithm Search search window appears where you can search for the respective algorithm.

    This field appears only when you select the Data Transformation Required field.

    		 Yes (Conditional)
    Note: This field is required while data transformation.
    Maximum Retry for Error Record Used to specify the maximum number of retry attempts that are allowed for records which are in the error status while processing the uploaded file. No
    Validate Record Payload Used to indicate that you want to validate and process only those records that have payloads for other services that are configured using the file request type. No
    Display Profile Used to indicate how the date should be displayed when the entity is created. The valid values are:

    • Europe

    • North America

    • HIJRI Format

    • Other

    		 No
    File Upload Approval Required Used to indicate whether approval is required to upload and process the file using the file request type.
    Note:

    If you select this option you need to ensure that the approval workflow for file upload interface is configured in the system.

    When the File Transform and Upload (C1-FTRAN) batch is run, the system will create an Approval Transaction ID and mark the file in the Pending for Approval status. The approver can then search and approve the file from the Approval Transaction screen using the Approval Transaction ID.

    Once the approver approves the file from the Approval Transaction screen, the File Transform and Upload (C1-FTRAN) batch is triggered automatically for processing the file.

    		 No
    Date Format Used to specify the format in which you want to display the date.
    Note: This field appears only when the Other option is selected from the Display Profile list.
    		 No
    Time Format Used to specify the format in which you want to display the time.
    Note: This field appears only when the Other option is selected from the Display Profile list.
    		 No
    File Decryption Required Used to indicate whether decryption is required for the file before processing.
    Note: If you select this field, the system will check for the encryption details configured for the file upload interface in the Master Configuration screen.
    		 No
    Duplicate Record Identifier Expression Used to specify the field for which you want to identify duplicate records in the uploaded file.
    Note:

    If you want to specify multiple fields, you can do so by adding <space>&&<space> as the separator in between the fields.

    If you want to specify a combination of fields, you can do so by adding <space>||<space> as the separator in between the fields.

    		 No
    Group Duplicate Records Used to indicate whether duplicate records in the uploaded files should be processed in a same thread or not. No
    Duplicate Records Order By Used to indicate the order in which you want to process the duplicate records. No
    External System Used to specify an external system for configuring a file request type. No
    Force File Archival Used to indicate whether the file should be archived and moved to the location mentioned in the Master Configuration screen after processing. No
    Record Size Greater Than 32KB Used to indicate whether each record in the file which you want to upload using the file request type is greater than 32 KB or not.
    Note: Record size greater than 32 KB will be stored in the CLOB data type. Whereas, record size less than 32 KB, will be stored in VARCHAR2 data type in the database.
    		 No
    Error To Do Type Used to indicate the To Do entry of the specified To Do Type must be created in case of any error encountered while processing the file using the file request type.
    Note: The Search (The Search Icon) icon appears corresponding to the Error To Do Type field. On clicking the search icon, the To Do Type Details window appears where you can search for the respective To Do Type.
    		 No
    Detailed Description Used to specify additional information about the file request type. No
    Tip: Alternatively, you can access this screen by clicking the Add button in the Page Title area of File Request Type screen.
  4. Enter the required details in the Main section.
  5. Add, edit, or delete services from the file request type, if required.
  6. Add, edit, or delete messages from the file request type, if required.
  7. Add, edit, or delete the data transformation details from file request type, if required.
  8. Click Save.
    The File Request Type is defined.

Related Topics

For more information on... See...
File Request Type screen File Request Type
How to add services in a file request type Adding Services in a File Request Type
How to add messages in a file request type Adding Messages in a File Request Type
How to add header data transformation details in a file request type Adding Header Data Transformation Details in a File Request Type
How to add footer data transformation details in a file request type Adding Footer Data Transformation Details in a File Request Type
How to add field data transformation details in a file request type Adding Field Data Transformation Details in a File Request Type