Viewing and Managing Document Repository Resources

Use the Document Repository view to browse the tenant-specific content of the attached Jackrabbit repositories independently of the concrete interpretation of folders and documents for the different purposes in Infinity. This way, folders and documents containing user interface configurations, style settings and correspondence templates can be administered.

As Infinity allows to use federated document repositories as described in chapter Federated Document Repositories in our Concepts Federated Document Repositories in our Concepts documentation, also functionality to manage document repositories is provided in this view. You can bind, unbind and view repositories as well as marking a bound repository as the default repository.

The Document Repository view can be opened from the Administration Perspective launch panel.

Document Repository View
Figure: The Document Repository View

Note:
To enable the usage of the Repository view in an EJB environment without Spring, you need to configure some environment setting for document service usage. Please refer to section Configuration in an EJB Environment without Spring of chapter Managing Resources for details.

Folder Structure

The Repositories folder acts as a container for all bound repositories.

Expanding the Repositories node reveals a node for each bound repository. These can be expanded to navigate the repositories starting from the root.

This root folder tree has the following structure depending on some aspects. Note that some of the described folders only exist in case they have content.

Folders and documents are sorted alphabetically in the tree.

artifacts

In the artifacts folder, you can create and upload documents into the folders reserved for style settings like skins, bundles and other content. The runtime instances of reports, published benchmark definitions, calendars and published rule sets are stored in the runtime folder.


Figure: artifacts

reports

The reports folder contains all reports that were defined or imported.

reports folder
Figure: reports

rules

The rules folder contains all rules that were created or imported in the Rules Management perspective. These rules are stored as JSON files. Refer to chapter Managing Business Rules for details on working with rules.

rules folder
Figure: rules

process-models

The process-models folder is created once the Modeling perspective is accessed for the first time. It contains all process models created or imported in the Modeling perspective.

Process Models folder
Figure: process-models

documents

The documents folder contains correspondence templates as well as global style settings created for the user interface.


Figure: documents

realms

In the realms folder, you find the documents belonging to the individual users ordered by their realm.


Figure: realms

documentTypes

The documentTypes folder is the root node for all Document Type data.


Figure: Document Types

In sub-folder schemas, you find the XSD file for a particular Document Type Schema location, in the following structure:

documentTypes/schemas/<URLEncode(Document Type Schema Location)>/<XSD file>

process-instances

In the process-instances folder you find process attachments, specific documents and correspondence documents pertaining to process instances in folders ordered by the creation date.


Figure: process-instances

activity attachments

Documents uploaded in the checklist panel activity are displayed under the specific activity instance in the activity attachments folder.

process attachments

Documents uploaded in the checklist panel process are displayed under the specific process instance in the process attachments folder.


Figure: activity and process attachments

business-calendars

Calendars are stored as JSON files in the /business-calendars folder in the document repository. The JSON files are stored in separate folders per calendar plugin.

Time-off Calendars are stored in the timeOffCalendar sub-folder that is under /business-calendars/timeOffCalendar. Time-off Calendars are stored with auto-generated file name timeOffCalendar-<uuid>.json. For example, </business-calendars/timeOffCalendar/timeOffCalendar-097fcef5-e725-4c16-b66c-ed4b35418283.json>

Processing Calendars are stored in the processingCalendar sub-folder with a folder hierarchy that includes the modelId, businessObjectID as follows: /business-calendars/processingCalendar/<modelId>/<businessObjectId>. Process calendar JSONs are created on demand whenever the user first opens it. Processing Calendars are stored as <businessObjectInstancePrimaryKey>.json. For example, /business-calendars/processingCalendar/InvestOneCore/Fund/Fund001.json.


Figure: business-calendars

Please refer to chapter Working with Calendars for details on Business Calendars.

benchmark-definitions

The benchmark definitions are stored as JSON files in the /benchmark-definitions folder in the document repository. Benchmark Definitions have the .json file extension and file name as benchmark-definition-<uuid>.json</uuid>. For example, /benchmark-definitions/benchmark-definition-097fcef5-e725-4c16-b66c-ed4b35418283.json

This folder is created dynamically when you save the first benchmark definition in the Design mode from the Benchmark Management view.


Figure: benchmark-definitions

The benchmark-definition folder and its sub-folders are created dynamically at runtime under /artifacts/runtime/<artifactTypeId>/<OID>. Each JSON file is stored in separate folder per published benchmark definition. For example, /artifacts/runtime/benchmark-definition/1/UUID of the published benchmark.


Figure: runtime/benchmark-definition

However, note that these details should not be modified. In case you delete a benchmark (that is in use by an active process instance) from artifacts, an ObjectNotFound exception is thrown on console when trying to load a benchmark that has been deleted.

Binding Repositories

To bind a repository:

  1. Right-click the Repositories node and select Bind Repository from the context menu.

    Bind Repository

  2. The Bind Repository dialog opens.

    Bind Repository Dialog

  3. Select a provider from the Provider drop-down list. All registered providers are available in the list.

    Select Repository Provider

  4. The Capabilities section provides details on the settings for:

    Capabilities

  5. The Repository Settings section provides entry fields depending on the selected Repository Provider.
    For example, for the default JCR 2.0 Provider, the following entry fields are available:

    Bind Repository Dialog

    Please see section Binding the IPP CMIS DMS Provider for details on the according entry fields for a CMIS provider.
  6. Click OK to bind the repository or Cancel to close the dialog without binding the repository.

If the binding was successful, a node for the new repository is added to the tree.

New Repository
Figure: New repository added to the tree

In case the binding fails, an error message dialog opens accordingly with details and the repository is not bound. For example the following error message occurs, if no ID for the repository was provided:

Binding error message
Figure: Binding Repository error message

Binding the IPP CMIS DMS Provider

IPP offers a CMIS DMS Provider, which allows different content management systems to share their information. For details on this provider and how to integrate it in your Web project, please refer to chapter Using the IPP CMIS DMS Provider in the Programming Guide.

If you have selected the CMIS provider, the Repository Settings section opens with CMIS provider related entry fields.

Binding dialog for CMIS Provider
Figure: Binding dialog for CMIS Provider

Unbinding Repositories

In some cases you might like to unbind bound repositories. Documents stored in the repositories that are unbound are no longer accessible. To unbind a repository:

  1. Right-click the bound repository node and select Unbind Repository.

    Unbind Repository

  2. The following confirmation dialog appears:

    Unbinding Confirmation Dialog

  3. Click Yes to confirm to unbind the repository or No to close the dialog without unbinding the repository.

Making a bound Repository the default Repository

At least one default repository must exist, where document calls that do not specify a target repository send the document to. Per default, a default repository System (default) exists, but you can make any bound repository the default repository.

Note
If you make a repository the default repository, this repository should support as many capabilities as possible. At minimum it should provide writing and versioning support. XA support is strongly recommended.

To make a bound repository the default repository:

  1. Right-click the bound repository node and select Make Default.

    Make Default

  2. The default repository is indicated by the term (default) appended to the bound repository node.

    Marked Default

Note that you cannot unbind the default repository. Once a repository is made the default repository, the Unbind Repository option is disabled.

Viewing Repository Details

To obtain details about a repository right-click the a repository node and select Properties.

Repository Properties
Figure: Select Properties to view details

A dialog opens with details as shown below.

Properties details
Figure: Properties details

Quick Search

You have the option to search for documents and folders via the Quick Search entry field at the top of the view. Note that document names may be searched across all repositories (e.g. CMIS or JCR), whereby folder names may only be searched within the default JCR repository. Folder names within secondary JCR repositories and CMIS repositories are not queried and thus will not be part of the result set.

Once you type at least 3 characters in the field, the top 10 matching results for both, folders and documents, are provided in a list.

Quick Search
Figure: Quick Search

If you select one of the matching documents in the list, the corresponding node in the tree is located and expanded. The document is highlighted accordingly.

Quick Search Result
Figure: Quick Search Result

Dragging and Dropping a File to another Folder

You can move files from one folder to another via drag and drop. To move a file to a different folder, click the file, drag it to the other folder and drop it there.

Drag and Drop a File
Figure: Dragging and dropping a file to another folder

Document and Folder Operations

A context menu is available for folders and documents.

Provided Folder Operations

To open the folder menu, right-click on the folder node.

Folder Operations
Figure: Folder Context Menu

The following operations are provided on folders in the Document Repository view:

For detailed information on the listed folder operations, refer to chapter Document Operations.

Provided File Operations

To open the document menu, right-click on the file node.

File Operations
Figure: Document Context Menu

The following operations are provided on documents in the Document Repository view:

For detailed information on the listed document operations, refer to chapter Document Operations.