AX1505

Process Summary component for Axiom forms

The Process Summary component can be used to display information about users' current process tasks. The component is automatically filtered to show the tasks for the current user, for a specified plan file process. The goal is to direct the user's attention to their active tasks, and allow the user to easily take action on those tasks.

This component is primarily intended to be used in form-enabled Home files for the Web Client, to provide users with a way to easily see and manage their process tasks in the Web Client. The component could also be used in a form-enabled Home file for the Desktop ClientGeneral term for using either the Excel Client or the Windows Client, both of which are installed to the user's desktop.. However, in this case you may want to disable the Process task pane (or only show it to certain users), so that end users are not confused by having two user interfaces for viewing and completing process tasks.

Component overview

The component displays the following information for the current user, for a specified plan file process:

  • The total number of tasks for the user
  • The number of new tasks for the user (optional)
  • The number of tasks due soon for the user (optional)
  • The number of overdue tasks for the user (optional)

For each of the optional sections, the component displays the plan codes and descriptions for the plan file tasks in that category (up to a maximum number of items). You can also optionally allow users to create new plan files for on-demand file groups from this component.

The following screenshot shows an example component with the major sections and features annotated:

NOTE: The built-in hyperlinks to the process web pages always open in the Web Client (the user's browser), even if the form is open as an embedded web tab in the Desktop Client.

Component properties

You can define the following properties for a Process Summary component.

(missing or bad snippet)(missing or bad snippet)
ItemDescription

Selected Process

Specifies the process to display in this component, based on a selected file group. Click the Choose a plan file process button [...] to select a file group or a file group alias.

The selected file group must have a designated Plan File Process in its file group properties. The Process Summary component will use that process. If the designated process for the file group changes, the component will automatically update to use the new process.

If the selected file group is a file group alias, then the component will use the process for the file group that the alias currently points to. If the alias is changed to point to a different file group, the component will automatically update to use the new file group and its designated process.

In the Form Designer and Form Assistant, the Selected Process field displays the name of the plan file process that it is using, not the name of the selected file group or alias. However, if you look at the corresponding Form Control Sheet entry, the file group is indicated using shortcut syntax such as filegroup://Capital Requests?_tid=110.

Title Text

The title text for the component. This text displays in the title bar for the component within the Axiom form, if the title bar is enabled. If the title bar is disabled, then this text does not display at all in the form.

Show Title Bar

(missing or bad snippet)

Collapse Height

Specifies whether the component automatically collapses in height if the configured component height is greater than the content to be shown in the component.

You should leave this option disabled if you want the component height to always be the same, no matter how much content is available to display. If the content does not fill the component, then there will be blank space between the content and the bottom edge of the component.

If you enable this option, then when the content does not fill the component, the component will auto-shrink to fit the content instead of maintaining its configured height.

The component behavior when the content exceeds the available height is always the same: excess content will be excluded. In practice, this means that the number of plan file tasks in each section will be limited to whatever amount will fit in each section, rather than honoring the maximum tasks per section.

Orientation

Specifies how the sections in the component are presented within the form:

  • Vertical (default): Sections are stacked vertically. The component is tall and thin.
  • Horizontal: Sections are presented side-by-side horizontally. The component is short and wide.

If you do not include any of the optional sections, then the component is essentially a square and the orientation does not matter.

Show new item button

Specifies whether users can create new on-demand plan files from the title bar of the component. By default, this is disabled. If enabled, then a plus icon displays in the title bar. Users can click the plus icon to create a new on-demand plan file in the file group.

The file group is determined based on the specified process for the component. The plus icon only displays if:

  • The file group is an on-demand file group.
  • The file group uses an Add File Form to create new plan files.
  • The current user has the Create New Records permission for the file group.
  • The title bar is enabled for the component.

When a user clicks the plus button, the designated Add File Form opens. The user can use this form as normal to create a new plan file.

Task count text

Defines text for the total tasks section. This section always displays the total number of current tasks for the current user, for the specified process. This section is always included.

By default, this is set to Total. So if a user has 5 current tasks, this section displays the text 5 Total. You can customize the text by entering different text here, but you cannot omit the total count number. Also, the text cannot be omitted entirely—if you make this property blank, the component will display using the text Total by default.

Max tasks per section

Specifies the maximum number of plan file tasks to show per section. By default, this is set to 2.

If a section has active tasks, then the plan file names for those tasks display in the section, up to the maximum number of tasks per section. The plan file tasks display as hyperlinks that can be used to open the Process Routing page for that plan file. For more information, see Using the Process Routing page.

The number of tasks that can be displayed per section depends on the overall height of the component (for either orientation), and on the number of optional sections that are configured to display (when using vertical orientation). The space available for each section is divided equally among the optional sections. If you are using all three sections, each section gets one third of the available height. If the maximum tasks do not fit within the available height, then a lesser number of tasks will display.

Show new tasks

Specifies whether to include a section for new tasks. This option is selected by default, which means that details about new tasks display in the component.

If you disable this option, then the new tasks section does not display in the component.

The number of days that a task is considered new is configured within the process definition. By default, tasks are considered new for 2 days after they are created for the task owner.

New tasks header

Defines header text for the new tasks section. This setting only applies if Show new tasks is enabled.

By default, this is set to {count} New. For example, if the user has two new tasks, the header will display as 2 New. If the user has no new tasks, then the header will display as 0 New.

You can edit this text as desired, but if you want the number of new tasks to display, you must use the variable {count}.

Show tasks due soon

Specifies whether to include a section for tasks that are due soon. This option is selected by default, which means that details about tasks that are almost due display in the component.

If you disable this option, then the due soon section does not display in the component.

The number of days that a task is considered due soon is configured within the process definition. By default, tasks are considered due soon for 2 days until their due date.

Due soon header

Defines header text for the due soon section. This setting only applies if Show tasks due soon is enabled.

By default, this is set to {count} Due Soon. For example, if the user has two tasks that will be due soon, the header will display as 2 Due Soon. If the user has no tasks that will be due soon, then the header will display as 0 Due Soon.

You can edit this text as desired, but if you want the number of new tasks to display, you must use the variable {count}.

Show overdue tasks

Specifies whether to include a section for overdue tasks. This option is selected by default, which means that details about overdue tasks display in the component.

If you disable this option, then the overdue tasks section does not display in the component.

Overdue tasks header

Defines header text for the overdue tasks section. This setting only applies if Show overdue tasks is enabled.

By default, this is set to {count} Overdue. For example, if the user has two tasks that are past their due date, the header will display as 2 Over. If the user has no tasks that are overdue, then the header will display as 0 Overdue.

(missing or bad snippet)(missing or bad snippet)

Currently, the Axiom Financial Institutions Suite platform does not provide any styles specifically designed for Process Summary components. Only the generic styles are available. Most styling for the component is controlled by the form-level skin.

(missing or bad snippet)(missing or bad snippet)