Show TOC

EPMDocumentListLocate this document in the navigation structure

Applies to: Planning and Consolidation connections.

This function opens the Planning and Consolidation Documents view and retrieves a filtered list of documents. You can then double-click a document in the list to open it.
Note
  • Make sure that double-click actions are enabled (the Enable Double-Click option must be selected in Start of the navigation path EPM Next navigation step Options Next navigation step User Options End of the navigation path).
  • If the cell on which you double-click is merged with other cells, the double-click will not function.
Parameter Description
modelName Name of the model. If not specified, the model for the active connection is taken into account.
docType Optional. The document type assigned to the documents. If left blank, the system returns all document types.
docSubType Optional. The sub-type assigned to the documents. If left blank, the system returns all document subtypes.
docDescription Optional. The description of the document.
startDate A starting date from which to search the Documents list for the document. The format must be the one that is selected in your local settings. For example: mm-dd-yyyy.
endDate An ending date to which to search the Documents list for the document. The format must be the one that is selected in your local settings. For example: mm-dd-yyyy.
sortField Criteria on which you want to sort the documents. 0=title; 1=type; 2=sub-type; 3=model; 4=date. Optional.
sortOrder Sorting order. 0=ascending; 1=descending. Optional.
targetWindow Where in the web browser to display a document. Three possible values: "0"=same tab (default); "1"=new tab in the same window; "2"=new window. Optional.
displayedText Text in the cell to double-click on. Optional. If not specified, the following text appears: "View Documents".