Related Topics
Most objects in Process Director have a unique URL that is specified in the Properties or Options tab of the object's definition. Workspaces and Documents, however, each share a generic URL, and specific Workspaces or documents are identified via a URL parameter, as described below.
Workspaces
Hotlinks can be used to directly access a specific workspace on the system. To access a workspace directly use the following syntax:
https://servername.com/home.aspx?profile=profile_name
Where "servername.com" is the host where Process Director is installed and "profile_name" is the name of the workspace. A user must be a member of the workspace for the page to be displayed.
Documents
Hotlinks can be used to directly access and download documents on the system. You may access a single document, or multiple documents. A number of URL parameters can be used to define how you'd like to access the document(s).
| OPTION | DESCRIPTION |
|---|---|
| Did | The Document ID of the document(s) you wish to download. |
| Path | The Partition path to the document. |
| Zipname | The name of the file to save as a zip file when downloading the document(s). |
| Inline | Setting this parameter to "Inline=1" will open the document in the same window (if it is web viewable). |
| Viewable | Setting this parameter to "Viewable=1" tells the system to open the web viewable version of the document, and is only used when Process Director is creating a web viewable rendition (e.g. PDF). |
| Height | The height in pixels to make the popup window to display the document. |
| Width | The width in pixels to make the popup window to display the document. |
Examples
Download Via URL (Multiple Documents)
https://servername.com/download.aspx?DL=DID1,DID2
Where "servername.com" is the host where Process Director is installed and "DL" is the document ID of the document(s) you wish to download. In the example above, two documents would be downloaded by specifying two Document IDs as URL parameters. The specified documents would be zipped and downloaded in a single ZIP archive.
Open Via Path (Single Document)
https://servername.com/download.aspx?path=/Partition/Folder1/Folder2/document
Where "servername.com" is the host where Process Director is installed and "path" is the Partition path to the document.
Open Inline Option
You can optionally select to view the document inline in the browser, rather than downloading the document, by using the "inline" URL Parameter. This option is useful for files such as images, that can be viewed directly in the browser. For instance:
https://servername.com/download.aspx?path=/Partition/Folder1/Folder2/image.png&inline=1
In this example, the image.png file would be downloaded and displayed in the browser, rather than downloaded to your local file system as a file.
This function is available to end users only through
- Administrators providing the URL to a user;
- Server-side scripting; or
- Client-side JavaScript to construct the URL with the appropriate document IDs, such as from a Knowledge View displayed on a form.
Documentation Feedback and Questions
If you notice some way that this document can be improved, we're happy to hear your suggestions. Similarly, if you can't find an answer you're looking for, ask it via feedback. Simply click on the button below to provide us with your feedback or ask a question. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical issue with Process Director, please open a support ticket.
