JSON All-In-One Configuration

Describes the configuration of an All-In-One operation as a series of name/value pairs representing the processes (data mapping, content creation, job creation and output creation) to be completed as part of the overall operation. The value in each pair contains the parameters for that specific process.

The structure is variable, allowing for configurations containing one or more specific processes (as name/value pairs), as long as the processes specified result in a logical sequence or workflow. Used specifically with the All-In-One service.

Structure

The structure consists of an object with the following name/value pairs:

• datamining – data mapping configuration parameters, consisting of an object with the following name/value pairs:

  • identifier – the managed file identifier (type of number) or named identifier (type of string) of the data file

  • config – the managed file identifier (type of number) or named identifier (type of string) of the data mapping configuration

  • parameters (optional) – a set of runtime parameter names and their corresponding values, consisting of an object with one or more name/value pairs:

    • <name> – the name (name) and the value of the runtime parameter
      (type of either string, number, or boolean)

• contentcreation – content creation configuration parameters, consisting of an object with the following name/value pairs:

  • identifiers – an array of data record entity identifiers (type of number) (optional for configurations containing data mapping parameters)

  • config – the managed file identifier (type of number) or named identifier (type of string) of the input template

  • parameters (optional) – a set of runtime parameter names and their corresponding values, consisting of an object with one or more name/value pairs:

    • <name> – the name (name) and the value of the runtime parameter
      (type of either string, number, or boolean)

• jobcreation – job creation configuration parameters, consisting of an object with the following name/value pairs:

  • config – the managed file identifier (type of number) or named identifier (type of string) of the job creation preset (optional)

  • parameters (optional) – a set of runtime parameter names and their corresponding values, consisting of an object with one or more name/value pairs:

    • <name> – the name (name) and the value of the runtime parameter
      (type of either string, number, or boolean)

• outputcreation – output creation configuration parameters, consisting of an object with the following name/value pairs:

  • identifiers – an array of job entity identifiers (type of number) (optional for configurations containing content creation parameters)

  • config – the managed file identifier (type of number) or named identifier (type of string) of the output creation preset

  • createOnly – flag to specify if output is to be only created in the server and not sent to it's final destination (type of boolean)

  • jobOutputFolder (optional) - parameter to specify where output files are stored (type of string). The provided path takes precedence over the path defined in the output creation preset, but is ignored if createOnly is set to true.

Specific to the use of all processes, an additional name/value pair can be added to restrict the print output to a set of specific records in the input data:

• printRange – print range configuration parameters, consisting of an object with a single name/value pair:

  • printRange – the range of records in the data file to output (type of string)

Specific to any configuration using the data mapping process, but with the omission of the config job creation configuration parameter (if applicable), an additional data mapping entry can be added to the datamining object:

• persistDataset – parameter to specify if data record entities are to be created/persisted in the server during the data mapping process (type of boolean)

Specific to the use of all processes, an additional name/value pair can be added:

• returnIdInHeader – parameter to specify if the response from the Get Result endpoints of the All-in-One Service (Get Result of Operation, Get Result of Operation (as Text), Get Managed Result of Operation) should contain additional headers (type of boolean)

Example

The following are examples of this structure:

{
	"datamining":
	{
		"identifier": "Promo-EN-1000.csv",
		"config": "Promo-EN.OL-datamapper",
		"parameters": {
			"Gender": "Female"
		}
	},
	"contentcreation":
	{
		"config": "letter-ol.OL-template",
		"parameters": {
			"InvoiceDueDate": "2020-03-10"
		}
	},
	"jobcreation":
	{
		"config": "4567",
		"parameters": {
			"TrackingId": "20211"
		}
	},
	"outputcreation":
	{
		"config": "5678",
		"createOnly": true
	},
	"printRange":
	{
		"printRange": "1-3, 6, 10"
	}
}

{
    "contentcreation":
    {
        "identifiers": [
            34567,
            34568
        ],
        "config": "letter-ol.OL-template"
    },
    "jobcreation": {},
    "outputcreation":
    {
        "config": "5678",
        "createOnly": false
    }
}

{
    "datamining":
    {
        "identifier": "12345",
        "config": "23456"
    }
}

{
    "datamining":
    {
        "identifier": "Promo-EN-1000.csv",
        "config": "Promo-EN.OL-datamapper",
        "persistDataset": false
    },
    "contentcreation":
    {
        "config": "letter-ol.OL-template"
    },
    "jobcreation": {},
    "outputcreation":
    {
        "config": "5678",
        "createOnly": false
    }
}

{
    "contentcreation":
    {
        "identifiers": [
            34567,
            34568
        ],
        "config": "letter-ol.OL-template"
    },
    "jobcreation": {
        "config": "4567",
        "parameters": {
            "FirstName": "Benjamin",
            "InvoiceDueAmount": 123.45,
            "InvoiceDueDate": "2020-03-10",
            "InvoiceOverdue": true
        }    
    },
    "outputcreation":
    {
        "config": "5678",
        "createOnly": false
    }
}