Properties of a custom service

Configure the properties of a custom service.

The properties of a custom service are grouped under following tabs:

General

Name

A unique name for the custom service, such as Loan Request.

Description

A description for the new custom service, such as “Process of requesting a loan from the bank.”

Type

By default, the process type is displayed as Custom service. You cannot change the type.

Group

The group to which a custom service belongs. A group can be selected from a list of existing groups. See Manage a custom service group

Category

A category to store the custom service. By default, the custom service is stored in the working category of the resource. Once you select the group, the category is automatically updated to the category of the selected custom service group. However, you can again select a different category, if needed.

Note When you expand any of the selectors to select a server variable, resources and web service references, by default, the category of the custom service is displayed instead of the user's working category.

Owner

Owner of the custom service.

Capture

Classification group

A classification group to associate with the custom service to help classify documents.

See Create a classification group for more information.

Extraction mode

The mode of extracting text from PDF. Available options are:

  • All text: Extracts both visible and invisible text (default).

  • Visible text only: Extracts only visible text.

  • Automatic: Extracts only visible text. If results are empty, then extracts by including invisible text in the results.

  • Ignore all text layer: Extracts PDF through OCR and ignores the PDF text layer.

Word separation

The characters to use as word separators. When processing the PDF, text or strings of text containing these characters are treated as separate words. For example, "1234/56" is treated as three separate words, "1234", "/", and "56".

Default characters are: "/", ":", "(", ")", "-" and "#".

Access

Available from and Available to

Allows the custom service to be activated or deactivated on a particular date.

If set, the custom service expires as soon as the active period is over. Otherwise, it remains active. For example, a garment retailer decides to implement a discount scheme for Christmas and creates a custom service map that begins at the start of the season and expires at the end the season.

History, Reporting and execution

Max loop count

Allows you to define the number of times an activity can be executed in a synchronous job or business rule (default: 1000).

Continuous looping in a synchronous job or business rule can cause high workload on the TotalAgility server. Maximum loop count helps in reducing the workload on the TotalAgility server.

When a job is created on a process with custom service, the job creation fails if the permissible loop count is reached. For a process with a business rule node, if the Synchronous and Maximum loop count properties are set for the Business rule node but not on the map containing the Business rule node, the job gets created but gets suspended when the permissible loop count is reached. A note is added to the job to reference the loop count being reached.

Note
  • This property is not available for a case map.

  • By default, the maximum loop count set at the system level is available for all processes. The loop count set at the process level takes precedence over the loop count set at the system level.

.Net assemblies

The .NET assemblies to associate with the custom service so that the it can use external assembly components.

To add a .NET assembly, click Add, select the assembly and click Done. See .NET assemblies for more information.

Maintenance access

A resource with maintenance access permissions for a custom service can add or delete resources or change the access rights of resources to maintain the system depending on the access types.

You can only assign maintenance access to one resource or group.

The maintenance access includes the following access types.

Option Description

Full control

Users with this access type can modify the custom service, and also set and modify access permissions for other users. By default, Everyone group has Full control.

Read write Users with this access type can modify the custom service, but cannot change access permissions.
Read Users with this access type can only view the custom service; they cannot modify the process or set and change access permissions for other users.

Configure maintenance access

  1. Click for Maintenance access.

  2. On the Name list, select the individual or group for whom to set the maintenance access.

  3. On the Type list, select the access type.

  4. Click Add.

  5. Save the custom service.

On release

You can set the custom service that can be used to delay the final release of this process until the changes are reviewed and approved. The process remains in awaiting state pending final release.