Csav3 Apg en
Csav3 Apg en
This help is for ActiveView users and other power users that
create and manage perspectives for Smart View.
CSAV200300-APG-EN-01
ActiveView Perspective Manager
OpenText™ Content Server
CSAV200300-APG-EN-01
Rev.: 2020-June-09
This documentation has been created for software version 20.3.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: [Link]
For more information, visit [Link]
One or more patents may cover this product. For more information, please visit [Link]
Disclaimer
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
Part 1 Using the Perspective Manager 7
Important
• Starting from version 20.2, Content Server introduces a new perspective
node type. OpenText recommends all legacy ActiveView perspectives be
converted to use the new perspective node type.
• This system has not yet converted its legacy, ActiveView perspectives.
Although, you can temporarily continue to create and use ActiveView
perspectives, Content Server will eventually no longer support them.
• For information about how to convert ActiveView perspectives to use the
new perspective node type, see ActiveView Administration in the Classic
View Content Server Administration Help.
ActiveView perspectives allow you to control what various users see in the Content
Server Smart View interface. The Perspective Manager is a tool that allows you to
create and edit a perspective without needing to work in JSON format.
For details about more advanced tasks beyond creating and editing an ActiveView
perspective, see ActiveView Administration in the Classic View Content Server
Administration Help.
For a given part of Content Server, such as a folder, a perspective allows you to
define which users will see a customized view, as well as what customizations those
users will see. You can select functional elements, known as widgets, place those
widgets on an area of the page, called a tile, and then rearrange the tiles on the page
to achieve a custom view.
Smart View starts with two unchangeable, default perspectives: one for the Landing
page and one for the container view. While you cannot edit these default
perspectives, you can create new perspectives to override the defaults. For details,
see “Create a new perspective“ on page 13.
Notes
• The Perspective Manager supports creating and editing a few basic
perspectives. For more advanced perspective customization work, see
• Advanced users, who have been assigned the appropriate object and usage
privileges can use the Edit Page tool in Smart View or the Perspective
Manager tool to edit an existing perspective if they have Modify permission
for that perspective.
“Differences between ActiveView Perspectives and Perspectives that Use the New
Perspective Node Type” on page 10 lists the differences between legacy,
ActiveView perspectives and those which use the new perspective node type. To
facilitate the future conversion running smoothly, you should keep these differences
in mind when creating a new ActiveView perspectives.
Important
• Starting from Content Server 20.2, OpenText recommends that you convert
all ActiveView perspectives to use the new perspective node subtype.
• This system has not yet converted its legacy, ActiveView perspectives.
Although, you can temporarily continue to create and use ActiveView
perspectives, Content Server will eventually no longer support them.
• For information about how to convert ActiveView perspectives to use the
new perspective node subtype, see ActiveView Administration in the Classic
View Content Server Administration Help.
Your permissions determine whether you can create a new ActiveView perspective.
An administrator can create unlimited new perspectives for a component. An
advanced user, who has the appropriate privileges, can use the Edit Page tool in
Smart View and the Perspective Manager for certain actions.
Note: If you delay converting to using the new perspective node type and
continue using ActiveView perspectives, you should review “Differences
between ActiveView perspectives and perspectives that use the new
perspective node type” on page 10. Keeping these differences in mind when
creating a new ActiveView perspectives will facilitate the future conversion
process running smoothly.
Tip: If you ended a previous Perspective Manager session without saving your
perspective changes, for example from a session time out, that perspective will
be cached in your browser. When you next launch Perspective Manager, you
must decide whether to clear that perspective work and start over or to resume
your configuration.
Important
Selecting Create new will clear all settings and you will lose all unsaved
changes in Perspective Manager.
2. In the Title box, enter the name of the new perspective.
3. Choose the component and the audience as follows:
Notes
• If you do not define a rule, then the perspective will apply to all
users on all devices.
• If you are unsure about your perspective configuration, consider
applying it on a test server, or only applying it locally, to a
particular folder, or to a limited set of users. For more information
about limiting the impact of the perspective, see “Choose a
component“ on page 17 or “Define rules“ on page 21.
Tip: To test the effect of the perspective, apply a rule such as user is
<user name> or group is <group name>, and then sign in as the
specified user or as a member of the specified group. Doing this
allows you to see how the perspective functions without affecting the
experience of other users.
a. Choose a layout – Select a framework in which you can arrange tiles. For
details, see “Choose a layout“ on page 23.
Important
Changing the layout selection will clear any existing tile arrangements
and configurations.
b. Choose and configure widgets – Drag each widget to a tile, then arrange
the tiles within the framework, and configure the widget options. For
details, see “Choose and configure widgets“ on page 25.
5. Optional In the header of the Perspective Manager window, click Clear to reset all
settings, rules, layout, and widget choices.
Important
• You can only reset all settings before you save the new perspective.
• If you click Clear while editing an existing perspective, you will lose
any unsaved edits and will return to the General tab to start over by
either creating a new perspective or selecting an existing perspective to
edit.
6. In the header of the Perspective Manager window, click the Create button and
the new perspective will take effect immediately.
Notes
• Starting from Content Server version 20.2, the new perspective node
type does not support custom WebReports tags, so Perspective Manager
no longer provides access to the Code Editor tool.
• Perspective Manager will require you to provide any mandatory values
needed by any of the chosen widgets before creating the perspective.
Mandatory values are indicated by asterisks (*). If you attempt to save a
perspective without entering a mandatory value, you will be prompted
to provide the value before you can save the perspective. In a tabbed
perspective, you might need to check each tab to locate the field with the
mandatory value.
On the General tab, the Type selection specifies the type of component that is
affected by the perspective. Your permissions determine which component you can
specify.
• Landing page
Landing pages are visible immediately after a user signs in. To see the Landing
page options for a perspective, see “What Landing page options can you
specify?” on page 18. If you want different users to see their own custom
landing page, you can create multiple Landing page perspectives, define
different rules for each perspective, and then define a custom layout
configuration for the applicable widgets.
• Container
To see the container options for a perspective, see “What Container options can
you specify?” on page 18. If you want different containers to have a custom
appearance for different users, you can create a perspective for each type of
container or for a specific instance of a container, define different rules for each
perspective, and then define a custom layout configuration for the applicable
widgets.
• Workspace
A perspective for a business workspace is associated to a workspace type that
you have configured for this component.
For more information about business workspaces and workspace perspectives,
see the Connected Workspaces Help in the Classic View.
Tips
See “Define rules“ on page 21 and “Choose and configure widgets“ on page 25.
Tips
• OpenText recommends that you create a workspace perspective
using the business workspace layout that is available when you
open a workspace type object from the workspace type folder
and from the General tab, click Manage Perspectives for this
workspace type.
• To migrate a workspace perspective created using Content
Server 16.2.9 or earlier to use the new 16.2.10 workspace
component type, see the Connected Workspaces Help in the Classic
View.
Workspace Both regular administrators and delegated administrators can select either
Type all workspace types or a specific workspace type that you want.
Starting with version 16.2.10, this behavior has changed: Workspaces are
now a component, like containers or landing pages. The workspace type is
selected as a parameter for the override. If you experience performance
issues, you may consider changing your existing rule-based perspectives
into override-based perspectives.
Cascading Set whether the perspective will impact child objects within the
workspace.
• No – Affects only the workspace itself and none of the child objects.
• Yes – Affects the workspace and all child objects within the workspace.
Tip: At any point, you can click Clear on the header bar to reset all settings,
rules, layout, and widget configurations and automatically return to the
General tab to start over.
If you were creating a new perspective, nothing is saved and no new
perspective is created. If you were editing an existing perspective, you will lose
any unsaved changes.
On the Rules tab, you have the option to define simple rules or logical conditions.
The system evaluates the rules in first-to-last order to determine whether the
perspective takes effect and who will see it.
Notes
• Your role, your group membership, or your permissions may affect which
Perspective Manager options are available to you.
• If you do not define a rule, then the perspective will apply to all users on all
devices.
• Be sure that you define rules that are both valid and logically correct.
Logical Join When adding a new rule, specify the logical join between the new rule
and the preceding rules.
Type Choose whether to evaluate the rule against a user condition or a device
condition.
• Device
• Mobile Device
• User
• Group
• User Privilege
• Workspace Template – only available for Workspace components
Tip: At any point, you can click Clear on the header bar to reset all settings,
rules, layout, and widget configurations and automatically return to the
General tab to start over.
If you were creating a new perspective, nothing is saved and no new
perspective is created. If you were editing an existing perspective, you will lose
any unsaved changes.
Type Values
Device Choose from the following devices:
• iPad
• iPhone
• Blackberry
• Playbook
• Android
• Windows Mobile
Important
Notes
• The Flow layout allows you to drag the tiles to rearrange them.
• Tile widths are fixed and predetermined according to the widget
selected.
• Tile height is automatically determined by the screen size.
The Left-Center-RightL layout provides three columns for widget
eft - Center - placement: a left sidebar, a central section, and a right sidebar.
Right
On smaller screens, the three columns condense into a single column. The
tile in the central section becomes topmost, with the left sidebar tile
directly underneath, and the right sidebar tile at the bottom.
Notes
• The Left-Center-Right layout does not support dragging to
rearrange already placed widgets. Instead, you must remove the
existing tile and drag the new widget in its place.
• Tile height and widths are predetermined to fill the slot.
Tip: At any point, you can click Clear on the header bar to reset all settings,
rules, layout, and widget configurations and automatically return to the
General tab to start over.
On the Configure tab, you can drag functional elements, called widgets, from the
Widget Library pane to the tile outlines in the working area. Then, you can
rearrange the tiles holding those widgets and configure any required widget
options.
Some widgets might use the Perspective Assets volume to store items that are
automatically generated when a perspective is created. To create a perspective that
contains such a widget, you require Add Items permission to the Perspective Assets
volume. If you are the system administrator or have been granted permissions, you
can also manually add items to the Perspective Assets volume for use when
configuring widgets and perspectives. For more information, see the OpenText
Content Server Admin Online Help - ActiveView Administration (LLESAV-H-AGD).
Note: Your role, your group membership, or your permissions may affect
which Perspective Manager options are available to you.
Drag Widgets Drag widgets from the Edit Page pane to the empty tile outlines in the
work area.
Arrange Drag the widgets to change their order and placement, as permitted by the
Widgets layout.
Note: Remember that the layout you select can affect the
arrangement and size of the widgets. For more information, see
OpenText Content Server - Smart View User Help (CSSUI-H-UGD).
Configure Each widget may have zero or multiple configurable options. After you
Widgets drag the widget to the work area, click the widget to open the
configuration panel. For more information about the configuration options
for the different widgets, see OpenText Content Server - Smart View User
Help (CSSUI-H-UGD).
Remove a Click the Remove button to remove a widget from the current page.
Widget
Tip: At any point, you can click Clear on the header bar to reset all settings,
rules, layout, and widget configurations and automatically return to the
General tab to start over.
If you were creating a new perspective, nothing is saved and no new
perspective is created. If you were editing an existing perspective, you will lose
any unsaved changes.
Depending on your privileges and permissions, you can edit a perspective using
either the Perspective Manager tool or the Edit Page tool in Smart View.
Notes
• Administrators have full use of both the Perspective Manager tool and the
Edit Page tool in Smart View.
• Advanced users who have the appropriate privileges and Modify permission
for a perspective, can use both the Perspective Manager tool and the Edit
Page tool in Smart View to edit a perspective if they have Modify permission
for that perspective.
Tip: If you ended a previous Perspective Manager session without saving your
perspective changes, for example from a session time out, that perspective will
be cached in your browser. When you next launch Perspective Manager, you
must decide whether to clear that perspective work and start over or to resume
your configuration.
Important
If you are creating or editing a perspective, selecting Edit existing and
choosing an existing perspective will replace any unsaved configurations
with those from the selected perspective.
2. Click in the Browse box and select an existing perspective from the storage
location in Content Server.
Tip: At any point, you can click Clear on the header bar to reset all
settings, rules, layout, and widget configurations and automatically return
to the General tab to start over.
If you were creating a new perspective, nothing is saved and no new
perspective is created. If you were editing an existing perspective, you will
lose any unsaved changes.
a. Optional Edit the component – Edit which part of Content Server will be
affected by the perspective. The component could be a container, like a
project, task, or folder, or it could be the Landing page, which all users see
after signing in. For details, see “Choose a component“ on page 17.
Notes
• If you delete all the rules, then the perspective will apply to all
users on all devices.
• If you are unsure about your perspective configuration, consider
applying it on a test server, or only applying it locally, to a
particular folder, or to a limited set of users. For more information
about limiting the impact of the perspective, see “Choose a
component“ on page 17 or “Define rules“ on page 21.
4. Optional Change the tile layout and widget configuration as follows:
a. Optional Change the layout – Change the framework in which you can
arrange tiles. For details, see “Choose a layout“ on page 23.
Important
Changing the layout selection will clear any existing tile arrangements
and configurations.
b. Optional Choose and configure widgets – Drag widgets to new tiles,
rearrange the tiles within the framework, and configure the widget options.
For details, see .
Important
Perspective Manager will require you to provide any mandatory
values needed by any of the chosen widgets before creating or
updating the perspective.
5. Click Update.
Important
Perspective Manager will require you to provide any mandatory values
needed by any of the chosen widgets before creating or updating the
perspective.
6. In the warning dialog box, click Update. This warning applies to advanced
perspective customization work that can be performed in the Classic View and
which can affect multiple perspectives at the same time. For details, see
Customizing Content Server Using ActiveView in the Content Server Help available
in the Classic View. The perspective changes take effect immediately.
For more information about enabling widgets in Perspective Manager, see the online
help for OpenText™ Content Server Perspective Manager.
For more information about working with the My Shares and Manage Shares tiles,
see the online user help for OpenText™ Content Server Smart View.
You can also embed another widget in the Header widget, currently only the
Activity Feed widget.
Workspace Properties
Workspace properties are displayed in the left part of the Header widget in the
following top-down order, with the font becoming smaller. You can use the
suggested properties, add others, and combine attributes and properties with
text.
Property Description
Title Name of the business workspace, prefilled
with the {name} node property.
Type Name of the workspace type, prefilled
with the {business_properties.
workspace_type_name} business
property.
Description Description of the business workspace,
prefilled with the {description} node
property.
Widget
You can embed another widget in the header widget. It depends on your
system, which widgets are available.
Property Description
Embed Widget Select one of the available widgets to
embed it into the header widget. It is
displayed in the right half of the header
widget. Currently available is the Activity
Feed widget, which displays all activities
in relation to this business workspace and
its related child workspaces. You see
comments or recently added documents.
If you want to use the Activity Feed
widget, you must enable Content Server
Pulse and, optionally, create activity
manager objects. For more information, see
OpenText Connected Workspaces -
Configuration Guide (CSCWS-CGD).
General
Property Description
Title Title of the widget, typically the
workspace type name in plain text.
Workspace type Workspace type of the related workspaces.
Relation type Child or Parent.
Collapsed view
Property Description
Message for empty result Custom message if no business
workspaces of this type are available.
Preview pane The preview pane is a window that opens
when you hover with the mouse over a
related workspace in the widget. The
preview pane contains additional
information as well as team members of
this business workspace.
• Preview title – Title of the preview
pane, for example the workspace type.
The title is displayed in small font
above the display name of the related
workspace.
• Message for empty metadata – Custom
message if there is no metadata to
display.
• Name of role – Name of the role whose
members are displayed in the preview.
• Message for empty role – Custom
message if there are no roles or team
members to display.
Message that is displayed if the
specified role has no members. The
default text is No role members
assigned.
Property Description
Metadata in preview pane The preview pane uses data from category
attributes. You select a category or single
attributes. To group attributes, enter a
group name and then select the categories
and attributes. Leave the group name
empty to add a category or attribute
without a group. Drag attributes or groups
to change the order.
• Group name – Name of a group of
attributes or categories
• Category or attribute – Category or
single attributes. You can use the
following data sources: A single
attribute or a complete category with
all its attributes.
Order by Orders the list of related workspaces by a
custom column and defines the sort
direction. The default sorting is ascending
by the name of the business workspace.
If you have not selected a custom column
in the Order by option, the workspaces are
ordered by the custom column configured
in Related workspace title. And in this
case, you can only use custom columns
that are configured for ordering. If you
selected a custom column that is not
configured for ordering, an error message
is displayed when the widget is loaded.
For more information about configuration
of custom columns, see OpenText Connected
Workspaces - Configuration Guide (CSCWS-
CGD).
If you want to have the workspaces sorted
by another order than by name, you must
explicitely define the column and the sort
order in the order by section.
• Default is an order ascending by name.
• Sort ascending by the column that you
want to display as Title: select that
column as Title, do not specify
anything in the Order by field.
• Sort descending by the column that
you want to display as widget title:
select that column as Title, additionally
select this column in the Order by field,
and select the sort order Desc.
Property Description
Related workspace title Name of the related workspace. You can
use the following:
Variables: {name}. It uses the name of the
business workspace, which may already be
assembled from several attributes.
{modify_date}. For this, the custom
column for Workspace Modify Date
must be configured and have the Used for
Sorting and Filtering option enabled.
Custom columns if they have the Used for
Sorting and Filtering option enabled
Related workspaces description Description of the related workspace. You
can use the following:
Variables: {name}, {description},
{type_name}, {modify_date},
{create_date}
System Default Columns: {id}, {size},
or {type}
Custom columns if they have the Used for
Sorting and Filtering option enabled
Metadata fields Additional fields to display metadata in
the widget. Enter a label and the value,
which can be a custom column or one of
the following variables: {name},
{description}, {type_name},
{modify_date}, {create_date}. The
{name} variable uses the name of the
business workspace, which may already be
assembled from several attributes.
To format a custom column to be
displayed in currency format,
add :currency within in the brackets, for
example: {wnf_att_fl14_
5:currency}. With this format, zeros are
displayed and thousands separators are
added.
Expanded view
Property Description
Order by Orders the list of workspaces by a custom
column and defines the sort direction.
Property Description
Custom columns Custom columns to be displayed in the
expanded view. Select a custom column,
then click Add to array. You can drag the
columns to change the order.
You can enable sorting by date in the
Related Workspaces widget. For this, you
create a custom column for the Workspace
Modify Date data source and configure it
to be sortable and used for sorting and
filtering. No further configuration is
required in the widget. For more
information, see OpenText Connected
Workspaces - Configuration Guide (CSCWS-
CGD).
Property Description
Title Title of the Team widget. Default is Team.
Property Description
Title Title of the Metadata widget. Default is
Metadata.
Hide empty fields Hide metadata fields that have no value.
Default is False.
Property Description
Metadata The Metadata widget uses data from
category attributes. You select a category or
single attributes. To group attributes, enter a
group name and then select the categories
and attributes. Leave the group name empty
to add a category or attribute without a
group. Drag attributes or groups to change
the order.
• Group name – Name of a group of
attributes or categories. You can use this
option to visually group attributes.
• Category or attribute – Category or
single attributes. To add an attribute,
select the category and then select the
attributes that you want to display.
General
Property Description
Title Title of the Workspaces widget, typically
the type of business workspaces listed
here. Default is My workspaces.
Workspace type Type of business workspaces that you
want to display.
Collapsed view
Property Description
Title Title of the Workspaces widget, typically
the type of business workspaces listed
here. Default is My workspaces.
Message for empty result Custom message if no business
workspaces of this type are available.
Expanded view
Property Description
Title Title of the Workspaces widget, typically
the type of business workspaces listed
here. Default is My workspaces.
Order by Orders the list of workspaces by a custom
column and defines the sort direction.
Custom columns Custom columns to be displayed in the
expanded view. Select a custom column,
then click Add to array. You can drag the
columns to change the order.
You can enable sorting by date in the
Workspaces widget. For this, you create a
custom column for the Workspace Modify
Date data source and configure it to be
sortable and used for sorting and filtering.
No further configuration is required in the
widget. For more information, see
OpenText Connected Workspaces -
Configuration Guide (CSCWS-CGD).
Notes
For information about how to configure the Discussion widget, see OpenText Content
Server ActiveView Perspective Manager - Online Help (CSAV-H-APG). For information
about how to configure the frequency of notifications if a user chooses to follow a
topic, see OpenText Content Server Admin Online Help - Notifications Administration
(LLESWBN-H-AGD).
This section describes the use and configuration for the following Communities
widgets:
Notes
Set notifications
To support the Follow feature in the Discussion widget, you must configure
notifications just as you would for a Forum in Classic View. For information
about how to configure the frequency of notifications if a user chooses to follow
a topic, see OpenText Content Server Admin Online Help - Notifications
Administration (LLESWBN-H-AGD).
Set elink
To support the Follow feature in the Discussion widget, you must configure
eLink just as you would for a Forum in Classic View. For information about how
to configure eLink, see Administering OpenText eLink - Content Server Admin
Online Help (LLESELK-H-AGD).
Parameter Description
Width Choose the size that you want for the Discussion widget.
For the Overview tab of a business workspace, the recommended size is
single width.
Forum object To associate the widget with the Forum object in the business workspace,
leave this parameter empty and the widget will automatically link to the
forum. Typically, the administrator creates a new Forum object in the
business workspace or in the business workspace template.
Notes
• If the business workspace does not include a Forum object, the
Discussion widget will display a message that no discussion is
configured. If you later add a Forum, the Discussion widget will
automatically link to it.
• If there is more than one Forum object in the business workspace,
the Discussion widget automatically links to the oldest Forum.
For information about how to create a Forum, see OpenText Content Server
- Forums (LLESFOR-H-UGD).
This section describes the use and configuration for the following standard widgets:
Parameter Description
Theme Choose the background theme from the list.
Target object You must browse Content Server to find the target object to which you
want to link.
Volume Choose the volume fallback from the list. Possible values include the
fallback following:
• Enterprise
• Personal
• Categories
Display name Enter the name that you want to appear in the hyperlink text.
Parameter Description
Display Enter the text string that you want to appear on the tile.
message
Video Provide the URL to the thumbnail image to be used for the video.
thumbnail
Video location Enter the URL for the location of the video.
Note: You need to have Add Items permission for the Perspective Assets
volume to add or configure an HTML Tile widget.
After adding the HTML Tile to a perspective, you can set permissions in the tile to
determine which groups can edit its contents. Users with Write permissions to the
tile can add content to it.
Widget size The size for the HTML Tile widget in the Flow layout: Single width,
Double width, or Full page.
Title The title that appears at the top of the HTML Tile.
Target wiki for The wiki container that the HTML tile will use to hold the wiki page that
HTML Content stores the HTML content created for the tile.
• If you do not specify a wiki, the HTML tile will automatically create a
wiki in the Perspective Assets folder in the Perspective Assets volume.
That wiki will include a wiki page to store the HTML content for the
tile. The HTML tile will also automatically use a Records Management
Cross-Reference to link the Perspective Assets folder and the
perspective that uses the tile,
• If you specify an existing wiki container as the target, the HTML tile will
automatically create a wiki page in the specified target wiki container.
The new wiki page will store the HTML content for the tile.
Template wiki The wiki page to use as a template for the HTML Tile. Templates are
page (optional) preconfigured wiki pages that you can use as starting points for adding
content to HTML Tiles. You can select one of the prepared templates
stored in the Perspective Assets > TemplateAssets > HTML Widget
Templates wiki. If you do not select a template, the HTML Tile is created
as a blank page with the message your content goes here.
If you do not specify a template, the HTML tile creates a new, blank wiki
page that it attaches to the specified target wiki container.
1. Optional If you want to select a target wiki to store content for the HTML Tile,
create the wiki.
3. On the Configure tab, click to expand the Content Server UI Widgets group,
drag the HTML Tile widget onto the perspective, and set Options for the
widget. For more information, see “HTML Tile Widget Configuration”
on page 49. Click Create or Update to save the perspective.
5. Optional To edit the HTML content, browse to the location where the perspective
is applied, click in the tile, and then click Edit. The available actions are a
subset of the actions available for editing wiki pages.
This section describes the use and configuration for the following Collaboration
widgets:
To use the Collaboration widgets, you must include and configure each widget in a
perspective. For more information about creating perspectives, see the OpenText
Content Server - ActiveView (LLESAV-H-UGD) or the Online Help available in the
Perspective Manager.
• By default, the Activity Feed widget always appears on the on the Following/
Followers tab of each User Profile.
• Depending on configuration, in Smart View, the Activity Feed widget can
optionally appear on a landing page perspective or at the container level
perspective. For more information about how you can use perspectives to
customize how users see Smart View, see OpenText Content Server Admin Online
Help - ActiveView Administration (LLESAV-H-AGD).
• If you have Connected Workspaces installed, you can embed the Activity Feed
widget into the Header widget of Connected Workspaces.
Important
You must have the following prerequisites in place before you can begin to
configure the Activity Feed widget:
After you have included the Activity Feed widget in your perspective, you can
configure the following parameters:
Wrapper Class
Enter the wrapper class to be applied to the activity feed list. If the wrapper class
is set to the Hero tile view/black theme, then the activity feed will also be black.
Feed Size
Enter the maximum number of feed items or posts to be included in each feed
page.
Default = 20
Important
The minimum feed size must be 10 or higher or else the scroll bar will not
be available and users may not be able to view all feed items.
Feed Type
Optional. Enter the type of feed. Possible values include status, content, and
attribute.
Default = all
Feed Settings
Select the following feed setting options:
• Enable Comments – Select whether or not you want to allow comment and
replies on the activity feed posts.
Default = True
• Enable Filters – Select whether or not you want to enable the end user to
filter the activity feed posts that appear on the tile when the tile is expanded.
If set to True, the ActivityFeed widget will show the activity feed based on
the feed source setting with the filter enabled. If set to False, the ActivityFeed
widget will show the feed based on the feed source without the filter.
Default = False
• Source – Enter the name of the source of the activity feed to be displayed on
the tile. Possible values include: all, node, and pulsefrom.
Default = all
• Id – If the Source is configured to be node or pulsefrom, enter the object ID of
the source of the activity feed to be displayed on the tile.
Updates From
Choose the source to be used for the feed.
Default = all
• Id – If From is set to following, followers, user, or group, then you must
specify the User ID or group ID of the applicable user or group.
Config Settings
Specify the widget-instance level configuration settings.
Example 12-1:
To configure Extended ECM for Engineering in Smart View, you can do the
following:
• Import the Extended ECM for Engineering search template used by the Search
tile. For more information, see OpenText Extended ECM for Engineering -
Administration Guide (LLESENG-AGD).
• Create an Extended ECM for Engineering perspective that contains the tiles you
want to display on the Smart View home page.
• Create an Extended ECM for Engineering Connected Workspace perspective that
defines the tiles that appear when a user accesses a Project or Connected
Workspace from the Workspaces tile.
• Import the Extended ECM for Engineering Search for Engineering Assignments
template used by the My Assignments tile. For more information, see OpenText
Extended ECM for Engineering - Administration Guide (LLESENG-AGD).
Note: Perspective templates to help with setup are packaged with Extended
ECM for Engineering. For more information, see OpenText Extended ECM for
Engineering - Administration Guide (LLESENG-AGD).
• Create: Users can initiate Bulk Load processes and create new engineering
objects, such as Controlled Documents and Equipment Tags, from a central
location.
• Jobs: Users can view all processes that are running in the background, and they
can view details about the processes that have finished. You configure how long
processes are displayed on the tile.
• My Assignments: Users can view and complete ProcessFlow and Workflow
assignments.
Note: OpenText recommends that you configure the Search tile to span two
columns on the home page. The double-column layout makes more of the
search fields visible in the tile by default, which means a user might not
have to scroll in the tile to perform a simple search.
• Workspaces: Users can access shared engineering Project folders and workspaces
for effective collaboration.
OpenText also recommends that you configure the following Content Server tiles to
display on the home page:
• Shortcut: OpenText also recommends that you configure this tile to point to the
Enterprise Workspaces, so users can quickly access information in the Enterprise
Workspace.
• Welcome Header: Users can quickly see information you customize to appear on
the tile.
Tips
• For information about tiles in other areas of the Widget Library, see
OpenText Content Server ActiveView Perspective Manager - Online Help (CSAV-
H-APG).
• Perspective templates to help with setup are packaged with Extended ECM
for Engineering. For more information, see OpenText Extended ECM for
Engineering - Administration Guide (LLESENG-AGD).
2. On the General Settings page, click Create new, then type a name for the
perspective in the Title box. For example, type xENG Perspective.
3. In the Type area, select whether this perspective is visible to users as the
Content Server home page or from a container in Content Server. OpenText
recommends you set the type as a Landing page for the Extended ECM for
Engineering perspective. Depending on the type, provide values for other
required options.
For more information, see OpenText Content Server ActiveView Perspective
Manager - Online Help (CSAV-H-APG).
4. Click the Configure tab.
5. In the Widget Library area, click Content Server UI Widgets, then do the
following:
• Search
• Workspaces
• Create
• Jobs
• Overdue Items
• My Assignments
the Select link for the search template. For more information about the
search template, see OpenText Extended ECM for Engineering - Administration
Guide (LLESENG-AGD).
10. In the Widget Library area, click Content Server UI Widgets, then drag the
following widgets to the active area:
• Single Shortcut
• Recently Accessed
11. Click the Single Shortcut tile and in the Options area, do the following:
a. Click Browse in the Target object box, then select the Enterprise
Workspace in Content Server.
b. Select Enterprise in the Volume fallback list.
c. Select a color in the Background list.
OpenText recommends you configure the following tiles to display on the landing
page of a Connected Workspace that users access from the Workspaces tile:
• Project Header: Users can view metadata for the Project or Workspace including
information such as the start date, end date, and manager. Metadata is created
when the Project or Workspace is created.
• Create: Users can initiate Bulk Load processes and create new engineering
objects, such as Controlled Documents and Equipment Tags, from a central
location.
• My Assignments: Users can view and complete Workflow and ProcessFlow
assignments related to the current Project or Workspace.
For more information about configuring these tiles, see “Configuring the Overview
tab” on page 62.
OpenText recommends you configure the following tiles to display on the tabs of the
Connected Workspace landing page:
• Vault: Users view revision information for Controlled Documents in the Vault
for the current Project or Workspace. For more information, see “Configuring the
Vault tab” on page 64.
• Projects: Users view and access projects for the current Project or Workspace. For
more information, see “Configuring the Projects tab” on page 65.
• Node Browsing Table: Users view and access all of the documents and objects
available for the current Project or Workspace. For more information, see
“Configuring the Documents tab” on page 63.
• Visual Count: Users view WebReport results. For more information, see
“Configuring the Reports tab” on page 67.
• ArcGIS Map: Users view and can drill-down in to a map of Projects for the
Program. For more information, see “Configuring the ArcGIS Map tab”
on page 70.
The Vault tab and Projects tab in the Extended ECM for Engineering Connected
Workspace perspective display revision information for Controlled Documents. To
display this information on the Projects and Vault tabs, you must create and
configure required custom columns in the Facets Volume. OpenText recommends
you create the custom columns before you add the Projects and Vault widgets to
your Connected Workspace perspective. For more information about creating and
configuring custom columns, see OpenText Extended ECM for Engineering -
Administration Guide (LLESENG-AGD).
Tip: Perspective templates to help with setup are packaged with Extended
ECM for Engineering. For more information, see OpenText Extended ECM for
Engineering - Administration Guide (LLESENG-AGD).
2. Click Workspace Types and then click the workspace type you want to create
the Smart View perspective for.
3. On the Change Workspace Type page, in the Perspective Manager area, click
the Manage Perspectives for this workspace type link.
4. On the General Settings page of the Perspective Manager, select the Create
new option.
5. Type a name for the Extended ECM for Engineering Connected Workspace
perspective in the Title box. For example, type xENG CWS Perspective.
2. If the Connected Workspaces Header widget displays, click the widget, then
click the Remove button.
3. In the Widget Library area, click Extended ECM for Engineering and drag the
Project Header to the active area.
4. Click the Overview tab. If the Overview tab does not exist, click Add tab,
double-click in the new tab, and type Overview.
5. In the Widget Library area, click Extended ECM for Engineering and drag the
following widgets to the active area:
• Create
• Overdue Items
• My Assignments
6. To configure the width of the Extended ECM for Engineering widgets, click
each tile and then, in the Options area, select One third in the Width list.
2. In the Widget Library area, click Content Server UI Widgets and drag the
Node Browsing Table widget to the active area.
3. Click the Node Browsing Table tile and then, in the Options area, select Full in
the Width list.
Note: OpenText recommends you create custom columns and add them to the
Program Vault before you add the Vault widget to your Connected Workspace
perspective.
To configure the Vault tab in the Extended ECM for Engineering Connected
Workspace perspective:
3. In the Widget Library area, click Extended ECM for Engineering and drag the
Vault widget to the active area.
4. Click the Vault tile and then, in the Options area, select Full in the Width list.
To configure the Projects tab in the Extended ECM for Engineering Connected
Workspace perspective:
3. In the Widget Library area, click Extended ECM for Engineering and drag the
Projects widget to the active area.
4. Click the Projects tile and then, in the Options area, select Full in the Width list.
To configure the Related tab in the Extended ECM for Engineering Connected
Workspace perspective:
3. In the Widget Library area, click Connected Workspaces and drag the Related
Workspaces widget to the active area.
4. Click the Related Workspaces tile and then, in the Options area, select Full in
the Width list.
To configure the Reports tab in the Extended ECM for Engineering Connected
Workspace perspective:
3. In the Widget Library area, click Content Intelligence and drag the Visual
Count widget to the active area.
• Project
• ProcessFlow
• State
• Revision Type
• ProcessFlow
• State
• RevisionType
f. Specify values for Values as Percentage, Group After, Sort By, Sort
Direction, Chart Options, and Expanded View.
g. To specify a button to display on the WebReport, do the following:
5. To display the Active Documents based on Revision Types report, click the
Visual Count tile, and then in the Options area, do the following:
c. In the Chart Type list, select the type of chart that is used to display the
information.
d. To specify the source WebReport for the tile, do the following:
• Program
• Revision Type
• Project
• Project
• RevisionType
f. Specify values for Values as Percentage, Group After, Sort By, Sort
Direction, Chart Options, and Expanded View.
g. To specify a button to display on the WebReport, do the following:
• Type Revision_Types in the Parameter Name box and enter the name
of a revision type in the Parameter Value box.
• Type Days_in_RevisionTypes in the Parameter Name box and enter
the number of days in the Parameter Value box.
To configure the ArcGIS Map tab in the Extended ECM for Engineering
Connected Workspace perspective:
3. In the Widget Library area, click ESRI ArcGIS Integration and drag the
ArcGIS Map widget to the active area.
4. Click the ArcGIS Map tile and then, in the Options area, select Full in the
Width list.
3. Confirm that the perspective you created appears in the ActiveView Template
area, then click Save Changes.
Note: You must restart Content Server core after you enable the Connected
Workspaces and Template Workspaces modules.
3. Enter your name as a signature and confirm that you have read the terms of
usage and have a valid license in place.
For more information about updating Search Regions, see OpenText Content Server -
Administering Search (LLESWBS-AGD).
3. Click the Functions menu of Enterprise Search Manager, click Properties, then
click Regions.
5. In the Display Name box, delete Organization Segment and type Program.
6. Click Update.
If the OpenText Extended ECM for Microsoft Office 365 module is installed,
Extended ECM for Office 365 widgets are available in Perspective Manager.
To make the widgets available to users, you must configure a new perspective for a
business workspace type and then add the widgets to that perspective. For more
information, see OpenText Extended ECM for Microsoft Office 365 - Installation and
Configuration Guide (CSSOG-ICG).
To use the Physical Objects widgets, you must include and configure each widget in
a perspective. There are two types of Physical Object widgets and they are grouped
separately in the Perspective Manager Widget Library:
For more information about creating perspectives, see the OpenText Content Server -
ActiveView (LLESAV-H-UGD) or the Online Help available in the Perspective
Manager.
This section describes the use and configuration for the Content Intelligence
widgets.
Note: You will need to have a valid WebReports license to see the Content
Intelligence widgets.
To use the Content Intelligence widgets, you must include and configure each
widget in a perspective. For more information about how to create a perspective, see
the Online Help available in Perspective Manager.
Note: Any WebReport that you intend to display in the Smart UI cannot
contain custom parameters. Custom parameters can only be displayed in the
Classic UI. By default, any custom parameter screen executed from the Smart
UI will run in the Classic UI. A custom parameter is created on the Parameters
tab when you select “Custom” from the Type list.
End users can expand the tile containing the Nodes List WebReport widget to see a
full table view of the nodes. When expanded, the nodes table shows additional
columns of data, such as Type, Name, Size, and Modified. Similar to the standard
Smart View browse view, the expanded widget allows users to filter on name, sort
by column, and view the properties for each node.
Note: The expanded Nodes List WebReport widget does not replicate all
Smart View browse behavior. For example, the columns shown are only a static
subset of the default: neither the facet bar, nor the multi-action bar is shown.
After you have included the Nodes List WebReport widget in your perspective, you
can configure the following parameters:
Title
Optional. Enter the title for the tile. Typically, this would describe the
WebReport that you are rendering.
Icon Class
Optional. Provide the CSS class for the icon that you want to appear in the top
left corner. For example: <Content ServerInstallDir>/support/csui/
themes/carbonfiber/[Link] contains icons such as title-assignments,
title-customers, title- favourites, title-opportunities, title-
recentlyaccessed, title-activityfeed, title-customviewsearch.
Default = title-webreports
Search Placeholder
Optional. Enter a custom string that will appear when the user clicks Search.
Default value = “Search NodesList Report.”
WebReport ID
Mandatory. Enter the ID for the WebReport that you want to appear on the tile.
WebReports Parameters
Optional. Enter one or more “name”-“value” pairs for the parameters that you
want to pass into the WebReport.
1. Create a new WebReports node using the Nodes List WebReport Widget -
Report JSON default reportview. For information about how to create a
WebReport, see OpenText Content Server - WebReports (LLESWEBR-H-UGD).
2. On the Source tab, set the data source of the WebReport to the database source
that contains a column called DataID, which references valid nodes that you
want to display in the widget. For more information about how to set the data
source, see OpenText Content Server - WebReports (LLESWEBR-H-UGD).
Note: For more information on the options available for the Nodes
List WebReport widget, see Nodes List WebReport Widget
Configuration Parameters on page 82.
6. Navigate to the location where the new perspective is applied to verify the
Nodes List WebReport widget output.
Notes
• This widget supports HTML and CSS. For the 16.0.3 release and onwards,
this widget will also support Javascript. For releases prior to 16.0.3,
Javascript is not supported.
• Be sure to avoid style conflicts with the Content Server Smart View user
interface framework or any other widgets on the page.
Important
Although these templates include examples using the bootstrap library,
OpenText does not officially support this library. If you use this library, you
must consult the published documentation. In addition, the Content Server
Smart View implements a customized version of bootstrap. It is expected that
in some cases the Smart View version of bootstrap will diverge from the
publicly documented behavior. In a post-Content Server 16 update, OpenText
will provide developer documentation with style guidelines as well as the
Smart View UI SDK.
After you have included the HTML WebReport widget in your perspective, you can
configure the following parameters:
Widget Size
Mandatory. Select the size for the HTML WebReport widget in the Flow layout:
Single width, Double width, or Full Page.
Default = Double width.
Title
Optional. Enter the title for the tile. Typically, this would describe the
WebReport that you are rendering.
Default title = HTML WebReport
Icon Class
Optional. Provide the CSS class for the icon that you want to appear in the top
left corner. For example: support/csui/themes/carbonfiber/[Link]
contains icons such as title-assignments, title-customers, title-
favourites, title-opportunities, title-recentlyaccessed, title-
activityfeed, title-customviewsearch.
Default = title-webreports
Note: You can specify a custom icon within the WebReport template by
adding a CSS selector that uses background-image and then referencing
the selector in this option.
Header
Optional. Select the option for whether the tile will include a header area that
contains the title and title icon.
Default = True.
Scroll
Optional. Select the option for whether users can scroll through the content on
the tile. If scrolling is disabled, content will be truncated.
Default = True.
WebReport ID
Mandatory. Enter the ID for the WebReport that you want to appear on the tile.
WebReports Parameters
Enter one or more “name”-“value” pairs for the parameters that you want to
pass into the WebReport.
1. Create a new WebReport node using the blank reportview, the HTML
WebReport Widget - Image and Icons Report template, or the HTML
WebReport Widget - Responsive Table Report template. For information
about how to create a WebReport, see OpenText Content Server - WebReports
(LLESWEBR-H-UGD).
2. Edit the WebReport to contain the desired output using the guidelines and
general practices used in the sample reportviews.
Note: For more information on the options available for the HTML
WebReport widget, see HTML WebReport Widget Configuration
Parameters on page 84.
6. Browse to the location where the new perspective is applied to verify the HTML
WebReport widget output.
Important
Javascript used with the HTML WebReport widget must follow the standards
described in this help and in the Smart UI SDK documentation. Javascript that
is not written to be compatible with the Smart UI may conflict with the Smart
UI framework and result in unpredictable behavior.
Watch out for Javascript in your HTML WebReport widget that is not written to be
compatible with the Smart UI. The following situations may cause problems:
• If you include a WebReport that is written for the Classic UI, it may include
Javascript that conflicts with the Smart UI framework.
• If you use <script src="..." > syntax to load external Javascript files directly
on the page, such as new third-party libraries, these libraries may conflict with
the Smart UI framework. Including such an HTML WebReport widget on a
Smart UI page that is subsequently embedded in an external site may also cause
problems.
Note: The Smart UI SDK is available starting from the 16.0.3 Content Server
release, so this approach is not supported for releases prior to 16.0.3.
If you add a script block to the WebReport that will be loading within an HTML
WebReport widget, you can access the csui global object. Then, you can use csui.
require to load modules and use of them in your application.
// Wrap any calls to third party modules and Smart UI components using [Link].
[Link](['csui/lib/jquery', 'csui/utils/base'], function ($, base) {
});
</script>
.binf-widgets .webreports-example-hello {
margin: 10px;
padding: 10px;
}
</style>
<div class="webreports-example-hello"></div>
<script>
[Link]("webreports-example-hello")[0].[Link] = "2px
solid #87CEFA";
[Link]("webreports-example-hello")[0].[Link] =
"10px";
[Link]("webreports-example-hello")[0].innerHTML = "Hello
World";
</script>
.binf-widgets .webreports-example-hello-jquery {
margin: 10px;
padding: 10px;
}
</style>
<div class="webreports-example-hello-jquery"><div>
<script>
});
</script>
.binf-widgets .webreports-example-marionette-view {
margin: 10px;
padding: 10px;
border: 2px solid #87CEFA;
border-radius: 10px;
}
</style>
<script>
var helloWorldView,
// Create a Marionette Region from our main div element
contentRegion = new [Link]({el: '#webreports-example-
marionette'}),
// Create a new Marionette view extending from the built-in ItemView
HelloWorldView = [Link]({
// Apply a class name to the view element
className: 'webreports-example-marionette-view',
// Override the render function to update the view.
render: function () {
this.$[Link]('Hello World');
return this;
}
});
});
</script>
<div id="webreports-example-marionette"></div>
Collection processing refers to the paging, sorting, and filtering for the data. It can be
a webreport or datasource. If WebReport is specified then all the data from the data
source will be returned to Content Server and collection processing will be
performed by the WebReports engine. If datasource is specified then collection
processing will be performed by the WebReports data source.
Important
Because this method does not perform pagination in the data source, all rows
will be returned to the WebReport for processing. Therefore, OpenText
recommends that you only apply this method for small to medium sized data
sets.
If you have a large data set, see “Method 2: Instructions to perform collection
processing in the data source” on page 92
1. Create a WebReport:
LABEL:SUBTYPE /]":CreatedBy:"[LL_REPTAG=CreatedBy
USERINFO:FULLNAME /]":ModifyDate:"[LL_REPTAG=ModifyDate DATE:LONG /]" /]
3. Create a second, new WebReport. For the purposes of this example, call your
second new WebReport “WebRep CPWR02”:
<script>
[Link](['csui/lib/marionette', 'csui/utils/contexts/page/
[Link]', 'webreports/controls/[Link]/[Link]'], function
(Marionette, PageContext, TableReportView) {
options = {
context: pageContext,
data: {
id: 463381,
title: 'My Table Report',
header: false,
titleBarIcon: 'title-assignments',
columnsWithSearch: 'name',
sortBy: 'ModifyDate',
sortOrder: 'desc'
}
};
});
</script>
<div id="content"></div>
[LL_WEBREPORT_STARTROW /]
[LL_WEBREPORT_ENDROW /]
to put in the ID that you copied from the first WebReport in 1.f.
h. Click Add Version.
4. Open the Perspective Manager and create a new perspective. Choose, or create,
a specific test folder in which to save this perspective. For the purposes of this
example, browse to “WebRep TableReport Perspective”.
For information about the Perspective Manager, see the Online Help available in
Perspective Manager.
a. On the General tab, type a unique name for this perspective. For the
purposes of this example, call this perspective “WR-Persp01”.
b. On the Layout tab, in the Type box, click Left - Center - Right.
c. On the Configure tab, do the following:
6. While in Smart View, browse to the test folder in which you saved the
perspective in 4. For the purposes of this example, browse to “WebRep
TableReport Perspective”.
Important
Because this method performs pagination in the data source, only one page of
results will be returned to the WebReport for processing. Therefore, this
method can be used for larger data sets.
If you have a small to medium sized data set, see “Method 1: Instructions to
perform collection processing in the WebReport” on page 90
1. Create a WebReport:
2. Choose, or create, a sample Content Server folder node to use as a container. For
the purposes of this example, create a folder called “DatSrc TableReport
Perspective”.
a. From the Functions menu of the “WebRep CPDS01” WebReport, click Edit
Reportview.
b. On the Edit WebReport page, scroll to the end and edit the last section so
that it reads:
[LL_WEBREPORT_INSERTJSON @TABLEREPORT
COLLECTIONPROCESSING:"datasource"
EXCLUDECOLUMNS:'["RowNumber"]'
FORMATCOLUMNNAMES:AuditID:"Event":PerformerID:"User"
FORMATCOLUMNS:AuditID:"[LL_REPTAG=AuditID
LABEL:AUDITID /]":SubType:"[LL_REPTAG=SubType LABEL:SUBTYPE
DEF:'' /]":PerformerID:"[LL_REPTAG=PerformerID USERINFO:NAME /]" /]
4. Create a second, new WebReport. For the purposes of this example, call your
second new WebReport “WebRep CPDS02”:
d. Click Add. In the information message dialog informing you that you have
not selected a data source, click OK.
e. From the Functions menu of the “WebRep CPDS02” WebReport, click Edit
Reportview.
f. On the Edit WebReport page, edit the content so that it reads:
[/* Title: Blank Reportview */]
<script>
[Link](['csui/lib/marionette', 'csui/utils/contexts/page/
[Link]', 'webreports/controls/[Link]/[Link]'], function
(Marionette, PageContext, TableReportView) {
options = {
context: pageContext,
data: {
id: 463411,
title: 'Audit Events for the Past Week',
header: false,
titleBarIcon: 'title-assignments',
columnsWithSearch: 'name',
sortBy: 'AuditDate',
sortOrder: 'desc'
}
};
});
</script>
<div id="content"></div>
[LL_WEBREPORT_STARTROW /]
[LL_WEBREPORT_ENDROW /]
to put in the ID that you noted from the first WebReport in Step 1.f.
h. Click Add Version.
i. Type a unique name for this perspective. For the purposes of this
example, call this perspective “DS-Persp01”.
ii. Choose a specific test folder in which to save this perspective. You can
choose to save this perspective in the folder you selected in Step 2. For
7. While in Smart View, browse to the test folder in which you saved the
perspective. For the purposes of this example, browse to “DatSrc TableReport
Perspective”.
Important
Following this next step requires a strong knowledge of SQL and
LiveReports.
This data source is just a sample to get you started. It is set up in a specific way
to work with the INSERTJSON @TABLEREPORT option when
COLLECTIONPROCESSING is set to “datasource”. For more information, see
OpenText Content Server - WebReports (LLESWEBR-H-UGD).
10. Edit the WebReport you created in 4, “WebRep CPDS02”. From the Functions
menu of the “WebRep CPDS02” WebReport, click Edit Reportview.
11. On the Edit WebReport page, edit the content so that it reads:
[/* Title: Blank Reportview */]
<script>
[Link](['csui/lib/marionette', 'csui/utils/contexts/page/[Link]',
'webreports/controls/[Link]/[Link]'], function (Marionette,
PageContext, TableReportView) {
options = {
context: pageContext,
data: {
id: 463411,
title: 'Documents Modified in the Past Week',
header: false,
titleBarIcon: 'title-assignments',
columnsWithSearch: 'name',
sortBy: 'Name',
sortOrder: 'desc'
}
};
});
</script>
<div id="content"></div>
[LL_WEBREPORT_STARTROW /]
[LL_WEBREPORT_ENDROW /]
13. While in Smart View, browse to the test folder in which you saved the
perspective. For the purposes of this example, browse to “DatSrc TableReport
Perspective”.
Widget Size
Mandatory. Select the size for the Widget Carousel widget in the Flow layout:
Single width, Double width, or Full Page.
Default = Double width.
Show Header
Optional. Select whether or not the tile will include a header that contains the
title and title icon. If set to True, the header will appear. If set to False, there
will be no header.
Default = False
Notes
• If the tile header is enabled and the child widget already has a header,
then both headers will appear.
• In most cases, you would only enable the Widget Carousel header if all
the included child widgets did not have a header.
Title
Optional. Enter the title for the Widget Carousel. If the header is enabled, the
title will appear on the header.
Default title = “Widget Carousel”
Icon class
Optional. Enter the CSS class for the icon that will appear before the Title in the
Header. For example: support/csui/themes/carbonfiber/[Link]
contains icons such as title-assignments, title-customers, title-
favourites, title-opportunities, title-recentlyaccessed, title-
activityfeed, title-customviewsearch.
Default = “title-webreports” (the WebReports icon )
Note: You can specify a custom icon within the WebReport template by
adding a CSS selector that uses background-image and then referencing
the selector in this option.
Behavior
Set the options that control the behavior of the Widget Carousel.
• Cycle automatically
Optional. Select whether or not the Widget Carousel will rotate through the
slides. If set to True, the carousel will automatically rotate through the slides.
If set to False, the carousel will only advance to the next slide if the user
explicitly clicks on the navigation controls.
Default = True
• Interval
Optional. If the Widget Carousel is set to cycle automatically, set the amount
of time, in milliseconds, each slide will appear before advancing to the next
one.
Default = 5000 (ms)
• Pause on hover
Optional. If the Widget Carousel is set to cycle, and this option is set to True,
the carousel will stop cycling if the user explicitly points to the current slide.
If set to False, the carousel continues to cycle, regardless of where the user
points the cursor.
Default = True
• Loop
Optional. If the Widget Carousel is set to cycle automatically and Loop is set
to True, the carousel will advance through all the slides in an endless loop. If
the Widget Carousel is set to cycle automatically and Loop is set to False, the
carousel will only show each slide once.
Default = True
Child widgets
Mandatory. Add and configure up to ten slides in the order in which you want
them to appear in the carousel. You can populate each slide by dragging a child
widget from the Content Intelligence widget group to the Child Widget Drop
Area.
For more information about how to configure child widgets from the Content
Intelligence widget group, see the following topics:
Notes
Note: Each Perspective can only include one Widget Carousel widget.
Notes
5. To verify the Widget Carousel widget output, navigate to the location where the
new perspective is applied.
Each Visual Count widget depends on a WebReports object to format its data, which
can be any valid WebReports data source. For more information about how to create
these prerequisites, see “Examples and Walkthroughs of How to Use the Visual
Count Widget” on page 107.
You can use the Perspective Manager to configure the initial appearance of the chart
in Smart View, but, depending on the widget configuration, the end user may be
able to use the controls in Smart View to sort and filter the chart.
Smart View end users can change the filtering of the Visual Count widget in the
following ways:
• From the Tile view, if an administrator uses the Perspective Manager to set Enable
Tile Filtering Controls option to True.
• From the Expanded view, if an administrator uses the Perspective Manager to set
Enable Expanded View option to True. The expanded view also allows filtering
by multiple columns.
Widget Size
Mandatory. Select the size for the Visual Count widget in the Flow layout: Single
width or Double width.
Default = Double width.
Title
Optional. Enter the title for the widget. The title appears in the tile header.
Default = “Visual Count”
Chart Type
Optional. Select the type of chart appropriate for your data. Options include Bar
chart, Donut chart, and Pie chart.
Default = Bar chart
Source WebReport
Mandatory. Browse for the WebReport that retrieves the data that you want to
visualize.
Note: You can use the following reportviews that have been specifically
created to use with this widget and edit them as required.
• When you enter the column name, you must be careful of the case
sensitivity if your data source is a LiveReport that queries a case-
sensitive database.
• Avoid choosing an Active Column that returns unique values because
the data will not be meaningful on a count-based chart. Ideally, this
widget works best for data with columns containing no more than 20
distinct values.
• Include fewer than ten columns to make the chart more user-friendly.
More than ten columns are more complex to configure and may
potentially have a performance cost.
• You can include and exclude columns by editing the reportview used for
the WebReports object associated with this widget.
• If Enable Tile Filtering Controls is set to True, a Smart View end user
can select a different Active Column value for the chart. For more
information, see Chart Options on page 102.
Values As Percentages
Choose whether to show the values as percentages of the total count. If False,
the values will appear as the actual count instead.
Default = False
Group After
Optional. Choose the number, from one to twenty, as the threshold for the
maximum number of discrete values whose total counts will appear on the
chart. Values that exceed this threshold are grouped as “Other” and will show
the combined total. Options include values from one to twenty and “Use Chart
Default”, which will use the default number appropriate for the chart type
selected.
Sort By
Optional. Choose the sorting criteria for the chart. Options include the
following:
Default = Count
Sort Direction
Optional. Choose whether the criteria specified in the Sort By on page 102
setting are sorted in ascending or descending order.
Default = Descending
Chart Options
Optional. Choose whether Smart View end users can access the filter menu on
the Tile view of the chart to change how they want to filter the chart data. If set
to True, the end user can see the Configure button on the Tile view. If set to
False, then the end user cannot see the Configure button and cannot filter
the chart in the Tile view.
Default = False
Note: This setting only affects the end user ability to filter the chart in the
Tile view, not the Expanded view.
Expanded View
Optional. Choose whether Smart View end users can expand the Tile view of the
chart to see more chart details as well as change how they want to filter the chart
data.
Default = False
Button WebReports
Optionally, configure custom buttons for the Expanded view. Each button can
pass in fixed values and then launch the associated WebReport.
Note: There is a hard limit of 50,000 rows. If you try to set a value
higher than 50,000, you will get an error.
Custom Buttons
Optionally, add one or more custom buttons to the footer of the Expanded view.
Configure each button to launch the selected WebReport in a new window,
optionally passing in preset parameters.
Source Parameters
Optional. If the Source WebReport that generates the data to be visualized
accepts parameters, you can specify them here.
• Parameter Name – Optional. Name of the parameter that you want to pass to
the WebReport that generates the data to be visualized.
• Parameter Value – Optional. Value of the parameter that you want to pass to
the WebReport that generates the data to be visualized.
1. Create a WebReport to generate the data that you want to visualize as a chart
with the Visual Count widget. Choose from the following reportview templates
that generate data compatible with the Visual Count widget:
Note: You will need to open your data source and make note of the
column that you want to use to group the data. You will need this label to
configure the widget in Step 5.c.
2. Optional Create a WebReport for each action that you want end users to be able to
perform on the results in the Expanded view of the Visual Count widget. You
will be able to configure a custom button that end users can click to launch this
WebReport.
6. Browse to the location where the new perspective is applied to verify the Visual
Count widget output.
The reportviews available for the WebReport and specific to the Visual Count
widget include the following:
Figure 18-1 illustrates the factors you should consider when choosing the
appropriate reportview for this WebReport.
• The intensity of the data source resource query – Light, moderate, or heavy.
• The type of data source – The Visual Count Widget - Grouping in Data Source
Simplified JSON reportview works with a simple tab-separated text file. The
Visual Count Widget - Grouping on Client JSON reportview and Visual Count
Widget - Grouping in WebReport JSON reportview work with any data source.
While the Visual Count Widget - Grouping in Data Source JSON reportview
currently only works with LiveReports.
• Whether or not you want to allow end users to use client browser-based controls
to filter the data in the resulting chart.
• The frequency of access for the page where the Visual Count widget resides.
Tip: In any data source, to see which columns are available to use as an Active
Column, click the source WebReport to run it and view the JSON output.
Important
Optionally, after configuring the WebReport for the main chart, you can configure
additional WebReports, that the end user can launch from custom buttons in the
Expanded view of the Visual Count widget. For more information about how to
prepare these WebReports for the custom buttons, see “Preparing WebReports for
the Custom Buttons” on page 134.
Consider this simple data set that lists the employee count on various days at a
retail store.
Weekday Employee_Count
Sunday 3
Monday 3
Weekday Employee_Count
Tuesday 4
Wednesday 6
Thursday 5
Friday 4
Saturday 5
In this example, the data is minimal. The data source already has a count
corresponding to the grouped data. All the employees who worked on a
Saturday have been grouped as “Saturday”, and their total is shown as
“Employee_Count”. Since there are no further details for each employee, such
as job title, gender, or name, there are no other criteria to count so there is no
point enabling tile filtering or expanded view. In this case, we want to show a
non-interactive “infographic” type of chart. The Visual Count widget allows
you to plot this data as a bar chart, showing the weekday on the x axis and the
employee count on the y axis. This kind of data is suitable when you need to
display a graphical chart and do not require the end user to interact with the
chart.
To visualize a very simple data source that includes pre-grouped, static data, such as
in a tab-separated value (TSV) file or a comma-separated value (CSV) file, you can
use the Visual Count Widget - Grouping in Data Source Simplified JSON
reportview template.
• Size
Recommended for static, pre-grouped data where the size of the data used to
generate the grouped counts does not affect overall performance.
• Filtering
Does not support filtering.
• Data source
A very simple data source that includes pre-grouped, static data, such as in a
TSV file or a CSV file.
• WebReports object
Must use the Visual Count Widget - Grouping in Data Source Simplified JSON
reportview template. For an example, see “Step-by-step Walkthrough for a
Simple Chart with Static Data” on page 109.
• Visual Count widget configuration
No special configurations required.
• Performance
– Renders static data without user interaction on the client, so it has very little
additional impact on performance.
– Suitable for use in a frequently-accessed location, such as a landing page.
To step through the process of visualizing a very simple chart with static data
• Widget Size
If using the Flow layout, choose either Single width or Double width.
• Title
Employees by Country
• Chart Type
Bar
• Source WebReport
<YourWebReportID> as created in Step 2.
• Active Column
Country
Notes
– Make sure to use the correct case because Content Server folder
columns are case-sensitive.
• Group After
Use chart default
• Sort By
Count
• Sort Direction
Descending
c. Sign in to Smart View and verify that the Visual Count widget in the
perspective produces the bar chart as shown in Figure 18-2:
Consider these first few rows of a larger data set that lists several kinds of data
for each employee in a local company.
In this example, the count is derived by grouping whichever values are the
same in the column of data that is of interest, the Active Column.
If the Active Column is “Country”, we group all the rows with the same
country value and then count those rows with the following results:
• England = 3
• France = 1
• USA = 3
If the Active Column is “Gender”, we need to regroup and recount with the
following results:
• Male = 3
• Female = 3
• No value = 1
Notes
• If the data source has missing values, it is important to exclude them from
the resulting chart to avoid misleading information. We group them as “No
value”.
• The sum of each value count, including the count of missing values, if any,
should be the same as the total number of rows in the data source.
• This data source includes more information than we can easily display on a
bar chart or a pie chart. The more data that you retrieve, the more it affects
performance, so it makes sense to only bring back the columns needed for
the chart and to exclude the columns that are not needed.
• By enabling end-user filtering, the end user can choose an Active Column, so
that the same data can produce several different charts. It also allows the end
user to perform more complex analyses by combining filters. For example,
“Total count of Sales employees in Europe, by gender”.
If you have a small data set from a standard WebReports data source query that is
minimally intensive, you can use the Visual Count Widget - Grouping on Client
JSON reportview template. This reportview relies on the javascript engine of the
client browser to filter the entire data set.
• Size
Recommended for small data sets where the results can quickly load to the client
browser.
• Filtering
Allows filtering by the end users using the client browser.
• Data source
Any standard WebReports data source.
• WebReports object
Must use the Visual Count Widget - Grouping on Client JSON reportview
template.
• Visual Count widget configuration
– After the Visual Count widget finishes loading, end-user filtering will be fast
and responsive because no additional requests are sent back to the server.
– OpenText does not recommend using for a chart in a frequently loaded
location, such as on the landing page. Frequent loading of even a small data
set may result in a significant impact on performance.
• Performance Considerations
– In this scenario, the entire data set is returned to the browser. The browser
filters the data using the client-side Javascript layer.
– The data set size is affected by both the number of columns and the amount
of data it contains. For example, a report with 10 columns that only contains
integers will process quickly. However, a report with only two columns will
process more slowly if that report includes a cell containing the lengthy
description field.
– It is a good practice to tune your LiveReport to only return the data that you
need. For information about how to optimize a LiveReport, see OpenText
Content Server - LiveReports (LLESREP-H-UGD).
• Advantages
– No requests are made to the server when the end user uses the browser to
change the Active Column or to choose other chart options.
– Performance is quick when the data set is small.
• Disadvantages
Performance may degrade if the data set is large. The browser will use more
memory to manipulate the data as the data set size increases. To address this
concern, see “Step-by-step Walkthrough for a Basic, Filter-enabled Chart”
on page 114.
For this example we will use a Content Server folder as a data-source. To support
filtering by the end user, perform the following procedures:
• Widget Size
If using the Flow layout, choose either Single width or Double width.
• Title
Documents by type
• Chart Type
Pie
• Source WebReport
<YourWebReportID> as created in Step 1.
• Active Column
FileType
Notes
– Make sure to use the correct case because Content Server folder
columns are case-sensitive.
• Group After
Use chart default
• Sort By
Count
• Sort Direction
Descending
c. Sign in to Smart View and verify that the Visual Count widget in the
Perspective produces the pie chart as shown in Figure 18-3:
To produce a chart that performs well with larger datasets, we need to limit the data
returned from the server to only the subset of data required to visualize the chart.
You can limit the data by editing the data source or the SQL query to return only the
columns that you need. However, this is not always possible. The user creating the
WebReport may not have the SQL skills or permission to edit the LiveReport data
source. If you are comfortable working with WebReports, it may be more convenient
to edit the data at the application layer, by using conditional logic and sub-tags in
the reportview. You can also exclude columns by using directives, as illustrated in
the commented section of the Visual Count Widget - Grouping in WebReport
JSON reportview template. Rather than return all the data to the client browser in a
single request, the application layer can provide the Visual Count widget with the
minimum data required to create the chart. In this case, the application layer need
only return the data relating to the active column that contains the value counts that
we want to visualize. To show the chart for a different active column, or with
different filter criteria, you can make a new request to the server for fresh data that
contains the information you need.
Consider these first few rows and columns of a much larger data set that lists
several kinds of data for each employee in a national company.
In this example, the count is derived by grouping whichever values are the
same in the column of data that is of interest, the Active Column.
If the Active Column is “Function”, we group all the rows with the same
function value and then count those rows with the following results:
• Sales = 2
• Engineering = 3
• Finance = 1
• Human Resources = 1
If the Active Column is “Gender”, we need to regroup and recount with the
following results:
• Male = 3
• Female = 3
• No value = 1
Note: If the data source has missing values, it is important NOT to exclude
them from the resulting chart to avoid misleading information. Even though
they have no value, they still need to be counted. For example, an employee
who has not specified their gender is still an employee and must still be
counted. In the Visual Count widget, these “unknown” values are grouped as
“No value”.
If you have a larger data set from a standard WebReports data source that requires a
moderately-intensive data source query, and if you cannot group and filter the data
in the data source, you can use the Visual Count Widget - Grouping in WebReport
JSON reportview template. This reportview groups and filters the data in the
WebReports object.
• Size
Useful for larger data sets that take longer to load to the client browser.
• Filtering
Requires filtering at the WebReports object.
• Data source
Any standard WebReports data source.
• WebReports object
Must use the Visual Count Widget - Grouping in WebReport JSON reportview
template.
• Visual Count widget configuration
– Improved performance between client and server because it does not return
all data rows to the client browser.
– Performance dependent on data transfer between the database and Content
Server before the WebReports object can group and filter the data.
– OpenText does not recommend using for a chart in a frequently loaded
location, such as on the landing page. Frequent loading of even a small data
set may result in a significant impact on performance.
Note: This approach suits larger data sets when you expect a moderately large
number of results and do not want to retrieve all the data at once.
• In this scenario, only a subset of the data set is returned to the browser. The
server-side WebReports application filters the data.
• Each time an end user changes the Active Column or changes the filtering
settings, the widget passes parameters to the WebReport, which then makes a
new server request that returns a new data set.
• It is a good practice to tune your LiveReport to only return the data columns that
you need.
[Link].2 Step-by-step Walkthrough for a Filter-enabled Chart for Larger Data Sets
This definition is optional. It will take all the values in the SubType
column and give them a friendly label. For example, “0” becomes
“Folder” and “144” becomes “Document”.
iii. Click Add Version.
• Widget Size
If using the Flow layout, choose either Single width or Double width.
• Title
Test
• Chart Type
Bar
• Source WebReport
<YourWebReportID> as created in Step Step 1.
• Active Column
MimeType
Notes
– Make sure to use the correct case because Content Server folder
columns are case-sensitive.
– Additional columns may be available depending on which
Content Server modules are installed.
– Many columns will contain unique values, such as Name, ID,
and so on, and will not be useful for a chart that counts items
with similar values.
• Show Values as Percentages
False
• Group After
Use chart default
• Sort By
Count
• Sort Direction
Descending
• Enable Tile Filtering Controls
True
• Enable Expanded View
True
c. Sign in to Smart View and verify that the Visual Count widget in the
perspective produces the bar chart, such as shown in Figure 18-4.
[Link] Scenario 4: Filter-enabled Chart for Very Large Data Sets (Data
Layer)
This section provides examples of how to limit the data retrieved from a very large
data set to produce a chart that end users can filter to get further information.
Example 18-5, “Employee Information Data for GlobalMega Corp.”
on page 122describes a conceptual use case for employee information from a global
company. Next, “Preparing to Visualize a Filter-enabled Chart from a Very Large
Data Set” on page 122 shows you how to prepare the template and “Step-by-step
Walkthrough for a Filter-enabled Chart from a Very Large Data Set” on page 124
takes you through the process of visualizing that data using the Visual Count
widget.
To produce a chart that allows better performance with larger datasets, where the
filtering task is performed at the data layer. The SQL query of the LiveReport groups
all the values. To enable end users to change the Active Column and otherwise filter
the data in the expanded view, you can design the LiveReport to use input
parameters to make dynamic queries.
Consider these first few rows and columns of a much larger data set that lists
several kinds of data for each employee in a huge global corporation. If we
want a chart that shows the number of employees in each country, we can
create a SQL query that groups by country and counts the rows for each. By
changing the parameters, we can achieve different results to explore the data in
a different way, for example, by choosing to group by Gender instead of
Country.
[Link].1 Preparing to Visualize a Filter-enabled Chart from a Very Large Data Set
If you have a large data set, such as from a LiveReport data source, that requires a
heavily-intensive database query, you can group and filter the data in the
LiveReport data source and then use the Visual Count Widget - Grouping in Data
Source Simplified JSON reportview template for the WebReports object.
Note: The Visual Count Widget - Grouping in Data Source JSON reportview
template only works in conjunction with a LiveReport data source since it
depends on the LiveReport ability to group counts of a specific column in the
data source.
• Size
Useful for larger data sets that would take too long to return from the database in
full.
• Filtering
Requires filtering at the LiveReport data source.
• Data source
– Improved performance between client and server because it does not return
all data rows to the client browser. The rows are grouped and filtered in the
data source.
– OpenText does not recommend using for a chart in a frequently loaded
location, such as on the landing page. Frequent loading of even a small data
set may result in a significant impact on performance.
Note: This approach is most suitable for situations where the amount of data
makes it more appropriate for the database engine to perform the task of
filtering and grouping the data.
• In this scenario, only a subset of the results are returned to the browser. The
server-side SQL code in the LiveReport filters the results at the data layer.
• It is a good practice to tune your LiveReport to only return the data that you
need.
Important
Each time an end user loads the page, the widget makes a server request and a
database request. Caution should be applied – if multiple users are likely to be
accessing the chart and interacting with filter parameters, the load on the
database could be significant. Before using this approach you can consider
either of the following strategies:
• Return a smaller, pre-filtered subset of the data and using the approaches
described in “Scenario 2: Filter-enabled Chart” on page 111 and “Scenario 3:
Filter-enabled Chart for Larger Data Sets (Application Layer)” on page 116.
• Schedule the data to be fetched from the database periodically and use the
cached results to generate a chart, as described in “Scenario 5: Scheduled
Data Chart for Very Large Data Sets (Data Layer)” on page 129.
[Link].2 Step-by-step Walkthrough for a Filter-enabled Chart from a Very Large Data
Set
Note: These examples have been tested for MSSQL and Oracle databases. If
you are using a different type of database, the syntax may differ.
To step through the process of visualizing a very simple chart with static data:
• Values 1-3 are mandatory and ensure the Visual Count widget passes in
the correct active column and sort details to group and sort the data
when the user changes values in the widget controls.
• Values 4-6 are optional and are used by the filtering feature in the
Expanded view. For every column that you include in your report, you
need to include an input in this section.
Note: The URL Parameter name must match the data source column
name. The URL Parameter type must be SQLList so that the widget
can send in one or more filters for each column.
d. Edit the LiveReport to add the following SQL code to the SQL section:
SELECT %1, Count(%1) as Count
FROM DAuditNew
WHERE AuditDate > %7
AND AuditID IS NOT NULL
AND SubType IS NOT NULL
AND PerformerID IS NOT NULL
~1
~2
~3
Group By %1
ORDER BY %2 %3
After the parameters and conditional templates have been substituted, this
should build a SQL statement similar to the following:
# Type Options
%1 User Input Input #1
%2 User Input Input #2
%3 User Input Input #3
%4 User Input Input #4
%5 User Input Input #5
%6 User Input Input #6
%7 Last Week-End
Note: Ensure that the Options Flag Value is blank for all three values.
These three templates are used for the three filters for the AuditID,
SubType, and PerformerID columns. These ensure the filters are only
inserted into the SQL if a filter is applied for that column. For example, if
the Visual Count widget sends in the values “0” and “144” for SubType
(only show audit events for folders and documents), then the following line
will be added to the SQL in place of the ~2 marker:
AND SubType IN (0,144)
g. In the Report Format area, select Auto LiveReport from the list.
h. Click Save and Exit.
FORMATCOLUMNS:AuditID:"[LL_REPTAG=AuditID
LABEL:AuditID /]":PerformerID:"[LL_REPTAG=Pe
rformerID
USERINFO:FULLNAME /]":SubType:"[LL_REPTAG=Su
bType LABEL:SubType /]"
This definition is optional. It will take all the values in the AuditID
column, PerformerID column, and SubType column and gives them a
friendly label. For example, with the SubType column, “0” becomes
“Folder” and “144” becomes “Document”.
iii. (Optional) Add a FORMATCOLUMNNAMES definition:
FORMATCOLUMNNAMES:AuditID:"Event
Type":PerformerID:"[LL_REPTAG_'WEBNODE_LABEL
.User' XLATE /]"
• Widget Size
If using the Flow layout, choose either Single width or Double width.
• Title
Audit Events for the Past Week
• Chart Type
Bar
• Source WebReport
<YourWebReportID> as created in Step 2.
• Active Column
AuditID
• Show Values as Percentages
False
• Group After
Use chart default
• Sort By
Count
• Sort Direction
Descending
• Enable Tile Filtering Controls
True
• Enable Expanded View
True
c. Sign in to Smart View and verify that the Visual Count widget in the
Perspective produces the bar chart as shown in Figure 18-5.
[Link] Scenario 5: Scheduled Data Chart for Very Large Data Sets (Data
Layer)
This section provides examples of how to schedule data retrieval from a very large
data set to produce a static chart. Example 18-6, “Employee Information Data for
GlobalMega Corp.” on page 129describes a conceptual use case for employee
information from a global company. Next, “Preparing to Visualize a Scheduled Data
Chart for Very Large Data Sets” on page 130shows you how to prepare the template
and “Step-by-step Walkthrough for a Scheduled Data Chart for Very Large Data
Sets” on page 130takes you through the process of visualizing that data using the
Visual Count widget.
Consider these first few rows and columns of a much larger dataset that lists
several kinds of data for each employee in a huge global corporation. If we
want a chart that shows the number of employees in each country, we can
create a SQL query that groups by country and counts the rows for each. It is
not important that the data is “live”, in this case it is acceptable to see a
snapshot of the data so long as it is updated on a daily basis.
[Link].1 Preparing to Visualize a Scheduled Data Chart for Very Large Data Sets
Note: This approach is most suitable for situations where you might expect a
very large number of results.
• In this scenario, only a subset of the results are returned to the browser. The
server-side SQL code in the LiveReport filters the results at the data layer.
• The data is fetched from the database periodically. You can define how
frequently the scheduling report runs, achieving the best balance between
placing heavy demands on the database versus how accurate and up-to-date the
results are.
• It is a good practice to tune your LiveReport to only return the data that you
need.
[Link].2 Step-by-step Walkthrough for a Scheduled Data Chart for Very Large Data Sets
Note: These examples have been tested for MSSQL and Oracle databases. If
you are using a different type of database, the syntax may differ.
To step through the process of visualizing a very simple chart with static data:
d. In the Report Format area, select Auto LiveReport from the list.
e. Click Save and Exit.
2. Create a WebReports object that generates a static data file and runs on a
schedule:
For more information about how to create a WebReport, see OpenText Content
Server - WebReports (LLESWEBR-H-UGD).
b. On the Add WebReport page, in the Name section, enter a name for the
WebReport.
c. In the Data Sourcesection, click Browse Content Server and choose the
LiveReport created in Step 1.
d. In the Reportview file section, from the list, select Comma Separated
Values Report - Scripted.
e. Click Add.
f. Open the WebReport Properties, click the Destination tab, and make the
following changes:
3. Create a WebReports object that will format the data in the required way to
support the Visual Count Widget:
4. Edit the reportview for this WebReport by making the following changes:
• Widget Size
If using the Flow layout, choose either Single width or Double width.
• Title
Storage by File Type
• Chart Type
Donut
• Source WebReport
<YourWebReportID> as created in Step 3.
• Active Column
Label
• Show Values as Percentages
Use the default value.
• Group After
Use the default value.
• Sort By
Use the default value.
• Sort Direction
Use the default value.
• Enable Tile Filtering Controls
Use the default value.
• Enable Expanded View
Use the default value.
c. Sign in to Smart View and verify that the Visual Count widget in the
Perspective produces the donut chart as shown in Figure 18-6.
To configure a custom button to appear in the Expanded view, you must prepare a
WebReport for each button. For example, you could create the following
WebReports:
Note: When using a custom button to retrieve data, the WebReport returns
document metadata to the user, not grouped counts. This means that you must
make sure to apply permissions filtering. Some data sources automatically
apply permissions filtering or can be configured to do so. For more information
about how to configure permissions filtering, see the documentation for your
data source. If the data source does not have permission filtering, you can edit
the Row Section of the reportview that generates the JSON data to exclude
nodes to which the user does not have permissions by adding the following
tag:
[LL_WEBREPORT_INCLUDEIF "[LL_REPTAG=DATAID
PERMCHECK:SEECONTENTS /]" == "TRUE" /]
• Active Column
[LL_REPTAG_&active_column /]
Name of the column in the data source that the WebReport uses for filtering the
data.
• Count Column
[LL_REPTAG_&count_column /]
Name of the column in the data source that contains the count values.
• Column Names
[LL_REPTAG_&column_names /]
Comma-separated list that shows the current columns available for grouping and
filtering.
• View Value as Percentage
[LL_REPTAG_&view_value_as_percentage /]
Boolean that indicates whether the values are displayed as a percentage of the
total or as the actual count.
• Group After
[LL_REPTAG_&group_after /]
Current threshold that determines how many distinct data values should be
displayed before grouping the remaining values under the label “Other”.
• Sort Column
[LL_REPTAG_&sort_by /]
Name of the column currently being used to sort the grouped data.
• Sort Direction
[LL_REPTAG_&sort_order /]
ASC or DESC string that indicates whether the grouped data is currently sorted
in ascending order or descending order.
• Total Count
[LL_REPTAG_&total_count /]
Total count of the data rows, including applied filters.
• Filters
[LL_REPTAG_&fc_filters /]
JSON array of the currently applied filters.
1. “To create a WebReport that generates the JSON data:“ on page 136
2. “To create a WebReport that converts the JSON data to a CSV file:“ on page 136
3. “To create a WebReport that calls the other two WebReports to generate and
convert the data:“ on page 137
1. Create a WebReports node that uses the Visual Count Widget - Grouping on
Client JSON default reportview.
For example:
[LL_WEBREPORT_INSERTJSON @FILTEREDCOUNT
INCLUDECOLUMNS:"{'TYPE','FILESIZE'}"
FILTERBY:[LL_REPTAG_&fc_filters /]
GROUPBY:"FALSE"
COUNTFORMAT:"SI" /]
1. Create a WebReports node that uses the Comma Separated Values Report -
Scripted default reportview.
c. Click Update.
To create a WebReport that calls the other two WebReports to generate and
convert the data:
1. Create a WebReports node that uses the Blank Report default reportview.
[LL_REPTAG_$CREATECSV RUNSWR:DSREQUESTDATA:
[LL_REPTAG_!chartData
ASSOC:data /]:DSFILETYPE:OSCRIPT SHOW /]
Notes
d. For the GETJSON constant, in the Constant Type box, from the list, select
Content Server Object, click Browse, and then select the WebReport
created in “To create a WebReport that generates the JSON data:“
on page 136.
e. For the CREATECSV constant, in the Constant Type box, from the list, select
Content Server Object, click Browse, and then select the WebReport
created in “To create a WebReport that converts the JSON data to a CSV
file:“ on page 136.
f. Click Update and close the window.
6. Sign in to the Perspective Manager, for the Visual Count widget, configure the
Button WebReports settings to associate this WebReport to the custom button.
7. Sign in to Smart View and verify the custom button in the Expanded View of
the Visual Count widget.
1. “To create a WebReport that generates the JSON data:“ on page 138
2. To create a WebReport that converts the JSON data to an HTML table:
on page 139
3. “To create a WebReport that calls the other two WebReport to generate and
convert the data:“ on page 139
1. Create a WebReports node that uses the Visual Count Widget - Grouping on
Client JSON default reportview.
For example:
[LL_WEBREPORT_INSERTJSON @FILTEREDCOUNT
INCLUDECOLUMNS:"{'TYPE','FILESIZE'}"
FILTERBY:[LL_REPTAG_&fc_filters /]
GROUPBY:"FALSE"
COUNTFORMAT:"SI" /]
• Create a WebReports node using the HTML Table Report - Basic Scripted
default reportview.
To create a WebReport that calls the other two WebReport to generate and
convert the data:
1. Create a WebReports node that uses the Blank Report default reportview.
which will resolve to the email address of the current user who runs this
WebReport.
d. In the Email Subject box, enter a subject.
e. Click Update.
[LL_REPTAG_$CREATETABLE RUNSWR:DSREQUESTDATA:
[LL_REPTAG_!chartData
ASSOC:data /]:DSFILETYPE:OSCRIPT SHOW /]
Notes
6. Sign in to the Perspective Manager and open the perspective that includes the
Visual Count widget to which you want to associate this custom button
WebReport.
7. On the Configure tab, select the Visual Count widget and configure the Button
WebReports settings to associate this WebReport to the custom button.
8. Sign in to Smart View and verify the custom button in the Expanded View of
the Visual Count widget.
1. “To create a WebReport that generates the JSON data snapshot:“ on page 141
2. “To create a WebReport that calls the JSON WebReport and redirects the user to
the snapshot overview:“ on page 141
3. “To create a WebReport that visualizes the snapshot as a chart for a new Visual
Count widget :“ on page 142
1. Create a WebReports node that uses the Visual Count Widget - Grouping on
Client JSON default reportview.
For example:
[LL_WEBREPORT_INSERTJSON @FILTEREDCOUNT
INCLUDECOLUMNS:"{'TYPE','FILESIZE'}"
FILTERBY:[LL_REPTAG_&fc_filters /]
GROUPBY:"FALSE"
COUNTFORMAT:"SI" /]
To create a WebReport that calls the JSON WebReport and redirects the user
to the snapshot overview:
1. Create a WebReports node that uses the Blank Report default reportview.
Notes
• Next, we need to build a Smart View URL to this node and redirect
the user to it using the REDIRECT sub-tag. Although this WebReport
runs using a Classic View WebReports URL, this is hidden from the
user who is only aware that they start and end in Smart View. The
resulting URL will take the user to the document overview screen
for the new document and will resemble: [Link]
nodes/12345
b. Click Add Version & Continue.
To create a WebReport that visualizes the snapshot as a chart for a new Visual
Count widget :
1. Create a WebReports node that uses the Blank Report default reportview.
Note: This WebReport uses the GETTEXT sub-tag to read in the JSON
and then return it to the chart. The data in the JSON file is ungrouped,
so you must choose an Active Column to group the data when the
chart is run.
b. Click Add Version & Continue.
6. Sign in to the Perspective Manager and open the perspective that includes the
Visual Count widget to which you want to associate this Button WebReport.
a. In the Source WebReport box, enter the ID for the WebReport created in
this procedure.
b. In the Active Column box, enter a column name.
c. In the Enable Tile Filtering Controls, select False.
d. In the Enable Expanded View box, select False.
1. “To create a WebReport that generates the JSON data:“ on page 144
2. “To create a WebReport that calls the JSON WebReport and redirects the user to
the snapshot overview:“ on page 141
1. Create a WebReports node that uses the Visual Count Widget - Grouping on
Client JSON default reportview.
2. Edit the WebReport properties:
For example:
[LL_WEBREPORT_INSERTJSON @FILTEREDCOUNT
INCLUDECOLUMNS:"{'TYPE','FILESIZE'}"
FILTERBY:[LL_REPTAG_&fc_filters /]
GROUPBY:"FALSE"
COUNTFORMAT:"SI" /]
Note: For this example custom button, you must ensure that the data
source consists of nodes and the output JSON data includes the DataID
column.
To create a WebReport that calls the JSON WebReport to retrieve the data and
change the owner:
1. Create a WebReports node that uses the Blank Report default reportview.
2. Edit the WebReport reportview:
Notes
• This WebReport extracts a list of DataIDs in the JSON data and calls
NODEACTION:OWNEDBY for each node in the list. If the current user
has the appropriate permissions, they will be assigned as the new
owner.
d. For the GETJSON constant, in the Constant Type box, from the list, select
Content Server Object, click Browse, and then select the WebReport
created in “To create a WebReport that generates the JSON data:“
on page 144
4. Sign in to the Perspective Manager and open the perspective that includes the
Visual Count widget to which you want to associate this Button WebReport.
a. In the Source WebReport box, enter the ID for the WebReport created in
this procedure.
b. Click Create.
This section describes the use and configuration of the following Workflow widgets:
Title
Type a title. The title is displayed as the name of the tile on the Smart View
Home page. By default, the title is Workflow Tracking.
Workflow Type
Choose the Workflow Types that display on the tile. Options include: Managed
Workflows, Initiated Workflows, or Both managed and initiated Workflows.
Reference
Choose None, Parent, or Custom from the Reference list to filter the Workflows
that the widget shows:
• None does not apply a filter and shows all Workflows that are managed or
initiated by the current user.
• Parent only shows Workflows related to the container that the current
perspective is configured for.
• Custom only shows Workflows related to the item chosen in the Custom
Reference list.
Custom Reference
Click Browse to choose an item to filter Workflows with. The widget will only
show Workflows related to the chosen item.
Title
Type a title. The title is displayed as the name of the tile on the Smart View
Home page. By default, the title is Workflow Monitoring.
Workflow Status Filter
Browse Content Server to find and select the defined Workflow Status Item that
filters the Workflows that display on the tile.
This widget is part of the Extended ECM for SAP SuccessFactors module.
Note: The effective date option supports only the SuccessFactors user
business object and its data attributes.
2. Click Technical Settings > Integration. In the Scripts list, edit the SF Query
URL script.
<xsl:text>$filter=</xsl:text>
<xsl:for-each select="query/input/value[
@parameter!='asOfDate' and
@parameter!='includeInactive']">
<xsl:choose>
<xsl:when test="contains(@parameter,'/')">
<xsl:value-of select="substring-after(
@parameter,'/')"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="@parameter"/>
</xsl:otherwise>
</xsl:choose>
<xsl:text>%20eq%20%27</xsl:text>
<!--xsl:value-of select="."/-->
<xsl:value-of select="."/>
<xsl:text>%27</xsl:text>
<xsl:if test="position()!=last()">
<xsl:text> and </xsl:text>
</xsl:if>
</xsl:for-each>
<xsl:if test="query/input/value[
@parameter='includeInactive' and .='true']">
<xsl:text>%20and%20%28status%20eq%20%27
inactive%27%20
or%20status%20eq%20%27active%27%29
</xsl:text>
</xsl:if>
<xsl:if test="query/input/
value[@parameter='asOfDate']">
<xsl:text>&asOfDate=</xsl:text>
<xsl:value-of select="query/input/value[
@parameter='asOfDate']"/>
</xsl:if>
<xsl:text>&</xsl:text>
<xsl:for-each select="properties/property/map">
<xsl:if test="position()=1">
<xsl:text>$select=</xsl:text>
</xsl:if>
<xsl:choose>
<xsl:when test="contains(.,'__metadata/uri')">
<xsl:call-template name=
"substring-before-last">
<xsl:with-param name="string1" select="."/>
<xsl:with-param name="string2"
select="'/__metadata'"/>
</xsl:call-template>
<[Link]>/</[Link]>
<xsl:value-of select="//businessobject
/mappings/map[@name='identifier']"/>
</xsl:when>
<xsl:when test="contains(.,'__deferred/uri')">
<xsl:call-template name=
"substring-before-last">
<xsl:with-param name="string1" select="."/>
<xsl:with-param name="string2"
select="'/__deferred'"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="."/>
</xsl:otherwise>
</xsl:choose>
<xsl:if test="position()!=last()">
<xsl:text>,</xsl:text>
</xsl:if>
<xsl:if test="position()=last()">
<xsl:text>&</xsl:text>
</xsl:if>
</xsl:for-each>
<xsl:for-each select="properties/property/
map[contains(.,'/')]">
<xsl:if test="position()=1">
<xsl:text>$expand=</xsl:text>
</xsl:if>
<xsl:variable name="substring-after-last">
<xsl:call-template name=
"substring-after-last">
<xsl:with-param name="string1"
select="."/>
<xsl:with-param name="string2"
select="'/'"/>
</xsl:call-template>
</xsl:variable>
<xsl:choose>
<!--xsl:when test="ends-with($substring-
after-last,'Nav')">
<xsl:value-of select="."/>
</xsl:when-->
<xsl:when test="$substring-after-last!
='uri'">
<!--xsl:value-of select=
"substring-before(.,'/')"/-->
<xsl:call-template name=
"substring-before-last">
<xsl:with-param name=
"string1"select="."/>
<xsl:with-param name=
"string2"select="'/'"/>
</xsl:call-template>
</xsl:when>
<xsl:when test="$substring-after-
last='uri'">
<xsl:choose>
<xsl:when test="contains
(.,'/__deferred')">
<xsl:call-template
name="substring-
before-last">
<xsl:with-param
name="string1"
select="."/>
<xsl:with-param
name="string2"
select=
"'/__deferred'"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:call-template
name="substring-
before-last">
<xsl:with-param
name="string1"
select="."/>
<xsl:with-param
name="string2"
select="'/__metadata'"/>
</xsl:call-template>
</xsl:otherwise>
</xsl:choose>
</xsl:when>
</xsl:choose>
<xsl:if test="position()!=last()">
<xsl:text>,</xsl:text>
</xsl:if>
<xsl:if test="position()=last()">
<xsl:text>&</xsl:text>
</xsl:if>
</xsl:for-each>
</xsl:when>
<xsl:otherwise>
<xsl:text>odata/v2/</xsl:text>
<xsl:value-of select=
"mappings/map[@name='module_name']"/>
<xsl:text>?$filter=</xsl:text>
<xsl:value-of select=
"mappings/map[@name='identifier']"/>
<xsl:text>%20eq%20%27</xsl:text>
<xsl:text>0</xsl:text>
<xsl:text>%27</xsl:text>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<xsl:template name="substring-before-last">
<xsl:param name="string1" select="''"/>
<xsl:param name="string2" select="''"/>
<xsl:if test="$string1 != '' and $string2 != ''">
<xsl:variable name="head"
select="substring-before($string1, $string2)"/>
<xsl:variable name="tail"
select="substring-after($string1, $string2)"/>
<xsl:value-of select="$head"/>
<xsl:if test="contains($tail, $string2)">
<xsl:value-of select="$string2"/>
<xsl:call-template name="substring-before-last">
<xsl:with-param name="string1"
select="$tail"/>
<xsl:with-param name="string2"
select="$string2"/>
</xsl:call-template>
</xsl:if>
</xsl:if>
</xsl:template>
<xsl:template name="substring-after-last">
<xsl:param name="string1"/>
<xsl:param name="string2"/>
<xsl:choose>
<xsl:when test="contains($string1, $string2)">
<xsl:call-template name="substring-after-last">
<xsl:with-param name="string1"
select="substring-after
($string1, $string2)"/>
<xsl:with-param name="string2"
select="$string2"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="$string1"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<xsl:template name="substring-before-sfsfNavigation">
<xsl:param name="string1"/>
<xsl:choose>
<xsl:when test="ends-with($string1,'Nav')">
<xsl:call-template
name="substring-before-sfsfNavigation">
<xsl:with-param name="string1"
select="substring-before($string1, '/')"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="$string1"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
</xsl:stylesheet>
4. Click Change.
2. For the Employee Workspaces widget, select True for the Enable Effective Date
Input option.
4. The date picker for selecting an effective date displays. Click the Date
picker icon and select a date to define the effective date.
The Activity Logs widget is included in the Employee workspace container for all
functional rights Employee, Manager and HR Administrator and shows the
document specific activities that happened on this specific employee workspace.
Note: The Activity Logs widget shows information from the Content Server
audit history. If the audit history has been cleared, activities in the Activity
Logs widget are not displayed either.
Note: The logged in user sees the information for which he has See
permission in Content Server. Since the See permission does not apply to
the Delete Document audit activity, by default all Delete audits will be
displayed. If you do not want to display any Delete Document Audit
activities, you must select the False option.
Important
For the document types in the DocumentType classification, you must have
assigned unique names. If you use duplicate document type names, uploaded
documents can be stored in the wrong folder.
2. Configure the name format to be displayed for users. For the Create Document
widget, we recommend to select the FirstName LastName and the Append Log-
in ID check box options.
Users can create a snapshot for all business attachments displayed in the widget.
Snapshots are folders in Content Server, which contain a Generation of the latest
version of each business attachment that is a document. A Generation is a copy of a
document, which is separated from the original document, unlike a version. For
more information, see the Content Server help. The snapshot contains a shortcut to
objects other than documents. The name of the folder starts with a prefix, which you
configure for the widget.
In the expanded view, you see additional information for each business attachment
such as description, location and version.
General
Property Description
Title Title of the Business Attachments widget.
Default is Business attachments.
Snapshot folder name prefix Prefix that is added to the snapshot folder
when you create a snapshot from this
widget. A snapshot freezes the current
version of all business attachments of the
business object and stores them in a folder.
Business attachment
Property Description
Business object ID Category attribute that contains the ID of the
business objects for which you want to
display business attachments.
Business object type Category attribute that contains the business
object type.
Property Description
Business application ID Category attribute that contains the ID of the
business application where the business
object type resides.
If you want to use attribute sets in these fields, you must use the following format:
{categories.<category ID>_<set number>_<attribute ID>}, for example,
{categories.37275_33_1_34}. If the attribute picker does not provide this format,
you must enter it manually.
To retrieve the attribute ID, run the following report: <URL of content server>?
func=[Link].
Collapsed view
Property Description
Message for empty result Custom message if no business attachments
are available.
Order by Orders the list of business attachments by a
column. The default sorting is ascending by
the name of the business attachment.
Property Description
Metadata fields Additional fields to display metadata in the
widget. Enter a label and the value. You can
use one of the following variables: {name},
{description}, {type_name},
{modify_date}, {create_date}. The
{name} variable uses the name of the
business workspace, which may already be
assembled from several attributes.
Expanded view
Property Description
Order by Orders the list of business attachments by a
column and defines the sort direction.
Snapshot
Property Description
Parent folder name Folder in business workspace, where
Snapshots are created.
Snapshot name prefix The name of a snapshot consists of the prefix
and a timestamp.
Property Description
Default group by criterion Groups the documents by their creation date
or a classification.
Hide group by criterion dropbox Provides an option for users to hide certain
groups of documents. The default settings
display the dropbox.
Hide metadata Provides an option for users to hide
metadata of documents. The default settings
display the metadata.
Hide empty fields Hide metadata fields that contain no data.
The default settings display empty metadata
fields.
Note: Do not use multivalue attributes and multi-row set attributes in the
header widget.
Workspace Properties
Property Description
Title Name of the business workspace, prefilled
with the {name} node property.
Type Name of the workspace type, prefilled with
the {business_properties.
workspace_type_name} business
property.
Description Description of the business workspace,
prefilled with the {description} node
property.
Workspace properties are displayed in the left part of the Header widget in the
following top-down order, with the font becoming smaller. You can use the
suggested properties, add others, and combine attributes and properties with text.
Widget
You can embed another widget in the header widget. It depends on your system,
which widgets are available.
Property Description
Embed Widget Select one of the available widgets to embed
it into the header widget. It is displayed in
the right half of the header widget. Currently
available is the Activity Feed widget, which
displays all activities in relation to this
business workspace and its related child
workspaces. You see comments or recently
added documents.
Metadata settings
Property Description
Hide metadata Provides an option for users to hide
metadata of documents. The default settings
display the metadata.
Hide empty fields Hide metadata fields that contain no data.
The default settings display empty metadata
fields.
Property Description
Metadata The Header widget uses data from category
attributes. You select a category or single
attributes. To group attributes, enter a group
name and then select the categories and
attributes. Leave the group name empty to
add a category or attribute without a group.
Drag attributes or groups to change the
order.
Favorite
You can hide the Favorite button in the Header widget.
In the configuration of this widget, select one or more business object types. The
business object type must have a configuration for the category attribute, which
contains the barcode value.
•
• OpenText Content Server Mobile - Configuration Guide (CSMOB-CGD)