This page details the format for the JSON artefact set template definition file.
ArtefactSetTemplate
| Property Name | Data Type | Remarks |
|---|---|---|
| TemplateCode | String | The code that uniquely identifies this set template within the template source |
| TemplateName | String | The name of the set template, for identification of it in the UI |
| TemplateDescription | String | A description of the set template's usage/purpose |
| CategoryCode | String | The code of the set template category into which to place the set template |
| Sequence | string | The sequence of this artefact template in its parent category when shown in a list |
| Properties | Array of ArtefactSetTemplateProperty | The properties available for editing during initial use |
| Batches | Array of ArtefactSetTemplateBatch | The batches used to capture information from the user during use |
ArtefactSetTemplateProperty
Represents a property whose value is to be captured from the user during use of the artefact set template. These properties can be used to override properties on the artefacts being created, or within naming templates used to calculate the default names or values of artefacts being created.
| Property Name | Data Type | Remarks |
|---|---|---|
| PropertyName | String | The name by which this property can be accessed in the artefact set template |
| PropertyFriendlyName | String | The user-friendly name by which this property is known in the DesiGen UI |
| PropertyDescription | String | The description of this property, for display to a user in the DesiGen UI |
| DefaultValueTemplate | String | The template used to calculate the default value for this property when adding a new set of artefacts |
ArtefactSetTemplateBatch
Represents a subgroup of artefacts that are to be created. Use a batch for each set of artefacts that might have a different parent in the destination artefact hierarchy, or may be related to a different data structure.
| Property Name | Data Type | Remarks |
|---|---|---|
| BatchCode | String | The batch code, unique within this template source, by which this batch is recognised |
| BatchName | String | The name of the batch, used for display in the DesiGen UI |
| BatchDescription | String | The description of the batch, used for describing the purpose of this batch in the DesiGen UI |
| RequiresParent | Boolean | Whether the user must select a parent for the artefacts created by this batch |
| RequiresDataStructure | Boolean | Whether the user must select a data structure for the artefacts created by this batch |
| Sequence | string | The sequence of this batch within the wizard when shown in the UI |
| Members | Array of ArtefactSetTemplateBatchMember | The members representing artefacts that will be created by this batch |
ArtefactSetTemplateBatchMember
Represents a single artefact that will be created.
As a hierarchy of artefacts can be created in one go (such as creating a project, within which we are to create multiple item artefacts) this type exposes an array of children of the same type.
| Property Name | Data Type | Remarks |
|---|---|---|
| BatchMemberCode | String | The code for the template source in which the helper type is defined; empty string for this template source |
| CodeGenTemplateSourceCode | String | The code representing the template source within which the required artefact template resides; empty string for this template source |
| ArtefactTemplateCode | String | The code by which the artefact template to use to create this member's artefact is known in the template source |
| ArtefactNameOverrideTemplate | String | The template used to calculate the default name for the artefact that will be created |
| EditDuringCreation | Boolean | Whether to display this artefact for editing during the creation process |
| PropertyOverrides | Array of ArtefactSetTemplateBatchMemberPropertyOverride | The property overrides to perform on the artefact being created |
| Members | Array of ArtefactSetTemplateBatchMember | The members representing artefacts to be created as chldren of the artefact created by this member |
ArtefactSetTemplateBatchMemberPropertyOverride
Represents a property on the artefact being created that is to be overriden during artefact creation.
| Property Name | Data Type | Remarks |
|---|---|---|
| PropertyName | String | The name of the property on the artefact whose default value we are to override during creation |
| DefaultValueTemplate | String | The template used to calculate the value to assign to the artefact's property |