Content Services toolkit

The Content Services toolkit (SYSCST) provides views and services for content management and document processing. Some view functions are similar, but you can use these views in different scenarios.

For more information about the view components that are available in the Content Services toolkit, see the content-toolkit External link opens a new window or tab GitHub documentation.

Content list
Content list filter
Content properties
Document thumbnail
Document reference
Document viewer
File drop zone
Get content
Upload content
Property poller
Progress indicator
Summary tile
Search
Manage content
Document and folder modal settings

Content list

The Content list is a general component that you can use to display folder contents, search results, or a list of specific documents. It includes a breadcrumb for folder navigation, a toolbar, menus, and paging controls. When you configure the content list for search results, it can also display a search property filter control at run time. The Content list is built upon the Service Data Table component that comes from the UI toolkit that is delivered with the application development environment in IBM Business Automation Studio.

The Content list provides a general list of content management actions that can be performed on the documents or folders. You can call them either from the Add button on the toolbar or the menu per row. You can add custom actions to both lists. The Content Services toolkit includes many action services that are internally wired up to the content list to provide the data and behavior it must render. These action services make GraphQL calls through the Application Engine server to the Content Engine server. The GraphQL calls return response data in JSON format, which the toolkit components use to render.

Configuration

The Content list component displays a view configurator when you open the Properties dialog to modify the configuration settings. This dialog contains the following categories of settings:

Display options

Affect the way the Content list view renders.

Folder

Select a folder to populate the List view.

Search

Specify query parameters to populate the List view and filter configuration.

Actions

Control the display of the toolbar and menu actions.

Advanced

Specify miscellaneous and document processing options, including the following settings:

Disabled Values: When any of the configured values matches the specified state property value, the actions on a content item are disabled.
Polling exit property values: The polling stops when the document property value (Polling status property) returned from the polling is one of the values that you configured.
Polling negative exit property values: The polling stops when the document property value (Polling status property) returned from the polling is not one of the values that you configured.

Services: Specify the settings for GraphQL service in an IBM® Business Automation Workflow environment.
Viewer: Configure the Viewer component settings. The Viewer is displayed when the View action is run from the context menu.

Content list filter

You can use the Content list filter component to specify property values that filter your search results. Content list filter is part of the Content list component and must be configured within the search settings of Content list. To open the filter, click the funnel icon on the toolbar. You can cancel the current filter, which resets the filter values to the values configured in Content list at design time. You can define default values for filter properties and hide these filter properties on the runtime UI. By configuring these properties, you can ensure that the user cannot change certain search parameters.

Configuration

Configure the Content list filter settings within the Content list settings. Select the Enable search filter checkbox to enable the Content list filter.

You can configure the Content list filter settings in many ways.

Add multiple filter properties.
Add a default value to filter properties that are then used when users run a search.
Specify multiple default values for a single property. Separate the default values with a semicolon.
Hide filter properties. Define default values for the filter properties that you want to hide.

Content properties

You can use the Content properties component to display and edit content properties. It displays the custom properties that are assigned to the class type of the object being investigated. This component uses a vertical display for the list of properties with the labels before the values, which is intended for taller vertical areas, and is typically displayed to the right of the Content list. During the design of your application, you can configure whether to allow the user to edit the properties. If you do allow it, the application displays the appropriate buttons on the toolbar at the beginning of the component. In edit mode, the property picker controls recognize the data type of the properties and present the appropriate picker and validation logic, and you can see all properties that you can edit. In read-only mode, the property list displays only properties with values to minimize the display area.

To set up the loading of the Content properties component with the selection of an item from the Content list, both the Content list and the Content properties list must specify a binding. The binding must specify a CSContentItem object as the source in both components. At run time, when a user selects a row in the list view, the Content properties list picks up the new selection and load itself with the appropriate data. In addition, if the user edits the property values and saves the changes, the Content list picks up the new values and refreshes the row (column properties) with the new values.

Configuration: The Content Properties component has a view configurator that is implemented for its configuration settings. The view configurator contains basic settings such as an option to display buttons for editing property values, or an option to include a time picker for date and time values.

Document thumbnail

You can use the Document thumbnail component to display document thumbnail images. The images are generated by the thumbnail AddOn in the repository. Because it is an asynchronous process, if you do not configure this component or if a thumbnail is not yet generated, the MIME type icon for the document is displayed instead. In a typical scenario, you would position the Document thumbnail component to the right of the Content list view and before the Content properties list. This orientation gives the application a standard content management display and a general feature set.

Configuration: Configure the Document thumbnail component to bind it to the CSContentItem object. With this configuration, the component can react to the row selection of the Content list view and change its display based on the item that is selected.
The document thumbnail has a single configuration option to set the repository.

Document reference

You can use the Document reference component to display either document thumbnail images or document file names. The document thumbnail images are generated by the thumbnail AddOn in the repository. You can add a document and configure Document reference to provide the complete set of content management actions. You can also customize Document reference to add custom context menu actions.

Configuration: You can enable Document reference to add documents with or without the Content properties UI. Without Content properties, the specified document type is used. Use Enable actions to enable content management actions at run time. Select Enable title click menu action to perform the first action on the context menu, which by default is viewing the document.; Configure the Viewer component settings. The Viewer is displayed when View action is run from the context menu.

Document viewer

You can use the Document viewer component to display documents that are stored in the Content engine repository. Run the application page hosting Document viewer from an application that is accessed through an IBM Business Automation Navigator desktop.

Notes:

Document viewer cannot run in Business Automation Studio Preview mode.
Document viewer cannot load documents outside the repository, including documents on your local file system.

Configuration

Along with the standard object store setting, the Document viewer component contains the following configuration options:

Document ID

Dynamically link Document ID to an application variable of a document that you want to load in the Document viewer at run time.

Width and Height

Change the default width and height (600 px by 480 px) to match the application page design.

Features

Configure miscellaneous settings, including the following settings:

ICN repository: When the Business Automation Navigator desktop that is specified for the application has multiple ICN repositories, the Document viewer URL must specify this repository instead of the object store setting.
Show title bar: Controls the display of the Business Automation Navigator title bar.
Show banner: Controls the display of the Document viewer banner bar.

File drop zone

You can use the File drop zone component to add documents to the repository. This component does not display the standard Add Document user interface element and adds a document by using the setup that is in the configuration settings. In addition, it automatically uses the file name as the Document Title property value when you add a document. The File drop zone component supports both adding documents by dragging it or by opening the local file selection control to select it from the local file system. This component also supports both single selection or multi-selection to add a document.

You can configure this component to specify a folder that all the documents are added to. If you do not specify a folder, all documents are added to the root folder. You can also specify a default document class type to use when you add the document. If you do not specify the class type, the base Document class is used.

Note: You cannot drag emails from third-party email clients to the File drop zone. To add email files to the repository, export the emails from the email client to your local drive and drag the exported files from your local drive to the File drop zone.

Configuration: The File drop zone component does not have a view configurator for its configuration settings, and you must open the Properties dialog and select the Configuration tab to see them. You can specify a folder where the user adds documents at run time. You can specify this setting as a specific folder ID (GUID) or a folder at run time. You can also specify a document class type to use at, and here you must specify the class type ID.

Get content

You can use the Get content component to retrieve document content from the repository. You can reference it with JavaScript and it sends out an event when the content is retrieved from the server.

Configuration: The Get content component contains one configuration option which is for the repository and you can configure this setting in the Properties dialog.

Upload content

You can use the Upload content component to upload document content to the repository. You can reference it with JavaScript and it sends out an event when the content is uploaded to the repository.

Configuration: The Upload content component contains one configuration option which is for the repository and you can configure this setting in the Properties dialog.

Property poller

You can use the Property poller component to periodically retrieve property information from the repository and update the view with these new values. Property poller is part of the Content list component.

Configuration: Configure the Property poller in the Advanced section of the Content list component. You can enable property polling and select a property to use as the control property for the poller. Specify a polling interval that determines how often new data is retrieved. Also specify when the poller must stop polling.

Progress indicator

Use the Progress indicator to check the current progress of the documents being added to the repository and being processed by the content analyzer. Progress indicator is part of the Content list component. When you add a document in the Content list, the progress indicator automatically displays the status of document processing.

Configuration: Enable Progress indicator in the Advanced section of the Content list component.

Summary tile

You can use the Summary title component to display summary information. When an end user clicks this tile, it fires an event that can be handled and which starts your custom JavaScript, for instance a page navigation event. You can set the Summary tile and details text string in the configuration settings or dynamically with a JavaScript API. In this case, more information can be retrieved first, for instance, the search counts to be included as part of the details string.

The Summary tile component also includes an optional Info tooltip that you can configure to display help text and a link to external documentation.

Configuration: The Summary tile component does not have a view configurator that is created for its configuration settings, and you must open the Properties dialog and select the Configuration tab to see the settings. You can specify title and details text and whether to include the help icon. If the help icon is configured, you can include more help text and a help link.

Search

You can use the Search component to run searches and obtain search results. The component fires an event when the search results are returned, which can be used to send results to other component views.

Manage content

You can use the Manage content component to view the properties of a document and to file it in a specified folder. You can reference it with JavaScript and it sends out an event when the specified action is completed successfully.

Document and folder modal settings

Use the following views to configure the settings to add or edit documents and folders:

Add document modal: You can use the Add document modal component to add documents and to set custom properties on a selected document type. Specify the document classes and accepted file types to restrict the type of documents that the user can add.
Add folder modal: You can use the Add folder modal component to add folders and to set custom properties on a selected folder class. Configure the Folder classes settings to restrict the class of folders that the user can add.
Delete object modal: You can use the Delete object modal component to delete documents and folders.
Edit properties modal: You can use the Edit properties modal component to edit class properties. You can configure whether to display time when users edit date properties.
Upload version modal: You can use the Upload version modal component to allow users to upload a newer version of a document.
List annotations modal: You can use the List annotations modal component to display a list of all the annotations associated with a document. You can also download individual annotations.
List versions modal: You can use the List versions modal component to display the version list of a document. You can also download individual versions of a document.
Rename folder modal: You can use the Rename folder modal component to allow users to rename an existing folder.
File document modal: You can use the File document modal component to allow users to add a document to a folder. This component checks the access permissions of the user to the selected folder.
Move document modal: You can use the Move document modal component to allow users to move a document to a folder. This component checks the access permissions of the user to the selected folder.
Unfile document modal: You can use the Unfile document modal component to allow users to remove a document from a folder. The document is removed from only the folder and not from the repository.
Select object modal: You can use the Select object modal component to allow users to search for a document to select from a repository. Users cannot select the document from the local file system.