File Request Type
The File Request Type zone displays the details of the file request type. It contains the following sections:
-
Main – This section provides basic information about the file request type. It contains the following fields:
Field Name Field Description File Request Type Displays the unique identifier code of the file request type. Description Displays the file request type description. Data Transformation Required Indicates whether file transformation is required for the file request type. File Atomicity Indicates that a commit or rollback should take place for all the transactions in case of a single failure. File Format Displays the type of file XML / JSON / CSV / PSV / Fixed Position. File Extension Displays the file extension for the file request type. Upload and Process File Simultaneously Indicates that file upload and processing should take place. File Header Required Indicates that a file will have header details, available in the file request type. File Footer Required Indicates whether a file will have footer details or not in the file request type. Static Header Static Footer Service Log Required Indicates that processing details should be captured for individual events. Skip Duplicates Indicates that execution of multiple records must be skipped from a single file. File Validation Algorithm Displays the algorithm used for fields like file header required, file footer required, and checksum validation. Data Transformation Algorithm Maximum Retry for Error Record Displays the maximum number of retry attempts that are allowed in case of a record failure. Validate Record Payload Indicates that only those records should be processed that have payloads for all those configured services of file request type. Display Profile File Upload Approval Required Date Format Time Format File Encryption Required Duplicate Record Identifier Expression Group Duplicate Records Duplicate Records Order By External System Used to specify an external system for a file request type. Force File Archival Record Size Greater Than 32 KB Displays the flag used for performance optimization. Error To Do Type Detailed Description -
Services – This section lists the service defined for the file request type. It contains the following columns:
Column Name Column Description Sequence Defines the execution sequence of the service. Service Type Displays the service to be executed. Service Name Displays the value of the characteristic type. FK Reference Used to navigate to corresponding UI, to check the updated details Pre-Processing Algorithm Displays the algorithm that is used for pre-processing the execution of a service. Post-Processing Algorithm Displays the algorithm that is used for post-processing the execution of a service. Operation Displays the operation that has to be performed for the business object. The valid values are: - Add
- Delete
- Read
- Replace
- Update
Dependent Service Name To address the payload nesting level and dependent service execution. This signifies a parent-child relationship. Defer Completion Flag used to defer the completion of successfully processed request where the final status will be updated once the corresponding BO lifecycle gets completed. Note: An API is provided to update the final status of the respective request. -
Messages – This section lists the message defined for the file request type. It contains the following columns:
Column Name Column Description Message Category Displays the message category number. Message Number Displays the message number to handle the retry or sent for approval status. File Record Status Displays the status of the file request type. -
Data Transformation – This section lists the data transformation details defined for the file request type. It is divided into below sub-sections:
-
Header Transformation - This sub-section
contains the following columns:
Column Name Column Description Sequence Displays the sequence of the service execution. Field Name Displays the field name for the file request type. Required Indicates that field level validations are mandatory for every record while uploading the data, using the File Transform and Upload (C1-FTRAN) Batch. Edit Input Default Value Displays the default values for the fields while the record payload is getting generated. Date/Time Format
-
Footer Transformation - This sub-section
contains the following columns:
Column Name Column Description Sequence Displays the sequence of the service execution. Field Name Displays the field name for the file request type. Required Indicates that field level validations are mandatory for every record while uploading the data, using the File Transform and Upload (C1-FTRAN) Batch. Edit Input Default Value Displays the default values for the fields while the record payload is getting generated. Date/Time Format
-
Field Transformation - This sub-section
contains the following columns:
Column Name Column Description Sequence Displays the sequence of the service execution. Field Name Displays the field name for the file request type. Map Field XPath Displays the map field xpath for the file request type. Required Indicates that field level validations are mandatory for every record while uploading the data, using the File Transform and Upload (C1-FTRAN) Batch. Record Identifier Indicates that duplicate entries must be checked for each file record, before uploading the data in the ORMB system. Skip Validation Edit Input Default Value Displays the default values for the fields while the record payload is getting generated. Date/Time Format
Column Name Column Description File Segment Type Displays the file segment type for the file request type. Sequence Displays the sequence of the service execution. Field Name Displays the field name for the file request type. Map Field XPath Displays the map field xpath for the file request type. Start Position Displays the start position for the file that is to be transformed in a particular format. Note: This column is visible when the file format is selected as Fixed Position.End Position Displays the end position for the file that is to be transformed in a particular format. Note: This column is visible when the file format is selected as Fixed Position.Required Indicates that field level validations are mandatory for every record while uploading the data, using the File Transform and Upload (C1-FTRAN) Batch. Record Identifier Indicates that duplicate entries must be checked for each file record, before uploading the data in the ORMB system. Default Value Displays the default values for the fields while the record payload is getting generated. -
Header Transformation - This sub-section
contains the following columns:
Note: By default, the File Request Type zone
does not appear in the File Request Type screen.
It appears when you click the Broadcast (
) icon corresponding to a file request
type in the Search zone.
![The Broadcast Icon](../images/BroadcastIcon.jpg)
Related Topics
For more information on... | See... |
---|---|
How to define a file request type | Defining a File Request Type |
How to edit a file request type | Editing a File Request Type |
How to copy a file request type | Copying a File Request Type |
How to delete a file request type | Deleting a File Request Type |