Setup

This section describes the setup of the Aptean Equipment DMS x STIHL interface.

In this chapter, you can find the following sections:

Basic Setup

First, the basic interface setup must be performed. Please proceed as follows:

  • Open the Interface List page in our ERP solution and select the STIHL entry.
  • In the General FastTab:
    • Activate the Interface Log toggle switch to keep a record of all Aptean Equipment DMS x STIHL activities via the Log button in the menu bar.

Tip

If needed, enable automatic clearing of lines on the Interface Log page after a specific time by entering a value in the Delete Log Entries After field.
Example: 90D = all log entries older than 90 days are automatically deleted. Information about entering a time frame can be found here.

  • In the Authorization FastTab:
    • In the Authorization Type field, select the OAuth2 value.
    • In the Authorization Code field, select the STIHL value, and click on the Show details button.
      • The OAuth2 Application Endpoint page for the STIHL value opens.
      • In the OAuth2 Authorization Method field, select the Client Credentials value.
      • In the Client ID and Client Secret fields, enter your STIHL client credentials.
      • Close the OAuth2 Application Endpoint page.
    • In the Scope field, select the STIHL DEALER INV. value.
  • In the Parameters FastTab, enter the following information in the Value field to prepare the interface:
    • APIEndPoint: Defines the STIHL Dealer Inventory endpoint URL.
      Default value: https://ig.stihl.com/api/
    • CleanArchiveEntriesAfter: Defines the date formula for removing archive entries. If you want to keep archived transaction for a longer or shorter period of time, increase or decrease the value, respectively.
      Default value: 2M
    • DealerID: Defines the STIHL Dealer ID.
      This value must be retrieved from STIHL.
    • DMSName: Specifies the DMS name, which will be sent to the endpoint.
      If needed, please agree with your STIHL representative on which DMS name to send from your company.
    • ItemLastInventoryChangeWithinDays: Defines the number of days to look back for inventory changes to be included in the inventory upload for inventory of 0.
      Default value: 7
    • ManufacturerFilter: Defines the manufacturer code. This value is needed to identify STIHL items in your inventory.
      Default value: STIHL

When all requirements are met (green or grey values in the Parameters FastTab), users can enable the interface via the Activate Interface button of the STIHL Interface Card.

Please proceed with the Job Queues Setup section.

Back to parent section

Job Queues Setup

3 job queue entries are created as described in the following subsections:

Back to parent section

STIHL Stock Update Job Queue

This job queue is used to send the current STIHL inventory to STIHL. It is automatically created during the Aptean Equipment DMS x STIHL setup, so it is not necessary to create it manually. When activating the Aptean Equipment DMS x STIHL, a notification is displayed from where the job queue could be opened directly, if necessary. In case the job queue was changed or reset, please follow below instructions to recreate the recommended settings:

Note

STIHL requires to run this job queue at least once a day, preferably between 00:00 and 06:00 o'clock (00:00 and 06:00 AM) at an uneven minute value. It must not run at the same times as the Process STIHL Inventory Changes Job Queue.

  • Open the Job Queue Entries page in our ERP solution using the search (ALT+Q).
  • Click on the New button to create a new job queue entry.
  • In the General FastTab of the Job Queue Entry Card, do the following:
    • In the Object Type to Run field, select the Codeunit value.
    • In the Object ID to Run field, select the 72560293 value.
    • Optional In the Description field, enter a unique job queue description, if needed, e.g., STIHL Stock Update.
    • Optional In the Earliest Start Date/Time field, enter the date and time the job queue should run the next time. If no value is selected, the job queue will run as soon as Status = Ready.
  • In the Recurrence FastTab of the Job Queue Entry Card, do the following:
    • Activate the toggle switches for all weekdays.
    • In the Starting Time field, select a time before the usual business hours, so that the inventory change data can be sent to STIHL before the workday. Make sure to use an uneven minute value for better load distribution.
      Recommended value: 00:01:00 (00:01:00 AM)
    • In the Ending Time field, enter the following value: 06:00:00 (06:00:00 AM)
    • Leave the No. of Minutes between Runs field empty as the job queue should only run once a day.

The job queue entry is finished and has Status = On Hold.

Back to parent section

Process STIHL Inventory Changes Job Queue

This job queue is used to process any STIHL inventory changes. It is automatically created during the Aptean Equipment DMS x STIHL setup, so it is not necessary to create it manually. When activating the Aptean Equipment DMS x STIHL, a notification is displayed from where the job queue could be opened directly, if necessary. In case the job queue was changed or reset, please follow below instructions to recreate the recommended settings:

Note

STIHL requires this job queue to run only during business hours in an hourly interval. It must not run at the same times as the STIHL Stock Update Job Queue.

  • Open the Job Queue Entries page in our ERP solution using the search (ALT+Q).
  • Click on the New button to create a new job queue entry.
  • In the General FastTab of the Job Queue Entry Card, do the following:
    • In the Object Type to Run field, select the Codeunit value.
    • In the Object ID to Run field, select the 72560291 value.
    • Optional In the Description field, enter a unique job queue description, if needed, e.g., STIHL Inventory Change.
    • Optional In the Earliest Start Date/Time field, enter the date and time the job queue should run the next time. If no value is selected, the job queue will run as soon as Status = Ready.
  • In the Recurrence FastTab of the Job Queue Entry Card, do the following:
    • Activate the toggle switches for all weekdays.
    • In the Starting Time field, select the start of the usual business hours, so that the inventory change data can directly be sent to STIHL.
      Recommended value: 07:00:00 (07:00:00 AM).
    • In the Ending Time field, select the end of the usual business hours, so that no inventory change data is sent to STIHL if no changes occur.
      Recommended value: 19:00:00 (07:00:00 PM).
    • In the No. of Minutes between Runs field, enter 60.

The job queue entry is finished and has Status = On Hold.

Back to parent section

STIHL Req. Upload Status Job Queue

This job queue is used to request the upload status of waiting log entries and update the log entry after checking the status. It is automatically created during the Aptean Equipment DMS x STIHL setup, so it is not necessary to create it manually. When activating the Aptean Equipment DMS x STIHL, a notification is displayed from where the job queue could be opened directly, if necessary. In case the job queue was changed or reset, please follow below instructions to recreate the recommended settings:

  • Open the Job Queue Entries page in our ERP solution using the search (ALT+Q).
  • Click on the New button to create a new job queue entry.
  • In the General FastTab of the Job Queue Entry Card, do the following:
    • In the Object Type to Run field, select the Codeunit value.
    • In the Object ID to Run field, select the 72560292 value.
    • Optional In the Description field, enter a unique job queue description, if needed, e.g., STIHL Upload Status Request.
    • Optional In the Earliest Start Date/Time field, enter the date and time the job queue should run the next time. If no value is selected, the job queue will run as soon as Status = Ready.
  • In the Recurrence FastTab of the Job Queue Entry Card, do the following:
    • Activate the toggle switches for all weekdays.
    • In the Starting Time field, select a time before the usual business hours, so that the Aptean Equipment DMS x STIHL data is already up to date when starting.
      Recommended value: 01:00:00 (01:00:00 AM).
    • In the Ending Time field, select a time after the usual business hours, so that no traffic is generated if it is not needed.
      Recommended value: 23:00:00 (11:00:00 PM)
    • In the No. of Minutes between Runs field, enter a value which suits your processes best. We recommend a value between 15 and 30.

The job queue entry is finished and has Status = On Hold.

Back to parent section

Business Partner Setup

It is necessary to map the ERP solution vendor to the actual STIHL company. To set up a business partner, please proceed as follows:

  • Use the quick search (ALT+Q) to find the Business Partners page.
  • Open the STIHL Integration App entry.
  • In the General FastTab:
    • In the Interface Type dropdown menu, select the STIHL Dealer Inv. value.
  • In the menu bar of the Business Partner page, click on the Relations button.
  • In the Business Partner Relations table, proceed as follows:
    • In the Relation Type column, select Vendor.
    • In the Relation No. column, select the vendor number for the STIHL business partner.
    • The Description column is automatically filled and cannot be changed.
    • Repeat these steps for all STIHL business partners.
  • Close the Business Partner Relations table.
  • In the menu bar, click on Activate to activate the integration module.
  • You can close all pages.

Back to parent section