How to use the ERP connector

Custom Design creation and Event Mapping

  • Generate design like Generic and replace the payload module with yours. Associate this custom design with event mapping. For additional information about event mapping, refer to EVENT MAPPING.

Create Action
Figure 1. Create Action
Design Module
Figure 2. Çustom Design Module
Design Module 1
Figure 3. Add items to design
Design Module 2
Figure 4. Select items to add to the design
Design Module 3
Figure 5. Rearrange the added items and connect

  • Add or modify the metadata to the module as per requirement.

MetadataUI 1
Figure 6. Click on wrench icon of the module
MetadataUI 2
Figure 7. configuration side panel

In the metadata side panel, you can configure a custom module as needed.

  • COMMON Tab: Configure the module’s label and description.

  • IN/OUT Tab: Define the module’s inputs and outputs.

  • CALLBACK Tab: Configure the module’s callback.

  • SETTINGS UI Tab: Configure the module’s properties by creating fields. The user can select the field type from the dropdown and provide the required details for field creation.

MetadataUI 3
Figure 8. Metadata side panel (Common tab)
MetadataUI 4
Figure 9. IN/OUT tab
MetadataUI 5
Figure 10. CALLBACK tab
MetadataUI 6
Figure 11. SETTINGS UI (Field type)
MetadataUI 7
Figure 12. SETTINGS UI (Field creation)
For more details about Flow design configurations please check Flow Design Configurations
For more details about Flow api please check JavaScript API for Flow Modules

Custom Payload Module creation

  • Create custom payload module and implement the functionality to generate the required payload.

Create Action
Figure 13. Create Action
PayloadModule
Figure 14. Çustom Payload Module
Payload Module Metadata
Figure 15. Çustom Payload Metadata

Module Configuration

Once the design is ready, the user can configure the module properties for Destination, Payload, Attribute Mapping, and Token Module as required. The configuration options for each module are described in the following sections.

The Module Configuration settings define how modules are set up and interact with external systems. Each tab or configuration area provides specific options for customizing behaviour, managing authentication, mapping attributes, and sending data to external systems.

Destination Module.

The Destination Module receives the payload as input and sends it to the ERP system. The connection to the ERP system can be established using either the Destination URL or the Destination Name.

If the destination system does not support any of the standard authentication methods—API Key, Basic Authentication, Bearer Token, or OAuth2 (Client Credentials) the Token Module must be used in conjunction with the Destination Module. In this case, the Token Module is responsible for fetching the required token, which is then used by the Destination Module to connect with the destination system.

User can configure the module settings as shown below.

Destination Module Properties 1
Figure 16. Open Destination module property form
Destination Module Properties 2
Figure 17. Destination module → Common
Destination Module Properties 3
Figure 18. Destination module → Settings → Destination
Destination Module Properties 4
Figure 19. Destination module → Settings → Request Settings → headers
Destination Module Properties 5
Figure 20. Destination module → Settings → Request Settings → Params

Payload Module

The Payload Module receives the Object ID as input from the Use Case Module and generates the required payload using this Object ID. The generated payload can then be sent to the Attribute Mapping Module to modify the payload according to the configured mappings.

User can configure the module settings as shown below.

Payload Module Properties 1
Figure 21. Open Payload module property form
Payload Module Properties 2
Figure 22. Payload module → Common
Payload Module Properties 3
Figure 23. Payload module → Settings
Payload Module Properties 4
Figure 24. Payload module → Test Data

User can upload the valid payload file to test the use case design.

Supported Formats: The payload can be in any format supported by the destination system, for example, JSON or XML.

Attribute Mapping Module

Attribute mapping module helps the user to map 3DEXPERIENCE attributes with Destination attributes from UI. If there is no mapping found data will be sent as is.

User can configure the module settings as shown below.

AM Module Properties 1
Figure 25. Open Attribute Mapping module property form
AM Module Properties 2
Figure 26. Attribute Mapping module → Common
AM Module Properties 3
Figure 27. Attribute Mapping module → Settings → Attributes
AM Module Properties 4
Figure 28. Attribute Mapping module → Settings → Attributes → Create
AM Module Properties 5
Figure 29. Attribute Mapping module → Settings → Attributes → New Attributes
AM Module Properties 6
Figure 30. Attribute Mapping module → Settings → Mappings → Create
AM Module Properties 7
Figure 31. Attribute Mapping module → Settings → Mappings → New Mapping
AM Module Properties 8
Figure 32. Attribute Mapping module → Settings → Mappings → New Mapping

Token Module

The Token Configuration settings are used to manage authentication when a module interacts with secured APIs. These settings define how a token is requested, which parameters are required to fetch it, and how the token or related values are read from the response and passed to other modules.

Token 1
Figure 33. Token module → Common

  • TOKEN URL SETTING

In this tab of the module settings, the user must configure the Token URL, Username, Password, Request Type, and Read Token From.

  • Read Token From: Specifies the source in the response from which the token should be read.

Token 2
Figure 34. Token module → Settings → Token URL Settings

  • TOKEN PARAM MAPPING

In this tab of the module settings, the user can configure the required headers and parameters that will be used to fetch the token.

Token 3
Figure 35. Token module → Settings → Token Param Mapping → Headers

  • parameters added in the body params will be used to generate request body.

Token 4
Figure 36. Token module → Settings → Token Param Mapping → Params

  • TOKEN RESPONSE MAPPING

In this tab of the module settings, the user must configure the mapping to read and write parameters from the token response.

  • Read parameter/header from token response: Defines how to read parameters from the token response.

  • Request Header Name: Specifies the header name to be used when passing the value to the Destination Module.

Token 5
Figure 37. Token module → Settings → Token Read/Write Mapping → Params

  • Testing the flow using the test window.

    1. Open newly created custom design

    2. click Test

    3. The flow will execute, and the results will be displayed in the Test Window.

Test
Figure 38. Test
Save the design after modifying any module configuration or setting to ensure changes are applied during execution.

Testing a Postman collection

  1. Go to Action and click on Transform to convert the postman collection into JavaScript code.

  2. Select the Transformer.

  3. Enable the Allow Postman Javascript code if you want to execute the generated Postman JavaScript code.

  4. Choose the valid Postman collection file.

  5. Choose valid JSON file to load environment variables.

  6. Provide the configuration location and specify a name for the configuration to be created.

  7. Select Extension Context and click Submit.

  8. The generated configuration will open automatically.

  9. Open the Test window.

  10. Select the Agent and provide the Security Context (If required).

  11. Click RUN.

  12. The execution details will be displayed in the Test Window.

Postman 1
Figure 39. Transform
Postman 2
Figure 40. Collection details
Postman 3
Figure 41. Generated configuration
Postman 4
Figure 42. Test generated configuration