Table of contents

• Introduction
• Prerequisites
• How to generate service account token
• How to create a connector
• Setting up connector with different execution component
  • Setting up connector with Service Account Token
  • Setting up with AzureAD SignIn
• Test & Persist
  • Probable reasons for failed test

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
• Generate Service account token

How to generate service account token

1. Log in to Ilap Analytics web ui.
2. Go to Admin → Generate new token → put the token name and set the expiry date

   
   

   Must need "administrator" role in ILAP Analytics to access this section.

   
   
3. Copy the generated token

Service token

How to create a connector

1. Access the IDE web application and navigate to Setup > Connectors
2. Click on the button +New Connector
   • A modal will appear having the following required fields:
     • Title, Host System, Execution component
       
3. Provide a meaningful title.
4. 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
5. Select the execution component, based on the selection different authentication type will be available. See next section to find out more about authentication types.
6. 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

Setting up connector with different execution component

Connectors can be created using either the Desktop Client or the Autonomous Component as the execution component. Each option supports different authentication types, which are explained in the following sections.  

When using the Desktop Client as the execution component, the following authentication types are available:  

• Service Account Token
• Azure AD Sign-In  

While the Desktop Client offers multiple authentication methods, the Autonomous Component only supports Service Account Token.  

Setting up connector with Service Account Token

Here is the setting you need to configure, and they are shown with red numbers and described below:

Setting up with AzureAD SignIn

1. Go to IDE web
2. Make sure the user has tenant setup role assigned
3. Go to connector → new connector select Ilap Analytics from dropdown. Select AzureAd Signin as authentication type

Here is the setting you need to configure, and they are shown with red numbers and described below:

The values to be put here are:

• Authority: https://login.microsoftonline.com/[YourTenantId]/v2.0
• ClientId:  Client Id of the ILAP Analytics UI app registration 
• Scopes: Typically:  api://ClientId_of_Your_Ilap_Analytics_Api/user_impersonation User.Read offline_access (also can be found from from IA installation)

A sample configuration could look like below: 

"Authority": "https://login.microsoftonline.com/e8ddb777-121f-4abc-a113-6b91d4b5dafc/v2.0", 
"ClientId": “b680058e-860b-4acc-80cb-89f8a1fd5a99”,
"Scopes": “api://5f9d20ce-8ac7-4115-80a7-2f1baacd7bda/user_impersonation User.Read offline_access”

Note: Copying the example without changing it won’t work

If you don’t have access to your organization’s IT infrastructure, ask your it team (preferrably the  person who setup ILAP Analytics in your organization) the following questions

1. What is your organization tenant ID
2. What is the Client id of the analytics ui app registration
3. What is the application ID URI for the analytics api app registration

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. 

Probable reasons for failed test

• The desktop application user might not have network access to the Ilap Analytics API.
• The analaytics api might not be up and running

Connector Not working

• The connector was not properly configured with proper Azure ad configs.

                                    Connector Invalid Authority

• The user might not have sufficient permission to access this app.

Checkout this article to find out more about test & persist