OCMS Administration Guide - tsgrp/HPI GitHub Wiki

By default, users in the hpi_administrators group may update OCMS configurations as described below. The administration group can be configured to a different set of groups if needed per implementation.

OCMS Administration

Login to OCMS as an Administrator. Navigate to the admin and visit the following sections:

Application Config

Upon entering the admin, you will automatically be taken to this config. Fill out the sections as directed. Be sure to configure hpi_administrators as an allowed group to the OCMS Admin. Other groups can be added as well depending on your security settings.

Object Type Config

Add all types that will be used in OCMS. Configure labels, filters, and more as needed. Types must be added to the Object Type config before continuing.

Notes:

  • The Object Type Config must contain at least one type for much of the rest of the OCMS admin to work properly. Be sure to configure your types before continuing.
  • Be sure to configure any container types as having Container set to true. Common types that require this setting:
    • Any folder types
    • Active Wizard Page Set Instance (Form Instance) object and any subtypes
  • Available filters include User Display Name, Date, Date Time, Time, Content Size, Mimetype, and Picklist.
    • Date and Date Time filters will honor the application config date format.
    • Picklist filtered values will utilize a single picklist named "OTCFilterPicklist" to filter the value. If the value is not found in the picklist, displays the original value. For example, if you configure the "Picklist" filter on the "objectTypeReadOnly" property, you would be able to format "dm_document" as Document or "tsg:qualityDocument" as "Quality Document" for the end user to see when they are searching, viewing properties, etc. See https://github.com/tsgrp/HPI/issues/1904 for more information.

Other single-file configs

The following config sections are only set up once per OCMS installation. Navigate to the following tabs to configure:

  • Picklists - Add any picklists that will be used throughout the application (optional)
  • Dashboard - Configure dashlets that appear on the Dashboard (optional)
  • Collections - configuration for how collections are displayed in the Collections tab (optional)

Forms

Create forms for the types you would like users to interact with in the Forms tab. You will need forms for items such as Advanced Search, View/Edit Properties, Add Documents, Bulk Edit Properties, etc.

Note that forms can be reused. For example, you may choose to use the same form for View/Edit Properties and Bulk Edit Properties.

Recommended Forms

Forms allow for a broad range of flexibility in OCMS. So much so, that starting from scratch can be daunting unless you are very familiar with configuring OCMS. If you are just starting out with OCMS, TSG recommends creating the following forms:

Form Name Configured Types Notes
createObj{tracName} Any type that can be created using an OCMSform. Examples: Documents, Folders, Notes. This form name should contain a trac name if certain tracs only allow certain types. Or, a generic 'createObject' form could be used across tracs if desired. Active Wizard Form Instances do not need to be configured here since they are not created with an OCMS form. The createObject form should be selected for actions such as: bulkUpload, createFolder, folderNotes.
search{tracName} Any type that can be searched for on the given Trac. Using the typical trac names for the TSG Controlled Document Solution, this would give us two search configs: searchWizard and searchControlledDocs. This form should be selected for the Advanced Search for the given trac.
viewProperties Any type that can utilize the view/edit properties action in OCMS This form should be used for the viewProperties and bulkProperties actions.

Search Config

Configure search, including modules for Advanced Search, Search Results View (Table/Grid/List), Search Facets, etc. Typically search configurations are named the same as the trac name; however, you can apply a search config to multiple tracs.

Table View, Grid View, List View

These modules control how search results are displayed to the user, per object type.

  • Table View - display results in a table. Good for users that are more concerned with metadata
  • Grid View - display results in a grid with a thumbnail along with a few attributes. Good for users that want a thumbnail preview.
  • List View - display results in a vertical list and with a thumbnail (smaller than grid view) along with a few attributes. Often used along with Grid View.

Behavior that can be configured include:

  • Which attributes are displayed to the user
  • Which attributes are returned in the results, but initially hidden to the user (table view only)
  • What should happen when a user clicks on a result
    • Navigate to the OCMS stage
    • Navigate to the OCMS stage in "Wizard" mode (container ID and document ID are the same)
    • Stream the object contents

Additionally, the admin can configure a set of actions that can be executed on a single search result item. Grid and list view present these as an actions button next to each item. Table view present these actions as a right click menu.

Advanced Search

Allows the administrator to configure advanced search forms for each object type in a given trac. Typically, the admin is configuring about 3-5 attributes a primary search criteria, with other attributes as secondary. Secondary attributes appear below the "more fields" button.

Facets

Configure attributes that OCMS will facet on after search results are returned. Currently, this is only supported when the back-end repository is Alfresco.

Group Actions

Configure actions that can be executed on multiple search results at once.

Stage Config

Configure how documents should appear in the OCMS stage. This includes configurations for modules such as Stage Info, Doc Viewer, Folder Tags and Related Objects. As with search configs, stage configs are typically named with the trac name.

Stage Info

Configure the properties that appear for each type in the stage. Can be configured for the folder loaded into the stage, or the document currently in view.

Related Objects

Used to display related documents. This can include:

  • Listing folder contents
  • Displaying folder tags
  • Related objects based on repository relationships
  • Related objects based on a query. For example: When viewing a Policy Folder in the stage, List the Claim Folders that have the same policy_number.

Folder Actions

Configure the available actions on the folder (or Active Wizard form) loaded in the stage.

Doc Viewer

Configure:

  • Which file types should be streamed vs. downloaded in OCMS.
  • Actions that should display above the document when loaded in the stage
  • Whether or not to burn in Annotations when viewing PDFs

Trac Config

Add a trac config for every trac in your application. Select the appropriate search config and stage config that your trac will use.

Types Used In Trac Select the types that this trac will use. This configuration is used so that OCMS knows what trac to put documents on if there is no trac context. OCMS uses the following logic:

  1. If coming from a trac-aware module, the document will be sent to the stage on the context trac. For example, if you search for a document in the 'Engineering' trac, clicking on the document will take you to the document using the Engineering Trac's stage config.
  2. If coming from a non trac-aware module, the document will be sent to the stage on the trac as configured in the trac config. For example, if the user clicks on an Engineering document in the Dashboard or in a Notification, OCMS will look for any trac configs that contain the Engineering document's type in the "Types used in trac" list. If only one trac is found, the user will be taken to the stage for that trac. If the Engineering document's type is found in more than one trac, the user will be given a choice as to what trac to use.

If you would like to limit what users have access to each trac, see this.

Activiti Workflow Config

See the Activiti Workflow Config page for more information

OCMS 2.1

Login to OCMS as an hpi_administrator. Navigate to the admin and:

Create an Application Config

  1. Click the plus sign by the ApplicationConfig link
  2. The name will be 'default' click Create Config
  3. There a several config options, but the most important are ensuring that you add some links to your header bar.

Create an Object type Config

  1. The name of your OTC will associated with all other configs on the same 'trac' if you only have one, it is suggested that you use 'default'
  2. For a basic start, just add the document type and any custom types you wish to show.

Add a search Config

  1. The config name should match the name of the OTC you just created.
  2. Select the types from the list and click add.
  3. Configure at least one of (grid/table/list) and then advanced searched.

Configure Stage

Related Objects Config

Query Based

  • Add a name for your config
  • Select Query based
  • Choose which child types you'd like to display
  • Drag attributes to be displayed in the info box
  • Select sorting information
  • Select search criteria

Relation Based

  • Add a name for your config
  • Select Relation based
  • Drag attributes to be displayed in the info box
  • Select sorting information
  • Enter the relation name or 'children'