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.
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:
Following are the steps for implementing the solution:
The steps outlined above are detailed in the following sections:
Enable the required licenses
The ETIM Taxonomy API Importer is activated by the X.Import.ETIM_API license, while the Import Flow Process Framework requires the X.Importflow license. These licenses enable the necessary system components to access full functionality, and are activated with the ETIM Industry Standards Package commercial license.
Contact Stibo Systems to begin the process of enabling the license or licenses for your system.
Update the configuration properties
The integration between STEP and ETIM server uses the service principal method of authentication, which allows the application (in this case, STEP) to log in to the ETIM service on behalf of the user that is using service principal credentials. The service principal authenticates the application by using an application ID and an application secret and is configured with properties added / enabled on the STEP application server.
Note: For SaaS systems, properties are set within the Self-Service UI by going to the Configuration Properties tab for your system. If the properties you need are not shown, submit an issue within the Stibo Systems Service Portal to complete the configuration.
Changing any property may require a restart of the system for the property to take effect. Changes to the properties, outlined below, are implemented when the server is restarted.
###Properties for configuring the connection between the etim-importer microservice and the ETIM API microservices 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 - 1] ETIM.Importer.Server.Global.ClientScope=EtimApi ETIM.Importer.Server.Global.ClientSecret=[Passkey - 1] ETIM.Importer.Server.Nederland.BaseUrl=https://api.ketenstandaard.nl/ETIM ETIM.Importer.Server.Nederland.AuthUrl=https://authorize.ketenstandaard.nl ETIM.Importer.Server.Nederland.ClientId=[UserName - 2] ETIM.Importer.Server.Nederland.ClientScope=Api ETIM ETIM.Importer.Server.Nederland.ClientSecret=[Passkey - 2] ETIM.Importer.Server.Nederland.GlobalServer=false ETIM.Importer.Servers=Global,Nederland ###Properties for configuring the connection between STEP server and the etimimporter microservice StepServices.Auth.ClientId=[UserName - 3] StepServices.Auth.ClientSecret=[Passkey - 3] 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
The URL https://euwe-dev.app.stibosystems.com in the above property may vary depending on the environment, such as:
-
Development: https://euwe-dev.app.stibosystems.com
-
Preproduction: https://euwe-preprod.app.stibosystems.com
-
Production: https://euwe-prod.app.stibosystems.com
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 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 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 point, 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.