Skip to main content

Environment-Aware Synchronization for TDI Packages - User Guide

  • April 10, 2026
  • 0 replies
  • 8 views

Overview 

When setting up a Data Integration data provider, you need to map your TimeXtender instances to the three environments used in the platform: Development, Testing, and Production. This tells the system which TDI instance to use when executing packages in each environment. 

 

Step 1 - Enter your API Key 

Enter your TimeXtender API key in the API Key field. This key is used to authenticate against the TimeXtender API when fetching your available instances. 

 

Step 2 - Fetch Instances 

Click the Fetch Instances button. The platform will connect to the TimeXtender API and retrieve all available instances across your Ingest, Prepare, and Deliver packages. 

  • While fetching, the button shows Fetching… and is temporarily disabled. 

  • Once complete, the instance table appears below. 

  • If you have already fetched it before, the button reads Re-fetch Instances and will refresh the list. 

 

Step 3 - Assign Instances 

The instance table shows one row per instance group. For each row, use the three dropdowns to assign which TDI instance should be used for each environment: 

Column 

Purpose 

Development 

Instance used when running in a development context 

Testing 

Instance used when running in a testing/integration context 

Production 

Instance used in the live production environment             

 

Select an instance from the dropdown in each column. All three must be filled in for every row before you can save. 

 

⚠ Warning triangle - if a row has more than 3 instances available, a warning triangle appears. This means there are more instances than environments. You can still assign instances normally; just pick the one that best fits each environment. Instances that are not selected will not be synced. 

 

Step 4 - Save 

Once all rows have all three environment columns filled in, the Save button becomes active. Click it to persist your configuration. 

 

Step 5 - Sync with TDI 

After saving with all instances assigned, the Sync with TDI button becomes available. Click it to synchronize the data provider with TimeXtender, which will create or update the corresponding process map in your selected workspace. 

 

Notes 

  • The Sync with TDI button remains disabled until instances have been fetched, all environment columns are filled, and the configuration has been saved. 

  • If you change the API key or environment after saving, the Save button re-activates and Sync with TDI is disabled again until you save the updated configuration. 

  • Instance assignments are saved to the database and restored automatically the next time you open the data provider.