Basic

Beyond the empty object ({}) any Assembly Template will have to have a “$$Id” object whose value matches the Package’s name.

{"$$Id":"My Package"}

The presence of any child object array is optional such that a Document, Layout, Content does not have to contain any children. If any child objects of Document, Layout or Content are added to any parent object the child object must have an “$$Id” object whose value matches the name of that child.

{"$$Id":"My Package", "Documents":[{"$$Id":"My First Document"},{"$$Id":"My 2nd Document"}]}

Condition and Iteration as well as a collection of Fields is also optional on each object type supporting them. A child object can be included without a Condition or Iteration and without a collection of Field; however, such a structure provides no value.

Field

A Field collection defines the mapping between the incoming JSON data and the referenceable Field names used in Content configuration to display the data. In order to reference incoming data in a Content configuration (e.g. Hello ) a Field for that data must be defined in the Assembly Template.

Fields defined in one object can be referenced during configuration by any Content within the configuration hierarchy defined through association. Fields can be over written by redefining the Field in a child object in which case the Content under the child’s hierarchy will use the over written value.

{"$$Id" : "My Package", "Fields" : [{"Name":"FullName","Path":"$.beneficiary.name"}]}

The Assembly Template above would provide a Field with the Name of “FullName” that could be referenced in any Content within the My Package hierarchy through any Document->Layout association. If the JSON data submitted in the Assembly request is {"beneficiary":{"name": "Jim Smith"},"spouse":{"name": "Jane Smith"}},"spouse":{"name": "Jane Smith"}} the value of FullName in all areas would be Jim Smith.

Given the same data and the following Assembly Template{"$$Id" : "My Package", "Fields" : [{"Name":"FullName","Path":"$.beneficiary.name","Mandatory": false}], "Documents":[{"$$Id": "Right of Ownership", "Fields":[{"Name":"FullName","Path":"$.beneficiary.spouse"}]}]}

The value of FullName in any Content included in the “Right of Ownership” Document would be “Jane Smith” while all other Document Content would get a value of “Jim Smith”.

The value for the field Mandatory indicates if the field is required. By default, it is set to True. When it is set to false, no error message is displayed about missing JSON path and if you do map to it, the value will be empty in output. If the Mandatory attribute is set to true or is missing, an error is displayed and no output is rendered from the assembly.

Condition

A Condition on any object will determine if that object is included in the assembled output. If an object is not included in the Assembly Template or does not have a Condition, it will always be included in the output. Iteration can also impact the inclusion of an object in the output as discussed elsewhere.

Example:

Given the following Assembly Template {"$$Id":"My Package","Documents":[{"$$Id":"Auto Renewal","Condition":"$[?(@.account.auto == 'True')]"}]}

If the data is {"account": {"auto": " True"} the Auto Renewal document will be included in the output, but if the data is {"account":{"auto": "annual"} the Auto Renewal document will not be included in the output.

Given the following Assembly Template { "$$Id": "My Package", "Documents": [ { "$$Id": "Auto Renewal", "Condition": "$[?(@.account.auto == 'annual' || @.account.auto == 'True')]" } ] }

If the data is {"account": {"auto": " True"} or {"account":{"auto": "annual"} the Auto Renewal document will be included in the output.

Iteration

An Iteration on an object will determine if that object is included multiple times in the assembled output. The object, and its child objects if any, will be include one for each instance of the referenced JSON path in the data. The Fields array, if any, within the Iteration will utilize the Path defined in the Iteration as their root within their JSON path.

Given the following Assembly Template {"$$Id":"name of package object","Documents":[{"$$Id":"name of document object that repeats","Fields":[],"Iteration":{"$$Id":"name given to repeating node","Path":"$.account[*]","Type":"Spliterator","Fields":[{"Name":"acct_number","Path":"$.number"}]}}]} the Account Details document will be included twice in the output. Within the Account Details document Content that references act_number within the first copy of the document will get the value XK12T-11 tand the second copy will get the value YR15T-01.