Process Queue | 3.0.2609.0

A process queue is a table view of processes with configured types, columns, filter and sort.

Setup

You can see the feature operation in Demo System.

Filter by title and configuration.

Duplicate an existing queue.

In queue properties have been defined the process types.

Enabling a parent type, like on the screen above, implicitly includes all its children types.

The rest of settings is done in the queue configuration.

Columns

You can see (queue Kernel Process Queue Column) the feature operation in Demo System.

One or more records of the following format:

column.<ID>.title=<TITLE>
column.<ID>.value=<TYPE>
# optional
# do not wrap column value
column.<ID>.nowrap=1
# horizontal align: left, center, right
column.<ID>.align=
# CSS style
column.<ID>.style=
# convert line brakes to HTML <br> tags, to make them visible in the column
column.<ID>.formatToHtml=1
# truncate a column value longer than <MAX_SYMBOLS> characters with link to show the full value
column.<ID>.cutIfMore=<MAX_SYMBOLS>
# truncate a column value longer than <TITLE_IF_MORE> characters, the full value is shown as HTML title popup on mouse hover
column.<ID>.titleIfMore=<TITLE_IF_MORE>
# show the value as URL for HTML link
column.<ID>.showAsLink=<LINK_TITLE>

# different process to take value for
#column.<ID>.process=<TARGET_PROCESS>
# convert the column value text to unsigned int, can be useful for sorting
#column.<ID>.convert=int
# aggregating function
column.<ID>.aggregate=<AGGREGATE_FUNCTION>

Where:

<ID> - unique numeric column ID;
<TITLE> - title;
<TYPE> - the selected value, see the possible variants below;
<MAX_SYMBOLS>, <TITLE_IF_MORE> - maximal not truncated column value text;
<LINK_TITLE> - text for the HTML link, linkUrl - use the column value itself;
<TARGET_PROCESS> - linked the column value has been taken for the parent linked process;
<AGGREGATE_FUNCTION> - aggregating function: SUM, AVG, COUNT.

When an aggregate function is specified for a column, the column header will display the function’s value for all filtered processes in square brackets, in addition to the column name. Only one function is allowed per column.

Using aggregate functions requires an additional query for each process queue table output, which may slow down display performance.

Types

<TYPE> can have the following values:

<TYPE>

what is selected

titleIfMore, cutIfMore

Sorting

process ID with link to open it

Yes

title

Process Title

Yes

type_title

process type title

Yes

status_title

current process status title

Yes

status_pos

position of the current process status

Yes

status_dt

date and time when the current status was set

Yes

status_user

user which set the current status

Yes

status_comment

comment of the current status

Yes

status:<STATUS_IDS>:dt

date and time of the last set status with ID in comma-separated <STATUS_IDS> values

Yes

status:<STATUS_IDS>:user

user of the last set status with ID in comma-separated <STATUS_IDS> values

Yes

status:<STATUS_IDS>:comment

comment of the last set status with ID in comma-separated <STATUS_IDS> values

Yes

priority

the column colors process row with priority background

Yes

Priority number

create_dt

date and time of process creation

Yes

create_user

created process user

Yes

close_dt

date and time of closing process

Yes

close_user

closed process user

Yes

executors:<GROUP_IDS>:<ROLE_IDS>

Comma-separated process executors. Optional suffixes :<GROUP_IDS> and :<ROLE_IDS> allow restriction the executors by comma-separated process execution group and role IDs. For only roles restriction use: executors:*:<ROLE_IDS>

Yes

groups:<ROLE_IDS>

Comma-separated process execution groups. Optional suffix :<ROLE_IDS> restricts those by comma-separated execution role IDs.

Yes

description

process description

Yes

descriptionLink

process description with link opening the process

Yes

param:<PARAM_ID>

Value of process parameter with ID equal to <PARAM_ID>.

For parameters with types date and datetime can be defined the output format.

For parameter with type address param:<PARAM_ID>:quarter or param:<PARAM_ID>:street - for showing only address quarter or street.

Yes

ifListParam:<PARAM_ID>:<VALUE>:<SET_FLAG>:<UNSET_FLAG>

Show <SET_FLAG> if list parameter value with ID <PARAM_ID> is set to <VALUE>, or <UNSET_FLAG> in another case; :<SET_FLAG>:<UNSET_FLAG> are optionally needed, by default are used symbols ✓ and ✗.

the numeric value

messageInCount

quantity of incoming process messages (messages type Note are also counted there too)

Yes

messageInLastDt

creation date and time of the last incoming process message

Yes

messageInUnreadCount

quantity of unread incoming process messages

Yes

messageInLastText

text of the last incoming process message

Yes

messageInLastUser

the user, read the last incoming process message

Yes

messageInLastSubject

subject of the last incoming process message

Yes

messageOutCount

quantity of outgoing process messages

Yes

messageOutLastDt

creation date and time of the last outgoing process message

Yes

messageOutLastText

text of the last outgoing process message

Yes

messageOutLastUser

the user, created the last outgoing process message

Yes

messageOutLastSubject

subject of the last outgoing process message

Yes

message:<TYPE_IDS>:systemId

system_id of process message with comma-separated type IDs <TYPE_IDS>

Yes

You can see (queue Kernel Process Link) the columns' below operation in Demo System.

linkCustomer:param:<PARAM_ID>

value of parameter ID <PARAM_ID> of process linked customer

Yes

linkCustomer:<COLUMN>

value of <COLUMN> in DB table customer for process linked customer: id - ID, title - title

Yes

linkObject:<OBJECT_TYPE_PREFIX>

comma-separated process_link::title with object_type prefix <OBJECT_TYPE_PREFIX>

Yes

linkObject:<OBJECT_TYPE_PREFIX>:id

Comma-separated process_link::id with object_type prefix <OBJECT_TYPE_PREFIX>. Example: linkObject:bgbilling-helpdesk:id - ID of linked topic BGBilling HelpDesk.

Yes

linkCustomerLink

linked customers list with UI open links

linkObject:process

comma-separated list of related child processes with UI open links

linkProcessList:<LINK_TYPE>:<OPEN>:<TYPE_IDS>

ID, type and status of related child processes. Optional settings:

<LINK_TYPE> - process relation type;
<OPEN> - open only open processes;
<TYPE_IDS> - comma-separated process type IDs.

Yes

linkedProcessList:<LINK_TYPE>:<OPEN>:<TYPE_IDS>

ID, type and status of related parent processes. Optional settings:

<LINK_TYPE> - process relation type;
<OPEN> - open only open processes;
<TYPE_IDS> - comma-separated process type IDs.

Yes

linkProcessCount:<LINK_TYPE>:<OPEN>:<TYPE_IDS>

count of related child processes. Optional settings:

<LINK_TYPE> - process relation type;
<OPEN> - open only open processes;
<TYPE_IDS> - comma-separated process type IDs.

Yes

linkedProcessCount:<LINK_TYPE>:<OPEN>:<TYPE_IDS>

count of related parent processes. Optional settings:

<LINK_TYPE> - process relation type;
<OPEN> - open only open processes;
<TYPE_IDS> - comma-separated process type IDs.

Yes

actions

Links or buttons with process actions.

BGBilling [RU]

linkObject:contract:<BILLING_IDS>

List of BGBilling contracts linked to the process. The optional suffix :<BILLING_IDS> specifies comma-separated billing IDs.

For all date and time columns after <TYPE> can be defined :<FORMAT>. As an example, status_dt:dd.MM.yy displays only date with two-digits year.

If a column used not for showing but sorting then instead the format :value suffix should be added. A column can be added two times if its used both for displaying and sorting, the sorting column have to be hidden.

By default all configured queue columns are visible and ordered by ID. That can be changed with configuration record media.html.columns=<COLUMN_IDS>, where <COLUMN_IDS> - comma-separated order of IDs of visible columns. For example:

media.html.columns=1,2,3

Actions

You can see (queue Kernel Process Queue Action) the feature operation in Demo System.

Show actions as buttons:

actionShowMode=buttons

Any of action has been added to the configuration:

# link text or buttons' tooltip
action.{@inc:cnt}.title=<TITLE>
# action logic, see below
action.{@cnt}.doExpression=<EXPRESSION>
# optional
# comma-separated status IDs for displaying the action
action.{@cnt}.statusIds=<STATUS_IDS>
# buttons' text
action.{@cnt}.shortcut=<SHORTCUT>
# html style for button
action.{@cnt}.style=<STYLE>

The <EXPRESSION> contains JEXL expression with action logic.

Previously used commands key must be replaced to doExpression

Example of process queue action configuration:

// PzdcDoc snippet of: 'Configuration of "Kernel Process Queue Action" queue', lines: 13 - 28

actionShowMode=buttons
action.{@inc:cnt}.title=Accept to Progress
action.{@cnt}.shortcut=A
action.{@cnt}.statusIds={@STATUS_OPEN_ID},{@STATUS_WAIT_ID}
action.{@cnt}.style=padding: 0.2em 0.6em;
action.{@cnt}.doExpression=setStatus({@STATUS_PROGRESS_ID});addExecutors({ctxUser.getId()});ui.refreshQueue()
action.{@inc:cnt}.title=Accept to Progress and Open
action.{@cnt}.shortcut=P&O
action.{@cnt}.statusIds={@STATUS_OPEN_ID},{@STATUS_WAIT_ID}
action.{@cnt}.style=padding: 0.2em 0.6em;
action.{@cnt}.doExpression=setStatus({@STATUS_PROGRESS_ID});addExecutors({ctxUser.getId()});ui.open()
action.{@inc:cnt}.title=Back to Open
action.{@cnt}.shortcut=O
action.{@cnt}.statusIds={@STATUS_PROGRESS_ID},{@STATUS_WAIT_ID}
action.{@cnt}.style=padding: 0.2em 0.6em;
action.{@cnt}.doExpression=setStatus({@STATUS_OPEN_ID});deleteExecutors(p.getExecutorIds());ui.refreshQueue()

Check Column

Enabled with:

checkColumn=1

Allows print or export to Excel only selected rows. The column appears without the key, if any processor is used.

Print

For generation PDF print form for the queue, place to the configuration media.print.columns key with comma-separated column IDs, have to be visible. Page orientation for that setup is landscape, all column widths are same, except process description with doubled one.

The print setting may by defined more precisely with configuration blocks:

media.print.{@inc:cnt}.title=<TITLE>
media.print.{@cnt}.columns=<COLUMNS_MAPPING>
# optional
# portrait orientation
#media.print.{@cnt}.orientation=portrait
# file name
#media.print.{@cnt}.fileName=bgerp_process_queue.pdf

Where:

<TITLE> - item title for the queue’s More drop-down;
<COLUMNS_MAPPING> - semicolon-separated pairs <COLUMN_ID>:<WIDTH_PROPORTION>

Here is the configuration sample:

// PzdcDoc snippet of: 'Configuration of "Kernel Process" queue', lines: 34 - 41

# print columns with default widths
media.print.columns=1,17,4,11,19

# fine print configuration
media.print.{@inc:cnt}.title=Print Special
# column width proportion mapping
media.print.{@cnt}.columns=1:2;4:10;9:4
media.print.{@cnt}.orientation=portrait

Export to Excel

To export table data in XLS format, define comma-separated column IDs in media.xls.columns like here:

// PzdcDoc snippet of: 'Configuration of "Kernel Process" queue', lines: 43 - 44

# export to Excel
media.xls.columns=1,17,4,11,19

Expression

You can see (queue Kernel Process Queue Expression) the feature operation in Demo System.

The process table can be customized further by adding the following to the configuration:

rowConfig.{@inc:cnt}.media=html
rowConfig.{@cnt}.expressionHead=<CONFIG_HEAD>
rowConfig.{@cnt}.expressionRow=<CONFIG_ROW>

Where <CONFIG_HEAD> and <CONFIG_ROW> are JEXL expressions that generate the HTML for the table header and data rows, respectively.

The following objects are available in the JEXL context when generating the header:

checkAllLink - a string containing a link to select all rows when using processors in the queue.

When generating a row:

priority - a string containing the color corresponding to the process priority;
col<X> - HTML containing the value of the column with ID <X>.

Example of configuring the table header and rows with expression:

// PzdcDoc snippet of: 'Configuration of "Kernel Process Queue Expression" queue', lines: 1 - 25

column.1.value=id
column.2.value=priority
column.3.value=description
column.4.value=create_user
column.5.value=create_dt

CONFIG_HEAD=<<END
   return "<tr>"
    + "<td>ID</td>"
    + "<td>Description</td>"
    + "<td title='Sample Head Title'>Created [Creator]</td>"
    + "</tr>";
END

CONFIG_ROW=<<END
   return "<tr bgcolor='" + urgColor + "' processId='" + process.getId() + "'>"
     + "<td>" + col1 + "</td>"
     + "<td>" + col3 + "</td>"
     + "<td><b>" + col5 + "</b> [" + col4 + "]" + "</td>"
     + "</tr>";
END

rowConfig.1.media=html
rowConfig.1.expressionHead={@CONFIG_HEAD}
rowConfig.1.expressionRow={@CONFIG_ROW}

The configured queue looks so.

Filters

One or more entries in the following format:

filter.<ID>.type=<TYPE>
# optionally hide the filter
#filter.<ID>.show=0
# additional entries, which vary by filter <TYPE>
filter.<ID>.<KEY_1>=<VALUE_1>
..
filter.<ID>.<KEY_X>=<VALUE_X>

Where:

<ID> - the filter’s unique numeric ID;
<TYPE> - the filter type, the only required key; see the available values below.

The order of filters in the configuration determines the order in which they are displayed.

The table below describes the settings for the different filter types.

<TYPE> value	Filter	Details
type	Process type.	Optional: availableValues - comma-separated process type IDs shown in the filter, in display order; if omitted, all process types are shown; defaultValues - comma-separated process type IDs selected by default; onEmptyValues - comma-separated process type IDs values used if no one was selected.
status_date	Date range when the process was last moved to a status.	Optional: availableValues - comma-separated status IDs shown in the filter, in display order; if omitted, all statuses are shown.
status	Current process status.	Optional: width - filter width in pixels; values - comma-separated hard-defined status IDs; in this case, the filter is useful only when hidden; availableValues - comma-separated status IDs shown in the filter, in display order; if omitted, all statuses are shown; defaultValues - comma-separated status IDs selected by default; onEmptyValues - comma-separated filter values used if no one was selected.
param:<PARAM_ID>	Process parameter with ID <PARAM_ID>.	Supported parameter types: "address", "blob", "date", "datetime", "list", "listcount", "money", and "text". Required: title - filter label. Optional: orEmpty - "1" to include processes with an empty parameter value; for "date(time)" parameters; width - filter width in pixels; for "list" and "address" parameters; values - comma-separated hard-defined value IDs for a "list(count)" parameter; availableValues - comma-separated available values IDs for a "list(count)" parameter; defaultValues - comma-separated "list(count)" parameter value IDs selected by default; onEmptyValues - comma-separated "list(count)" parameter value IDs used if no one was selected; valueFrom - curdate to force the start of the period to the current date; for "date(time)" parameters; valueTo - curdate to force the end of the period to the current date; for "date(time)" parameters; fields - semicolon-separated fields for an "address" parameter; available values: "city;quarter;street;house;flat". The city, street, and house fields are always displayed, regardless of whether they are included in the configuration.
openClose	Open or closed processes.	Comparing to the status filter, this filter can significantly speed up retrieval. Optional: defaultValue - open or close, the default value; values - hard-defined open or close value.
linkedCustomer:title	Substring in the title of the customer linked to the process.	Optional: width - filter width in pixels.
linkedCustomer:param:<PARAM_ID>	Parameter with ID <PARAM_ID> of the customer linked to the process.	Only the "list" type is supported. Required: title - filter label. Optional: width - filter width in pixels; availableValues - comma-separated available value IDs for the "list(count)" parameter; defaultValues - comma-separated "list(count)" parameter value IDs selected by default; onEmptyValues - comma-separated "list(count)" parameter value IDs used if no one was selected.
linkedObject	Process link with all filter values hard-defined.	Parameters: objectTypeMask - SQL LIKE expression for the object type; objectTitleRegExp - SQL REGEXP expression for the linked object’s title; notMode - 1 to find processes without a link.
linkObject	Process link; unlike linkedObject, the user enters the filter values.	Required: title - filter’s title; objectType - type of linked objects; whatFilter - what to filter: id - ID of linked object, title - its title. Example of a filter by BGBilling HelpDesk topic ID: filter.{@inc:cnt}.type=linkObject filter.{@cnt}.objectType=bgbilling-helpdesk:bitel filter.{@cnt}.whatFilter=id filter.{@cnt}.title=HelpDesk topic ID
groups	Groups executing the process, regardless of their roles.	Optional: width - filter width in pixels; availableValues - group IDs shown in the filter, in display order; if omitted, all groups are shown; defaultValues - comma-separated group IDs selected by default; onEmptyValues - filter values used if no one was selected.
grex	Combined filter for process groups and executors.	Filters groups according to their roles in processes. Required: roleId - role ID. Optional: groups.show - 0 to hide the group selector; groups.width - group selector width in pixels; groups.availableValues - comma-separated group IDs shown in the filter, in display order; if omitted, all groups are shown; groups.defaultValues - comma-separated group IDs selected by default; groups.onEmptyValues - comma-separated group IDs used if no one was selected; groups.title - title for the groups selection, for example: Follower Group; executors.show - 0 to hide the executor selector; executors.width - executor selector width in pixels; executors.title - label for the executor selector, for example: Observer.
executors	Process executors.	Does not account for which group the user belongs to. This filter works only together with the groups filter; the executor list shows users who have ever belonged to the groups specified by that filter. Optional: width - filter width in pixels; values - current to show only processes where the current user is an executor; in this case, it is recommended to hide the filter; showEmptyExecutor - "1" to show a "not specified" option in the executor filter and select processes without an executor.
create_user	User who created the process.	The user list includes the current user and other users who belong to the same groups.
close_user	User who closed the process.	The user list includes the current user and other users who belong to the same groups.
description	Substring in the process description.
create_date	Process creation date range.
code	Numeric process code.
close_date	Process closing date range.
message:systemId	Message system ID.

<TYPE> value

Filter

Details

type

Process type.

Optional:

availableValues - comma-separated process type IDs shown in the filter, in display order; if omitted, all process types are shown;
defaultValues - comma-separated process type IDs selected by default;
onEmptyValues - comma-separated process type IDs values used if no one was selected.

status_date

Date range when the process was last moved to a status.

Optional:

availableValues - comma-separated status IDs shown in the filter, in display order; if omitted, all statuses are shown.

status

Current process status.

Optional:

width - filter width in pixels;
values - comma-separated hard-defined status IDs; in this case, the filter is useful only when hidden;
availableValues - comma-separated status IDs shown in the filter, in display order; if omitted, all statuses are shown;
defaultValues - comma-separated status IDs selected by default;
onEmptyValues - comma-separated filter values used if no one was selected.

param:<PARAM_ID>

Process parameter with ID <PARAM_ID>.

Supported parameter types: "address", "blob", "date", "datetime", "list", "listcount", "money", and "text".

Required:

title - filter label.

Optional:

orEmpty - "1" to include processes with an empty parameter value; for "date(time)" parameters;
width - filter width in pixels; for "list" and "address" parameters;
values - comma-separated hard-defined value IDs for a "list(count)" parameter;
availableValues - comma-separated available values IDs for a "list(count)" parameter;
defaultValues - comma-separated "list(count)" parameter value IDs selected by default;
onEmptyValues - comma-separated "list(count)" parameter value IDs used if no one was selected;
valueFrom - curdate to force the start of the period to the current date; for "date(time)" parameters;
valueTo - curdate to force the end of the period to the current date; for "date(time)" parameters;
fields - semicolon-separated fields for an "address" parameter; available values: "city;quarter;street;house;flat". The city, street, and house fields are always displayed, regardless of whether they are included in the configuration.

openClose

Open or closed processes.

Comparing to the status filter, this filter can significantly speed up retrieval.

Optional:

defaultValue - open or close, the default value;
values - hard-defined open or close value.

linkedCustomer:title

Substring in the title of the customer linked to the process.

Optional:

width - filter width in pixels.

linkedCustomer:param:<PARAM_ID>

Parameter with ID <PARAM_ID> of the customer linked to the process.

Only the "list" type is supported.

Required:

title - filter label.

Optional:

width - filter width in pixels;
availableValues - comma-separated available value IDs for the "list(count)" parameter;
defaultValues - comma-separated "list(count)" parameter value IDs selected by default;
onEmptyValues - comma-separated "list(count)" parameter value IDs used if no one was selected.

linkedObject

Process link with all filter values hard-defined.

Parameters:

objectTypeMask - SQL LIKE expression for the object type;
objectTitleRegExp - SQL REGEXP expression for the linked object’s title;
notMode - 1 to find processes without a link.

linkObject

Process link; unlike linkedObject, the user enters the filter values.

Required:

title - filter’s title;
objectType - type of linked objects;
whatFilter - what to filter: id - ID of linked object, title - its title.

Example of a filter by BGBilling HelpDesk topic ID:

filter.{@inc:cnt}.type=linkObject
filter.{@cnt}.objectType=bgbilling-helpdesk:bitel
filter.{@cnt}.whatFilter=id
filter.{@cnt}.title=HelpDesk topic ID

groups

Groups executing the process, regardless of their roles.

Optional:

width - filter width in pixels;
availableValues - group IDs shown in the filter, in display order; if omitted, all groups are shown;
defaultValues - comma-separated group IDs selected by default;
onEmptyValues - filter values used if no one was selected.

grex

Combined filter for process groups and executors.

Filters groups according to their roles in processes.

Required:

roleId - role ID.

Optional:

groups.show - 0 to hide the group selector;
groups.width - group selector width in pixels;
groups.availableValues - comma-separated group IDs shown in the filter, in display order; if omitted, all groups are shown;
groups.defaultValues - comma-separated group IDs selected by default;
groups.onEmptyValues - comma-separated group IDs used if no one was selected;
groups.title - title for the groups selection, for example: Follower Group;
executors.show - 0 to hide the executor selector;
executors.width - executor selector width in pixels;
executors.title - label for the executor selector, for example: Observer.

executors

Process executors.

Does not account for which group the user belongs to. This filter works only together with the groups filter; the executor list shows users who have ever belonged to the groups specified by that filter.

Optional:

width - filter width in pixels;
values - current to show only processes where the current user is an executor; in this case, it is recommended to hide the filter;
showEmptyExecutor - "1" to show a "not specified" option in the executor filter and select processes without an executor.

create_user

User who created the process.

The user list includes the current user and other users who belong to the same groups.

close_user

User who closed the process.

The user list includes the current user and other users who belong to the same groups.

description

Substring in the process description.

create_date

Process creation date range.

code

Numeric process code.

close_date

Process closing date range.

message:systemId

Message system ID.

Example of a status filter with a default value and a restricted set of available values, along with filters for creation date, execution groups, executors, process ID, and closing date.

filter.{@inc:cnt}.type=status
filter.{@cnt}.availableValues=9,10,12
filter.{@cnt}.defaultValues=10

filter.{@inc:cnt}.type=create_date

filter.{@inc:cnt}.type=groups
filter.{@cnt}.defaultValues=17

filter.{@inc:cnt}.type=executors
filter.{@inc:cnt}.type=code
filter.{@inc:cnt}.type=close_date

Sort

Sort modes have been defined using multiple configuration blocks:

sort.mode.<ID>.columnId=<COL_ID>
sort.mode.<ID>.title=<TITLE>
# desceniding
#sort.mode.<ID>.desc=1

Where:

<ID> - unique numeric mode’s ID, starting from 1;
<COL_ID> - the column ID, used in the mode;
<TITLE> - mode’s title for the combobox item;

Amount of sort comboboxes with modes, are configured in this way:

sort.combo.count=<AMOUNT>

For each of the comboboxes can be set a default selected mode:

sort.combo.<COMBO_ID>.default=<DEFAULT_MODE_ID>

Or the fixed one, used as example in Mobile interface:

sort.combo.<COMBO_ID>.value=<FIXED_MODE_ID>

Here is the sample of sort configuration:

// PzdcDoc snippet of: 'Configuration of "Kernel Process" queue', lines: 62 - 73

sort.mode.1.columnId=4
sort.mode.1.title=Description
sort.mode.2.columnId=1
sort.mode.2.title=Created desc
sort.mode.2.desc=1
sort.mode.3.columnId=3
sort.mode.3.title=Priority desc
sort.mode.3.desc=1

sort.combo.count=2
sort.combo.1.default=3
sort.combo.2.default=2

And how does it look like in UI. By default sorting is first performed by descending priority and after by descending creation time.

Processor

You can see the feature operation in Demo System.

Processors are added in the queue configuration with entries of the following form:

processor.{@inc:cnt}.title=<TITLE>
processor.{@cnt}.class=<CLASS>

Where:

<CLASS> - a custom or regular class extending ru.bgcrm.model.process.queue.Processor

Example of processors in the configuration:

processor.{@inc:cnt}.title=Description Prefix (DemoProcessor)
processor.{@cnt}.class=DemoProcessor

DefaultMarkedProcessor

The processor supplied with the system allows some standard process operations to be performed. Processor addition template:

processor.{@inc:cnt}.title=<TITLE>
processor.{@cnt}.class=DefaultMarkedProcessor
processor.{@cnt}.commands=<COMMANDS>
# optional
processor.{@cnt}.openPrintDialog=<PRINT>
processor.{@cnt}.doExpression=<DO_EXPRESSION>

Where:

<COMMANDS> - commands, see below;
<PRINT> - 1 to show the browser print dialog after the print command;
<DO_EXPRESSION> - JEXL script with Standard Process Context.

Supported commands:

setStatus:<STATUS_IDS> - sets one of the statuses whose IDs are listed comma-separated in <STATUS_IDS>;
addExecutors:<GROUP_IDS> - adds executors to the process from groups whose IDs are listed comma-separated in <GROUP_IDS>;
setParam:<PARAM_ID> - sets the process parameter with code <PARAM_ID>; types 'date', 'datetime', and 'list' are supported;
print:<PATTERN_ID> - this command must be the only one in the processor; generates a document of type jspHtml or pdfForm.

The document template for the print command must have scope=processQueue.

Example of processors configuration from the Demo:

// PzdcDoc snippet of: 'Configuration of "Kernel Process" queue', lines: 75 - 90

# processors
processor.{@inc:cnt}.title=Set Status (DefaultMarkedProcessor)
processor.{@cnt}.class=DefaultMarkedProcessor
processor.{@cnt}.commands=setStatus:{@STATUS_OPEN_ID},{@STATUS_PROGRESS_ID},{@STATUS_WAIT_ID}

processor.{@inc:cnt}.title=Delete Processes (DefaultMarkedProcessor)
processor.{@cnt}.class=DefaultMarkedProcessor
processor.{@cnt}.doExpression=delete()

processor.{@inc:cnt}.title=Print Report (DefaultMarkedProcessor)
processor.{@cnt}.class=DefaultMarkedProcessor
# ID 100 comes from configuration of plugin Document
processor.{@cnt}.commands=print:100

processor.{@inc:cnt}.title=Description Prefix (DemoProcessor)
processor.{@cnt}.class=DemoProcessor

Open Interface

For open interface can be defined a special simplified processor, single per queue. As an example of such ones, have a look on Subscription plugin.

Interfaces

showIn=<SHOW_IN>
createAllowedProcessList=<BUTTONS>
allowCreateProcess=<DENY>
openUrl=<OPEN_URL>

Где:

<SHOW_IN> - usermob to make the queue available via mobile interface;
<BUTTONS> - semicolon-separated pairs <PROCESS_TYPE_ID>:<TITLE> for process creation in usermob interface;
<DENY> - 0 disable process creation for user interface;
<OPEN_URL> - the queue available via open interface with URL: <SERVER_URL>/open/process/queue/<OPEN_URL>

Process Link

A process queue can be displayed on an object’s Processes tab, with a filter for that object added automatically. Columns and sort modes with an explicit value can be defined in the queue configuration.

This feature is enabled in the configuration:

<OBJECT_TYPE>.processes.queue=<QUEUE_ID>

Where:

<OBJECT_TYPE> - the type of the linked object, for example customer or contract:<BILLING_ID>;
<QUEUE_ID> - the process queue ID.

Example:

customer.processes.queue=12
contract:bitel.processes.queue=11

Usage

A user can see process queues allowed for him or one of his current groups. When the tool is open the previously queue’s selection is restored in the drop-down list.

The O link left of the queue title means that it is configured to be shown in open interface and can be accessed with the link.

Clicking the plus button within the queue drop-down list turns that queue into a separate quick-access button next to the drop-down list. The button can be moved back into the list by clicking the cross icon on it.

The table shows paged processes with configured filters and order. The output is being refreshed on every switch to the tool from others.

Creation

The first item in the More drop-down menu.

Opens process creation mode with allowed process types.

Print

Following More menu items do configured queue printing. The printed processes can be restricted with checkboxes.

Filter

On the first usage a queue runs with all configured filters in so-called Full mode. A drop-down list is used to manage visible filters. Bold text indicates that a filter contains data, even if the filter itself is hidden. Filters' state can be reset to the default state by choosing Filter / Reset option in the More menu

Right of the filters can be selected configured sorting options. For this case sorting is first performed by descending priority and over equal priorities by descending creation time.

A frequently used set of filter and sort values can be saved using the Filter / Save option in the More menu. Put the wanted Saved filter name in the shown input field.

Number in square braces reflects how many processes match the filter’s criteria.

To switch between Full and Saved filters modes use Filter / Back to Full and Filter / Saved options in the More menu. There are multiple saved filters can be created.

Saved filters can be rearranged by dragging them with the mouse.

Or moved into the Filters drop-down menu to reduce horizontal space.

There is no way to edit existing saved filters, instead you can extract a saved filter to full with More / Filter / Extract to Full option, adjust it and save again. Not more needed saved filters are removed by More / Filter / Delete.

Counter

The number of processes from a saved filter can be displayed as a counter in the notification area. After selection More / Filter / Counter on Panel the color of the counter can be chosen.

The resulting counter has a tooltip with the queue’s and saved filter’s title, clicking it will bring you to the queue with the saved filter. So a user can observe important process numbers from any place of User interface.

Beside that the counters are shown in Mobile interface. To remove the related counter for a saved filter, call More / Filter / Delete Counter from Panel when the filter is active.

Processor

Processors allow batch processing of several selected in a queue processes. For example, changing the status or assigning an executor. They are configured for a queue and displayed in the More menu of the process queue alongside the standard items.

Export to Excel

Configured queue columns can be exported to XSL format for all the processes or only marked with checkboxes.

Actions

The actions are configurable operations, performed over a process in a queue. The list of them is shown in queue column actions as links.

Or buttons.

Process QueueS

BGERP 3.0.2609.0

Setup

Columns

Types

Actions

Check Column

Print

Export to Excel

Expression

Filters

Sort

Processor

DefaultMarkedProcessor

Open Interface

Interfaces

Process Link

Usage

Creation

Print

Filter

Counter

Processor

Export to Excel

Actions