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 Stardust. This way, folders and documents containing user interface configurations, style settings and correspondence templates can be administered.

As Stardust allows to use federated document repositories as described in chapter Federated Document Repositories in the Concepts part, 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. Some folders only exist in case they have content.

artifacts

In the artifacts folder you can create and upload documents into the folders reserved for style settings like skins, bundles and other content.


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 Business Process Modeler is accessed for the first time. It contains all process models created or imported in the Business Process Modeler.

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 documents pertaining to process instances in folders ordered by the creation date.


Figure: process-instances

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.
  4. To view details about the selected provider, mouse over the info icon Info.

    Provider Details

  5. Specify the Repository ID and the jndiName of the repository.

    Bind Repository Dialog

  6. Click OK to bind the repository or Cancel to close the dialog without binding the repository.

Now a new repository node will be added to the tree.

New Repository
Figure: New repository added to the tree

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.

To make a bound repository the default repository:

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

    Make Default

  2. A confirmation dialog opens to confirm that the selected repository should be made the default repository. Click Yes to make it the default repository or No to close the dialog without making it the default repository.

    Confirmation Dialog

  3. 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

In the Quick Search entry field you have the option to search for documents and folders in the repository. Enter a text string and choose the file in the provided search result drop down list.

Quick Search
Figure: Quick Search

Click on the provided search result drop down list. The folder containing the file will be expanded and the file is highlighted orange shortly.

Quick Search Result
Figure: Quick Search Result

Document and Folder Operations

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.