Class: ECMFileProperties

ECMFileProperties

The ECM File Properties control displays and allows users to view, change and delete properties associated with an ECM file/document. An ECMFileProperties control provides the following configuration properties in Process Designer:

Content Management Advanced

ECM Server Configuration Name: ECM Server to be used. Default is the Embedded ECM Server. string
Default Document Type: Document type for first use. Defaults to "cmis:document" string

Events

On Load:
Description: This event is triggered when the control is loaded.
Example:
me.getDocumentId()
On Error:
Description: This event is triggered when there is an error within control.
Example:
alert("There has been an error with the conrol")
Context Variables error {object}
On Document Type Changed:
Description: This event is triggered when document type is changed.
Example:
console.log("Document type is changed: "+docType)
Context Variables docType {String}
Article(s)

new ECMFileProperties()

This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

clears value of all properties

getDefaultDocumentTypeId(){String}

returns default document type id of ECM Document Properties
Returns:
Type Description
String

getDocumentId(){String}

returns Document ID of control
Returns:
Type Description
String

getDocumentProperties(){List.<Object>}

returns list of properties
Returns:
Type Description
List.<Object>

getDocumentType/getDocumentTypeId(){String}

returns document type id
Returns:
Type Description
String

getType(){String}

Get descriptive string representing the type of control
Returns:
Type Description
String

setDefaultDocumentTypeId()

sets default document type id for ECM Document Properties
Type Description
String

setDocumentId()

Sets Document ID to fetch properties for document
Type Description
String

setDocumentName()

Sets document name
Type Description
String

setDocumentType/setDocumentTypeId()

Sets document type id
Type Description
String

setPropertiesWithDefaultValues(List)

Sets passed value of property list as default value
Name Type Description
List List.<Object> of properties with default value

setServerConfig()

sets ECM server name
Type Description
String