AX1778
Using the Process Directory page
Using the Process Directory page in the Web Client, users can view the process status for all plan files they have access to within a file group.
This directory is primarily intended to be used when plan files are form-enabled, and the main client for end users is the Web Client. It can also be used with spreadsheet plan files, but in this case you must consider the user experience between the Web Client and the Desktop ClientGeneral term for using either the Excel Client or the Windows Client, both of which are installed to the user's desktop.. For example, if users normally access the Web Client and only use the Desktop Client when they need to open a spreadsheet plan file, then it makes sense to provide users with access to the directory so that users can review process status without needing to launch the Desktop Client. However, if the Desktop Client is the main client for end users, then it may be confusing for users to be directed to the Web Client for this information.
The Process Directory page shows the list of plan files that the user has permission to access for a particular file group, along with information about each plan file's current status in the plan file process.
-
You can customize this page to specify which columns are shown, the initial sort level of the list, and other formatting options.
-
Users who are step owners of one or more plan files can complete the associated process tasks. Administrators and process owners can also complete tasks from this page.
-
Users can use the search box at the top to locate a particular plan file. You can configure which columns are included in the search.
-
Using the View options, users can see all of the plan files they have access to, or just the plan files for their current process tasks. If the file group is an on-demand file group, users can also see all of the plan files where they are the process initiator.
-
Using the Filters panel, users can filter the page by process status, step status, and current owner. You can also optionally provide users with a set of predefined options to filter the list by plan code groupings, using refresh variables.
-
To open the Process Routing page for a particular plan file, users can click the hyperlink in a designated column. In the following example screenshot, the CapitalID column is the designated hyperlink column.
Example Process Directory page
The process details shown on this page are from the designated Plan File Process for the file group, as defined in the file group properties.
If the file group is an on-demand file group, users can also create new on-demand plan files by clicking the plus button in the top right-hand corner. This button uses the Add File Message text, and it only displays if the file group has a designated Add File Form (both as defined in the file group properties). Clicking the button launches the form. This is equivalent to the functionality in the Open Plan Files dialog to create a new on-demand plan file.
For more information on configuring this page, see Configuring display settings for the Process Directory web page. For more information on using this page from an end user perspective, see Viewing process status for all plan files.
Accessing the Process Directory page
There are two ways to access this page:
-
Users can click the totals links in the Process Summary component to be taken to this page. This is the only "built-in" way for users to navigate to the page.
-
Alternatively, you can create a link to the directory page within a custom task pane (either for use in the Desktop Client or as a web navigation task pane), a custom ribbon tab, or an Axiom form.
The Process Directory command can be used in these assets to automatically open the Process Directory page for a file group. When setting up the command, you specify the target file group and whether the directory should be opened in a new window. When the command is used, the appropriate directory page is automatically opened.
It is also possible to manually generate a URL to the directory page and use it as needed. . To create a URL to the Process Directory page for a file group, use the following syntax:
<baseURLtoAxiom>/filegroups/filegroupID/process
For example, if the file group ID is 50, the URL would look as follows:
https://ClientName.axiom.cloud/filegroups/50/process
You can use the GetFileGroupID function to return the ID for a file group. To make the link dynamic, you can use a file group alias in the function. For example:
=GetFileGroupID("Current Budget")
Where Current Budget is the name of a file group alias that always points to the file group for the current budget cycle.