Installation and Configurations

Installation

Go to Extensions → Marketplace → Search for extension ERP Connector → Click the install action in "actions" menu

Extension Installation 1
Figure 1. Install connector
Extension Installation 2
Figure 2. About connector
Extension Installation 3
Figure 3. Changelog
Extension Installation 4
Figure 4. License
Extension Installation 5
Figure 5. Installation
Extension Installation 6
Figure 6. Installation completed
Extension Installation 7
Figure 7. Connector installed

Configurations

User need to configure the properties as per requirement. There is CONNECTION tab from which the user can configure the properties as shown below.

Configure the following properties from Extensions → Settings.

Connection

In this tab, User need to configure 3DEXPERIENCE Agent ID/Secret under 3DEXPERIENCE Agent section.

3DEXPERIENCE Agent
Setting Description Example

3DEXPERIENCE Agent id

3DEXPERIENCE agent id for Extension.

-

3DEXPERIENCE Agent secret

3DEXPERIENCE agent secret for Extension.

-

Security Context

Set the security context which need to be used else default be used.

VPLMProjectLeader.Company Name.Common Space

Regex won’t work with security context. Actual value is to be used.

In this tab, User need to configure base URL for ERP system and connection read/write timeout under ERP section.

ERP
Setting Description Example

ERP Base URL

Base URL to ERP system.

Read/Write timeout in milliseconds

Connection Read/Write timeout in milliseconds

120000

Connection
Figure 8. Connection

Authentication

Create an authentication object to get authenticated by the destination ERP system.

  1. Go to Settings

  2. Select Common Settings

  3. Go to AUTHENTICATION tab

  4. Click on CREATE

  5. Select authentication type and enter the required details

Authentication 1
Figure 9. Create Authentication
Authentication 2
Figure 10. Select Authentication type
Authentication 3
Figure 11. Name, Authentication type and required details
Authentication 4
Figure 12. Authentication created

Destination

Create the destination object using the previously created authentication object to connect with the destination ERP system.

  1. Go to Settings

  2. Select Common Settings

  3. Go to DESTINATION tab

  4. Click on CREATE

  5. Fill the required details on each tab as per requirement

Destination 0
Figure 13. Create Destination
Destination 1
Figure 14. Name and Description
Destination 2
Figure 15. Request URL, type and Authentication setting
Destination 3
Figure 16. Header (if required)
Destination 4
Figure 17. Parameters (if required)
Destination 5

Service

Service corresponds to a job queue. Every event mapping needs to specify to which service it belongs. A service can be configured to run its jobs in sequence OR parallel execution. Either create a single service to handle all the events or create separate services for each event mapping.

Create new Service Group and Service as shown below.

  1. Go to Services

  2. Click on down arrow and click NEW GROUP

  3. Enter the name and submit

  4. New Service group is created

  5. Click on CREATE to create new service

  6. Enter the required details and click CREATE

Service Group
Figure 18. Create service group
Service 1
Figure 19. Create new service
Service 2
Figure 20. Enter service details
Service 3
Figure 21. Create service
For more details about SERVICES please check Service

Event Mapping

Event mapping holds the information about which use-case needs to be executed when the event is received. It is a binding between the event and job-request. Need to enable what events needs to be published from the DS tenant using Event Publishing app.

Example of configured events publishing are as follows.
Engineering item → Created, Status Changed, Versioned, etc…​

DS Event Publishing

Create new EVENT MAPPING as shown below.

  1. Go to MAPPINGS

  2. Select EVENT MAPPINGS tab and click on CREATE

  3. Enter the required details on BASICS, EXECUTION, EVENT tab and click on create.

Event Mappings 1
Figure 22. Create new event mapping
Event Mappings 2
Figure 23. Enter basic mapping details
Event Mappings 3
Figure 24. Enter mapping execution details
Event Mappings 4
Figure 25. Enter event mapping details
For more details please check DS Event Mappings
Service and event mapping need to be configured first if you want to trigger a job on any particular event published by the 3DEXPERIENCE.