Jump to Content

Dev Guide User Guide

Dev Guide User Guide GitHub NuGet DevCommunity Doc feedback Log In

GitHub NuGet DevCommunity Doc feedback Log In

Get Started with OCP

Get started with OCP
When to use OCP
Configure your development environment

Quickstart: Build an App

Overview
Scaffold the app and define the schema
Publish to the ODP sandbox
Configure and authenticate the app
Write a function
Write a job
Publish the app in ODP App Directory

Core Concepts

App structure
Lifecycle
Jobs
Functions
Global functions
Channel apps
- Campaign and channel events
- Liquid extensions
Forms
Storage
Schema for objects and fields
- Schema modules
App logs and troubleshooting
Activity Log notifications
Test your app
OAuth authentication

Reference

ODP APIs
Add a dependency
Job cron expression
Batcher and CSV parser utilities

App SDK API REFERENCE

Overview
Classes
Enums
Functions
Interfaces
Types
Variables
namespace: Form

NODE SDK API REFERENCE

Overview
Variables
- z
namespace: Zaius
Zaius - Classes
- ApiError
Zaius - Interfaces
Zaius - Types
- FieldValue
- ReachabilityUpdateType
namespace: Zaius.ApiV3
Zaius.ApiV3 - Classes
- HttpError
Zaius.ApiV3 - Enums
- ErrorCode
Zaius.ApiV3 - Functions
Zaius.ApiV3 - Interfaces
Zaius.ApiV3 - Types
- HttpMethod
Zaius.ApiV3 - Variables
- BATCH_LIMIT

Release notes

2023 OCP release notes

Variables

Variables

APP_ID_FORMAT
DEFAULT_LOG_LEVEL
LOG_LEVELS
LOG_LEVELS_BY_STRING
VENDOR_FORMAT
VERSION_FORMAT
functions
jobs
logger
notifications
queue
storage

Updated 4 months ago

Table of Contents
- Variables