Interfaces and Integrations

In TRASER DMS 365, the setup of interfaces is mostly automated, i.e., when opening the Interface List page via the search (ALT+Q), the basic interface values like Interface Type, Description, Provider Code, Group Code, and applicable parameters are all automatically initialized including all their dependencies (except for dealer-specific parameters). This is valid for all new companies.

This chapter has the following subsections:

• 'General' FastTab
  • Interface Log
  • Running Modes
• 'Authorization' FastTab
• 'Parameters' FastTab
• 'Mapping Setup'/'Setup' FastTab
• Activate interfaces

'General' FastTab

The General FastTab holds the basic interface information. The values are set up automatically. The read-only Provider Code and Group Code fields are used to define a specific manufacturer or partner and area (e.g., Trade, Service) to filter the list for a better overview. The values in the Provider Code field are taken from the Interface Providers table which is automatically filled upon interface initialization.

Interface Log

The Interface Log toggle switch can be manually enabled by the dealer to log all interface activities and access further process or import/export file information via the Log button in the menu bar. Corresponding instructions are described in the relevant interface documentation.

Running Modes

The Switch Running Mode button is used to switch the interface and all of its settings between the different test and productive environments, if available. When clicking on this button, users can select which mode to apply. After selecting a different mode, the default parameters of the mode are applied. By default, interfaces are initialized as Productive.

The following modes are available:

• empty: only shown if no mode selection is available
• Test: sets the test environment up with default parameters, if available
• Productive: sets the productive environment up with default parameters
• Individual: only shown if no valid test or productive mode is defined

'Authorization' FastTab

The Authorization FastTab is used to define the authorization options required by the interface or integration to authenticate against the service outside of TRASER DMS 365.

The Authorization FastTab shows fields context-dependent:

• if Authorization Type = empty, no other fields are displayed
• if Authorization Type = Basic, only the Authorization Code field is displayed
• if Authorization Type = OAuth2, the Authorization Code and Scope fields are displayed
  • The Scope field is used to define the interface-specific access parameters. These are automatically set up during initialization.

'Parameters' FastTab

Parameters are used to set up specific options for interface usage. This comprises, for example, specific import or export file definitions, dealer-specific accounts or resources, URLs, currency or language codes, default values, etc. The Instructions field shows corresponding hints for filling the Value field.

Many Value fields in the Parameters FastTab support lookups, so that valid values can be directly selected. Other fields require plain text or numbers which are described in the relevant interface documentation or in the Instructions field.

The Secured Value checkbox is used to set up parameters where the actual value must not be readable by users. If the checkbox is activated, the entered value is replaced by asterisks (*), so that it is not possible to see or reverse engineer it.

The color coding in the Parameters FastTab has the following meaning:

• red font = mandatory dealer-specific parameter has no value yet; interface cannot be fully functional
• green font = mandatory dealer-specific parameter has a value
• black font = optional parameter; potentially required for convenience functionalities, i.e., when a value is filled, the feature described in the Instructions field can be used

'Mapping Setup'/'Setup' FastTab

The mapping setup shows different objects which have to be filled with values first, so that the interface can process any data. Usually, this applies only to dealer-specific objects like resources, items, etc. In most cases, values in the Parameters FastTab rely on a complete mapping setup to leverage the lookup feature via the selection field.

To fill an object with the required data, please proceed as follows:

• Click on the object name in the Name column to open the relevant table.
• Add new lines for all applicable values and fill them correspondingly.

• Close the table, and confirm the Do you want to complete the interface setup for [...]? dialog by clicking on Yes.
  • When clicking on Yes, the Completed checkbox is automatically selected, and the Name value turns from red to green font.
  • When clicking on No, the Name value stays in red font, and the Completed checkbox remains cleared. You can restart the setup again later on, but the interface cannot be activated until the mapping and parameter setup is complete.
• Repeat these steps for all objects which have the Mandatory checkbox selected. Otherwise, the interface or integration cannot be activated! Objects with the Mandatory checkbox cleared are optional.

Activate interfaces

When all requirements are met (only green and/or black values in the Parameters FastTab, and/or only green values in the Mapping Setup FastTab), click on the Activate Interface button in the menu bar. The General > Active toggle switch is enabled.

If any requirement is missing, TRASER DMS 365 will show a dialog with a list of all mandatory parameters or mapping setups which do not yet have a value.

When adding the required value(s) and confirming by clicking on the OK button, the interface is enabled and fully functional. When not adding the required value(s) and confirming by clicking on the OK button, the interface cannot be activated.

Below, please find a list of all interfaces and integrations currently supported by TRASER DMS 365: