Oracle Revenue Management and Billing. File Upload Interface (FUI) - User Guide. Version Revision 1.1

Transcription

1 Oracle Revenue Management and Billing Version File Upload Interface (FUI) - User Guide Revision 1.1 E May, 2018

2 Oracle Revenue Management and Billing File Upload Interface (FUI) - User Guide E Copyright tice Copyright 2018, Oracle and/or its affiliates. All rights reserved. Trademark tice Oracle and Java are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. License Restrictions Warranty/Consequential Damages Disclaimer This software and related documentation are provided under a license agreement containing restrictions on use and disclosure, and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or de-compilation of this software, unless required by law for interoperability, is prohibited. Warranty Disclaimer The information contained herein is subject to change without notice and is not warranted to be errorfree. If you find any errors, please report them to us in writing. Restricted Rights tice If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Oracle programs, including any operating system, integrated software, any programs installed on the hardware and/or documentation delivered to U.S. Government end users are commercial computer software pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware and/or documentation shall be subject to license terms and restrictions applicable to the programs. other rights are granted to the U.S. Government. ii Copyright 2018, Oracle and/or its affiliates. All rights reserved.

3 Hazardous Applications tice This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications. Third Party Content, Products, and Services Disclaimer This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third party content, products, or services. Copyright 2018, Oracle and/or its affiliates. All rights reserved. iii

4 Preface About This Document This document lists and describes various file upload interface features in Oracle Revenue Management and Billing. It describes all screens related to the file upload interface modules and explains how to perform various tasks in the application. Intended Audience This document is intended for the following audience: End-users Implementation Team Consulting Team Development Team Organization of the Document The information in this document is organized into the following sections: Section. Section Name Section 1 Introduction Provides an overview of Master Configuration and File Upload Interface Configuration. Section 2 File Request Type Provides an overview of File Request Type. It also explains the process of defining, searching, viewing, editing, copying and deleting file request type. Section 3 File Upload Dashboard Describes and explains the File Upload Dashboard. It also explains how to search, view file details using the file upload dashboard. It also lists and describes the tasks you can perform when viewing file record details. Related Documents You can refer to the following documents for more information: Document Oracle Revenue Management and Billing Banking User Guide File Upload Interface - Batch Execution Guide Lists and describes various banking features in Oracle Revenue Management and Billing. It also describes all screens related to these features and explains how to perform various tasks in the application. Provides detail information about various batches to be executed while performing tasks such as uploading, processing and updating status of files using File Upload Interface. iv Copyright 2018, Oracle and/or its affiliates. All rights reserved.

5 Document File Upload Interface (FUI) Quick Reference Guide Provides a detail explanation of ORMB approach for Data Conversion and integration. It describes parameters related to File Upload Interface Master Configuration and also explains how to perform important tasks using File Upload Interface. Change Log Revision Last Update Updated Section Comments Aug-2018 Section Defining Services for File Request Type Section Defining Messages for File Request Type Section Defining Transformation Details for File Request Type Section 2.3 Viewing Details of a File Request Section 2.4 Editing Details of a File Request Section 3.1 Searching File Details Updated Information Updated Information Added Information Made changes in Main section Made changes in Main section Updated Information Copyright 2018, Oracle and/or its affiliates. All rights reserved. v

6 Contents 1. Introduction Master Configuration File Upload Interface Configuration File Request Type Defining a File Request Type Defining Parameters for File Request Type Defining Services for File Request Type Defining Messages for File Request Type Defining Transformation Details for File Request Type Searching a File Request Type Viewing Details of a File Request Editing a File Request Type Copying a File Request Type Deleting a File Request Type File Upload Dashboard Searching File Details Viewing File Details Viewing File Details with Complete or Pending Status View Files with Error or Reject Status Viewing Specific File Record Details Updating Record Status vi Copyright 2018, Oracle and/or its affiliates. All rights reserved.

7 1. Introduction Oracle Revenue Management and Billing (ORMB) provides one or more master configuration that may be used for configuration. A master configuration is an object that enables an implementation to define configuration for features in the system. ORMB application provides File Upload Interface Configuration which defines the parameters used by the file upload and transform process. The system allows you to define a file request type which is used to upload file records. A file record is processed using the defined File Request Types. Each individual file will have records with reference to same File Request Type. Each single record in a file is staged using a File Upload and Transform (C1-FTRAN) batch. The file request type helps the system to understand how to process the uploaded file. 1.1 Master Configuration A master configuration is an object that enables an implementation to define configuration for features in the system. A master configuration is defined using a business object. The Master Configuration List zone lists every category of master configuration. To view Master Configuration, 1. From the Admin menu, select M and then click Master Configuration. The Master Configuration zone appears. Figure 1: Master Configuration 2. The Master Configuration zone contains the following columns: Column Name Master Configuration Action Displays the name of the Business Object Name using which entity configuration will be done. Provides options to update the respective master configurations. The valid actions are: Edit ( ) allows you to edit the master configuration. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 1

8 Add ( ) allows you to add new parameters to the master configuration. 3. To view details information about master configuration, click Broadcast ( ) icon. 4. The Master Configuration Details zone appears. It contains display-only information about a master configuration. Tip: If a master configuration record exists for a given master configuration business object, the broadcast icon may be used to view details information about the adjacent master configuration. Figure 2: Master Configuration Details 1.2 File Upload Interface Configuration Oracle Revenue Management and Billing allows you to define master configuration for File Upload Interface Configuration. File Upload Interface Configuration defines the parameters used by the file upload and transform process. It lists the business object which contains the information for Master Configuration of File Request Type. It also allows you to define, edit, copy and delete a file request type using which you can upload a file request. To configure the File Upload Interface, you need to the following: 1. From the Admin menu, select M and then click Master Configuration. 2. The Master Configuration zone appears. You will see list of master configurations. 3. The icons in Action column highlight their usage purpose. Add ( ) - Used to add configuration. Edit ( ) Used to edit existing configuration details. 4. If Add ( ) icon appears corresponding to File Upload Interface Configuration, click Add ( ) icon to add the configuration details. te: If a master configuration record does not exist for File Upload Interface, the Add icon is visible corresponding to File Upload Interface Configuration. If a master configuration record exists for File Upload Interface, the Edit icon is visible. 2 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

9 Prerequisites Figure 3: Master Configuration - File Upload Interface Configuration To edit a file upload interface master configuration, you should have: Procedure File Upload Interface configuration business objects defined in the application. To edit a file upload configuration, you need to do the following: 1. From the Admin menu, select M and then click Master Configuration. The Master Configuration screen appears. 2. Click Edit ( ) icon corresponding to the File Upload Interface Configuration. The Master Configuration screen appears. It contains the following fields: Field Name Mandatory (Yes or ) Master Configuration Used to indicate name of the master entity. te: You cannot edit the Master Configuration Name. Yes Validate Checksum Validate Duplicate Name Audit Required Archive File File Log Used to validate file integrity before staging file contents in ORMB system. If True, checksum validation will be done for that uploaded file. Used to decide the required validation of duplicate file name before uploading a file. If False, file with same name can be uploaded multiple times. Used to decide whether to log corresponding file request status transition after processing an individual file request. Used to decide whether to relocate the file to another location after processing on SFTP server. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 3

10 Field Name Mandatory (Yes or ) Archive Location File Archive Error File Location File Encryption Required File Decryption Algorithm Used to specify the file path used for archiving the successfully staged files. Path will always start with either 1."@SHARED_DIR" that is configured path of shared directory. 2."@INSTALL_DIR" that is configured path of installation directory defined with a property "spl.runtime.environ.splebase" in "spl.properties" file. Used to specify the file path used for archiving the error files. Path will always start with either 1."@SHARED_DIR" that is configured path of shared directory. 2."@INSTALL_DIR" that is configured path of installation directory defined with a property "spl.runtime.environ.splebase" in "spl.properties" file. Used to decide whether to first decrypt and then extract the files on SFTP server. Used to define the algorithm to be used for decrypting the third party provided encrypted file before uploading in ORMB staging. Yes (Conditional) te: This field value is required when Archive File flag is True. Yes (Conditional) te: This field is required when Archive File flag is True. Yes (Conditional) te: This field value is required when File Encryption flag is True. Cipher Type Decryption Key Used to define the type of encryption methodology used to generate encrypted key. This will be used to get the encrypted keystore password that is required to read ouaf_keystore file which holds the encrypted file key. Used to decrypt the encrypted file. Decryption key will be updated in ouaf_keystore file. This key is not stored in database. Yes (Conditional) te: This field value is required when File Encryption flag is True. Yes (Conditional) te: This field value is required when File Encryption flag is True. 4 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

11 Figure 4: File Upload Interface Configuration Copyright 2018, Oracle and/or its affiliates. All rights reserved. 5

12 2. File Request Type Oracle Revenue Management and Billing allows you to define a file request type using which you can upload and transform a record. File request type is a configuration which will allow you to upload files in different formats and transforms the files to ORMB compliant formats. It will also help the system to understand how to process the uploaded file. The File Request Type screen allows you to define, edit, copy, and delete a File request type. This screen consists of the following zones: Search zone allows you to search for a file request type. It contains the following sections: o Search Criteria allows you to search for file request type. There are two search fields: Field Name File Request Type Allows you search file request by name. Allows you to search file request by its description. te: By default, all the file requests in the system are displayed. o Search Results displays results based on the specified search criteria. It contains following columns: Column Name File Request Type Edit Delete Duplicate Used to indicate the name of file request type. Used to indicate the description of file request type. Allows you to edit an existing file request type. Allows you to delete an existing file request type. Allows you to create a duplicate file request type. File Request Type zone displays the details of the file request type. This zone contains the following sections: i. Main - Indicates the basic configuration details of a file request. ii. Services - Indicates the defined services for a file request. iii. Messages Indicates the message defined for a file request. iv. Transformation Details Indicates the defined configuration to transform file requests. v. Record Actions Displays buttons to edit, delete and duplicate file requests. vi. Record Information has following fields: o o Business Object - Indicates the Business Object using which the file request type is created. It is linked to the respective business object. Create Date/Time displays the creation date and time of business object. 6 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

13 Figure 5: File Request Type 2.1 Defining a File Request Type To define a File Request Type, you should have File request business objects defined in the application. To define a file request type: 1. From the Admin menu, select F and then click File Request Type. 2. Select Add from the options. Tip: You can also define file request type from File Request Type zone. To define file request type, navigate using Admin > F > File Request Type > Search. Click Add ( ) button on File Request Type zone. 3. The File Request Type zone appears. It contains the following sections: Main - Used to specify basic configuration details about file requests. Service(s) - Used to define services to be executed for file requests. Message(s) - Used to define messages for file requests. Transformation Details Used to define configuration for transforming file requests. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 7

14 2.1.1 Defining Parameters for File Request Type The Main section within the File Request Type zone allows you to define important parameters related to file requests. To define parameters: 1. From the Admin menu, select F and then click File Request Type. 2. Select Add from the options. Tip: You can also define file request type from File Request Type zone. To define file request type, navigate using Admin > F > File Request Type > Search. Click Add ( 3. The File Request Type zone appears. 4. The Main section contains the following fields: ) button on File Request Type zone. Field Name Mandatory (Yes or ) File Type Request Used to define identifier code of the file request type. Used to define description of file request type. Yes File Transformation Required Flag used to transform uploaded file to XML. te: This is required if the file record is to be transformed to ORMB conform service schema. Yes File Atomicity Flag used to commit or rollback all transactions for any single failure. File Format File Extension File Upload and Process Used to define the file formats supported for file transformation. The valid formats are: CSV XML Fixed Position JSON PSV Tilde Separated Values Used to specify file extensions which will be picked from SFTP server for upload and process batch execution. Flag used to upload and process file records in a single batch using File Transform and Upload (C1-FTRAN) batch. te: If flag is True, it is not required to execute File Request Process (C1-FREQP) batch. Yes (if File Transformation Required check box is selected.) te: By default, the File Format selected is XML. 8 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

15 Field Name Mandatory (Yes or ) Root XML Tag Used to indicate the name of root tag being used in XML. Yes (Conditional) te: This field is required when file format is XML and File Transformation Required flag is True. File Header Required Header XML Tag File Footer Required Footer XML Tag Service Log Required Skip Duplicates Flag used to specify whether file will have header details. If True, then first row data will be passed as header string to File Validation Algorithm. Used to indicate name of the header tag element of a file in XML format. This will be used to get the header element block from the corresponding XML file. Flag used to specify whether file will have footer details. If True, then last row data will be passed as header string to File Validation Algorithm. Used to indicate the name of footer tag being used in XML. This will be used to get the footer element block from the corresponding XML file. Flag used to validate if processing details need to be captured for individual records. The same details will be used on File Request dashboard for navigating to its created or updated corresponding entity. Flag used to skip execution of multiple records in a single file. Multiple entries in a file are identified using Record Identifier configured in Transformation Details section. Yes (Conditional) te: This is required when file format is XML and File Header Required flag is True and File Transformation Required flag is True. Yes (Conditional) te: This field is required when file format is XML and File Footer Required flag is True and File Transformation Required flag is True. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 9

16 Field Name Mandatory (Yes or ) File Validation Algorithm Used to indicate algorithm used for file header, footer and checksum validation. Yes (Conditional) te: This is required when either File Header Required or File Footer Required flags in File Request Type or Validate Checksum flag in File Upload Interface Master Configuration is True. Record Transformation Algorithm Error Record Maximum Retry Used to indicate algorithm called to transform uploaded file to the required ORMB compliance service schema. Used to define the number of maximum retry attempts allowed for any failed record. te: The value should be greater than 0. Yes (Conditional) te: This is required when File Transformation Required flag is True. Validate Record Payload External System Record Greater 32KB Size than Flag used to process only those records having payloads for all those configured services of File Request Type. For example, If services for Person, Account and Contract are configured for this File Request Type and legacy system wants to upload data only for Account using the same File Request Type, then Validate Service flag should be False. Used to specify external system for a file request type. This is an info field. Flag used to optimize performance. If True 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. 5. Enter details in respective fields. 10 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

17 Figure 6: Defining File Request Type Parameters Copyright 2018, Oracle and/or its affiliates. All rights reserved. 11

18 2.1.2 Defining Services for File Request Type The Services section within the File Request Type zone allows you to define services to be executed for this corresponding File Request Type. For every File Request Type you should have: At least service mapping defined in the application. To define service for a file request type: 1. From the Admin menu, select F and then click File Request Type. 2. Select Add from the options. Tip: You can also define file request type from File Request Type zone. To define file request type, navigate using Admin > F > File Request Type > Search. Click Add ( 3. The File Request Type zone appears. ) button on File Request Type zone. 4. Ensure that the Services section is expanded when you are defining, editing, or copying a file request type. The Services section consists of following fields: Field Name Mandatory (Yes or ) Sequence Service Type Service Name FK Reference Pre- Processing Algorithm Operation Dependent Service Name Used to define sequence of service invocation and execution. Used to define the type of service. The valid values are: Business Object (BO) Business Service (BS) Service Script (SS) Used to specify the name of the service to be invoked and executed for every record processing. Used to navigate to corresponding UI, to check the created or updated details. Used to specify algorithm to be used for pre-processing the execution of corresponding service. For example, this can be used to update the XML payload with more elements or override the operation based on the condition or skip this service execution. Used to define the operation to be performed for the individual Service (Business Object). The valid operations are: Add Update Replace Delete Used to address Payload nesting level and dependent service execution. This signifies parent-child relationship. Yes Yes Yes 12 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

19 Defer Completion Flag used to defer the completion of successfully processed request and the final status will be updated once corresponding BO Life cycle is completed. te: An API is provided to update the final status of the respective request. te: One or more services can be configured. Service can be child of other service. Service with no interdependency can also be configured. Moreover, it is typical for child service to be linked to primary service in a File Request Type; it is also possible to link child services as child objects to other child services. This allows hierarchies of objects to be modeled in a File Request Type. 5. Enter sequence number in Sequence field. 6. Select service type from the Service Type drop-down list. 7. Select the service name by clicking on the Search ( ) icon in the Service Name column. 8. Click on the Search ( ) icon in the FK Reference Code and Pre Processing Algorithm field, to search for the predefined values for the respective columns. 9. Define the operation mode to be performed from the Operation drop-down list. 10. You can also specify a child of other service. This can be done using Dependent Service Name. 11. You can also chose to defer the completion of successfully processed request by selecting the Defer Completion checkbox. Tip: You can configure more than one service for a file request type. Click Add ( to Sequence field. To remove a service from the file request type, click Delete ( that service. ) icon corresponding ) icon corresponding to Figure 7: Defining Services Defining Messages for File Request Type The Messages section allows you to update the error file record status with reference to the configured messages. You can configure multiple messages with either Retry or Sent for Approval status. If record processing fails in return with the configured error message then it will be updated with its corresponding status. Else, the file record will be updated with Error status. To define messages for a file request type: Figure 8: Defining Messages 1. From the Admin menu, select F and then click File Request Type. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 13

20 2. Select Add from the options. Tip: You can also define file request type from File Request Type zone. To define file request type, navigate using Admin > F > File Request Type > Search. Click Add ( Request Type zone. 3. The File Request Type zone appears. ) button on File 4. Ensure that the Messages section is expanded when you are defining, editing, or copying a file request type. The Messages section consists of following fields: Field Name Mandatory (Yes or ) Message Category Used to specify message category. Yes Message Number Message Text Used to specify number to handle Retry or Sent for Approval status. Used to indicate description of message. This is read-only field. Record Status Used to specify status for every file record. Yes 5. Select the Message Category and Message Number by clicking on the Search ( ) icon corresponding to the respective field names. 6. When you specify the Message Category and Message Number, the message description corresponding to the message number appears in the Message Text field. Yes Tip: You can configure more than one messages for a file request type. Click Add ( ) icon corresponding to Message Category field. To remove a message from the file request type, click Delete ( corresponding to that service. ) icon 14 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

21 2.1.4 Defining Transformation Details for File Request Type The Transformation Details section allows you to define the configuration for transforming file requests. It is required for transformation of each individual file record into required XML format that is in compliance with ORMB service schema. To define a transformation details, you must ensure File Transformation Required flag is checked in Main section. Figure 9: Defining Transformation To define transformation details for a file request type: 1. From the Admin menu, select F and then click File Request Type. 2. Select Add from the options. Tip: You can also define file request type from File Request Type zone. To define file request type, navigate using Admin > F > File Request Type > Search. Click Add ( 3. The File Request Type zone appears. ) button on File Request Type zone. 4. Ensure that the Transformation section is expanded when you are defining, editing, or copying a file request type. The Transformation section consists of following fields: Copyright 2018, Oracle and/or its affiliates. All rights reserved. 15

22 Field Name Mandatory (Yes or ) File Segment Type Sequence Used to define the file segment type. The valid values are: Field Detail File Footer File Header Used to map field values in CSV or PSV format files. The sequence number will be proportionate to the fields in a file. Yes Yes Comments This field value signifies the record type whether its file header or footer or a record to be processed. For example, if a CSV file has a record details such as ZZBBSS1,CA,94701,true,Redwood Shores,USA,California There are seven commaseparated field values in this record. It refers that sequence numbers from one to seven can be configured. te: You can map or configure same sequence number to multiple fields (Number of fields can refer to same field value provided in an individual record). Sequence Number ZERO: 0 is reserved for capturing default values. Field Name Map XPath Field Used to define unique field name, which will have the mapped file sequence field value. Used to specify syntax in an XPath expression referencing elements in the instructions referenced business objects. Start Position Used to indicate the starting position from where you want to transform the characters from the file. Yes A map with these configured Field Names and the corresponding Field Values is provided as an input to transformation algorithm. te: This is required if ORMB provided File Request Transformation sample algorithm is to be used. te: This is required if you have selected Fixed Position as file format type. 16 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

23 Field Name Mandatory (Yes or ) End Position Used to indicate the ending position in a file. Comments te: This is required if you have selected Fixed Position as file format type. Record Identifier Default Value Flag used for checking duplicate entries of a file record before uploading in ORMB system. Used to set the default values while formation of record payload. Yes (Conditional) te: This is required when Sequence Number is ZERO: 0. Sequence Number ZERO: 0 is reserved for capturing default values. 5. Select file segment type details from the File Segment Type drop-down list. 6. Enter sequence, field name in respective fields: Sequence, Field Name. This will also be used to get the file record identifiers field values and display those details on File Record Identifier Details zone in File Record Detail dashboard. You can set default values to Date field using Date picker or using below listed predefined date constants: :BUS_DATE for Business Date time - This will be process date time. :SYSDATE for System date time - This will be System Date Time. :STD_DATE for Standard date time - This will be LOCALE date time. 7. Enter syntax in an XPath expression in Map Field XPath field. You can use the Search ( ) icon to search for file request transform map field zone. 8. Select Record Identifier check box, if required. Tip: When you select Fixed Position as File Format, you can also specify Start Positon and End Position values. Tip: You can configure more than one transformation details for a file request type. Click Add ( ) icon corresponding to File Segment Type field. To remove a message from the file request type, click Delete ( ) icon corresponding to that service. 9. Click on Save to complete the process of defining a new file request type. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 17

24 2.2 Searching a File Request Type The Search zone allows you to search for file request types that are already defined in the system. To search a file request: 1. From the Admin menu, select F and then click File Request Type. 2. Select Search from the options. The Search File Request Type zone appears. te: By default, you will see all defined file request types. 3. The Search File Request Type section contains the following fields: Field Name File Request Type Allows you search file request by name. Allows you to search file request by its description. 4. Enter the file request name in File Request Type field or the description of file request type in field. 5. Click Search. The search results which match specified search criteria appear in File Request Type Search List zone. 18 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

25 2.3 Viewing Details of a File Request The File Request Type List helps you to view file requests already defined in the system. This zone allows you to edit, delete, and copy a file request type. To view the details of a file request: 1. From the Admin menu, select F and then click File Request Type. 2. Select Search from the options. The Search File Request Type zone appears. te: By default, you will see all defined file request types. 3. The File Request Type Search List zone contains the following columns: Column Name File Request Type Edit Delete Used to display the name of file request type. Used to display the description of file request type. Used to edit the details of the file request type. Used to delete a file request type. te: You can delete a File Request Type only when you have not created a file record using the File Request Type. Duplicate Used to define a new file request type using an existing file request type schema. Figure 10: File Request Type List 4. Click Broadcast ( ) icon corresponding to the file request type whose details you want to view. 5. This zone contains the following sections: Main - Used to specify basic configuration details about file requests. Service(s) - Used to define services to be executed for the file records with corresponding file requests. Message(s) - Used to define messages for file requests. Transformation Details Used to define configuration for transforming file requests. Record Actions Displays buttons to edit, delete and duplicate file request type. Record Information - Displays name and creation date, time of Business Object. Main - This section provides basic information about the File Request Type. It contains the following fields: Copyright 2018, Oracle and/or its affiliates. All rights reserved. 19

26 Field Name File Request Type File Transformation Required File Atomicity File Format File Extension File Upload and Process Root XML Tag File Required Header Header XML Tag File Required Footer XML Tag Service Required Skip Duplicates Footer Log File Validation Algorithm Record Transformation Algorithm Error Record Maximum Retry Validate Payload External System Record Record Size Greater than 32KB Used to indicate name of the file request type. Used to indicate description of file request type. Used to indicate whether the file record is transformed to ORMB conform service schema. Used to indicate whether file atomicity flag is True or False. Used to indicate the file formats supported for file transformation. Used to indicate extension of files picked from SFTP server for upload and process batch execution. Used to indicate whether file records are uploaded and processed in a single batch using File Transform and Upload (C1-FTRAN) batch. Used to indicate the name of root tag being used in XML. Used to indicate whether file has header details. Used to indicate name of the header tag element of a file in XML format. Used to indicate whether file has footer details. Used to indicate the name of footer tag being used in XML. Used to indicate if processing details are captured for individual records. Used to indicate whether execution of multiple records in a single file is skipped. Used to indicate algorithm called to validate file header, footer and checksum. Used to indicate algorithm called to transform uploaded file to the required ORMB compliance service schema. Used to indicate the number of maximum retry attempts allowed for any failed record. Used to indicate whether the records having payloads for all those configured services of File Request Type are processed. Used to indicate external system for a file request type. This is an info field. Used to indicate whether REQUEST field with CLOB data type is used to capture file record payload. Service(s) - This section defines services for the file request type. It contains the following fields: 20 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

27 Field Name Sequence Service Type Service Name FK Reference Pre-Processing Algorithm Operation Dependent Service Name Defer Completion Used to indicate the sequence number of service invocation and execution. Used to indicate the type of service. Used to Indicate the name of the service invoked and executed for every record processing. Used to indicate the foreign key reference which specifies the created upload request type. Used to indicate algorithm called during pre-processing and execution of corresponding service. Used to indicate the operation performed for the individual Service (Business Object). Used to indicate the Payload nesting level and dependent service execution. This signifies parent-child relationship. Flag used to defer the completion of successfully processed record and the final status will be updated once corresponding BO Life cycle is completed. te: An API is provided to update the final status of the respective request. Message(s) - This section defines messages for the file request type. It contains the following fields: Field Name Message Category Message Number Message Text Record Status Used to indicate the message category. Used to indicate message number to handle Retry or Sent for Approval status. Used to indicate the description of message. This is read-only field. Used to indicate the status of every failed file record. Transformation Details This section defines configuration for transforming file requests. It contains the following fields: Field Name File Segment Type Sequence Field Name Map Field XPath Record Identifier Default Value Used to define the file segment type. Used to define sequence of service invocation and execution. Used to indicate field name specific to Payment stage upload and Transaction business services file request transformation Used to specify syntax in an XPath expression referencing elements in the instructions referenced business objects. Flag used for checking duplicates entries of a file record before uploading in ORMB system. Used to indicate default value for Sequence. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 21

28 Record Actions - Displays buttons to edit, delete and duplicate. The table below describes the different buttons: Button Name Edit Delete Used to edit the details of the file request type. Used to delete the file request type. te: You can delete a File Request Type only when you have not uploaded a file in ORMB system using this File Request Type. Duplicate Used to create a new file request type using an existing File Request Type entity. Record Information - Displays name and creation date, time of Business Object. This section contains the following fields: Field Name Business Object Create Date/Time Used to indicate the business object using which the File Request Type is created. Tip: A context menu appears corresponding to this field which helps in navigating to other screens in the application. Click on the link to view the associated Business Object of the file request type. Used to indicate the date and time when the file request type was created. By default, the File Request Type zone does not appear in the File Request Type screen. It appears only when you click Broadcast ( List zone. ) icon corresponding to a File Request Type in the File Request Type 22 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

29 2.4 Editing a File Request Type To edit a file request type, you should have: File Upload Interface configuration business objects defined in the application. To edit a file request type: 1. From the Admin menu, select F and then click File Request Type. Select Search from the options. te: By default, you will see all defined file request types. You can search a specific file request type which you want to edit. 2. In the File Request Type Search List zone, click Edit ( ) icon in the Edit column corresponding to the File Request Type whose details you want to edit. Tip: Alternatively, you can click Broadcast ( ) icon in the Search zone corresponding to the File Request Type whose details you want to edit. The File Request Type zone appears. Click on Edit button in the Record Actions section. 3. The File Request Type zone appears. It contains the following sections: Main - Used to specify basic configuration details about the file request type. This section contains the following fields: Field Name Mandatory (Yes or ) File Request Type File Required Transformation Used to define name of the file request type. Used to define description of file request type. Flag used to transform uploaded file to XML. te: This is required if the file record is to be transformed to ORMB conform service schema. Yes Yes File Atomicity File Format Flag used to commit or rollback all transactions for any single failure. Used to define the file formats supported for file transformation. The valid formats are: CSV XML Fixed Position JSON PSV Tilde Separated Values Yes (if File Transformation Required check box is selected.) te: By default, the File Format selected is XML. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 23

30 Field Name Mandatory (Yes or ) File Extension File Upload and Process Used to specify file extensions which will be picked from SFTP server for upload and process batch execution. Flag used to upload and process file records in a single batch using File Transform and Upload (C1-FTRAN) batch. te: If flag is True, it is not required to execute File Request Process (C1-FREQP) batch. Root XML Tag File Header Required Header XML Tag File Footer Required Footer XML Tag Used to indicate the name of root tag being used in XML. Flag used to specify whether file will have header details. te: If True, then first row data will be passed as header string to File Validation Algorithm. Used to indicate name of the header tag element of a file in XML format. This will be used to get the header element block from the corresponding XML file. Flag used to specify whether file will have footer details. te: If True, then last row data will be passed as header string to File Validation Algorithm. Used to indicate the name of footer tag being used in XML. This will be used to get the footer element block from the corresponding XML file. Yes (Conditional) te: This field is required when file format is XML and File Transformation Required flag is True. Yes (Conditional) te: This is required when file format is XML and File Header Required flag is True and File Transformation Required flag is True. Yes (Conditional) te: This field is required when file format is XML and File Footer Required flag is True and File Transformation Required flag is True. 24 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

31 Field Name Mandatory (Yes or ) Service Log Required Skip Duplicates File Validation Algorithm Flag used to validate if processing details need to be captured for individual records. The same details will be used on File Request dashboard for navigating to its created or updated corresponding entity. Flag used to skip execution of multiple records in a single file. Multiple entries in a file are identified using Record Identifier configured in Transformation Details section. Used to indicate algorithm used for file header, footer and checksum validation. Yes (Conditional) te: This is required when either File Header Required or File Footer Required flags in File Request Type or Validate Checksum flag in File Upload Interface Master Configuration is True. Record Algorithm Transformation Used to indicate algorithm called to transform uploaded file to the required ORMB compliance service schema. Yes (Conditional) te: This is required when File Transformation Required flag is True. Error Record Maximum Retry Validate Record Payload External System Used to define the number of maximum retry attempts allowed for any failed record. te: The value should be greater than 0. Flag used to process only those records having payloads for all those configured services of File Request Type. For example, If services for Person, Account and Contract are configured for this File Request Type and legacy system wants to upload data only for Account using the same File Request Type, then Validate Service flag should be False. Used to specify external system for a file request type. This is an info field. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 25

32 Field Name Mandatory (Yes or ) Record Size Greater than 32KB Flag used to optimize performance. If True 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. Services - Used to define services to be executed for the file records with corresponding file request type. This section contains the following fields: Field Name Mandatory (Yes or ) Sequence Service Type Service Name FK Reference Pre-Processing Algorithm Operation Dependent Service Name Used to define sequence of service invocation and execution. Used to define the type of service. The valid values are: Business Object (BO) Business Service (BS) Service Script (SS) Used to specify the name of the service to be invoked and executed for every record processing. Used to navigate to corresponding UI, to check the created or updated details. Used to specify algorithm to be used for pre-processing the execution of corresponding service. For example, this can be used to update the XML payload with more elements or override the operation based on the condition or skip this service execution. Used to define the operation to be performed for the individual Service (Business Object). The valid operations are: Add Update Replace Delete Used to address Payload nesting level and dependent service execution. This signifies parent-child relationship. Yes Yes Yes 26 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

33 Field Name Mandatory (Yes or ) Defer Completion Flag used to defer the completion of successfully processed request and the final status will be updated once corresponding BO Life cycle is completed. te: An API is provided to update the final status of the respective request. te: One or more services can be configured. Service can be child of other service. Service with no interdependency can also be configured. Moreover it is typical for child service to be linked to primary service in a file request type; it is also possible to link child services as child objects to other child services. This allows hierarchies of objects to be modeled in a file request type. Messages - Used to define messages for the file request type. This section contains the following fields: Field Name Mandatory (Yes or ) Message Category Message Number Message Text Used to specify message category. Used to specify number to handle Retry or Sent for Approval status. Used to indicate description of message. This is readonly field. Status Used to specify status for every file record. Yes Transformation Details Used to define configuration for transforming file requests. This section contains the following fields: Field Name Mandatory (Yes or ) File Type Segment Used to define the file segment type. The valid values are: Field Detail File Footer File Header Yes Yes Yes Comments Copyright 2018, Oracle and/or its affiliates. All rights reserved. 27

34 Field Name Mandatory (Yes or ) Sequence Used to map field values in CSV or PSV format files. The sequence number will be proportionate to the fields in a file. Yes Comments For example, if a CSV file has a record details such as ZZBBSS1,CA,94701,true,Redwood Shores,USA,California There are seven commaseparated field values in this record. It refers that sequence numbers from one to seven can be configured. te: You can map or configure same sequence number to multiple fields (Number of fields can refer to same field value provided in an individual record). Sequence Number ZERO: 0 is reserved for capturing default values. Field Name Used to define unique field name, which will have the mapped file sequence field value. Yes A map with these configured Field Names and the corresponding Field Values is provided as an input to transformation algorithm. Map Field XPath Used to specify syntax in an XPath expression referencing elements in the instructions referenced business objects. te: This is required if ORMB provided File Request Transformation sample algorithm is to be used. Record Identifier Flag used for checking duplicates entries of a file record before uploading in ORMB system. This will also be used to get the file record identifiers field values and display those details on File Record Identifier Details zone in File Record Detail dashboard. 28 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

35 Field Name Mandatory (Yes or ) Default Value Used to set the default values while formation of record payload. 4. Modify the required fields. Yes (Conditional) te: This is required when Sequence Number is ZERO: 0. Sequence Number ZERO: 0 is reserved for capturing default values. Comments You can set default values to Date field using Date picker or using below listed predefined date constants: :BUS_DATE for Business Date time - This will be process date time :SYSDATE for System date time - This will be System Date Time :STD_DATE for Standard date time - This will be LOCALE date time. te: If you want to define more than one message or service or transformation details for a file request type, click Add ( ) icon in the respective sections. Similarly, if you want to delete a message or service or transformation details, click Delete ( ) icon in the respective sections. 5. Click Save. The changes made to the file request type are saved. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 29

36 2.5 Copying a File Request Type Instead of creating a new file request type, you can use an existing file request type to create a new File Request Type. This is possible by copying a file request type. On copying a file request type, all the details including the service are copied to the new file request type. You can also edit the respective details. To copy a File Request Type: 1. From the Admin menu, select F and then click File Request Type. Select Search from the options. te: By default, you will see all defined file request types. You can search a specific file request type which you want to duplicate. 2. In the File Request Type List zone, click Duplicate ( ) icon in the Duplicate column corresponding to the File Request Type to be copied. Tip: Alternatively, you can click Broadcast ( ) 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. 3. The File Request Type zone appears. It contains the following sections: Main - Used to specify basic configuration details about file requests. This section contains the following fields: Field Name Mandatory (Yes or ) File Request Type Used to define name of the file request type. Yes File Transformation Required Used to define description of file request type. Flag used to transform uploaded file to XML. te: This is required if the file record is to be transformed to ORMB conform service schema. Yes File Atomicity Flag used to commit or rollback all transactions for any single failure. File Format File Extension Used to define the file formats supported for file transformation. The valid formats are: CSV XML Fixed Position JSON PSV Tilde Separated Values Used to specify file extensions which will be picked from SFTP server for upload and process batch execution. Yes (if File Transformation Required check box is selected.) te: By default, the File Format selected is XML. 30 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

37 Field Name Mandatory (Yes or ) File Upload and Process Flag used to upload and process file records in a single batch using File Transform and Upload (C1-FTRAN) batch. te: If flag is True, it is not required to execute File Request Process (C1-FREQP) batch. Root XML Tag File Header Required Header XML Tag File Footer Required Footer XML Tag Used to indicate the name of root tag being used in XML. Flag used to specify whether file will have header details. te: If True, then first row data will be passed as header string to File Validation Algorithm. Used to indicate name of the header tag element of a file in XML format. This will be used to get the header element block from the corresponding XML file. Flag used to specify whether file will have footer details. te: If True, then last row data will be passed as header string to File Validation Algorithm. Used to indicate the name of footer tag being used in XML. This will be used to get the footer element block from the corresponding XML file. Yes (Conditional) te: This field is required when file format is XML and File Transformation Required flag is True. Yes (Conditional) te: This is required when file format is XML and File Header Required flag is True and File Transformation Required flag is True. Yes (Conditional) te: This field is required when file format is XML and File Footer Required flag is True and File Transformation Required flag is True. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 31

38 Field Name Mandatory (Yes or ) Service Log Required Skip Duplicates File Algorithm Validation Flag used to validate if processing details need to be captured for individual records. The same details will be used on File Request dashboard for navigating to its created or updated corresponding entity. Flag used to skip execution of multiple records in a single file. Multiple entries in a file are identified using Record Identifier configured in Transformation Details section. Used to indicate algorithm used for file header, footer and checksum validation. Yes (Conditional) te: This is required when either File Header Required or File Footer Required flags in File Request Type or Validate Checksum flag in File Upload Interface Master Configuration is True. Record Transformation Algorithm Error Record Maximum Retry Validate Payload External System Record Used to indicate algorithm called to transform uploaded file to the required ORMB compliance service schema. Used to define the number of maximum retry attempts allowed for any failed record. te: The value should be greater than 0. Flag used to process only those records having payloads for all those configured services of File Request Type. For example, If services for Person, Account and Contract are configured for this File Request Type and legacy system wants to upload data only for Account using the same File Request Type, then Validate Service flag should be False. Used to specify external system for a file request type. This is an info field. Yes (Conditional) te: This is required when File Transformation Required flag is True. 32 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

39 Field Name Mandatory (Yes or ) Record Size Greater than 32KB Flag used to optimize performance. If True 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. Services - Used to define services to be executed for file requests. This section contains the following fields: Field Name Mandatory (Yes or ) Sequence Used to define sequence of service invocation and execution. Yes Service Type Service Name FK Reference Pre- Processing Algorithm Operation Dependent Service Name Defer Completion Used to define the type of service. The valid values are: Business Object (BO) Business Service (BS) Service Script (SS) Used to specify the name of the service to be invoked and executed for every record processing. Used to navigate to corresponding UI, to check the created or updated details. Used to specify algorithm to be used for pre-processing the execution of corresponding service. For example, this can be used to update the XML payload with more elements or override the operation based on the condition or skip this service execution. Used to define the operation to be performed for the individual Service (Business Object). The valid operations are: Add Update Replace Delete Used to address Payload nesting level and dependent service execution. This signifies parent-child relationship. Flag used to defer the completion of successfully processed request and the final status will be updated once corresponding BO Life cycle is completed. te: An API is provided to update the final status of the respective request. Yes Yes Copyright 2018, Oracle and/or its affiliates. All rights reserved. 33

40 te: One or more services can be configured. Service can be child of other service. Service with no interdependency can also be configured. Moreover it is typical for child service to be linked to primary service in a file request type; it is also possible to link child services as child objects to other child services. This allows hierarchies of objects to be modeled in a file request type. Messages - Used to define messages for file requests. This section contains the following fields: Field Name Mandatory (Yes or ) Message Category Message Number Message Text Used to specify message category. Used to specify number to handle Retry or Sent for Approval status. Used to indicate description of message. This is readonly field. Record Status Used to specify status for every file record. Yes Transformation Details - Used to define configuration for transforming for file requests. This section contains the following fields: Field Name Mandatory (Yes or ) File Segment Type Used to define the file segment type. The valid values are: Field Detail File Footer File Header Yes Yes Yes Comments 34 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

41 Field Name Mandatory (Yes or ) Sequence Used to map field values in CSV or PSV format files. The sequence number will be proportionate to the fields in a file. Yes Comments For example, if a CSV file has a record details such as ZZBBSS1,CA,94701,true,Redwood Shores,USA,California There are seven commaseparated field values in this record. It refers that sequence numbers from one to seven can be configured. te: You can map or configure same sequence number to multiple fields (Number of fields can refer to same field value provided in an individual record). Sequence Number ZERO: 0 is reserved for capturing default values. Field Name Used to define unique field name, which will have the mapped file sequence field value. Yes A map with these configured Field Names and the corresponding Field Values is provided as an input to transformation algorithm. Map XPath Field Used to specify syntax in an XPath expression referencing elements in the instructions referenced business objects. te: This is required if ORMB provided File Request Transformation sample algorithm is to be used. Record Identifier Flag used for checking duplicate entries of a file record before uploading in ORMB system. This will also be used to get the file record identifiers field values and display those details on File Record Identifier Details zone in File Record Detail dashboard. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 35

42 Field Name Mandatory (Yes or ) Comments Default Value Used to set the default values while formation of record payload. Yes (Conditional) te: This is required when Sequence Number is ZERO: 0. Sequence Number ZERO: 0 is reserved for capturing default values. You can set default values to Date field using Date picker or using below listed predefined date constants: :BUS_DATE for Business Date time - This will be process date time. :SYSDATE for System date time - This will be System Date Time. :STD_DATE for Standard date time - This will be LOCALE date time. 4. Modify the required fields. 5. Click Save. The changes made to the file request type are saved. te: If you want to define more than one message or service or transformation details for a file request type, click Add ( ) icon in the respective sections. Similarly, if you want to delete a message or service or transformation details, click Delete ( ) icon in the respective sections. 36 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

43 2.6 Deleting a File Request Type To delete a File Request Type: 1. From the Admin menu, select F and then click File Request Type. Select Search from the options. te: By default, you will see all defined file request types. You can search a specific file request type which you want to delete. 2. Click Delete ( ) icon in the Delete column corresponding to the file request type. A message appears confirming whether you want to delete the File Request Type. Tip: Alternatively, you can use the Broadcast ( ) icon in the Search zone corresponding to the File Request Type which you want to delete. The File Request Type zone appears. Click on Delete button in the Record Actions section. te: You can delete a file request type only when you have not uploaded a file in ORMB system using this File Request Type. Here, uploading a file relates to creating a file request. 3. Click OK. The file request type is deleted. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 37

44 3. File Upload Dashboard Once you create a file request, you can have an overview of uploaded files in ORMB staging using file upload dashboard. The file upload dashboard allows you to: 1. Search for file details 2. View files as per status 3. Update status of records 4. View File Record Service Details 5. View File Record Identifier Details 6. View File Record Status Transitions 7. View File Record Error Message History To launch File Upload Dashboard: 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. This zone contains the following two sections: Search Criteria - allows you to search for a file request using various search criteria Search Results - allows you to view the search results based on the specified search criteria. 3.1 Searching File Details The Search File Detail zone allows you to search for file detail using various search criteria. To search file details, you need to follow below steps: 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. This zone contains the following fields: Figure 11: Searching File Details Field Name Mandatory (Yes or ) File Name Allows you to search by uploaded or staged file name. Yes File Request Type Allows you to search by file request description. Yes File Status Allows you to search by file request status. The valid values are: Complete Error 38 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

45 Pending Reject External System Allows you to search by external system. File Business From Date File Business To Date File Upload From Date File Upload To Date Allows you to search file details that are uploaded from legacy system on or after a particular date. Allows you to search file details that are uploaded from legacy system on or before a particular date. Allows you to search file details that are uploaded or staged in ORMB system on or after a particular date. Allows you to search file details that are uploaded or staged in ORMB system on or before a particular date. 4. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 5. Select status from the File Status drop-down list. te: Default value for File Status is set to Complete. 6. Click Search. The search results appear based on the specified search criteria. 3.2 Viewing File Details When viewing file details, you have four options while selecting file status. They are: Complete - This status is applied only over those files that are successfully staged. Pending - This status is applied only over those files that hold partially uploaded records. For example, if a file has 10 records and only five records are successfully uploaded with remaining five failing due to some errors. In such scenario, the file status will be considered as Pending. Error - This status is applied only over those files that have records not uploaded due to any failed validations. Reject - This status is applied only over those files for which the File Validation Algorithm fails. You have two modes to view file details based on their respective status: 1. View file details with Complete or Pending status 2. View file details with Error or Reject status Viewing File Details with Complete or Pending Status This section explains how to view file details with complete or pending status. It also explains how to view files based on various status. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 39

46 Viewing Details of a File 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. The Search Results section contains the following columns: Column Name File ID File Name File Request Type Pending Processed Error Retry Ignore Skipped In Progress Retry Limit Exceeded Total Records File Business Date File Upload Date Time Used to display unique auto generated File ID. Used to display name of the uploaded or staged file. Used to display the file request type associated with this record. Used to display number of records in Pending status. Tip: Click the link to view the file record detail. Used to display number of records in Processed status. Tip: Click the link to view the file record detail. Used to display number of records in Error status. Tip: Click the link to view the file record detail. Used to display number of records in Retry status. Tip: Click the link to view the file record detail. Used to display number of records in Ignore status. Tip: Click the link to view the file record detail. Used to display number of records in Skipped status. Tip: Click the link to view the file record detail. Used to display number of records in In Progress status. Tip: Click the link to view the file record detail. Used to display number of records in Retry Limit Exceeded status. Tip: Click the link to view the file record detail. Used to display total number of records in this file. Tip: Click the link to view the file record detail. Used to display the date on which the file record is created. Used to display the date and time when file was uploaded or staged in ORMB system. 40 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

47 Figure 12: Viewing Details of a File Viewing Linked File Request Type 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. Figure 13: Viewing Linked File Request Type 6. Click on the link in File Request Type column. The File Request Type zone appears. 7. This zone contains the configurations of the selected file. The configured values are displayed across following sections: Main - Indicates the basic configuration details of a file request. Services Indicates the defined services for a file request. Messages Indicates the messages for a file request. Transformation Details Indicates the defined configuration to transform file requests. Record Actions Displays buttons to edit, delete and duplicate file request type. Record Information - Displays name and creation date, time of Business Object. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 41

48 Figure 14: Viewing Details of Linked File Request Type 42 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

49 Viewing Files in Pending Status To view the files in Pending status: 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. 4. Tip: You can use the % wildcard character in File Name field. 5. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 6. Click Search. The search results appear based on the specified search criteria. 7. In the Search Results section, click on the link in the Pending column whose details you want to view. te: Each count is hyperlinked to respective status. You need to click on the respective count to view the respective details. In the File Request search results section, you must select a value greater than 0 in the corresponding column, for the results to appear on the File Record Detail screen. 8. The File Record Detail zone appears. It displays following information: Column Name Request Id Record Payload Transformed Payload Retry Count Record Status Record Record Upload Date Time Record Update Date Time Used to display the unique auto generated request id. Used to display the payload used for request processing. Click on the View Payload ( ) icon to view the record payload. Used to display the transformed payload. Click on the View Payload ( ) icon to view the record payload. Used to display number of Retry attempts done. Used to display the record status. Used to display the ORMB system date and time when the records were uploaded. Used to display the date and time of last updated records. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 43

50 Viewing Files in Processed Status To view the files in Processed status: 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. In the Search Results section, click on the link in the Processed column whose details you want to view. te: In the File Record search results section, you must select a value greater than 0 in the Processed column, for the results to appear on the File Record Detail screen. 7. The File Record Detail zone appears. It displays following information: Column Name Request Id Record Payload Transformed Payload Retry Count Record Status Record Record Upload Date Time Record Update Date Time Used to display the unique auto generated request id. Used to display the payload used for request processing. Click on the View Payload ( ) icon to view the record payload. Used to display the transformed payload. Click on the View Payload ( ) icon to view the record payload. Used to display number of Retry attempts done. Used to display the record status. Used to display the ORMB system date and time of uploading records. Used to display the date and time of record updation. Figure 15: Viewing Files in Processed Status 44 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

51 Viewing Files in Error Status To view the files in Error status: 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. In the Search Results section, click on the link in the Error column whose details you want to view. te: Each count is hyperlinked to respective status. You need to click on the respective count to view the respective details. In the File Request search results section, you must select a value greater than 0 in the Error column, for the results to appear on the File Record Detail screen. 7. The File Record Detail zone appears. It displays following information: Column Name Request Id Record Identifier Error Message Retry Count Record Payload Transformed Payload Record Used to display the unique auto generated request id. Flag used for checking duplicates entries of a file record before uploading in ORMB system. Used to display the error message of file request. Used to display number of Retry attempts done. Used to display the payload used for request processing. Click on the View Payload ( ) icon to view the record payload. Used to display the transformed payload. Click on the View Payload ( to view the transformed payload. ) icon Copyright 2018, Oracle and/or its affiliates. All rights reserved. 45

52 Figure 16: Viewing Files in Error Status You also have an option to view details of Error message with respective number of records of the corresponding broadcasted file. This can be done using File Records Error Message(s) List zone. To view error message list: 1. Click on the Broadcast ( ) icon corresponding to File ID column for which you need to view Error list. te: You will see details only for files in Error status. 2. The File Records Error Message(s) List zone appears. This zone contains the following sections: Column Name Message Category Message Number Retry Retry Limit Exceed Error Used to display category of the message. Used to display number to handle Retry or Sent for Approval status. Used to display number of records in Retry status. Tip: Click on count to view all the records with Retry status. Used to display number of records in Retry Limit Exceeded status. Tip: Click on count to view all the records with Retry Limit Exceeded status. Used to display number of records in Error status. Tip: Click on count to view all the records with Error status. 46 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

53 Viewing Files in Retry Status To view the files in Retry status: Figure 17: File Records Error Message(s) List 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. In the Search Results section, click on the link in the Retry column whose details you want to view. te: In the File Record search results section, you must select a value greater than 0 in the Retry column, for the results to appear on the File Record Detail screen. 7. The File Record Detail zone appears. It displays following information: Column Name Request Id Record Identifier Error message Used to display the unique auto generated request id. Flag used for checking duplicates entries of a file record before uploading in ORMB system. Used to display the error message of file request. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 47

54 Retry Count Record Payload Transformed Payload Record Used to display number of Retry attempts done. Used to display the payload used for request processing. Click on the View Payload ( ) icon to view the record payload. Used to display the transformed payload. Click on the View Payload ( ) icon to view the record payload. 8. Click on the Broadcast ( ) icon corresponding to Request Id column to view File Record Error Message History for that record Viewing Files in Skipped Status To view the files in Skipped status: 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. In the Search Results section, click on the link in the Skipped column whose details you want to view. te: Each count is hyperlinked to respective status. You need to click on the respective count to view the respective details. In the File Request search results section, you must select a value greater than 0 in the Skipped column, for the results to appear on the File Record Detail screen. 7. The File Record Detail zone appears. It displays following information: Column Name Request Id Record Payload Transformed Payload Retry Count Record Status Record Record Upload Date Time Used to indicate the unique auto generated request id. Used to display the payload used for request processing. Click on the View Payload ( ) icon to view the record payload. Used to display the transformed payload. Click on the View Payload ( ) icon to view the record payload. Used to indicate number of Retry attempts done. Used to indicate the status of the record. Used to display the ORMB system date and time of uploading records. 48 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

55 Record Update Date Time Used to display the date and time of record updation. Figure 18: Viewing Files in Skipped Status 8. Click Broadcast ( ) icon corresponding to Request Id to view service execution details, record identifier details, status transition and error message history details for that record Viewing Files in In Progress Status To view the file requests in the Progress status: 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. In the Search Results section, click on the link in the In Progress column corresponding to the File ID whose details you want to view. 7. The File Request Detail zone appears. It displays the selected Request ID with the status as In Progress in the Status column. te: In the File Request search results section, you must select a value greater than 0 in the In Progress column, for the results to appear in the File Request Detail zone. 8. Click Broadcast ( ) icon to view the details in Status Transition zone. This zone displays the Status and Reason along with the Transition Date Time. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 49

56 3.2.2 View Files with Error or Reject Status 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Error or Reject status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. The Search Results section contains the following columns: Column Name File ID File Name File Request Type Error Message File Business Date File Upload Date Time Used to display unique auto generated File ID. Used to display name of the uploaded or staged file. Used to display the file request type associated with this record. Used to display the error message. Used to display the date on which the File Request is created. Used to indicate the date and time when file was uploaded or staged in ORMB system. Figure 19: View Files with Error or Reject Status 50 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

57 3.2.3 Viewing Specific File Record Details This section lists and describes the following tasks you can perform when viewing file record details: 1. View File Record Service Details 2. View File Record Identifier Details 3. View File Record Status Transition Details 4. View File Record Error Message History Details File Record Service Detail The File Record Service Detail zone displays service execution details of the successfully processed records. To view File Record Service Detail: 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. In the Search Results section, click on the link in any of the status columns corresponding to the File ID whose details you want to view. te: In the File Detail search results section, you must select a value greater than 0 in the respective columns, for the results to appear in the Search File Record Detail zone. 7. The Search File Record Detail zone appears. Click Broadcast ( ) icon corresponding to Request Id column. 8. The File Record Service Detail zone appears. This zone contains the following columns: Column Name Sequence Service Name Entity Information Service Payload Service Status Record Used to display sequence of service execution. Used to indicate the name of the invoked service for this record. Used to display entity information for the FK Reference selected in Request Type screen. Used to display the service transformed payload passed to the corresponding service for processing the record. Used to indicate the service level status of that record. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 51

58 File Record Identifier Detail Figure 20: File Record Service Detail The File Record Identifier Detail zone displays the record identifier details of the respective file record. 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. In the Search Results section, click on the link in any of the status columns corresponding to the File ID whose details you want to view. te: In the File Detail search results section, you must select a value greater than 0 in the respective columns, for the results to appear in the Search File Record Detail zone. 7. The Search File Record Detail zone appears. Click Broadcast ( ) icon corresponding to Request Id column. 8. The File Record Identifier Detail zone appears. This zone contains the following columns: Column Name Sequence Field Name Field Value Used to display the order in which the records must be transformed. Used to indicate the field for which you want to define the record identifier. Used to display the field value for the record identifier. Figure 21: File Record Identifier Detail 52 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

59 File Record Status Transition The File Record Status Transition zone displays the status transition details of the respective file record. To view File Record Status Transition: 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. In the Search Results section, click on the link in any of the status columns corresponding to the File ID whose details you want to view. te: In the File Detail search results section, you must select a value greater than 0 in the respective columns, for the results to appear in the Search File Record Detail zone. 7. The Search File Record Detail zone appears. Click Broadcast ( ) icon corresponding to Request Id column. 8. The File Record Status Transition zone appears. This zone contains the following columns: Column Name Transition Time Record Status Status Reason Updated By Date Update Used to display the status transition date and time of a file record. Used to display the status of transitioned records. Used to display the reason of status updation. Used to display the name of the user who has transitioned the corresponding record status. Figure 22: File Record Status Transition Copyright 2018, Oracle and/or its affiliates. All rights reserved. 53

60 File Record Error Message History The File Record Error Message History zone displays the error history details for the respective failed file record. 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. In the Search Results section, click on the link in Error column corresponding to the 7. File ID whose details you want to view. te: In the File Detail search results section, you must select a value greater than 0 in the Error column, for the results to appear in the Search File Record Detail zone. 8. The Search File Record Detail zone appears. Click Broadcast ( ) icon corresponding to Request Id column. 9. The File Record Error Message History zone appears. This zone contains the following fields: Column Name Error Log Date Time Error Message Displays the date and time of file record error log entry. Displays the file record error message. Figure 23: File Record Error Message History 54 Copyright 2018, Oracle and/or its affiliates. All rights reserved.

61 3.3 Updating Record Status You can update file records with Pending or Error or Retry Limit Exceed status to Retry status. To update status, you need to follow below steps: 1. From the main Menu, select Tools and click File Upload Dashboard. 2. The Search File Detail zone appears. 3. Specify file name in File Name or select file request type from the File Request Type list. te that either of File Name or File Request Type filter criteria is mandatory. Tip: You can use the % wildcard character in File Name field. 4. Select Complete or Pending status from the File Status drop-down list. te: Default value for File Status is set to Complete. 5. Click Search. The search results appear based on the specified search criteria. 6. Click on the count present in Pending or Error or Retry Limit Exceed columns in Search Results section. te: Records with only Pending (PEN) or Error (ERR) or Retry Limit Exceed (RTLE) status can be updated. Each status count is hyperlinked to respective detail. You need to click on the respective count to view the respective details. In the File Detail search results section, you must select a value greater than 0 in the corresponding column, for the results to appear in the Search File Record Detail zone. 7. The Search File Record Detail screen appears. Select the Request Id whose status you want to update. Figure 24: Updating Record Status 8. Click Update Record Status button. The File Request Detail Update Reason pop up window appears. Enter a reason. Copyright 2018, Oracle and/or its affiliates. All rights reserved. 55

62 9. Click OK. The record status is updated. Figure 25: File Request Detail Update Reason 56 Copyright 2018, Oracle and/or its affiliates. All rights reserved.