Class: ECMFileRevisions

ECMFileRevisions

The ECM File Revisions control displays (in tabular form) revisions of an ECM file/document given the id of that document. Events can be fired from user actions on the list, such as clicking on a file. An ECMFileRevisions 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

Appearance

Table Style: Style of the table
{Default | Elegant | Bordered | Striped | Hover Row | Condensed}
string
Color Style: Color style for table display
{None | Light | Primary | Info | Success | Warning | Danger}
string
Width: Width in px, %, em For example: 500px, 20%, 40em. If no unit is specified, px is assumed string
Height: Height in px, %, em For example: 500px, 20%, 40em. If no unit is specified, px is assumed string

Events

On Load:
Description: This event is triggered when the control is loaded.
Example:
console.log(me.getVersionCount())
On File Clicked:
Description: This event is triggered when a version of file is clicked.
Example:
window.open(url, '_blank');
Context Variables url {string} doc {object}
Properties id
fileName
versionLabel
url
On Refreshed:
Description: This event is triggered when the control is refreshed.
Example:
console.log("List refreshed")
On Refresh Error:
Description: This event is triggered when there is an error with refresh.
Example:
alert("There has been an error with the refresh")
Article(s)

new ECMFileRevisions()

This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

getRevisionsService(){com.ibm.bpm.coach.CoachView}

Returns the view of the GetAllVersions Service Call
Returns:
Type Description
com.ibm.bpm.coach.CoachView

getServerName(){string}

Returns the view of the GetAllVersions Service Call
Returns:
Type Description
string

getType(){string}

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

getVersionCount(){integer}

Get the number of documents that is in the file list
Returns:
Type Description
integer

queryDocumentVersions(Document)

Fetches all revisions for specified document id
Name Type Description
Document String ID
Refreshes the file list

setTitle/setLabel(Title/label)

Sets title/label of control
Name Type Description
Title/label String of control