ECMFileProperties

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 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");

clear()

Clears the value of all properties.

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();

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 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

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.

Name Type Default Description

id {string} The document type ID.

setDocumentId(id)

Sets the document ID for which to retrieve property values.

Name Type Default Description

id {string} The document ID.

setDocumentName(name)

Sets the document name.

Name Type Default Description

name {string} The document name.

setDocumentTypeId(id)

Sets the document type ID for which to retrieve property definitions.

Name Type Default Description

id {string} The document type ID.

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);

setPropertiesWithDefaultValues(defaultPropertyValueList)

Sets the default values for the given list of properties.

Name Type Default Description

defaultPropertyValueList {Object[]} The list of properties with the default value.

setServerConfig(serverName)

Sets the 'ECM server configuration name' option.

Name Type Default Description

serverName {string} The server name.

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