Processing: Stack Organizer

While indexing and restructuring of documents is usually automated, the Stack Organizer allows the user to manually index and restructure document batches that have been read in any way. Restructuring involves separating, linking, and deleting documents, file attachments, and individual pages within the file attachments.

The "Office+ Index Client" web application (see WebserviceIndexClient) in this context, the Index Client is not used to capture new documents, but to perform post-processing of existing documents.

The Stack Organizer is an optional function that can be activated; it is integrated into the "Process" step. If the function is activated, the Stack Organizer is executed as the last sub-step (i.e., after all index data has been extracted and all macro functions have been executed). The user can then edit the prepared batch.

In contrast to the standard operation of the "Process" step, the batch is used here in its entirety. A batch is not ready for transfer to the Stack Organizer until all the documents it contains have passed through the preceding "Process" sub-steps. The status value "WaitingFetch" indicates that a batch is waiting to be picked up by a user. The status value "WaitingReturn" indicates that a batch is waiting to be returned by the user after processing has been completed.

Editing Batches

A batch in the Stack Organizer can only be edited by the first user to open it. As long as the batch is being edited, it is locked for editing by other users. The purpose of this internal locking mechanism is to prevent parallel editing; it is only functional if user authentication against the web application is active. The name of the user who locks the editing of a batch is saved as metadata; it can be viewed in the batch properties in the Status Monitor.

You can use the global macro function ResetStackOrgBatches() to define the reset interval between the "WaitingReturn" status and the "WaitingFetch" status. This function makes batches available again when they have been locked by a user for a long period of time, so that they can be processed by other users.

Assignment of Index Values

The bidirectional assignment of index values between a document and its indexing mask in the Stack Organizer takes place implicitly via identical field names in the field catalog of the scenario and in the definition of the mask. The fields in the mask are pre-assigned with the current index values of the document. These values are then overwritten with the values that were entered in the mask. Only fields with the same name are overwritten. All other fields remain unchanged.

Supported File Formats

The Stack Organizer allows restructuring at page level. Therefore, the Stack Organizer can only process file attachments that have a page-by-page structure. The only file formats supported are the two multipage formats PDF and TIFF. Pages in PDF format and pages in TIFF format can be mixed within a target file. In this case, PDF will be used as the common target format. File attachments in other formats must be converted beforehand. To do this, you can use a file macro.

File attachments in other formats that have not been converted to PDF or TIFF are ignored and will not appear in the Stack Organizer. These file attachments are implicitly passed on to the respective target document unless the user has deleted the whole document.

If a document does not contain any attachments that are relevant for the Stack Organizer, it will not be transferred in its entirety to the Stack Organizer; instead, it will be attached unchanged to the target batch.

Output System "StackOrg"

To ensure that the reference to the original data records in the management database is not lost when restructuring documents in the Stack Organizer, the original batch will remain unchanged. A new batch with the changed structure will be generated for downstream processing. For continued processing of a new batch, the use of a different scenario is recommended.

The "StackOrg" output system uses the metadata returned by the Stack Organizer to temporarily create the restructured batch. The output system then saves it as a new input batch for the target scenario. For more information on this output system, see Output System "StackOrg".

Properties

Property	Description
Process.StackOrg.Activate	Boolean value determining whether the Stack Organizer functionality is activated Call the web user interface of the Stack Organizer via the URL of the Office+ Index Client (see `WebserviceIndexClient`). If multiple Stack Organizer scenarios or the regular Index Client are active in the same program instance, specify the parameter `Scenario=` in the URL. You can then use this parameter to select a scenario. To use the web user interface, the delivery of static web files must also be activated (property WebService.WebRootFolder). Default value: `TRUE`
Process.StackOrg.ConditionMacro	Field macro expression that determines which batches are processed If the Stack Organizer is generally activated, you can decide for each batch whether it should actually be processed in the Stack Organizer. The condition must be formulated in the form of a field macro expression that returns a Boolean value. If no condition is configured, it is implicitly considered fulfilled. Caution The check for a condition is limited to batches that consist of only one document. As the evaluation is carried out document by document, it could otherwise return different results for different documents. In principle, the Stack Organizer only supports the processing of the entire batch as a single unit, not the processing of individual documents in this batch. If processing in the Stack Organizer is linked to a condition, a similar condition must also be defined for the execution of the "StackOrg" output system. Without the data previously generated by the Stack Organizer, this output system is not functional.
Process.StackOrg.Category(%) Process.StackOrg.DisplayName(%) Process.StackOrg.Description(%)	Definition of batch category, display name, and optional description text The batches are displayed with this information in the batch selection list of the Index Client. In order to express the values individually, we recommend having them generated dynamically from field variables. The values of the first document in the batch are used for the field variables. This also applies to subsequent properties that allow the use of variables.
Process.StackOrg.PreviewPageHeight	Height of the thumbnail in pixels The Stack Organizer thumbnail view shows preview images of the page content. The previewed images are generated in advance in the "Process" step for quick display. A user-defined height specification in the web application is ignored in this context. Default value: `200`
Process.StackOrg.DefaultMaskName(%)	Name of an indexing mask (optional) This indexing mask is automatically loaded for the documents in a batch.
Process.StackOrg.DefaultMaskOnly	Boolean value determining whether only a mask specified as `DefaultMaskName` is to be used If this mask is not set as the only one to be used, the user can manually select a different mask. Default value: `TRUE`
Process.StackOrg.FileFilter	Name filter determining the file attachments to be displayed in the Stack Organizer Support is implicitly limited to PDF and TIFF files, but a user-defined filter can be used to further restrict this selection if required. Default value: `.pdf\|.tif\|*.tiff`
Process.StackOrg.IndexMaskFolder* Process.StackOrg.ResourceFolder Process.StackOrg.AllowUser[] Process.StackOrg.AllowGroup[]	Folder path of the mask definitions, folder path of additional resource files and a list of the names and groups of the users or of name of client certificates that have access to the web service These properties are analogous to the properties of the "WebServiceIndexClient" input system (see `WebServiceIndexClient`).
Process.StackOrg.BatchAllowUserMacro Process.StackOrg.BatchAllowGroupMacro	Definition of which specific batches are available to which users and groups (optional) The definition is dynamic in the form of a field macro expression that is executed in the context of the first document in the batch. This expression can return a single text value or an array of text values. The returned values must be user and group names (in the same syntax as for `.AllowUser[]` and `AllowGroup[]`). If the macro is not defined or the return value is empty, no restrictions apply and all users can see all batches.

Property

Description

Process.StackOrg.Activate

Boolean value determining whether the Stack Organizer functionality is activated

Call the web user interface of the Stack Organizer via the URL of the Office+ Index Client (see WebserviceIndexClient). If multiple Stack Organizer scenarios or the regular Index Client are active in the same program instance, specify the parameter Scenario= in the URL. You can then use this parameter to select a scenario.

To use the web user interface, the delivery of static web files must also be activated (property WebService.WebRootFolder).

Default value: TRUE

Process.StackOrg.ConditionMacro

Field macro expression that determines which batches are processed

If the Stack Organizer is generally activated, you can decide for each batch whether it should actually be processed in the Stack Organizer. The condition must be formulated in the form of a field macro expression that returns a Boolean value. If no condition is configured, it is implicitly considered fulfilled.

Caution

The check for a condition is limited to batches that consist of only one document. As the evaluation is carried out document by document, it could otherwise return different results for different documents. In principle, the Stack Organizer only supports the processing of the entire batch as a single unit, not the processing of individual documents in this batch.

If processing in the Stack Organizer is linked to a condition, a similar condition must also be defined for the execution of the "StackOrg" output system. Without the data previously generated by the Stack Organizer, this output system is not functional.

Process.StackOrg.Category*(%)

Process.StackOrg.DisplayName*(%)

Process.StackOrg.Description(%)

Definition of batch category, display name, and optional description text

The batches are displayed with this information in the batch selection list of the Index Client. In order to express the values individually, we recommend having them generated dynamically from field variables. The values of the first document in the batch are used for the field variables. This also applies to subsequent properties that allow the use of variables.

Process.StackOrg.PreviewPageHeight

Height of the thumbnail in pixels

The Stack Organizer thumbnail view shows preview images of the page content. The previewed images are generated in advance in the "Process" step for quick display. A user-defined height specification in the web application is ignored in this context.

Default value: 200

Process.StackOrg.DefaultMaskName(%)

Name of an indexing mask (optional)

This indexing mask is automatically loaded for the documents in a batch.

Process.StackOrg.DefaultMaskOnly

Boolean value determining whether only a mask specified as DefaultMaskName is to be used

If this mask is not set as the only one to be used, the user can manually select a different mask.

Default value: TRUE

Process.StackOrg.FileFilter

Name filter determining the file attachments to be displayed in the Stack Organizer

Support is implicitly limited to PDF and TIFF files, but a user-defined filter can be used to further restrict this selection if required.

Default value: *.pdf|*.tif|*.tiff

Process.StackOrg.IndexMaskFolder*

Process.StackOrg.ResourceFolder

Process.StackOrg.AllowUser[]

Process.StackOrg.AllowGroup[]

Folder path of the mask definitions, folder path of additional resource files and a list of the names and groups of the users or of name of client certificates that have access to the web service

These properties are analogous to the properties of the "WebServiceIndexClient" input system (see WebServiceIndexClient).

Process.StackOrg.BatchAllowUserMacro

Process.StackOrg.BatchAllowGroupMacro

Definition of which specific batches are available to which users and groups (optional)

The definition is dynamic in the form of a field macro expression that is executed in the context of the first document in the batch. This expression can return a single text value or an array of text values. The returned values must be user and group names (in the same syntax as for .AllowUser[] and AllowGroup[]).

If the macro is not defined or the return value is empty, no restrictions apply and all users can see all batches.

In this section:

xSuite Interface Windows Prism 5.x – Online Help