Skip to main content

Version: 18.05 (EOL)

Application Package JSON Definition

Transact Manager allows you to package forms and related services and assets into an Application Package. More information about application packages is available starting with Create an Application Package.

Example

An example Application Package definition file is shown below.

app-package-def.json
{
"name": "Loan App",
"description": "TODO...",
"clientCode": "maguire",
"connections": [
"connections/accounts-def.json"
],
"delivery": [],
"forms": [
"forms/loan-app/form-def.json"
],
"properties": [],
"services": [
"com/maguire/svc/accounts/service-def.json",
"com/maguire/svc/delivery/service-def.json",
"com/maguire/svc/profile/service-def.json",
]
}

Schema

Application Package definitions must comply with the following schema.

Fields are optional unless otherwise indicated.

FieldDescription
namestring

Required. The name used to identify the Application Package.

descriptionstring

A brief description of the Application Package.

clientCodestring

Required. The Application Package's organization client code.

connections[]string

Required. Each array element is the path to a Service Connection definition file.

delivery[]string

Required. Each array element is the path to a Delivery Channel definition file.

forms[]string

Required. Each array element is the path to a Form definition file.

properties[]string

Required. Each array element is the path to an Organization Property definition file.

services[]string

Required. Each array element is the path to a Service definition file.