Document Explorer

Integrating with an Enterprise Content Management server

To integrate the Document Explorer view with an Enterprise Content Management (ECM) server, the process application must have a connection to that server. See Adding an Enterprise Content Management (ECM) server. For information about building ECM services, see Building a service that integrates with an ECM system or a BPM store. For additional information, see the topics under Enabling document support.

Restrictions

This view supports only the Required, Hidden, and None visibility properties.

Data binding

Configuration properties

The content management configuration properties for the Document Explorer view are shown in the following table:

The content management advanced configuration properties for the Document Explorer view are shown in the following table:

The behavior configuration properties for the Document Explorer view are shown in the following table:

The appearance configuration properties for the Document Explorer view are shown in the following table:

Events

• On load: Activated when the view is loaded. For example,

  me.getRecordCount();

• On document clicked: Activated when a file is clicked. For example,

  console.log(doc.fileName)

  • To view documents for an upgraded solution by using custom view, update the On document clicked event with the following script:

    var isCaseClient = ${GetIsCaseClient}.getValue();
    
    if(isCaseClient == true) {
    	// This would open the document in Navigator viewer only for Case Client.
    	var docObject = {};
    	var frameURL= null;
    	var CaseClientTabID = null;
    	if(doc.id.includes("idd_")){
    		docObject.id = doc.id.split("_")[1];
    	}
    	frameURL=window.location.href;
    	if(frameURL.includes('tw.local.caseDetailsClientTabID')){
    		windowURL= frameURL.split('&tw.local.caseDetailsClientTabID=');
    		caseClientTabID= windowURL[1].split('&');
    		docObject.pageId = caseClientTabID[0];
    	}
    	docObject.caseAction = "documentClicked";
    	this.context.broadcastMessage (docObject);
    }
    else {
    	// This would open the document in native browser for browser supported mime types
    	window.open(doc.url, '_blank')
    }
    

  • If a process page that contains the Document Explorer view is accessed from Case Client, update the following script on the On document clicked event:

    var docObject = {};
        var frameURL= null;
        var zTaskId = null;
        if(doc.id.includes("idd_")){
            docObject.id = doc.id.split("_")[1];
        }
        frameURL=window.location.href;
        if(frameURL.includes('zTaskId')){
            windowURL= frameURL.split('&zTaskId=');
            zTaskId= windowURL[1].split('&');
            docObject.taskId = zTaskId[0];
        }
        docObject.taskAction = "documentClicked";
        this.context.broadcastMessage (docObject);

• On folder clicked: Activated when a folder is clicked. For example,

  console.log("Folder clicked: "+folder.name)

• On delete: Activated when a document or folder is deleted. For example,

  console.log("Object is deleted: "+record.name)

• On refreshed: Activated when the view is refreshed. For example,

  console.log("List refreshed")

• On error: Activated when there is an error while running operations in the view. For example,

  console.log("There has been an error with the operation : "+error.action)

• On folder rename: Activated when a folder is renamed. For example,

  console.log("Folder Renamed: "+folder.name);

• On remove from folder: Activated when an ECM folder or document reference is removed from a BPM folder. For example,

  console.log("Object removed from BPM : "+record.name)

• On document upload complete: Activated when a document is uploaded. For example,

  console.log("Uploaded document ID : "+documentId)

• On reference created: Activated when a reference to an external folder or document is created. For example,

  console.log("Reference created : "+reference.referenceName)

• On custom view: Activated when a document is clicked or the View menu option on the document is clicked. Enables customization to view documents in a custom document viewer using a custom script. This event is enabled when 'Enable on custom view' and 'View clicked document' configuration options are selected. Additional parameter: doc.
  For example,

  // This would open the document in Navigator viewer only for Case Client.
  var docObject = {};
  if(doc.id.includes("idd_")){
    docObject.id = doc.id.split("_")[1];
  }
  docObject.caseAction = "documentClicked";
  this.context.broadcastMessage(docObject);

  • To view documents for an upgraded solution by using custom view, update the On custom view event with the following script:

    var isCaseClient = ${GetIsCaseClient}.getValue();
    
    if(isCaseClient == true) {
    	// This would open the document in Navigator viewer only for Case Client.
    	var docObject = {};
    	var frameURL= null;
    	var CaseClientTabID = null;
    	if(doc.id.includes("idd_")){
    		docObject.id = doc.id.split("_")[1];
    	}
    	frameURL=window.location.href;
    	if(frameURL.includes('tw.local.caseDetailsClientTabID')){
    		windowURL= frameURL.split('&tw.local.caseDetailsClientTabID=');
    		caseClientTabID= windowURL[1].split('&');
    		docObject.pageId = caseClientTabID[0];
    	}
    	docObject.caseAction = "documentClicked";
    	this.context.broadcastMessage (docObject);
    }
    else {
    	// This would open the document in native browser for browser supported mime types
    	window.open(doc.url, '_blank')
    }
    

  • If a process page that contains the Document Explorer view is accessed from Case Client, update the following script on the On custom view event:

    var docObject = {};
        var frameURL= null;
        var zTaskId = null;
        if(doc.id.includes("idd_")){
            docObject.id = doc.id.split("_")[1];
        }
        frameURL=window.location.href;
        if(frameURL.includes('zTaskId')){
            windowURL= frameURL.split('&zTaskId=');
            zTaskId= windowURL[1].split('&');
            docObject.taskId = zTaskId[0];
        }
        docObject.taskAction = "documentClicked";
        this.context.broadcastMessage (docObject);

• On custom action click: Activated when the user clicks a custom action from the overflow menu. You can use it to add custom logic for executing the action triggered by the user's click. Data passed in includes the menu ID defined in the Custom actions configuration option and the metadata for the selected case instance. Also, "data" is passed in as an additional parameter.
  For example, to add a custom action, you can add business execution logic as follows:

  me.handleStandardActions(data);
  if(data.menuId === "customId"){
      // custom action logic
  };
  

Depending on the event, you can use JavaScript logic to modify the effects of the view. For more information about using events with views, see User-defined events.

Methods

For detailed information on the available methods for Document Explorer, see the Document Explorer JavaScript API.

Additional resources

For information about how to create a coach or page, see Building coaches.
For information about standard properties (General, Configuration, Positioning, Visibility, and HTML Attributes), see View properties.
For information about other UI and content management views, see UI toolkit and Content Management toolkit.