About the Document Manager Repository

A repository is a directory containing files that users can access from a document manager portlet.

The repository must contain a file called documents.txt. It can also contain an optional file called user-defaults.txt.

The documents.txt file contains a table that maps users or groups to documents. These users and groups are defined in DiveLine. It also lists available documents and defines other optional attributes. The table is stored as a tab-delimited text file with a header row. For example:

User<tab>Group<tab>Document<tab>Last Updated<tab>Status

James<tab><tab>E:\reports\Q1-final.pdf<tab>09/30/2017 <tab>final

<tab>sales<tab>E:\reports\sales.pdf\<tab>12/04/2017 <tab>current

 

User Group Document Last Updated Status
James   E:\reports\Q3-final.pdf 09/30/2017 final
  Sales E:\reports\sales.pdf 12/04/2017 current

 

When setting up your list of documents, consider the following:

  • The Document column is required.
  • Each row must contain at least one User or Group.
  • All other columns are optional attributes, defined by you.
  • A row cannot contain an entry in both the User and Group columns; it must be one or the other.
  • A row can have an asterisk (*) in the User column to specify that all users can access the document.
  • The tab character cannot be used in an attribute name, attribute value, document file name, user name, or group name.
  • Attribute names cannot contain commas.
  • Each line connects a User or Group to a Document or document source.
  • Each Document entry must be an absolute path to a file or directory, the name of a file stored within the repository directory, or an entire directory.
  • Excel documents must have an xlsx extension.
  • Each row in the table must contain a value for each attribute, even if this value is blank. Use <tab><tab> if needed to ensure that the number of fields in each row is the same (see the second line of the example above).
  • If the Document entry is a directory, it refers to each file in that directory as individual documents. This can be used to specify a group of documents at once or to make a placeholder for a set of documents whose names are not known in advance.
  • The Document Manager Portlet does not search subdirectories of the Document source.
  • Every file in the specified directory will become an accessible Document.
  • The names of the files within the Repository are displayed on a DivePort Page in a customizable table. Set the number of rows and columns, and optional filters.
  • If there are more document names than will fit in the table, multiple pages are produced.
  • For any given repository, all documents have the same list of attribute names, but each Document can have different attribute values. You can assign different attribute values to the same document, depending upon which user is looking at it.
  • User access can be assigned over and above DiveLine access control settings.

The optional user-defaults.txt file specifies default attribute values for each User or Group. This file is important if the initial value of an attribute filter is not All Values. The table is stored as a tab-delimited text file with a header row. For example:

User<tab>Group<tab>Manager

James<tab> <tab>Yes

<tab>Sales<tab>No

 

User Group Manager
James   Yes
  Sales No

 

Consider the following:

  • If the user-defaults.txt file is absent, the default selection is All Values.

  • A row cannot contain an entry in both the User and Group columns; it must be one or the other.
  • A row can have an asterisk (*) in the User column to specify that all users can access the document.

See also Creating a Document Repository.