ETIM Taxonomy API Importer

The ETIM Taxonomy API Importer offers an automated solution that replaces the manual, file-based approach for managing ETIM taxonomies. It enables users to integrate ETIM taxonomies in multiple languages and to select specific versions and Article Groups during the import process. Additionally, it supports saving configurations as reusable assets and allows scheduling automatic imports to ensure consistent updates.

This section covers the ETIM Taxonomy API Importer’s functionalities, initial setup, and detailed configuration steps to enable and use the importer effectively.

Prerequisites

The following are prerequisites for setting up the ETIM Taxonomy API Importer:

Before initiating the setup of the ETIM Taxonomy API Importer, ensure that the following credentials are readily available:

Username and password for accessing the ETIM API server: These must be manually requested from the ETIM International office.

Initial Setup

Setting up the ETIM Taxonomy API Importer is a straightforward process that utilizes component models for easy implementation. Follow these steps to prepare the system for use:

Enable the required licenses
Update / enable the configuration properties
Run easy setup of Import Flow Process
Run easy setup of ETIM Model
Prepare the ETIM API language - dimension Mapping
Configure Web UI for Monitoring the Import Process

The steps outlined above are detailed in the following sections:

Enable the required licenses

The ETIM Industry Standards Package commercial license must be enabled on your system to use this functionality. Contact Stibo Systems to begin the process of enabling a license or licenses for your system.

Contact Stibo Systems to begin the process of enabling the license or licenses for your system.

Update configuration properties to set up integration between STEP and ETIM servers

The integration between STEP and the ETIM server uses service principal method of authentication, allowing STEP to log in to the ETIM service on behalf of a user via service principal credentials. The service principal authenticates the application using an application ID and application secret, configured through properties on the STEP application server.

The following properties must be configured in your system to establish the connection between the etim-importer microservice and the ETIM API microservices.

Note: Unlike other generic properties, the ones listed below cannot be configured through the Self-Service UI. They are provided for informational purposes only. To configure them, submit a request through the Stibo Systems Service Portal.

Configure the connection between ETIM server and etim-importer microservice. ETIM servers can be global or local. In either case, the necessary relationships must be established between the ETIM server and etim-importer microservice.

Example 1: The following example shows configuration properties for connecting to a Global ETIM server:
```
ETIM.Importer.Server.Global.BaseUrl=https://etimapi.etim-international.com
ETIM.Importer.Server.Global.AuthUrl=https://etimauth.etim-international.com
ETIM.Importer.Server.Global.ClientId=[UserName]
ETIM.Importer.Server.Global.ClientScope=EtimApi
ETIM.Importer.Server.Global.ClientSecret=[Passkey]
ETIM.Importer.Servers=Global
```
In the above properties, [UserName ] and [Passkey] are credentials required to access the ETIM Global Server. They must be requested from your local ETIM office and provided to Stibo Systems for configuring the above properties.

Example 2: The following example shows configuration properties for connecting to a local ETIM server. In this example, a server in the Netherlands is being used.
```
ETIM.Importer.Server.Nederland.BaseUrl=https://api.ketenstandaard.nl/ETIM
ETIM.Importer.Server.Nederland.AuthUrl=https://authorize.ketenstandaard.nl
ETIM.Importer.Server.Nederland.ClientId=[Local Server UserName]
ETIM.Importer.Server.Nederland.ClientScope=Api ETIM
ETIM.Importer.Server.Nederland.ClientSecret=[Local Server Passkey]
ETIM.Importer.Server.Nederland.GlobalServer=false
ETIM.Importer.Servers=Nederland
```
The properties [Local Server UserName] and [Local Server Passkey] are credentials required to access the ETIM Netherlands Server. These must be requested from your ETIM Dutch office and provided to Stibo Systems for configuration. Additionally, the BaseUrl and AuthUrl should also be obtained from the same local ETIM office. A system can be connected to multiple local servers if needed.

Configure the connection between the STEP server and etim-importer microservice.

StepServices.Auth.ClientId=[STEP Service UserName]
StepServices.Auth.ClientSecret=[STEP Service Passkey]
StepServices.Cluster.External.URL=https://euwe-dev.app.stibosystems.com
StepServices.Rest.Direct.Base.Host=https://euwe-dev.app.stibosystems.com
StepServices.Rest.Request.Timeout=30
ETIM.Importer.DirectCall.Subdomains=etim-importer
ETIM.Importer.DirectCall=true
ETIM.Importer.PathElements=etim-importer

In the above properties, [STEP Service UserName] and [STEP Service Passkey] are credentials for accessing the STEP ETIM Importer microservice and must be requested from Stibo Systems.

Note: Replace https://euwe-dev.app.stibosystems.com with the actual URL of your system.

Changes to the properties outlined above are implemented when the server is restarted.

Run easy setup of Import Flow Process

The Import Flow Process framework is used for importing ETIM files via the ETIM Taxonomy API Importer. This setup only needs to be executed once per system, but it must be completed before using any Easy Setup functions for the ETIM standard.

Incoming ETIM files are modeled as entities in STEP. This setup action creates the necessary entity object types, as well as the attributes that will be available on the objects.

For more information on running easy setup of the Import Flow Process, refer to the Import Flow Process Component Model topic.

Run easy setup of ETIM Model

The ETIM Taxonomy API Importer requires a data model to function. Running the ETIM Model component sets up the necessary data model elements and completes many essential configurations for the importer to operate effectively.

For more information on running easy setup of the ETIM Model, refer to the ETIM Component Model Configuration topic.

Prepare the ETIM API language-dimension mapping

All ETIM data imported via the API is represented by a language code, so it is essential to establish a mapping between ETIM language codes and the language dimension points in the system. STEP allows multiple dimension points to be mapped to each language code, giving users the flexibility to specify which dimension point the data should be imported to.

For more information on how to map ETIM language code to STEP dimension points, refer to the ETIM: Prepare the Language Dimension Mapping topic.

Configure Web UI for monitoring the import process

Configuring the Web UI to monitor the import process is an optional but highly beneficial step. Running the Import Flow Process component model (described above) enables access to specific components and screens in the Web UI, allowing users to easily track and manage the import status.