DocumentReference

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 or ID: 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	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 or replace the CSS classes for this view.

Name Type Default Description

name {string} The CSS class names to add to the view. For multiple classes, use space to separate the class names.

replaced {string} The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names.

Example

Button.addClass("green");

filterDocumentsAndFolders(potential)

Filters the documents and folders that are currently loaded in the list based on the specified text.

Name Type Default Description

potential {string} The filter text.

Inherited getData() Returns: {Object}

Retrieve the bound data associated with the view. It applies only to views with bound data.

Example

var dec1 = MyDecimal.getData();

getType() Returns: {string}

Returns the descriptive string that represents the control type.

Inherited hide(collapseFlag)

Hide the view.

Name Type Default Description

collapseFlag {boolean} Set to true to collapse the view (equivalent to a view setting of "NONE")

Example

MyView.hide();

Inherited isBound() Returns: {boolean}

Indicate the bound status of the view.

Inherited isEnabled() Returns: {boolean}

Check whether the view is enabled.

Example

var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}

Check whether the view label is visible.

Example

var labelVisible = MyView.isLabelVisible();

Inherited isValid() Returns: {boolean}

Return the valid status as last set by the setValid() method.

Example

var valid = MyView.isValid();

Inherited isVisible() Returns: {boolean}

Check whether the view is visible.

Example

var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the parent views.

Name Type Default Description

event {Event} Value change event (usually an onchange event)

Example

MyView.propagateUp(event);

Inherited recalculate()

Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was 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.

Name Type Default Description

serverName {string} The server name.

Inherited setEnabled(enabled, required)

Enable or disable the view.

Name Type Default Description

enabled {boolean} Enabled/read-only flag (true to enable view, false to disable/make read-only)

required {boolean} Enable or disable the required field flag for the view.

Example

MyView.setEnabled(false); //Make MyView read-only

Inherited setLabelVisible(visible)

Show or hide the view label.

Name Type Default Description

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.

Name Type Default Description

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 the view as valid or invalid.

Name Type Default Description

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, "Fix your data entry"); //Make MyView invalid

Inherited setViewData(data, createPseudoBinding)

Set or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.

Name Type Default Description

data {Object} The value of the bound data. The parameter type must match the type of the bound data.

createPseudoBinding {boolean} If the value is set to true, the parameter 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 or hide the view.

Name Type Default Description

visible {boolean} Visibility flag (true to show the view, false to hide it)

collapse {boolean} Set it to true to collapse the view space when the option 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.

Example

MyView.show();

Inherited triggerFormulaUpdates([phase])

Broadcast the expression trigger for the specified view.

Name Type Default Description

phase {int} bpmext.ui.PHASE_NORMAL The phase we are currently in

Example

MyView.triggerFormulaUpdates();

Methods

Parent

Helpers