Adding Services in a File Request Type

Prerequisites

To add a service in a file request type, you should have:

  • A Business Service defined in the application.

  • A Business Object defined in the application.

  • A Service Script defined in the application.

Procedure

To define a service in a file request type:

  1. Click the Admin link in the Actions / Navigation area.
    A list appears.
  2. From the Admin menu, select F and then click File Request Type.
    A sub-menu appears.
  3. Click the Add option from the File Request Type sub-menu.
    The File Request Type screen appears.
  4. Enter the appropriate details in the Main section, if required.
  5. Ensure that the Services section is expanded when you are defining, editing, or copying a file request type. The Services section contains the following fields:
    Field Name Field Description Mandatory (Yes or No)
    Sequence Used to specify the sequence of service invocation and execution. Yes
    Service Type Used to indicate the type of service. The valid values are:

    • Business Object

    • Business Service

    • Service Script

    		 Yes
    Service Name Used to specify the name of the service to be invoked and executed for every processing record.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Service Name field. On clicking the search icon, the Schema Type / Schema Name Search window appears.

    		 Yes
    FK Reference Code Used to specify the foreign key reference code from where the added or updated details can be viewed.
    Note:

    The Search (The Search Icon) icon appears corresponding to the FK Reference Code field. On clicking the search icon, the Foreign Key Search window appears.

    		 No
    Pre-Processing Algorithm Used to specify the algorithm that is to be used for pre-processing the execution of the corresponding service.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Pre-Processing Algorithm field. On clicking the search icon, the Algorithm Search window appears.

    		 No
    Post Processing Algorithm Used to specify the algorithm that is to be invoked after successful processing of a record.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Pre-Processing Algorithm field. On clicking the search icon, the Algorithm Search window appears.

    		 No
    Operation Used to indicate the operation to be performed for the individual service (Business Object). The valid values are:

    • Add

    • Update

    • Replace

    • Delete

    		 No
    Dependent Service Name Used to specify the payload nesting level and dependent service execution. This signifies parent-child relationship. No
    Defer Completion Used to indicate the non-completion of successfully processed request where the final status is updated once the corresponding BO life cycle is completed.
    Note: An API is provided to update the final status of the respective request.
    		 No
  6. One or more services can be configured. A service can be a child of other service. A service with no inter-dependency can also be configured. If you want to define more than one service for the file request type, click the Add (The Add Icon) icon and then repeat Step 5.
    Note:

    However, if you want to remove a service from the file request type, click the Delete (The Delete Icon) icon corresponding to that service.

  7. Enter the required details and click Save.
    The services are added in the File Request Type.

Related Topics

For more information on... See...
File Request Type screen File Request Type (Used for Searching)
Search File Request Type zone Search File Request Type
How to add messages in a file request type Adding Messages in a File Request Type