Defining a document schema

A document definition is a schema with fields defined in JSON format. You create a document definition to access individual attributes within a metadata object and then use those attributes in an expression for a process. A document definition supports only JSON key value pairs to access attributes, such as a complex object, an array of objects, an array of strings, or nested complex objects.

A document definition defines the communication between two third-party modules. You can define a document definition when you communicate with a third-party module by using custom actions or connectors. The document definition enables you to access the attributes returned by the custom actions or connectors and use these attributes as an input or output within a process.

To create a document definition

1. Log in to BMC Helix Innovation Studio and navigate to the Workspace tab. 
2. Select the application for which you want to add a document definition.
3. On the Documents tab, click New.

4. In the Create Document Definition window, specify the properties for the document definition.
   The following table provides information about the properties: 

   Property	Description
   Document Name	Type a unique name that identifies the document.
   Document Schema	Provide a document schema in JSON format that defines the property structure of the document definition. Example 1: { "status":"" } Example 2: {   "status":"",   "error":{ "errorCode":"", "errorMessage":""    } }
   Scope/Customization Options	To define the scope of the document definition set the following options: (Default) Application/Library—Limits the use of the definition within the same application or library.  Public—Enables the definition to be used by all applications or libraries and allows customization to this definition.

5. Click Save. 

To copy a document definition

You can reuse an existing document definition by copying it within the application or to a different application or library.

1. Log in to BMC Helix Innovation Studio and navigate to the Workspace tab.
2. Select the application or library from which you want to copy the document.
3. Click Documents, select the document definition that you want to copy, and click Copy.

4. In the Copy definition dialog box, enter the following details:

   • From Target application/library, select the target application or library where you want to copy the document.
   • In the Definition name field, type a name for the document definition. 

   

   The copied document is saved in the target application.

Where to go from here