Docs/Hosts & resources/Documents
DartRelay 2.5 documentation
Hosts & resources

Documents

Documents let you publish files such as user guides, forms, policies and price lists on the portal, right beside the applications people use. Each document is a resource like a web application: it has an icon, sits in categories, can be starred as a favourite and is shown only to the people you choose. This page explains how to add documents, who sees them and where the files are kept.

What documents are for New in 2.1

People often need a reference beside the application they work in: the expenses policy next to the finance system, a how-to sheet next to a new program, a form they must fill in. Instead of a separate intranet page or an email attachment that goes out of date, you upload the file once in the console and it appears in the portal for the right people.

Before you begin

Add a document

  1. Open Documents. In the console, go to Catalog → Documents. It sits in the Catalog menu after Web Apps.
  2. Add a document. Click the button to add one. The edit page opens.
  3. Give it a title and description. The title is what people see on the card; the description is optional and appears in the Documents list.
  4. Choose the file. Pick the file to upload. When you edit an existing document later, choosing a new file replaces it; leaving the box empty keeps the current one.
  5. Choose an icon (optional). Pick one from the Icon Library. Without one, the card uses the built-in document icon.
  6. Choose categories (optional). Tick the categories the document belongs to. The card appears under each one on the portal. A document with no category appears with the uncategorised resources.
  7. Decide who can see it. Under Who can see it, choose All Authenticated Users, or Only Allowed and pick portal users, portal groups, or Active Directory users and groups.
  8. Keep Show in portal switched on and save. The document appears in the portal straight away. Switch Show in portal off to hide a document without deleting it.

The Documents list shows every document with its file, who can see it, where it is kept and its categories. Use the arrows to change the order in which documents are listed.

Allowed files and limits

ItemRule
File typesDocuments: pdf, txt, rtf, csv, md, doc, docx, xls, xlsx, ppt, pptx, vsdx, odt, ods, odp. Pictures: png, jpg, jpeg, gif, webp, bmp. Media: mp4, webm, mp3. Other: zip, msg, eml.
RefusedWeb pages, SVG pictures, scripts and programs. These could run inside the portal, so they are not accepted.
File sizeUp to 100 MB per file.
Number of documentsUp to 200.

Who sees a document

A person sees a document only when both of these allow it:

  1. The document's own setting under Who can see it.
  2. Its categories. If a document is filed only in restricted categories the person cannot see, they cannot see or open the document either, even from a link.

The same rule applies everywhere the document can be reached: the home page cards, the Documents tab and list, Favourites, and the file's own address.

Where documents are kept

The Where documents are kept card on the Documents page decides where uploaded files are stored.

ChoiceWhen to use it
This server's own folder (default)A single DartRelay server. Files are kept in a documents folder inside the data directory, so they are included when you back up that directory.
A network shareA pool of several servers, or when you want documents on your file server. Enter the share path (for example \\fileserver\share\DartRelay\Documents) and choose how DartRelay connects: as This server's own account (give the DartRelay server's computer account Modify permission on the folder) or as This account with a username and password.
  1. Choose A network share and enter the path and account.
  2. Click Test. DartRelay writes, reads and deletes a small test file to prove it can use the share.
  3. Save. A share that fails the test is refused. When the location changes, DartRelay moves the existing documents to the new place and tells you how many were moved.
Pools need a network share

If several servers are in use and documents are kept in a server's own folder, the card shows a red warning, and each document shows which server holds it. A person whose visit is handled by another server is told the document is kept on a different server. Move documents to a network share to fix this.

One account per file server

Windows allows only one set of credentials per file server for a given connection. If file transfer already connects to the same file server with a different account, use the same account here. See File transfer.

What people see in the portal

A theme can hide the Documents tab or change its icon; the cards on the home page still show. See The Hero panel. The end-user view is described in Opening applications and desktops.

Example: an HR handbook for staff only

A clinic wants its staff handbook and leave form on the portal, but not visible to the contractors who also use it. The administrator creates a category HR, uploads Staff-Handbook.pdf and Leave-Request.docx, files both under HR, and sets Who can see it to Only Allowed with the directory group Clinic Staff. Staff now see an HR tab with both documents: the handbook opens in a browser tab and the form downloads. Contractors see neither, and a link forwarded to them does not open.

If something goes wrong

What you seeCause and fix
The file is refused when uploading.Its type is not on the allowed list, or it is over 100 MB. Save it as PDF, or zip it.
A person cannot see a document they should.Check Who can see it, that Show in portal is on, and that at least one of its categories is visible to them.
"This document can't be opened right now."DartRelay could not read the file: the share is unreachable, its account has lost access, or the file is on another server's own folder. Check the storage card and the log.
Saving a network share is refused.The test failed. Check the path, the account's permission to create and delete files, and that the DartRelay server can reach the file server.
An administrator cannot find Documents in the menu.Their role was created before version 2.1. Grant Documents under System → Admin Roles.
Still stuck? Email support@dartinnovations.com with what you were doing, what you expected and what you saw. A screenshot helps.