Getting started

An Integration automates work in the CoCoCo platform. Use it to connect tenant resources, expose callable Actions, respond to events, run scheduled tasks, and coordinate workflows. It can also include app interfaces, retained data schemas and Edge App definitions when your solution needs them.

An Edge App runs on a controller and connects to local equipment and protocols. Choose an Integration for platform automation; use an Edge App for the part that needs controller access. The two can form parts of the same solution.

A definition is reusable XML describing behavior and required configuration. An instance uses one published definition for a tenant and supplies configuration, resource bindings and credentials. Publishing a definition does not create or start an instance. Before installing it, identify the resources it will use and the permissions it needs.

Start with a complete XML v1 document. The root contains a stable integration id, a definition version and an SDK version.

<integration id="com.example.minimal" version="1.0.0" sdk-version="2.0">
  <description>Example definition</description>
</integration>

This is a valid starting definition; it does not yet perform any work. Add an Action, timer or subscription when you are ready to give it behavior.

1. Open a new definition or import XML into the Integration authoring page.
2. Choose Validate and correct the reported errors. Save draft preserves the exact XML, including comments, whitespace and CDATA.
3. Choose Publish after reviewing the saved draft. Create an instance from the published definition, supply its configuration and bindings, then start it.
4. For a definition with Actions, open the instance's Actions, provide the inputs and choose Invoke Action.