PANDIUM.yaml
The PANDIUM.yaml provides Pandium with the necessary information in order to build and execute your integration script on our platform. It also defines the configuration options and UI, via the configs section, where your customers will input information vital to the integration run.

Name and Location

When setting up an integration on the Admin Dashboard, you are able to specify the name and location of the file with respect to the root of your integration code repository. If not set, by default we look for a file name PANDIUM.yaml in the root directory.

Structure

All Pandium.yaml files are required to start with the following 5 mappings.
1
version: 0.4
2
base: python:3.7 # Node, Ruby, PHP, Java, GO
3
build: pipenv install
4
run: pipenv run python -m hubspot2s3
5
6
configs: {} # details to follow
Copied!
    version: This should be at the top of the file. Currently this should always be set to 0.4.
    base: Use this property to tell us what language and version you have coded your integration in. Format should be <language>:<version>
      acceptable values include:closure, node, python, ruby, java, php, .net
      The version of the language should follow the the language using a colon.
        Examples python:3.7 or java:11
We strive to support all commonly used languages and at least the long-term supported version of the language if such a version is defined. If you don't see your preferred language or version, please let your Technical Account Manger know and we will work on getting support built out right away.
    build: This should be set to how you package your code, and get all of its dependency installed. We strive to support all common packing and dependency management tools. This includes pip (python), npm (node), composer (php), maven (java), etc.
    run: This property tells Pandium how to run your code at run time. This should be the same command you use to invoke your script on you local command line. For example, if you had a script named “main.py” you would use python -m main.py to execute it both locally and on Pandium.

Configs

The configs section fo the pandium.yaml file allow to define the configuration options and UI elements that should be presented to the user when they are creating their Tenant for your Integration. The configs currently support two types of properties: Schema and UiSchema.
To define a config, add a mapping underneath the schema.properties. The mapping is a string to an object. The string is the name of the config and prefixed with PAN_CFG_when injected into the environment at runtime. The only required prop of the object is typeother possible props are specific to the type and none are require.
Below is an example of a Configs specification. The tenant will be presented with the four properties defined under the schema, some of which have defaults. They will be labeled as described under the UISchema. You can also choose if the end users is even presented with an option, or if it is only configurable but an administrator on the Admin Dash.
1
# ... continuing from above
2
3
configs:
4
schema:
5
properties:
6
s3_bucket_name:
7
type: string
8
s3_file_name:
9
type: string
10
make_contact:
11
type: boolean
12
default: true
13
make_company:
14
type: boolean
15
type: object
16
uischema:
17
elements:
18
- label: S3 Bucket Name
19
scope: '#/properties/s3_bucket_name'
20
type: Control
21
- label: S3 File Name
22
scope: '#/properties/s3_file_name'
23
type: Control
24
- label: Make Contact?
25
scope: '#/properties/make_contact'
26
type: Control
27
admin: true
28
- label: Make Company?
29
scope: '#/properties/make_company'
30
type: Control
31
type: VerticalLayout
Copied!
In the above examplemake_contact is the name of the config. When presented to the user they will see a checkbox, that is checked, because a the default was set to true. When a Run happens this config will be injected into the environment as PAN_CFG_MAKE_CONTACT. Possible props:
In the above example, num_of_daysis the name of the config. When presented to the user they will see a number selector that is restricted to integers, with the value 0 being presented as the starting value. The user will be able to When a Run happens this config will be injected into the Environment as PAN_CFG_MAKE_CONTACT
In the above example, a_real_numberis the name of the config. When presented to the user they will see a number selector, with the value 1.3333 being presented as the starting value. When a Run happens this config will be injected into the Environment as PAN_CFG_A_REAL_NUMBER
In the above example, i_am_a_normal_stringis the name of the config. When presented to the user they will see a text box that is empty being the starting value. When a Run happens this config will be injected into the Environment as PAN_CFG_I_AM_A_NORMAL_STRING

Last modified 1mo ago