If you can't find the product or version you're looking for, visit support.ataccama.com/downloads

Web Console Component

The Web Console component enables the ONE Runtime Server Admin; in addition, it enables custom links (pointing to external servers and/or document folders) in the ONE Runtime Server Admin navigation panel.

To add the component to the online server, the server configuration must contain the following definition:

<component listeners="all" disabled="false" cacheTemplate="true" class="com.ataccama.dqc.web.console.WebConsoleComponent">
    <customMenuCategories/>
    <customMenuItems/>
</component>

A corresponding configuration in the Server Configuration Editor in ONE Desktop:

Property Value Required Description

Property	Value	Required	Description
Cache Template	true	Yes	Enables caching of ONE Runtime Server Admin page templates.
Custom Menu Categories	N/A	No	Specifies custom menu categories. Each custom category corresponds to a section in the ONE Runtime Server Admin navigation panel. Each `customMenuCategories` has the following attributes: Key - Category identification key. Used as a foreign key in the Custom Menu Items element to sort items into categories. Label - Category label displayed in the ONE Runtime Server Admin navigation panel.
Custom Menu Items	N/A	No	Specifies custom menu items (pointing to external servers and/or document folders) in ONE Runtime Server Admin. Each `customMenuItems` has the following attributes: Category Key - Identifies a category under which the item is displayed. Uses a Key defined in the Custom Menu Categories element or a predefined key. Predefined category keys use `wc.menu.group.<category_id>` notation to add an item under an existing ONE Runtime Server Admin section. Possible `category_id` values: `info`, `resources`, `server`, `workflows`. Label - Item label displayed in the ONE Runtime Server Admin navigation panel. Label Key - Predefined key used to retrieve a corresponding item label (displayed in the ONE Runtime Server Admin navigation panel) from the internal `WebMessages.properties` file. This is an expert setting. Label keys are useful when you need to rename the default labels. Label has priority over Label Key: if both are defined, then Label is displayed. Url - Item URL. It can be either absolute or relative to the `<host>:<port>/console/`. The absolute URL must include a protocol.
Listeners	all	No	Comma-separated list of names of HTTP listeners where the console should be accessible. If the attribute is missing, the console is deployed on all listeners.
Required Role	N/A	No	No longer used. To secure the ONE Runtime Server Admin if used as a standalone solution, configure a listener security in HTTP Dispatcher. This property can be used to restrict access to old MDM Admin Center (web application for MDM server) and RDM Admin Center. If specified, only this role can access the Admin Center.

Cache Template

true

Yes

Enables caching of ONE Runtime Server Admin page templates.

Custom Menu Categories

N/A

Specifies custom menu categories. Each custom category corresponds to a section in the ONE Runtime Server Admin navigation panel.

Each customMenuCategories has the following attributes:

Key - Category identification key. Used as a foreign key in the Custom Menu Items element to sort items into categories.
Label - Category label displayed in the ONE Runtime Server Admin navigation panel.

Custom Menu Items

N/A

Specifies custom menu items (pointing to external servers and/or document folders) in ONE Runtime Server Admin.

Each customMenuItems has the following attributes:

Category Key - Identifies a category under which the item is displayed. Uses a Key defined in the Custom Menu Categories element or a predefined key.

Predefined category keys use wc.menu.group.<category_id> notation to add an item under an existing ONE Runtime Server Admin section. Possible category_id values: info, resources, server, workflows.
Label - Item label displayed in the ONE Runtime Server Admin navigation panel.
Label Key - Predefined key used to retrieve a corresponding item label (displayed in the ONE Runtime Server Admin navigation panel) from the internal WebMessages.properties file. This is an expert setting.

Label keys are useful when you need to rename the default labels. Label has priority over Label Key: if both are defined, then Label is displayed.
Url - Item URL. It can be either absolute or relative to the <host>:<port>/console/. The absolute URL must include a protocol.

Listeners

all

Comma-separated list of names of HTTP listeners where the console should be accessible. If the attribute is missing, the console is deployed on all listeners.

Required Role

N/A

No longer used.

To secure the ONE Runtime Server Admin if used as a standalone solution, configure a listener security in HTTP Dispatcher.

This property can be used to restrict access to old MDM Admin Center (web application for MDM server) and RDM Admin Center. If specified, only this role can access the Admin Center.

Custom links configuration example

Custom menu items and categories are configured by the customMenuItems and customMenuCategories+ elements:

<component class="com.ataccama.dqc.web.console.WebConsoleComponent" listeners="all">
    <customMenuCategories>
        <category key="cat1" label="My Category1"/> <!--Creates "My Category1" section in the ONE Runtime Server Admin.-->
        <category key="cat2" label="My Category2"/>
    </customMenuCategories>
    <customMenuItems>
        <!--Adds a link leading to http://mail.google.com/ with the "Item 1" label under the "My Category1" section in the ONE Runtime Server Admin:-->
        <item categoryKey="cat1" label="Item 1" url="http://mail.google.com/"/>
        <!--Adds a link leading to http://www.google.com/ with the pre-defined label under the "My Category2" section in the ONE Runtime Server Admin:-->
        <item categoryKey="cat2" labelKey="label.item2" url="http://www.google.com/"/>
        <!--Adds a link leading to <host>:<port>/console/abcde/ with the "Item 3" label under the "Resources" section in the ONE Runtime Server Admin:-->
        <item categoryKey="wc.menu.group.resources" label="Item 3" url="abcde/"/>
    </customMenuItems>
</component>

Was this page useful?