Table of contents

• Introduction
• Step 1 - Sign up your organization as a new Tenant in IDE
• Step 2 – Install the Desktop Client
• Step 3 – Create one or more connectors for data reception
• Step 4 – Persist your connector(s)
• Step 5 – Create template(s) for the data you wish to send to your partner organization(s)
• Step 6 – Create sending config(s) against the template(s)
• Step 7 – Collaborate on and activate IEA(s) for uploads/downloads

Introduction

Follow this article to set up IDE for your tenant so that the planners in your organization can upload schedules.

Step 1 - Sign up your organization as a new Tenant in IDE

1. Sign in to the IDE website as the first user from your organization.
2. Click OK when prompted to create a new IDE Tenant. A System Admin must approve this request.
3. Finally, log in again after approval to see the IDE login screen for your new tenant—your account will be auto-provisioned as a valid user.

Step 2 – Install the Desktop Client

Step 3 – Create one or more connectors for data reception

1. In IDE’s Setup → Connectors, click + New Connector.

2. Choose the Execution component and Host system for your incoming data source.

3. Fill in the required authentication and path parameters.

4. Click Create.

Step 4 – Persist your connector(s)

1. Open the Desktop Client and go to the Connectors tab.

2. Find each connector you created and click Persist.

3. This action tells IDE which schedules are available and what user-field settings each schedule has.

Step 5 – Create template(s) for the data you wish to send to your partner organization(s)

1. In IDE’s Setup → Templates, click + New Template.

2. Add the ILAP Terms you wish to receive data for, and optionally specify a list of valid values.

3. Save the Template.

4. Share the template with the organizations you wish to send data to.

Step 6 – Create sending config(s) against the template(s)

1. In Setup → Configs, click + New Config.

2. Select the Template and Connector to use.

3. Select ScheduleId(s) where schedule can be received and map ILAP terms to host fields.

4. Save the Config.

Step 7 – Collaborate on and activate IEA(s) for uploads/downloads

1. Create one or more IEAs where you specify that your role is Sender. You also need to specify which Template to use as well as which Tenant will act as Receiver, and which person from the sender side will be representative for the IEA (more can be added later).

2. Specify which Connector to use, which Schedule to send data to, as well as which person(s) should be representatives in your organization.

3. When the IEA should be valid (start and expiration dates) as well as the frequency by which transfers should occur (or "On demand" if it is not on a regular basis).

4. Your partner will then be informed that they can fill out their side of the IEA (which Connector to use and which Schedule to receive from).

5. Once partner details have been added, the sender can then create a test event to verify the data mapping and execute the upload test (optionally this step can be skipped but is not recommended (*)).

6. When upload test is done (unless skipped), you can perform a download test to ensure you can correctly receive and mappings are working as expected.

7. After completion of download test, both you and the partner(s) of the IEA can view the test results and see comparison of the test in the IEA details. The IEA partner signs off the IEA.

8. Finally, you as the IEA owner sign the IEA and activate the IEA for transfers.
   
   

(*) Note: The sender may skip upload test, in that case receiver will not be able to do the download test. The IEA will become active once the owner signs the IEA.