Cabinet Manager Connector Help

ContentConnector Library

This page provides detailed information on how to use the Cabinet Manager connector. Visit the Managing Connectors for more information on how to manage ContentConnectors.


Description

Dashboards are a great way to present information to different groups of users. Embedding DocScript in the HTML provides the additional advantage of presenting real-time information from the DocuNECT database.

The following table provides a list of DocScript commands that can be used. For advanced templates, DocScript can be embedded with JavaScript/JQUERY and HTML5. The following screenshot shows an example of a graph that is created by a Google Gadget.

Dashboard.bmp

Note, a sample template is available on request.

Command Description
[LastUpdatedDate] Displays the last updated date in the following format: 12/1/2011 11:38:09 AM
[GetSystemStorage]("<Station Name>","<Name of Storage>") This provides a status of a storage location on an assigned station. This information is presented in the following format:
6.26 MB (.06%) used out of an assigned 10 GB
[SystemBatchTotalAll] Provides a count of all batches in the system.
[SystemBatchTotal]("<Cabinet Name>","<Batch Status>") This provides a status of batches in a cabinet, by batch status. If null value indicates all.

For example:

  • [SystemBatchTotal]("Account Payable","Distributed") - Provides a count for all Distributed batches in the Account Payable cabinet
  • [SystemBatchTotal]("","Distributed") - Provides a count for all Distributed batches in the all cabinets
  • [SystemBatchTotal]("Account Payable","") - Provides a count for all batches in the Account Payable cabinet

Note, you can provide the name of any valid cabinet and/or batch status.

[GetCabinetDescription]("<Cabinet Name>") This returns the description of a given cabinet.
[SystemDocumentTotal]("<Cabinet Name>","<Query Filter>") This function provides the total number of documents in a cabinet. A query filter can be provided which allows one or more valid index values and criteria to be specified.

For example:

  • [SystemDocumentTotal]("Accounts Payable","") - Counts all documents in the Accounts Payable cabinet.
  • [SystemDocumentTotal]("Accounts Payable","{Invoice Status} = RECEIVED") - Counts all the documents in the Acocunts Payable cabinet where the Index Status index is equal to RECEIVED.
  • [SystemDocumentTotal]("Accounts Payable","{Invoice Status} = RECEIVED&{Vendor No} = 001") - Counts all the documents in the Acocunts Payable cabinet where the Index Status index is equal to RECEIVED, AND the Vendor No index is equal to 001.
  • [SystemDocumentTotal]("Accounts Payable","{Invoice Status} = RECEIVED|{Invoice Status} = PAID) - Counts all the documents in the Acocunts Payable cabinet where the Index Status index is equal to RECEIVED, OR the Index Status index is equal to PAID.
[LinkToStations] Adds an HTML hyperlink to the stations sub-tab in the administration tab.
[LinkToConnectors] Adds an HTML hyperlink to the connectors sub-tab in the administration tab.
[LinkToRoles] Adds an HTML hyperlink to the roles sub-tab in the administration tab.
[LinkToUsers] Adds an HTML hyperlink to the users sub-tab in the administration tab.
[LinkToStorage] Adds an HTML hyperlink to the storage sub-tab in the administration tab.
[LinkToCabinets] Adds an HTML hyperlink to the cabinets sub-tab in the administration tab.
[LinkToLifecycles] Adds an HTML hyperlink to the lifecycles sub-tab in the administration tab.
[LinkToLogs] Adds an HTML hyperlink to the logs sub-tab in the administration tab.
[LinkToData] Adds an HTML hyperlink to the data tab.
[LinkToBarcodes] Adds an HTML hyperlink to the barcodes tab.
[LinkToInboxMyTasks] Adds an HTML hyperlink to the my tasks sub-tab in the inbox tab.
[LinkToInboxMyRolesTasks] Adds an HTML hyperlink to the my role tasks sub-tab in the inbox tab.
[LinkToInboxMyTaskHistory] Adds an HTML hyperlink to the my task history sub-tab in the inbox tab.
[LinkToInboxMyIndexingTasks] Adds an HTML hyperlink to the my indexing tasks sub-tab in the inbox tab.
[LinkToRecentSearches] Adds an HTML hyperlink to the user's recent searches.
[LinkToCabinet]("<Cabinet Name>", "<Link Mode>") Adds an HTML hyperlink to the cabinet. The link mode specifies whether the link targets the cabinet homepage, or the basic search page.

For example:

  • [LinkToCabinet]("Accounts Payable", "HOMEPAGE") - Links to the homepage of the Accounts Payable cabinet
  • [LinkToCabinet]("Accounts Payable", "BASICSEARCH") - Links tp the basic search page of the Accounts Payable cabinet
[LinkToSearch]("<Cabinet Name>", "<Query Name>") Adds an HTML hyperlink to a specific query within the cabinet.

For example:

  • [LinkToCabinet]("Accounts Payable", "All Invoices") - Links to the All Invoices query in the Accounts Payable cabinet
[LinkToUploadDocuments] Adds an HTML hyperlink to the upload documents tab.
[BuildHTMLCabinetTable]("<Role Name>","<HTML Table Format>","<HTML Table Header>","<Table Mode>","<Display Cabinet Description>) If the <Role Name> is specified then only the cabinets the role has rights to will be returned, otherwise all cabinets will be displayed. The HTML Table Format allows HTML tags defining the format to be specified. HTML tags can also be specified for the table header. The <Table Mode> can either be HOMEPAGE or BASICSEARCH and specifies whether the cabinet name will be hyerplinked to the cabinet in the HTML table. The <Display Cabinet Description> can either be Yes or No and displays the cabinet descriptios in the HTML table.

For example:
[BuildHTMLCabinetTable("","border=&quot;1&quot;
width=&quot;100%&quot; font size=&quot;2&quot; color=&quot;#FFFFFF&quot;", "<tr><td bordercolor="#000088" border="1" bgcolor="#0000AA"></font><font color="#FFFFFF" size="2">Cabinets</font><font size="2"></td><td bordercolor="#000088" border="1" bgcolor="#0000AA"></font><font color="#FFFFFF" size="2">Description</font><font size="2"></td></tr>","HOMEPAGE","Yes")

[BuildHTMLDataTable]("<Role Name>","<HTML Table Format>","<HTML Table Header>","<Table Mode>","<Display Data Table Description>) If the <Role Name> is specified then only the data tables the role has rights to will be returned, otherwise all cabinets will be displayed. The HTML Table Format allows HTML tags defining the format to be specified. HTML tags can also be specified for the table header. The <Table Mode> can either be Yes or No and specifies whether the cabinet name will be hyerplinked to the cabinet in the HTML table. The <Display Data Table Description> can either be Yes or No and displays the cabinet descriptios in the HTML table.

For example:
[BuildHTMLDataTable("","border=&quot;1&quot;
width=&quot;100%&quot; font size=&quot;2&quot; color=&quot;#FFFFFF&quot;", "<tr><td bordercolor="#000088" border="1" bgcolor="#0000AA"></font><font color="#FFFFFF" size="2">Cabinets</font><font size="2"></td><td bordercolor="#000088" border="1" bgcolor="#0000AA"></font><font color="#FFFFFF" size="2">Description</font><font size="2"></td></tr>","Yes","Yes")


License Type

This connector is included with the core purchase of DocuNECT and no additional license is required.


Download Latest Version


Version History

The following table details the connector version history:

Version No Release Date Change History
v1.3 10/31/11
  • Connector released.

Connector Parameters

The following table details the connector parameters:

Parameter Description Example
Template Name There are two ways to provide the HTML template to the Dashboard Manager:
1) A file path to the HTML.
2) If you are using the document management module then you can create a cabinet called Templates that contains an index called Template Name. If the Template Name is not a valid path then it will try and find the templates in the Template cabinet using the Template Name.
File Path: D:\DocuNECT\Dashboard.html
Template Cabinet: Daahboard Template
Template Target You can use the following targets:
ROLE=<Role Name> - Assigns the template to a specific role.
USER=<User Name> - Assigne the template to a specific user.
SYSTEM - Assigns the template to all users in the system.
(&(objectcategory=user))
Email Distribution You can specify that the template be emailed out to the target audience as in an HTML format. Either Yes or No
DocuNECT Server URL This is the URL of the target system which is used to build the hyerlinks. http://<MyServer>/DocuNECTWeb/Production

Additional Notes

Each instance of the connector manages one dashboard target. To manage multiple dashboards, simply add additional instances of this connector.