This article provides a list of essential terminologies used within OneConnect.
Term |
Definition |
Notes & Examples |
---|---|---|
Tenant |
An organization within the system. Previously this term exclusively referred to office 365 organizations. With the new login functionality, non-office 365 users can now create their own tenants. The Tenant name is updated automatically to reflect the Microsoft organization affiliated to the email (if using the sign in to Microsoft login button). For users logging in using the form (entering an email and password), the Tenant name can be set when first logging into OneConnect. Tenants do not expire. |
|
Subscription/OneConnect Group |
Each tenant will have at least one OneConnect group, also referred to as a subscription. Users must request access to a OneConnect group or be added by an Administrator. Each OneConnect group can have its own set of integrations. Additionally, a OneConnect group can be linked to a single OnePlan group facilitation. |
|
Connector |
A component within an integration enabling authentication to access the program. Additional settings and in some cases additional authentication methods are available in the additional options section. |
|
Integrator |
A web service that can be considered as middleware. The automated process that binds two connectors together. |
Used only when clients have specific business requirements that are outside of the standard scope for the integration. |
Integration |
An integration is any combination of two connectors, an integrator, and at least one strategy. |
OnePlan Plans to Azure DevOps Epics is an integration. |
Strategy |
A strategy is a set of operations to complete an action. This involves querying data from the source program and bringing those values over to the destination program. |
OnePlanPublish is a strategy within the OnePlan Plans to Azure DevOps Epics integration. |
Source Connection |
The origin point from which data is retrieved. The source connection may vary depending on the selected strategy. |
The OnePlanPublish strategy utilizes OnePlan as the source connection, indicating that data is extracted from OnePlan and imported into the other connected program. |
Destination Connection |
The endpoint where data is imported or directed to. |
In the context of the OnePlanPublish strategy, the data retrieved from OnePlan (source connection) is transferred to the specified destination connection. |
Incremental Deltas |
Certain strategies support the retrieval of items modified within a specified timeframe. To utilize this capability, the modification date must be accessible at the “plan level.” Plans lacking a modification date will not be included in the strategy’s data retrieval process. |
|
Full Deltas |
Certain strategies lack the capability to query modified dates for their items due to integration constraints. Despite being designated to run incrementally; these strategies execute a full data retrieval process. |
Full deltas will generally take a longer amount of time to process large amounts of data than when running incremental deltas on a strategy. |
Scheduled Strategy |
A strategy that runs automatically following a predefined schedule or when manually triggered using an asterisk (*) within the Item Id field. |
|
Event-Driven Strategy |
A strategy that is triggered by an event, such as user interaction or system-generated due to a trigger. If a value is entered within the Item Id field, it is most often the Plan Id/GUID from the source connection. Event-driven strategies provide detailed logs which can assist with debugging errors should a single plan consistently fail to process. |
When running an event on the OnePlanPublish strategy, I would enter the OnePlan plan level GUID within the Item Id field. |
Filters |
Filters for scheduled strategies and events are managed separately. Setting a filter for a scheduled strategy does not carry over if the strategy is subsequently as an event. |
Filters can only be set on fields that are mapped. |
Field Mappings |
Field mappings define how information is transferred between programs. Each mapping allows for the transfer of a single value at a time, preventing the assignment of the same value to multiple locations in either program. |
|
Item Mappings |
Item mappings define the connections between plans and tasks from one program to their corresponding entities within another program. These mappings may be represented by GUIDs or plain text. |
|
Relay |
A software application designed to securely bridge services within a client’s network with the public cloud. Relays are particularly useful for clients whose programs are not directly accessible over the internet. If a client’s employees require a VPN to access their company’s programs, deploying a relay is often necessary to facilitate connectivity. |
For more information, see What is a Relay? |
Legacy (Basic) Authentication |
Legacy authentication refers to the traditional method of logging into a site using only a username and password. |
|
Modern Authentication |
Modern Authentication enhances login security by requiring additional credentials beyond a username and password. Commonly, this includes a Client ID & Client Secret, offering an elevated level of security compared to traditional username and password combinations. |
|
Multi-Factor Authentication (MFA) |
Multi-Factor Authentication involves a multi-step login process where, in addition to entering the username and password, an extra step is required to complete the login successfully. Due to this additional security measure, accounts with MFA are not supported for use when entered to run an integration. |
|