Defining csv interface services

To define the CSV interface service:

  1. Select Configuration > Common > Interface Services.
  2. Click New.
  3. In the New Interface Service window, specify this information:
    Interface Type
    Specify the interface type. These are the options:
    • Advanced Planning
    • CSV
    • Database
    • EXCEL
    Data Entity
    Select the data entity that must be mapped to the interface. These are the options:
    • Calendar
    • Code List
    • Scenario Value
    • Transactional Data
    Interface Direction
    Select the interface direction for the interface service. These are the options:
    • Import
    • Export
    • Import and Export
    Note: This value for this field is generated based on the Interface Type and Data Entity fields.
    Column per Measure
    If this check box is selected, each measure is displayed in a new column in the interface. You can add new rows and measures with these dimensions, in the Mappings tab:
    • Item
    • Location
    • Calendar Period

    If this check box is cleared, the list of dimensions in the Mappings tab is fixed to five columns with these dimensions:

    • Item
    • Location
    • Calendar Period
    • Measure
    • Value
    Note: You can view this field only if Data Entity is set to Scenario Value, for all the interface types.
  4. Click OK.
  5. On the Interface Service (New) page, specify this information:
    Name
    The name of the interface service.
    Display Name
    Specify the name to be displayed in the application. This is an optional field.
    Module
    The cycle or cycle and module to which the interface service is related.
    System
    If this check box is selected, the interface service is a system record. By default, this check box is disabled.
    Data Source
    The data source used as part of the interface service. This value is based on the type of the Interface Service.
    Files
    Select the file defined for the selected Data Source. The selected file is used when executing the interface service with a macro. When you manually import or export using a file interface service, you are required to select the file that must be used on the client machine.
    Field Names in Header Row
    If this check box is selected, the field names must be included in the header row of the import/ export file.
    Calendar Period Definition
    Indicates if the calendar periods are imported using the bucket start date, end date, or the bucket name defined in the calendar format, for example, FY10 M03, is used These are the options:
    • Bucket Start Date
    • Bucket End Date
    • Bucket Name
    Note: For import, the periods must match the calendar period definition defined in the interface service.

    For export, the periods match the specified name.

    Clear Unchanged Scenario Values
    If this check box is selected, the scenario values that are not modified are cleared.
    Import Behavior
    Specify the method to process the values repeated in the import file. These are the options:
    • Overwrite: Overwrites the repeated keys and the last imported value is considered in the import file.
    • Sum: Adds the scenario values of all the repeated keys in the import file and provides the total value.
    Note: Default value is Overwrite.
    Calendar Level
    Specify the calendar level from which the scenario data is imported.
    Note: This field is displayed only when the Data Entity field is set to Scenario Value and the Interface Direction field is set to Import.

    If the Calendar level is NULL, uses the calendar level to store scenario values for the current scenario on execution.

  6. On the Mappings tab, specify this information:
    Dimension Description
    The description for the dimension that must be mapped. These are the predefined dimensions for all the interface services:
    • Item
    • Location
    • Calendar Period
    • Measure
    • Value
    Note: You can add new dimension records only if the Column per Measure check box is selected.
    Attribute
    The attribute name of the selected dimension that must be mapped to the interface service. If the attribute is not specified, the default element name is used.
    Note: This field is applicable for the Data Entity type, Scenario Value, Code List, and for all the interface types.

    You can view this field only if the Column per Measure check box is selected.

    Field Label
    The field label that must be mapped to the specified dimension. This indicates the column number of the selected dimension, in the interface.
    Note: For a dimension, the field label must be unique.

    If the Column per Measure check box is cleared, you cannot modify the list of these predefined dimensions:

    • Item
    • Location
    • Calendar Period
    • Measure
    • Value
  7. On the Import/ Export Measures tab, specify this information:
    Measure Code
    The measure code defined for the selected module that must be mapped to the interface service.
    Measure Description
    The description of the measure that must be mapped to the interface service. This value is based on the selected Measure Code.
    Measure Label
    The label for the measure in the interface that must be mapped to the specified measure code. If the name of the measure is similar in the application and also the interface, you can use this tab to limit the number of measures supported by the interface.
    Note: If the Data Entity is set to Scenario Value and Interface Type is set to Import, the Export Constants tab is disabled.
  8. To save the interface service, click Submit. Otherwise, click Cancel.
Related topics