Table of contents
- Introduction
- Prerequisites
- How to create
- Effect on Connector for selecting different execution component
- Test & Persist
Introduction
This guide walks you through setting up an ILAP Analytics connector with the available authentication systems.
Prerequisites
Make sure you have these before starting to create connector in IA:
- Your user must have Setup Admin role to access connector settings
- Desktop Client needs to be installed on you machine and/or Autonomous Component needs to be set up for your tenant
- Authentication Details (Get this information from Tenant Admin)
- (Optional): Custom request headers required in the authentication process
How to create
- Access the IDE web application and navigate to Setup > Connectors
- Click on the button +New Connector
- A modal will appear having the following required fields:
- Title, Host System, Execution component
- Title, Host System, Execution component
- A modal will appear having the following required fields:
- Provide a meaningful title.
- Select ILAP Analytics from Host System dropdown, which will populate the following fields in the modal
- Required: ILAP Analytics URL, Read & Write Batch Size, Authentication Type
- Optional: Manage Custom Request Headers
- Select the execution component, based on the selection different authentication type will be available. See next section to find out more about authentication types.
- Lastly add details to all of the required fields and hit create.
Please note each connector's URL must be unique otherwise error will be shown
Effect on Connector for selecting different execution component
Authentication types depend on the execution component you choose.
Selecting Desktop client as execution component provides the following options as authentication type
- Service Account Token
- AzureAd SignIn
While desktop client has more options to authenticate the connector, Autonomous Component provides only Service Account Token.
Setting up with Service Account Token
Here is the setting you need to configure, and they are shown with red numbers and described below:
1 | Title | Title of the connector |
2 | Host System | ILAP Analytics |
3 | Execution Component | Desktop Client or Autonomous Component |
4 | ILAP Analytics URL | The URL of the ILAP Analytics host system where the connector will connect. |
5 | Read Batch Size | Number of entities to retrieve per batch. If your schedule has 10k+ activities, we highly recommend specifying a batch size. |
6 | Write Batch Size | Number of entities to create/modify/delete per batch. |
7 | Authentication Type | Service Account Token |
8 | Service Account Token | Service Token generated from IDE web application for IA cliient |
9 | Manage Custom Request Headers | Custom HTTP headers if required by the host system for API. More info here |
Contact your Tenant Admin to get the details of the fields.
How to generate Service Account Token
Service Account Token resides in Tenant Admin > Clients > ILAP Analytics in the web application. Service tokens generated for ILAP Analytics clients by Tenant Admin. Here is the process of creating service token.
Navigating to the Client
Adding new token
Setting expiry of the token
Generated token
Setting up with AzureAD SignIn
Here is the setting you need to configure, and they are shown with red numbers and described below:
1 | Execution Component | Desktop Client |
2 | ILAP Analytics URL | The URL of the ILAP Analytics host system where the connector will connect. |
3 | Read Batch Size | Number of entities to retrieve per batch. If your schedule has 10k+ activities, we highly recommend specifying a batch size. |
4 | Write Batch Size | Number of entities to create/modify/delete per batch. |
5 | Authentication Type | Service Account Token |
6 | Authority | Service Token generated from IDE web application for IA cliient |
7 | Client ID | This is the unique identifier for your registered application in Azure AD |
8 | Scopes | Scopes define the permissions your connector is requesting |
9 | Manage Custom Request Headers | Custom HTTP headers if required by the host system for API. More info here |
Contact your Tenant Admin to get the details of the fields.
Test & Persist
After creating the connector:
For Desktop Client execution:
Open the IDE Desktop Client
Navigate to the Connectors tab
Click Test to verify connection
Click Persist to fetch schedules and host fields from P6
For Autonomous Component execution:
Test is done periodically via a background job, but it can be also done using desktop client.
Alternatively: Go to Setup > Connectors in the web app, and open the newly created connector and click Persist to force retrieval of schedules and host fields from P6. After persisting, reload the page after a few minutes to verify the updated connector status.
Checkout this article to find out more about test & persist
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article