Document Reference
The Document Reference is internal to the Document Explorer view and is not meant to be used standalone. No documentation should be provided for This view since it is not meant to be generally consumable.

Appearance
Table style: The style of the table.
Color style: The color style for the table display.
Width: The width in pixels (px), percent (%), or em units (em). For example: 500px, 20%, 40em. If "px", "%", or "em" is not appended to the numeric value, the value defaults to "px". String

Behavior
Is folder referenced: Is folder referenced Boolean
Is file referenced: Show files for the reference. Boolean
Selection mode: Determines the selectability of table items.
ECM get related folders service: Gets the folder info for the ECM servers listed in the Process Application Settings page.

Content management
Folder path: The folder path of the server 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

Events
On reference created:
Description: This event is fired when a reference for an external folder or document is created. Additional parameter: reference
Example:
console.log("Reference created: "+reference.referenceName)
Context Variables keepOpen {boolean} reference {object} Type Description
Properties id String The identifier of the instance where the reference is created
parentFolderId String The folder ID of the instance where the reference is created
referenceName String The reference name of the folder/document
referenceServerName String The name of the external content management server from where the folder or file is referenced
type String The type of the folder/document
On cancel:
Description: This event is fired when reference creation is cancelled.
Example:
console.log("Reference dialog is closed.")
On error:
Description: This event is triggered when there is an error while creating a reference.
Example:
alert("Creating reference failed")
Context Variables error {Object}
Extends:
com.ibm.bpm.coach.CoachView
Methods:

Inherited addClass(name, [replaced])
Add/replace CSS class(es) for this control
NameTypeDefaultDescription
name{string}CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced{string}CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class.
Example
Button.addClass("green");

filterDocumentsAndFolders(potential)
Filters the documents and folders that are currently loaded in the list based on the specified text.
NameTypeDefaultDescription
potential{string}The filter text.

Inherited getData() Returns: {Object}
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Example
var dec1 = MyDecimal.getData();

getType() Returns: {string}
Returns the descriptive string that represents the control type.

Inherited hide(collapseFlag)
Hide this view/control
NameTypeDefaultDescription
collapseFlag{boolean}Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();

Inherited isBound() Returns: {boolean}
Indicates bound status of control.

Inherited isEnabled() Returns: {boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}
Checks if control label is visible
Example
var labelVisible = MyView.isLabelVisible();

Inherited isValid() Returns: {boolean}
Returns the valid status as last set by the setValid() method.
Example
var valid = MyView.isValid();

Inherited isVisible() Returns: {boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}
Propagates value change of control up through parent views
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);

Inherited recalculate()
Only for formula-enabled views!
Explicitly triggers the re-evaluation of the formula
for this view (if a formula has been specified). If the view is not formula-enabled, recalculate() does nothing.
Example
Text1.recalculate();
//If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time

resetFileFolderSelection()
Clears the selection from the list of folders and documents.

setECMServer(serverName)
Sets the target server name from which to list the folders and documents.
NameTypeDefaultDescription
serverName{string}The server name.

Inherited setEnabled(enabled, required)
Enable/disable this view/control
NameTypeDefaultDescription
enabled{boolean}Enabled/read-only flag (true to enable view, false to disable/make read-only)
required{boolean}Enable/disable required field flag for control
Example
MyView.setEnabled(false); //Make MyView read-only

Inherited setLabelVisible(visible)
Show/hide the label of this view/control
NameTypeDefaultDescription
visible{boolean}Label visibility flag (true to show view label, false to hide)
Example
MyView.setLabelVisible(false);

setReferenceSelection(instanceId, parentFolderId, isFolderReferenceEnabled, isFileReferenceEnabled)
Sets the details for the Document Reference control.
NameTypeDefaultDescription
instanceId{string}The process instance ID for which the reference will be created.
parentFolderId{string}The ID of the parent folder where the reference will be created.
isFolderReferenceEnabled{boolean}Enables the use of folder references (when 'true').
isFileReferenceEnabled{boolean}Enables the use of document references (when 'true').

Inherited setValid(valid, errorText)
Flag this view/control as valid or invalid
NameTypeDefaultDescription
valid{boolean}Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)
errorText{string}Validation error text to show on the invalid-styled view
Example
MyView.setValid(false, "Please fix your data entry"); //Make MyView invalid

Inherited setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.

Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options
NameTypeDefaultDescription
data{Object}Value of bound data. The type of this parameter must match the type of the bound data.
createPseudoBinding{boolean}If set to true, creates a pseudo binding if there is no current binding.
Example
MyView.setViewData("TEST"); //Updates bound data to the string 'TEST'

Inherited setVisible(visible, collapse)
Show/hide this view/control
NameTypeDefaultDescription
visible{boolean}Visibility flag (true to show view, false to hide)
collapse{boolean}Set to true to collapse the control space when visible is set to false.
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"

Inherited show()
Show this view/control
Example
MyView.show();

Inherited triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();