Schema
The schema section of the configs allows you to define the properties that will be passed to the integration every-time the integration is executed. The property name will be prefixed with
PAN_CFG_
when injected into the environment at runtime. The only required prop of the object is type
other possible props are specific to the type and none are require. The current schema supports the following types:bool_input:
type: boolean
default: true
In the above example
bool_input
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_BOOL_INPUT
. Possible props:prop | values | note |
default | true or false | |

How the end-user will see this when combined with UISchema
integer_input:
type: integer
default: 0
min: -1
max: 10
In the above example,
integer_input
is 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_INTEGER_INPUT
prop | values | note |
default | an integer | |
min | an integer | negatives allowed |
max | an integer | |

How the end-user will see this when combined with UISchema
number_input:
type: number
default: 1.3333333
In the above example,
number_input
is 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_NUMBER_INPUT
prop | values | note |
default | any number | |
min | any number | negatives allowed |
max | any number | |

How the end-user will see this when combined with UISchema
string_input:
type: string
In the above example,
string_input
is 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_STRING_INPUT
prop | values | note |
default | any valid unicode string | |
format | null || "date" || "time" || "date-time" | when null or undefined control renders as a text box. date renders as a date picker time renders as a time picker and date-time renders a date and time control. |
enum | an array of values | if you add an enum to the control, it will render as a dropdown. |

How the end-user will see this when combined with UISchema
string_enum_input:
enum:
- option 1
- option 2
- option 3
type: string
In the above example,
string_enum_input
is the name of the config. When presented to the user they will see a select box allowing them to choose between the giving enum values. When a Run happens this config will be injected into the Environment as PAN_CFG_STRING_ENUM_INPUT

How the end-user will see this when combined with UISchema
array_input:
type: array
items:
type: object
properties:
date:
type: string
format: date
enum:
enum:
- foo
- bar
type: string
message:
type: string
maxLength: 5
In the above example,
array_input
is the name of the config. When presented to the user they will see a line with a combination of the three properties that make up each object in the list, the UI allows them to add or remove objects to the array. When a Run happens this config will be injected into the Environment as PAN_CFG_ARRAY_INPUT

How the end-user will see this when combined with UISchema
schema:
type: object
properties:
bool_input:
type: boolean
default: true
array_input:
type: array
items:
type: object
properties:
date:
type: string
format: date
enum:
enum:
- foo
- bar
type: string
message:
type: string
maxLength: 5
number_input:
type: number
default: 1.3333333
string_input:
type: string
integer_input:
max: 10
min: -1
type: integer
default: 0
string_enum_input:
enum:
- option 1
- option 2
- option 3
type: string
Last modified 2yr ago