Partitioning

Click the Operational Settings > Partitioning tab to configure the calculation of the partition key of different ImageMaster database realms. The actual mapping of a key to a database partition is not defined in the administration panel. For related details on this topic, see [SM Partitioning].

Figure 40: System – operational settings: partitioning

To configure partitioning:

  • Select one or several realms by selecting the corresponding boxes. The following options are available:

    • Standard: covers all records that are not defined explicitly in another setting

      This realm definition is mandatory! The default of the partitioning configuration is a “Constant Value” policy for the standard realm, using the 0 value.

    • Audit: covers audit trail records

    • Folder: covers records which are associated with registers in an ImageMaster file structure (see chapter File structure)

    • Document Types: defines specific policies for document types

  • Select one of the supported policies from the Policy list and specify the parameter. The supported policies and their parameters are described in table Operational settings – partitioning policy parameters below.

  • If the Document Types realm is selected, additionally perform the following actions:

    • Select one of the document types from the list. You can add a document type by clicking Add Document Type. The “Add Document Type” dialog will be displayed:

    • Select one of the document types from the list and click Ok. The newly created document type will be displayed in the list.

    • To remove a document type, select the document type to be deleted and click Remove Document Type. Confirm the deletion in the dialog.

    • For the Document Types realm, an additional Attribute policy is available. If this policy is selected, specify the following parameters:

    • Attribute: select one of the attributes from the list. You can add or remove attributes using Add Attribute / Remove Attribute. (If you add more attributes, their values will be concatenated in the given order.)

    • Filter Expression: a regular expression (see chapter Support of regular expressions) which is used as a filter to determine if the partitioning applies, and which part of the attribute value is extracted as a partition key

    • Replacement Expression: a regular expression (see chapter Support of regular expressions) replacement string, which transforms the extracted attribute value part based on the filter expression into a desired key

  • Optionally select Enable Query Optimizer, which can speed up queries based on partition keys.1

  • For an example of a regular filter and replacement expression as well as background information on the query optimizer, see the partitioning system manual [SM Partitioning].

  • Click Show Physical Partition Mapping to open a dialog showing the XML configuration. You can copy the XML snippet by pressing Ctrl + C (the dialog will be closed automatically in this case) or click Ok to close the window.

  • When the configuration settings have been completed, click Save.

The description of the parameters for the policy configuration is presented in the table below:

Policy

Parameter

Default Value

Comment

Constant Value

Value

0

A constant value is used as a key.

Random Value

Length

10

A random string of the given length is used as a key.

Tenant ID

N/A

N/A

The tenant ID is used as a key.

Tenant Name

N/A

N/A

The tenant name is used as a key.

UUID

N/A

N/A

The object's UUID is used as a key (documentId, folderId or auditId).

Creation Time

Format

N/A

The creation time in one of the following formats is used as a key:

  • YYYY (year)

  • YYYYMM (year and month)

  • YYYYWW (year and week)

  • YYYYMMdd (year, month, day)

  • YYYMMddHHmmssSSS (full date and time)

Attribute

A list of attributes in combination with filter and replacement expressions

 

This is only valid for document type realm. The key is extracted from the attribute value which can be transformed with regular expressions (see chapter Support of regular expressions).

Table 10: Operational settings – partitioning policy parameters