Defining transactional data interface services of type CSV or Excel

This topic describes the process of creating an interface service with Data Entity = Transactional Data and Interface Type = CSV or Excel

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 CSV or Excel.
    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 name of the data source (File, FTP or Amazon S3) defined in SCP. The definition defined in the data source is used when executing the interface service using a macro.
    Note: If you are manually importing or exporting data using a file interface service, browse the file to be used on your local machine.
    File
    The name of the file to be used for interface service. The files that are displayed are based on the Data Source defined. If the files are not displayed, click plus (+) to add the required file.
    Note: The definition of a File for an interface service type = CSV or EXCEL is used when executing the interface service only using a macro.
    Sheet
    Determines the sheet of the excel file from which the data must be exported or imported.
    Note: This field is displayed only for the interface type EXCEL.
    Field Names in Header Row
    Indicates the content of the first row of the file that is imported or exported. If set to On, these are the possible scenarios:
    • When the file is imported, the first row of the import file contains field labels and can be skipped.
    • When the file is exported, the first row of the export file contains the field headers.
  7. Specify this information in the File Detail tab:
    File Delimiter
    The file delimiter type. Possible options:
    • Comma
    • Tab
    • Pipe
    Note: By default, the value is set to Comma.
    Number Format
    The number format for the values to be validated when importing data to numeric fields in the SCV database. The numeric values are exported based on the defined format.
    Date Format
    The date format to be validated when importing data to the date fields in SCV database. The dates are exported based on this defined format.
    Note: You must specify the Month indicator and Hour indicator in upper case.
  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 Mappings tab. This tab displays the list of transactional data attributes to be mapped between SCP and the external application for the interface service.
  10. Add a new attribute, if required. See, Adding new transactional data attribute.
  11. Click the Import/Export Measures tab. This tab displays the list of Measures to be mapped in the interface.
  12. Add a new Measure, if required. See, Adding new Measure.
    Note: You must specify at least one measure with one transactional data type to be imported or exported.