Files Overview

The Files administration functionality allows you to select, transform and upload incoming data sent from an external application and insert it directly into the OIPA database. Following are some of the features available in this functionality:

  • You can filter imported data and activities based on the state of a particular entity or request.
  • You can customize the responses specific to customer implementation.

To create and configure requests and responses, the Files administration functionality has the following two sections:

  • Input
  • Output

Input

You can create input files for each required translation via a caller application. Each file's configuration consists of two sections: the XMLData and XSLT. The XMLData processes the incoming request by assigning values to variables that will be used for processing. The XSLT directs how the data should be transformed and formatted.

State approval records can be added to the database through the File process.

Output

If you want to customize the response, you can create an output file with the name according to the the OutputXSLT attribute in XMLData of the input file, and configure the responses. Each file's configuration has an XSLT section. The XSLT directs how the data in response should be formatted.

High Level Overview of Process

The steps outlined below show the path the files administration functionality takes in order to process a request from an external application.

High Level Overview of File Recieved Web Service

Overview of Files Functionality

  1. External Application sends FileReceived Web Service a request via a SOAP message.

  2. Using the FileID specified in the request, it identifies the input file. The FileID is created in the Rules Palette when a new input file is created.

  3. The XMLData’s AssignAttributes XML gets processed.

  4. The XSLT maps the request XML to AsXml.

  5. The transformed AsXml are mapped to data objects.

  6. PreInsert operations are performed on the objects.

  7. The objects are inserted into the database.

  8. PostInsert operations are performed on the objects.

  9. The transformed AsXml returnes to the caller via a SOAP response.

  10. If required, you can customize the response. To customize the response, do the following:

    1. Add an OutputXSLT attribute with a file name in XMLData of the input file.
      Example: <Attribute NAME="OutputXSLT" TYPE="VALUE">QuoteRequest</Attribute>
    2. Create a file inside Output folder with that name (Example: QuoteRequest).
    3. Check out the XML file from Output folder.
    4. Write XSLT in the text field for the desired response.
    5. Check in the XML file.

How it Works

A SOAP message is sent by the external application to the FileReceived Web Service. The SOAP message includes two OIPA-specific elements: the FileID and the XML element. The FileID element identifies the configuration for OIPA to use when transforming the inbound XML into OIPA’s AsXml. The XML element includes the data to be written to the OIPA database.

Once the SOAP response is received by the FileReceived Web Service, the attributes needed to complete the request are assigned values as configured in XMLData. The data in the XML element is then transformed into AsXml using the configured XSLT. The result of this transformation is then written to the database.

A SOAP response is sent back to the requester, or caller, including the result of the request. If the request was successful, then the response will consist of the transformed AsXml. If the request was not successful, then the message will consist of a SOAP Fault detailing any possible errors. You can create an output file, and configure the XSLT of output file to customize the message.

Important   OIPA adheres to the WS-Security standards for the authentication of SOAP messages. For additional information on SOAP messages and the FileReceived Web Service, refer to the File Received Web Service document available in the current release Documentation Library under Policy Administration Libraries of Oracle Help Center.

AsFileInput Database Table

The AsFileInput database table stores the user-configurable portion of the FileReceived Web Service. The table contains a separate record for each type of file OIPA has been configured to receive. The table includes six columns:

  • FileGUID

  • CompanyGUID

  • FileNameFormat: stores the descriptive name of the file format type

  • FileID: stores a unique three-character ID used to describe the file format

  • XSLT: stores the XSLT used to transform the inbound XML into AsXml

  • XMLData: stores the XML configuration for each specific File business rule

Important   An inbound SOAP message will include a <FileID> element specifying the format of the file being sent.

AsFileOutput Database Table

The AsFileOutput database table stores the user-configurable portion of the FileOutput Web Service. The table contains a separate record for each type of file OIPA has been configured to respond. The table includes tow columns:

  • Name: Name of the Output folder based on the customer requirement

  • XSLT: stores the XSLT used to customize the AsXml output message