What is a strategy?
In OneConnect, a strategy is a key tool that transfers data between two programs, such as Program A and Program B. Think of a strategy as a messenger: it's responsible for moving data from one place to another.
For integrations that can share data both ways (bi-directional), there are typically two strategies:
- OnePlanUpdate: Transfers data from Program A into OnePlan.
- OnePlanPublish: Transfers data from OnePlan into Program A.
There may be additional strategies in your integration, each serving a specific purpose. Understanding what each strategy does and which data tables it processes is crucial to using OneConnect effectively.
Strategy Descriptions
Sometimes, strategy names might not clearly explain their purpose. To learn more:
- View the Strategy Description: Click the Strategy Edit Icon to open the description for details.
- Check Integration Documentation: Review the strategies included in your integration for a more in-depth overview.
Some strategies focus on specific data types (e.g. resources vs projects). For example, a strategy designed to handle resource information won't process project-related data, and vice versa.
Strategy Statuses
When a strategy runs, its most recent status is updated on the Schedules page. Strategies can have one of three statuses:
| Status Value | Description |
|---|---|
| Success | All items were processed without issues. Everything ran smoothly. |
| Success with Exceptions |
Some items were successfully processed, but others failed. The logs provide details about the failed items. Consider running these items as events for further analysis. |
| Failure |
No data was processed. The strategy encountered an error before it could start transferring data. Review the logs for more details. |
Strategy Filters
Strategies often include filters to control which data gets transferred. Filters prevent the strategy from processing all data in your environment, ensuring only the relevant information is moved.
Important: If a filter is removed, the strategy may attempt to process and transfer all available data, which can cause delays or errors. It's recommended to always use filters, especially for scheduled strategies.
For more information on filters, please review the Understanding Strategy Filters page.
Types of Strategies
Events
An event-driven strategy runs when triggered by a specific action, such as a user interaction.
Key points about event-driven strategies:
- You may need to provide an Item ID (a Plan ID or a corresponding ID in another program).
- Events will process all mapped data for the specified item.
- Event logs provide detailed insights, especially useful for troubleshooting failures.
Example:
- OnePlanPublish events use a Plan ID from OnePlan as the source.
- OnePlanUpdate events use Program A's equivalent ID.
Not all strategies support event-based triggers. Please check your integration's documentation to confirm.
Scheduled Strategies
A scheduled strategy runs automatically at set intervals or can be triggered manually.
- Automatic Runs: Strategies execute based on their defined schedule. Integrations that have a Basic license will not have this functionality.
- Manual Runs: You can manually run a strategy by clicking the Execute Strategy button (lightning bolt icon). No Item ID should be entered.
Deltas: Full vs. Incremental
Strategies process data using either full deltas or incremental deltas:
- Full Deltas: Transfer all data, regardless of when it was last updated. This is a comprehensive but slower process.
- Incremental Deltas: Transfer only data updated since the last successful strategy run. This is faster and more efficient.
If Full Deltas is not available, the integration is most likely a trial or is running a Basic or Professional license. For more information on licenses, and how they affect your integration, please review the OneConnect Subscription Types page.
Manage Strategy Schedules
To learn more about what can be done for a strategy in terms of scheduling, please review the Manage Strategy Schedules page.
Logs
Logs provide a record of items processed during a strategy run.
- If an item repeatedly fails, you can use its ID to run an event and gather more details about the issue.
- Logs can help pinpoint where problems occur and provide insights into resolving them.
What data gets transferred over?
To get a better understanding of what data is brought over and where, please review the integrations Field Mappings section. This can be found within the Manage Integration Mappings page.