Defining transactional data interface services of type Database

This topic describes the process of creating an interface service with Data Entity = Transactional Data and Interface Type = Database.

To create an interface service:

  1. Select Configuration > Common > Interface Services > Interface Services.
  2. Click New. A New Interface Service window is displayed.
  3. Specify this information:
    Interface Type
    The type of the interface. Select Database.
    Data Entity
    The data entity to be mapped to the interface. Select Transactional Data.
    Interface Direction
    The direction of the data flow. Possible values:
    • Import
    • Export
    • Import and Export
  4. Click OK. A new Interface Services page is displayed.
  5. Specify this information on the Interface Details tab:
    Name
    A unique name of the interface service.
    Display Name
    The name that is displayed for the interface service. If not specified, the value specified in the Name field is defaulted.
    Note: This option is enabled for the entity defined by the system
    Interface Type
    The type of the interface. This value is defaulted from the New Interface Service window.
    Data Entity
    The data entity to be mapped to the interface. This value is defaulted from the New Interface Service window.
    Interface Direction
    The direction of the data flow. This value is defaulted from the New Interface Service window.
    Module
    The module in which the interface service is defined.
    System
    Indicates the status of the interface service. Possible values:
    • On (Enabled)
    • Off (Disabled)
  6. Specify this information in the Data Source tab:
    Data Source
    The data source of type Database defined in .
    Source
    Indicates the type of the data source interface. Possible options:
    • Table: If you select this option, Tables and Import Filter fields are displayed.
    • Query: If you select this option, Query field is displayed.
    Note: For Interface Type = Import & Export and Export , the Source is set to Table only.
    Tables
    The database table to which the interface service is applicable.
    Import Filter
    The SQL text to define the filter criteria for the data pass through the interface service from the source table.
    Note: If not defined, all data of the specified source table is applicable.
    Query
    The SQL query (up to 4000 characters) used to retrieve the required data for interface from the specified Data Source.
    Note: You must click Verify to validate the specified query. If the query cannot be resolved, this warning message is displayed:
    The entered interface service Query returned an error. [RDBMS error details].
  7. Click the Import Behaviour tab.
    Note: This tab is displayed only if the Interface Direction field is set to Import or Import and Export.
  8. Specify this information in the Import Behavior tab:
    Clear Destination Table Before Import
    Indicates if the target table must be cleared of all the rows or the data must be appended to the exiting record, before executing the interface and importing rows. Possible scenarios:
    • On: Delete and insert
    • Off: Append
  9. Click the Export Behaviour tab.
    Note: This tab is displayed only if the Interface Direction field is set to Export or Import and Export.
  10. Specify this information in the Export Behavior tab:
    Export Type
    The export behavior for new and existing record/data. Possible values:
    • Insert only: Inserts new rows in the destination table
    • Update Only: Updates the existing row available in the destination table
    • Insert and Update: Both
    Clear Destination Table before Export
    Indicates, if the target table must be cleared of all the rows or the data must be appended to the exiting record, before executing the interface and exporting the rows. Possible scenarios:
    • On: Delete and insert
    • Off: Append
  11. Click the Mappings tab. This tab displays the transactional data attributes to be mapped between and the Data source connection.
  12. Add a new attribute if required. See, Adding new transactional data attribute.
  13. Click the Import/Export Measures tab. This tab displays the list of Measures to be mapped in the interface.
  14. Add a new Measure, if required. See,Adding new Measure.
  15. Click the Export Constants tab. This tab contains a list of attributes from the specified data source, to be mapped a constant value while exporting.
    This tab is displayed only if the Interface Direction field is set to Export or Import and Exports.
  16. Add a new export constant, if required. See, Adding transactional data export constants.
  17. Click Save. The changes to the interface service are applied.