Getting Started

The goal is to establish the connection between TIF and the 3DEXPERIENCE™ Cloud application.

Pre-Requisites

The person who does the preparations in the 3DEXPERIENCE™ environment, must have the Enterprise Integration Architect (PFI) role.

This person must also be an Administrator of the tenant.

Also note that if you edit an existing agent that is being used from your integrations in TIF, you must also update the agent in TIF.

Step 1: Create an Agent

An agent, or openness-agent (DS terminology) is an object managed by the 3DEXPERIENCE™ service named Credential Lifecycle Management (CLM). It is required to set up these in order for the web-service communication from TIF to 3DEXPERIENCE™ to work.

a) Create an Agent in 3DEXPERIENCE™

First step is to create at least one Agent in the 3DEXPERIENCE™ Platform.

That is done from the Agent Management widget within the 3D Dashboard.

Figure 1. Create new Agent within 3DEXPERIENCE™

Remember to copy both the Agent ID and the Agent Password as you need to enter this into the TIF Administration UI in the coming step.

The agent should not operate as a user having the Administrator role as this will not work when using the DS REST APIs further on.

This is a restriction from the 3DEXPERIENCE™ platform itself.

b) Create an Agent in TIF

Now we will create the corresponding agent within the TIF Administration UI.

Figure 2. Create the Agent in TIF

Here you give the Agent a logical name + enter the Agent ID and Password (secret) as copied earlier.

The information entered is stored encrypted and once entered, no-one can see it again.

Step 2 (OPTIONAL):

If you intend to use the API Gateway for the communication between TIF and 3DEXPERIENCE™, you also need to create at least one API Gateway Key.

a) Create an API Gateway Key in 3DEXPERIENCE™

Within the API Gateway Portal widget of 3D Dashboard, you can administrate these keys.

Figure 3. API Gateway Portal Widget in 3DEXPERIENCE™

Each key that you create may be given different access rights. Thus, depending on the usage, you may need to create several keys.

Remember to, for each key created, copy the API Key value as you need to enter this into the TIF Administration UI in the coming step.

Step 3: Configure the Connection

The next step is to configure the connection settings from TIF to 3DEXPERIENCE™. From the same widget as you used in 3D Dashboard when creating the agent, there is a tab called "Available Services".

Within this tab, all connection details are available.

Figure 4. Avaiable Services

This information must be provided for the TIF Administration UI.

Although TIF tries to help you fill in the values, you should compare these with what’s provided from the 3D Dashboard widget as there might be some differences not being handled at the moment.

Within the TIF Administration UI, go to "Settings" → "Cloud Settings" → "Connection".

Fill in the name of the 3DEXPERIENCE™ Tenant and the region it belongs to. The tenant name typically starts with the character 'R' followed by a number.

Once these values are changed, most of the fields are updated automatically. Review these values and compare with the ones provided from 3D Dashboard.

On the first tab also whether to use the API Gateway is also available. If API Gateway mode is selected, a default API Gateway Key must be set. This key will be used unless overridden later, in specific integration use-cases.

Figure 5. Configure 3DEXPERIENCE™ Connection in TIF - General

The next tab contains the message bus settings. Remember to select what "Agent" to use when authenticating against the Message Bus.

Figure 6. Configure 3DEXPERIENCE™ Connection in TIF - Message Bus

The last tab holds all service urls. These are auto populated whenever tenant-name, region or the domain is being changed. Review that these values matches whats given by DS.

Figure 7. Configure 3DEXPERIENCE™ Connection in TIF - Service Urls

Press Save to persist the values.

To test the connection, use the "Test Connection" button and await the result.

Figure 8. Test Connection Result

You can now also select to enable the connection between TIF and the 3DEXPERIENCE™ Platform by clicking the "Enable" button.

You must enable the connection to receive events from the DS Message Bus.

Next Steps

Once you have a working connection between TIF and the 3DEXPERIENCE™ system, you should read and learn more about mapping events, creating custom REST endpoints and using scheduled tasks to understand how Jobs are triggered within TIF.

Also, understanding how a service is handling the jobs is important to understand.