Core concepts
App versioning
Optimizely Connect Platform (OCP) uses the following format for app versioning \<app name>@\<app version> . Where \<app version> consists of the version number and pre-release tag .
App structure
To build a complete application in Optimizely Connect Platform (OCP), you must have the following files src/ / / . yml .
Lifecycle of an app in OCP
The lifecycle is how you manage all the stages of an app. It includes the following App installation form submission upgrades uninstallation App templates generated by ocp app init contains a skeleton of lifecycle methods.
OAuth authentication
Optimizely Connect Platform (OCP) provides building blocks to help you implement OAuth authentication for your app. OAuth lets your app call third-party APIs on behalf of the owner of the OCP account where your app is installed.
Forms in OCP
Optimizely Connect Platform (OCP) apps have two tabs that display to users. Overview – Provide an overview of your app to users, including steps required to complete the installation and setup.
Storage
Optimizely Connect Platform (OCP) apps have access to the following four types of storage to support storing sensitive data, configuration data, general data structures, and common data between components of your app that are necessary for the operation of your app. Your app must use the provided storage layers and should not attempt to store data outside OCP or on a file system.
Jobs
A job is a unit of work that you can schedule or trigger manually. A common use for jobs is to handle historical and incremental imports.
Functions
In OCP, functions are small, executable blocks of code typically triggered by a real-time event. An app can have any number of functions stored in the src/functions directory.
CMS UI extensions
A CMS UI extension is an OCP app that contributes UI into Optimizely CMS. Each surface is an injection point, the key you declare the extension under in app.
Data syncs
The Optimizely Connect Platform (OCP) Sync Manager lets OCP end-users configure data syncs between Optimizely and external systems. Each data sync includes the following two core components Source – The source from which you want to sync data, such as the OCP database.
App data schema
Data in Optimizely Connect Platform (OCP) is stored in collections called objects (also known as a database table). Objects are composed of fields (database table columns).
Scheduled syncs
Scheduled syncs can pull data from the OCP database and sync to your destinations. The OCP database is extensible through apps, API, or within the user interface (UI).
Add a dependency
Optimizely Connect Platform (OCP) apps have a set of pre-defined dependencies in the package. json file.
App logs and how to troubleshoot
To assist in development and debugging, apps can log messages using the App SDK's logger. Log access differs by role.
Activity Log notifications
You can log important account-level events to the Optimizely Connect Platform (OCP) Activity Log using the App SDK's notifications . The OCP Activity Log provides detailed information regarding significant activity, like data or file load jobs, integration syncs, and more.
Test your app
Optimizely Connect Platform (OCP) app templates include a Vitest configuration ( vitest. config.