Table of contents
- Introduction
- Prerequisites
- How to create
- Effect on Connector for selecting different execution component
- Authentication types explained:
- Test & Persist
Introduction
In this article, you’ll learn how to set up a Safran connector using the available authentication options.
Prerequisites
Before creating a Safran connector, ensure you have:
- You should have the permission of Setup Admin role to create a connector.
- Desktop client should be installed on your machine or Autonomous component should be installed for your tenant.
- Required authentication details (provided by Tenant Admin).
- Any custom request headers (provided by Tenant Admin).
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 the execution component (Desktop or Autonomous Component).
- Select Safran Project from the Host system dropdown. This will populate the following new fields:
- Required: Authentication Type, URL
- Optional: Owner, User owner verification (checkbox), Manage Customer Request Headers
- 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
- AzureAD Authentication
- Basic Authentication
- NO Authentication
- Windows Authentication
While desktop client has more options to authenticate the connector, Autonomous Component provides only three types:
- Azure Authentication as Application (Client Secret)
- Basic Authentication
- No Authentication
Authentication types explained:
Each authentication method has its own setup process. Here's what you need to know
Azure Authentication as Application:
Azure Authentication as Application allows the connector to authenticate using an application identity registered in Azure Active Directory (Azure AD).
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 | Sarfan Project |
3 | Execution Component | Desktop Client or Autonomous Component |
4 | Authentication Type | Azure Authentication as Application: (Client Secret) |
5 | URL | The URL of the Safran host system where the connector will connect. |
6 | Directory (Tenant) ID | The unique identifier for the Azure AD tenant that owns the application registration |
7 | Application (Client) ID | The identifier of the Azure AD app registration |
8 | Scopes | Defines what resources the connector can access. |
9 | Client Secret | A secure credential generated during Azure AD app registration. |
10 | Activity Retrieval Batch Size (optional) | Number of activities to retrieve per batch. If your schedule has more than 50k activities, we highly recommend specifying a batch size. Use batch size like 10000. |
11 | Activity Write Batch Size | Number of activities to create/modify per batch. Use batch size like 500. |
12 | Owner (optional) | The designated user or group for this connector. |
13 | Use Owner verification (optional) | Toggle to check if owner verification is required. By default, it's unchecked. |
14 | Manage Custom Header (optional) | Custom HTTP headers if required by the host system for API |
Note: Consult with your Tenant admin to get the required information
AzureAD Authentication:
Here is the setting you need to configure, and they are shown with red numbers and described below:
1 | Authentication Type | AzureAD Authentication |
2 | URL | The URL of the Safran host system where the connector will connect. |
3 | Directory (Tenant) ID | The unique identifier for the Azure AD tenant that owns the application registration |
4 | Application (Client) ID | The identifier of the Azure AD app registration. |
5 | Redirect URI | The redirect URL |
6 | Activity Retrieval Batch Size (optional) | Number of activities to retrieve per batch. If your schedule has more than 50k activities, we highly recommend specifying a batch size. Use batch size like 10000. |
7 | Activity Write Batch Size | Number of activities to create/modify per batch. Use batch size like 500. |
8 | Owner (optional) | The designated user or group for this connector. |
9 | Use Owner verification (optional) | Toggle to check if owner verification is required. By default, it's unchecked. |
10 | Manage Custom Header (optional) | Custom HTTP headers if required by the host system for API |
Note: Consult with your Tenant admin to get the required information
Basic Authentication:
Here is the setting you need to configure, and they are shown with red numbers and described below:
1 | Authentication Type | Basic Authentication |
2 | URL | The URL of the Safran host system where the connector will connect. |
3 | Username | Your username |
4 | Password | Password |
5 | Activity Retrieval Batch Size (optional) | Number of activities to retrieve per batch. If your schedule has more than 50k activities, we highly recommend specifying a batch size. Use batch size like 10000 |
6 | Activity Write Batch Size | Number of activities to create/modify per batch. Use batch size like 500. |
7 | Owner (optional) | The designated user or group for this connector. |
8 | Use Owner verification (optional) | Toggle to check if owner verification is required. By default, it's unchecked. |
9 | Manage Custom Header (optional) | Custom HTTP headers if required by the host system for API |
Note: Consult with your Tenant admin to get the required information
Windows Authentication:
Here is the setting you need to configure, and they are shown with red numbers and described below:
1 | Authentication Type | Windows Authentication |
2 | URL | The URL of the Safran host system where the connector will connect. |
3 | Activity Retrieval Batch Size (optional) | Number of activities to retrieve per batch. If your schedule has more than 50k activities, we highly recommend specifying a batch size. Use batch size like 10000 |
4 | Activity Write Batch Size | Number of activities to create/modify per batch. Use batch size like 500. |
5 | Owner (optional) | The designated user or group for this connector. |
6 | Use Owner verification (optional) | Toggle to check if owner verification is required. By default, it's unchecked. |
7 | Manage Custom Header (optional) | Custom HTTP headers if required by the host system for API |
Note: Consult with your Tenant admin to get the required information
No Authentication:
Here is the setting you need to configure, and they are shown with red numbers and described below:
1 | Authentication Type | No Authentication |
2 | URL | The URL of the Safran host system where the connector will connect. |
3 | Activity Retrieval Batch Size (optional) | Number of activities to retrieve per batch. If your schedule has more than 50k activities, we highly recommend specifying a batch size. Use batch size like 10000 |
4 | Activity Write Batch Size | Number of activities to create/modify per batch. Use batch size like 500. |
5 | Owner (optional) | The designated user or group for this connector. |
6 | Use Owner verification (optional) | Toggle to check if owner verification is required. By default, it's unchecked. |
7 | Manage Custom Header (optional) | Custom HTTP headers if required by the host system for API |
Note: Consult with your Tenant admin to get the required information
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