Methods

addClass
clear
getData
getDefaultDocumentTypeId
getDocumentId
getDocumentProperties
getDocumentTypeId
getType
hide
isBound
isEnabled
isLabelVisible
isValid
isVisible
propagateUpValueChange
recalculate
setDefaultDocumentTypeId
setDocumentId
setDocumentName
setDocumentTypeId
setEnabled
setLabelVisible
setPropertiesWithDefaultValues
setServerConfig
setValid
setViewData
setVisible
show
triggerFormulaUpdates

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
ECM File Properties
The ECM File Properties view displays and allows users to view, change and delete properties associated with an ECM file/document.
Content management advanced
ECM server configuration name: The ECM server to use. The default server is the embedded ECM server. String
Default document type: The document type for the first use. The default document type is "cmis:document". String
Default document properties: Select the variable to use for the default properties of the ECM document. When an ECM document is created, the document list contains the default values for the document properties. The values might be read-only or hidden from users when they create the document. ECMDefaultProperty[]
Events
On load:
Description: The logic that is called when the control is loaded. This event is only fired one time for each page load.
Example: 
me.getDocumentId()
On document type changed:
Description: The inline event logic that is called when the document type is changed. Additional parameters passed: docType
Example: 
console.log("Document type is changed: "+docType)
Context Variables docType {string}
On error:
Description: This event is fired when an error occurs during the fetching of properties.
Example: 
alert("There has been an error with the conrol")
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");
clear()
Clears the value of all properties.
Inherited getData() Returns: {Object}
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Example
var dec1 = MyDecimal.getData();
getDefaultDocumentTypeId() Returns: {string}
Returns the default document type ID of ECM Document Properties.
getDocumentId() Returns: {string}
Returns the document ID of the control.
getDocumentProperties() Returns: {Object[]}
Returns the list of properties.
getDocumentTypeId() Returns: {string}
Returns the document type ID that is currently set in the view.
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
setDefaultDocumentTypeId(id)
Sets the default document type ID for which to retrieve property definitions. If a document type ID is not configured, this value is used to populate the property dialog.
NameTypeDefaultDescription
id{string}The document type ID.
setDocumentId(id)
Sets the document ID for which to retrieve property values.
NameTypeDefaultDescription
id{string}The document ID.
setDocumentName(name)
Sets the document name.
NameTypeDefaultDescription
name{string}The document name.
setDocumentTypeId(id)
Sets the document type ID for which to retrieve property definitions.
NameTypeDefaultDescription
id{string}The document type ID.
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);
setPropertiesWithDefaultValues(defaultPropertyValueList)
Sets the default values for the given list of properties.
NameTypeDefaultDescription
defaultPropertyValueList{Object[]}The list of properties with the default value.
setServerConfig(serverName)
Sets the 'ECM server configuration name' option.
NameTypeDefaultDescription
serverName{string}The server name.
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();