Document Reference

The Document Reference coach view displays referenced files and folders.

Configuration properties

Set or modify configuration properties for the control, such as behavior and appearance properties, in the Configuration properties tab.

Screen size: A configuration property that has the Screen Sizes icon beside the property name can have different values for each screen size. If you do not set a value, the screen size inherits the value of the next larger screen size as its default value. If you are using the Process Designer desktop editor (deprecated), you are setting the value for the large screen size. The other screen sizes inherit this value.

The content management configuration properties for the Document Reference control are shown in the following table:

Table 1. Content management properties for the Document Reference
Content management property	Description	Data type
Folder path	The folder path of the server name from where the folder or file is referenced.	`String`
Server name	The name of the external content management server from where the folder or file is referenced.	`String`
Parent folder ID	The folder ID of the instance where the reference is created.	`String`
Instance ID	The ID of the instance where the reference is created.	`String`

The behavior configuration properties for the Document Reference control are shown in the following table:

Table 2. Behavior configuration properties for Document Reference
Behavior configuration property	Description	Data type
Is folder referenced	If the property is set to false, folders are not shown for the reference.	`Boolean`
Is file referenced	If the property is set to false, files are not shown for the reference.	`Boolean`
Selection mode	The selection mode for items in the table.	`String`
ECM get related folders service	Gets the folder information for the ECM servers listed in the Process Application Settings page.	`Default Get Related ECM Folders Service`

The appearance configuration properties for the Document Reference control are shown in the following table:

Table 3. Appearance configuration properties for Document Reference
Appearance configuration property	Description	Data type
Table style	The table style for this control.	`String`
Color style	The color style for this control.	`String`
Width	The width of the control. You can specify the width in px (pixels), % (percent), or em units. For example, 50px, 20%, or 0.4em. If a unit type is not specified, px is assumed.	`String`

Events

Set or modify the event handlers for the control in the Events tab. You can set events to be triggered programmatically or when a user interacts with the control. For information about how to define and code events, see User-defined events. The Document Reference control has the following types of event handlers:

On reference created: Activated when a reference is created. For example:
```
console.log("Reference created: "+reference.referenceName
```
On cancel: Activated when a reference creation is canceled. For example:
```
console.log("Reference dialog is closed.")
```
On error: Activated when there is an error while creating a reference. For example:
```
alert("Creating reference failed")
```

Depending on the event, you can use JavaScript logic to modify the effects of the control. For more information about using events with controls, see User-defined events.

Methods

For detailed information on the available methods for Document Reference, see the Document Reference JavaScript API.

Additional resources

For information about how to create a coach, see Building coaches.
For information about standard properties (General, Configuration, Positioning, Visibility, and HTML Attributes), see Coach view properties.
For information about other BPM UI and content management controls, see BPM UI toolkit and Content Management toolkit.