3. Table of Contents
Preface...........................................................................................................................................................13
Changes to This Book........................................................................................................................................13
Related Documentation.....................................................................................................................................13
Chapter 1:
Teradata Viewpoint Basics........................................................................................................15
Teradata Viewpoint Portal and Portlets..........................................................................................................15
Getting Started.............................................................................................................................................15
Setting Up the Portal for Portlets..............................................................................................................16
Working With Portlets in the Portal........................................................................................................20
Chapter 2:
Profile.............................................................................................................................................................27
Profile...................................................................................................................................................................27
About the Personal Info Tab.....................................................................................................................27
About the Teradata Accounts Tab............................................................................................................29
Chapter 3:
System Administration..................................................................................................................33
System Administration......................................................................................................................................33
Admin Portlets.............................................................................................................................................33
Security and Permissions...........................................................................................................................34
Backup..................................................................................................................................................................34
About Backup Errors..................................................................................................................................35
Scheduling Viewpoint Backups.................................................................................................................35
Certificates...........................................................................................................................................................35
About Certificate Authorities....................................................................................................................36
About HTTPS Connections.......................................................................................................................36
General.................................................................................................................................................................38
Setting General Options.............................................................................................................................38
LDAP Servers......................................................................................................................................................38
Teradata Viewpoint User Guide, Release 14.01 3
4. What Is an LDAP Server?............................................................................................................................39
Adding an LDAP Server..............................................................................................................................39
About Role Mapping....................................................................................................................................40
Managed Servers..................................................................................................................................................41
Adding a Managed Server...........................................................................................................................42
Deleting a Managed Server.........................................................................................................................42
Enabling or Disabling a Managed Server..................................................................................................42
Portlet Library......................................................................................................................................................43
Enabling or Disabling Portlets....................................................................................................................43
Deleting a Shared Portlet.............................................................................................................................44
Query Group Setup.............................................................................................................................................44
Creating a Query Group..............................................................................................................................44
Viewing Query Groups................................................................................................................................46
Editing a Query Group................................................................................................................................46
Filter Symbols...............................................................................................................................................46
Deleting a Query Group..............................................................................................................................47
Roles Manager......................................................................................................................................................47
About Roles...................................................................................................................................................48
Example Roles...............................................................................................................................................48
About the Roles Manager View..................................................................................................................49
Adding a Role................................................................................................................................................49
Editing a Role................................................................................................................................................50
Copying a Role..............................................................................................................................................51
Deleting a Role..............................................................................................................................................52
Assigning Users to a Role............................................................................................................................52
Removing Users from a Role......................................................................................................................53
Portlet Preferences and Permissions.........................................................................................................53
Enabling Portlets for a Role........................................................................................................................53
Enabling Notifications for a Role...............................................................................................................54
Configuring Default Portlet Settings.........................................................................................................54
Granting Metric Permissions for a Role....................................................................................................55
Granting Portlet Permissions for a Role...................................................................................................55
Portlet Permissions......................................................................................................................................56
Shared Pages.........................................................................................................................................................61
About Shared Page Controls.......................................................................................................................62
About Read-Only and Mandatory Shared Pages.....................................................................................63
Creating a Shared Page................................................................................................................................63
Copying a Shared Page................................................................................................................................64
Editing Portlets on a Shared Page..............................................................................................................65
Viewing All Shared Pages............................................................................................................................66
Deleting a Shared Page................................................................................................................................66
Teradata Systems.................................................................................................................................................66
General...........................................................................................................................................................67
Table of Contents
4 Teradata Viewpoint User Guide, Release 14.01
5. Data Collectors........................................................................................................................................................72
System Health..........................................................................................................................................................79
Canary Queries.......................................................................................................................................................82
Alerts........................................................................................................................................................................84
Monitor Rates..........................................................................................................................................................93
Log Table Clean Up................................................................................................................................................95
Clean Up Schedule.................................................................................................................................................96
Disk Usage...............................................................................................................................................................96
User Manager.................................................................................................................................................................97
About the User List View......................................................................................................................................97
About the User Details View.................................................................................................................................98
Chapter 4:
Aster Completed Processes...............................................................................................................103
Aster Completed Processes........................................................................................................................................103
Aster Completed Processes View.......................................................................................................................103
About Details View..............................................................................................................................................108
Chapter 5:
Aster Node Monitor....................................................................................................................................111
Aster Node Monitor....................................................................................................................................................111
Aster Node Monitor View...................................................................................................................................111
About the Details View........................................................................................................................................116
Chapter 6:
Calendar................................................................................................................................................................119
Calendar........................................................................................................................................................................119
About the Calendar Week View.........................................................................................................................119
About the Calendar Month View.......................................................................................................................120
About the Calendar Event Details View............................................................................................................121
Adding an Event...................................................................................................................................................122
Editing an Event...................................................................................................................................................123
Deleting an Event.................................................................................................................................................124
Table of Contents
Teradata Viewpoint User Guide, Release 14.01 5
6. Chapter 7:
Canary Response Times..............................................................................................................125
Canary Response Times....................................................................................................................................125
About the Canary Response Times View................................................................................................125
About the Preferences View......................................................................................................................127
Chapter 8:
Capacity Heatmap.............................................................................................................................131
Capacity Heatmap.............................................................................................................................................131
About the Capacity Heatmap View.........................................................................................................131
About the Capacity Heatmap Menus and Toolbar...............................................................................139
About the Preferences View......................................................................................................................142
Chapter 9:
Elastic Performance........................................................................................................................145
Elastic Performance...........................................................................................................................................145
About the Elastic Performance View.......................................................................................................145
About the Preferences View......................................................................................................................148
Chapter 10:
External Content.................................................................................................................................149
External Content................................................................................................................................................149
About the Preferences View......................................................................................................................149
Chapter 11:
Lock Viewer.............................................................................................................................................151
Lock Viewer........................................................................................................................................................151
About the Lock Viewer View....................................................................................................................151
Table of Contents
6 Teradata Viewpoint User Guide, Release 14.01
7. Chapter 12:
Metrics Analysis............................................................................................................................................159
Metrics Analysis...........................................................................................................................................................159
About the Metrics Analysis View.......................................................................................................................159
About the Preferences View................................................................................................................................165
Chapter 13:
Metrics Graph...................................................................................................................................................169
Metrics Graph..............................................................................................................................................................169
About the Metrics Graph View..........................................................................................................................169
About the Metrics Graph Menus and Toolbar.................................................................................................177
Chapter 14:
My Queries..........................................................................................................................................................179
My Queries...................................................................................................................................................................179
About the My Queries View...............................................................................................................................179
About the Details View........................................................................................................................................184
About Managing Queries and Sessions.............................................................................................................189
About the Preferences View................................................................................................................................192
Chapter 15:
Node Resources.............................................................................................................................................195
Node Resources............................................................................................................................................................195
About the Summary Views.................................................................................................................................195
About the Table View..........................................................................................................................................201
About the Details View........................................................................................................................................204
About the Preferences View................................................................................................................................207
Chapter 16:
Productivity.......................................................................................................................................................209
Productivity..................................................................................................................................................................209
About the Productivity View..............................................................................................................................209
About the Preferences View................................................................................................................................210
Table of Contents
Teradata Viewpoint User Guide, Release 14.01 7
8. Chapter 17:
Query Groups.........................................................................................................................................215
Query Groups.....................................................................................................................................................215
About the Query Groups View.................................................................................................................215
About the Details View..............................................................................................................................222
About Managing Queries and Sessions...................................................................................................227
About the Preferences View......................................................................................................................229
Chapter 18:
Query Monitor.......................................................................................................................................231
Query Monitor...................................................................................................................................................231
About the Query Monitor View...............................................................................................................231
About the Utility View..............................................................................................................................242
About the Details View..............................................................................................................................242
About Managing Queries and Sessions...................................................................................................248
About the Preferences View......................................................................................................................251
Chapter 19:
Query Spotlight....................................................................................................................................255
Query Spotlight..................................................................................................................................................255
About the Query Spotlight View..............................................................................................................255
About the Details View .............................................................................................................................260
About the Preferences View......................................................................................................................266
Chapter 20:
Remote Console...................................................................................................................................269
Remote Console.................................................................................................................................................269
About the Remote Console View.............................................................................................................269
About the Remote Console Menus and Toolbar...................................................................................271
About Console Utilities.............................................................................................................................272
About the Preferences View......................................................................................................................273
Table of Contents
8 Teradata Viewpoint User Guide, Release 14.01
9. Chapter 21:
Space Usage......................................................................................................................................................275
Space Usage..................................................................................................................................................................275
About the Space Usage View..............................................................................................................................275
About the Space Usage Details View.................................................................................................................284
About the Preferences View................................................................................................................................285
Chapter 22:
SQL Scratchpad..............................................................................................................................................287
SQL Scratchpad............................................................................................................................................................287
About the Query Box...........................................................................................................................................287
About Query Results............................................................................................................................................290
About the Object Browser...................................................................................................................................292
About the History Tab.........................................................................................................................................294
About the Saved Tab............................................................................................................................................295
Chapter 23:
System Health.................................................................................................................................................297
System Health...............................................................................................................................................................297
About the System Health View...........................................................................................................................297
About the System Health Details View.............................................................................................................298
About the Preferences View................................................................................................................................300
Chapter 24:
Today's Statistics.........................................................................................................................................303
Today's Statistics..........................................................................................................................................................303
About the Today's Statistics View......................................................................................................................303
About the Preferences View................................................................................................................................306
Chapter 25:
TVS Monitor.......................................................................................................................................................309
TVS Monitor................................................................................................................................................................309
TVS Monitor Concepts........................................................................................................................................309
Table of Contents
Teradata Viewpoint User Guide, Release 14.01 9
10. Selecting a View..........................................................................................................................................310
Viewing Cylinder Distribution by Grade................................................................................................310
Viewing Historical Cylinder Distribution by Grade.............................................................................310
Viewing Cylinder Allocation by Temperature and Grade...................................................................311
Chapter 26:
Viewpoint Monitoring....................................................................................................................315
Viewpoint Monitoring......................................................................................................................................315
About the Viewpoint Monitoring View..................................................................................................315
About the Preferences View......................................................................................................................319
Chapter 27:
Workload Designer...........................................................................................................................323
Workload Designer...........................................................................................................................................323
Workload Designer Concepts..................................................................................................................323
About the Workload Designer View.......................................................................................................324
About Ruleset Options..............................................................................................................................325
About the Ruleset General View..............................................................................................................330
About Ruleset States...................................................................................................................................332
About Classification Settings....................................................................................................................344
About Ruleset Sessions..............................................................................................................................350
About Ruleset Filters..................................................................................................................................356
About Ruleset Throttles.............................................................................................................................358
About Ruleset Workloads.........................................................................................................................361
About Ruleset Exceptions.........................................................................................................................378
Chapter 28:
Workload Health.................................................................................................................................381
Workload Health...............................................................................................................................................381
Workload Health Concepts......................................................................................................................381
About the Workload Health View...........................................................................................................382
About the Workload Health Details View..............................................................................................384
About the Preferences View......................................................................................................................387
Table of Contents
10 Teradata Viewpoint User Guide, Release 14.01
11. Chapter 29:
Workload Monitor........................................................................................................................................389
Workload Monitor......................................................................................................................................................389
Workload Monitor Concepts..............................................................................................................................389
Workload Monitor Views...................................................................................................................................391
About the State Matrix.........................................................................................................................................394
About the Dynamic Pipes View.........................................................................................................................395
About the Static Pipes View................................................................................................................................397
About the Distribution View..............................................................................................................................400
About the Workload Details View.....................................................................................................................403
About the Workload Group View......................................................................................................................405
About the Request Details View.........................................................................................................................405
About Managing Queries and Sessions.............................................................................................................410
About the Preferences View................................................................................................................................412
Table of Contents
Teradata Viewpoint User Guide, Release 14.01 11
13. Preface
Changes to This Book
Date and Release Description
October 2012
14.01
Updated for the 14.01 release.
Related Documentation
Access the Teradata Information Products web site to view or download additional
documentation related to this product.
1. Go to http://www.info.teradata.com.
2. Under the Online Publications subcategory, click General Search.
3. Search on the title or publication ID.
Title Publication ID
Teradata Viewpoint Configuration Guide
Describes how to configure and upgrade a Teradata Viewpoint server.
B035-2207
Teradata Alerts User Guide
Describes how to set up and monitor alerts using Teradata Alerts portlets.
B035-2210
Teradata Alerts Installation and Configuration Guide
Describes how to configure Teradata Alerts on a Teradata Viewpoint server.
B035-2211
Teradata Data Lab User Guide
Describes how to use Teradata Data Lab portlets.
B035-2212
Teradata Viewpoint User Guide, Release 14.01 13
15. CHAPTER 1
Teradata Viewpoint Basics
Teradata Viewpoint Portal and Portlets
The Teradata Viewpoint portal is a framework where Web-based applications, known as
portlets, are displayed. IT professionals and business users can customize their portlets to
manage and monitor their Teradata systems using a Web browser.
Portlets enable users across an enterprise to customize tasks and display options to their
specific business needs. You can view current data, run queries, and make timely business
decisions, reducing the database administrator workload by allowing you to manage your
work independently. Portlets are added to a portal page from a menu. The Teradata
Viewpoint Administrator configures access to portlets based on your role.
Getting Started
Learn how to start and end a Teradata Viewpoint session, use the help, and use notifications.
Logging On
Logging on to the Teradata Viewpoint portal starts your session so you can begin working
with the Teradata Viewpoint portal.
1 Open a browser.
2 Enter the address for your Teradata Viewpoint portal.
The Welcome page appears, with the portal version number shown at the bottom.
3 Log on to the Teradata Viewpoint portal.
If your Teradata Viewpoint system is set up to create a user profile automatically, the
username and password you enter are authenticated against your company-provided
username and password the first time you log on to Teradata Viewpoint. Automatic
profile creation is known as auto-provisioning.
Using Viewpoint Help
The Teradata Viewpoint Help provides information about how to use Teradata Viewpoint
to manage and monitor your Teradata systems.
1 Click to open a browser window containing Teradata Viewpoint Help.
The display is divided into two panes. The Contents pane on the left lists the hierarchy
of topics contained in the help.
2 Do any of the following:
Teradata Viewpoint User Guide, Release 14.01 15
16. • Click next to a topic name to expand the list of available topics.
• Click next to a topic name to collapse the list of available topics.
3 Click any topic name to display corresponding topic information in the right pane.
4 [Optional] Select links to related topics that are above (parent) or below (child) the
current topic in the content hierarchy.
Using Notifications
Teradata Viewpoint uses notifications to communicate the status of Viewpoint operations.
Notifications are displayed in the Teradata Viewpoint portal for 72 hours from the last status
change.
Notifications appear if they are enabled for your role.
1 Read the notifications, and click to hide the notifications.
2 [Optional] Click to display hidden notifications.
You can click the icon again to hide notifications.
Logging Off
Logging off the Teradata Viewpoint portal ends your current session and returns you to the
Welcome page.
1 From the Teradata Viewpoint main menu bar, click Logout to exit the portal.
All page content is preserved for your next Teradata Viewpoint session. Any open
Teradata Viewpoint Help window is closed.
Setting Up the Portal for Portlets
Teradata Viewpoint provides portlets to manage and monitor systems. A portal page is a
virtual work space where you decide which portlets to display and how to arrange them on
the page. Examples of ways to organize your work include defining a page for each system
being monitored, or for each type of query or user. The currently selected page is called the
active page.
A portal page has two columns that can be resized. After adding portlets to the portal, you
can drag and drop portlets into either column. You can resize the width of the portal
columns on each page by dragging the column divider until the minimum size of a column is
reached. Portlets that can be horizontally resized will expand to fill the width of the column.
Portlets that cannot be horizontally resized are not affected by resizing the portal columns.
Resizing the browser window adjusts the columns proportionally unless a column is at its
minimum size. Not all Viewpoint portlets and products support resizing or two-column
layout.
Chapter 1 Teradata Viewpoint Basics
16 Teradata Viewpoint User Guide, Release 14.01
17. A shared page contains portlets that are applicable to your role. The Teradata Viewpoint
Administrator controls the type of shared page you have access to and can discuss
limitations you may have with read-only and mandatory pages. Your role may be prevented
from adding portlets, deleting portlets, moving portlets on a page, as well as other functions
you may have been accustomed to doing with regular portal pages.
Adding a Page
Organize your portlets by adding pages to the Teradata Viewpoint portal. Multiple pages
can be added or removed. The newest page is always the active page unless you click another
tab.
1 In the portal, do one of the following:
• Click Add Page.
• Click and select Add Page if shared page administration state is enabled for your
role.
A new tab appears and becomes the active page.
2 [Optional] Add portlets from the Add Content menu.
Naming a Page
One way you can customize the Teradata Viewpoint portal is by giving meaningful names to
the pages that display portlets. You can change the page name at any time during a Teradata
Viewpoint session. Two pages can have the same name.
1 Click the page tab to highlight the page name.
2 Enter the new name up to 30 characters.
3 Press Enter to apply the new name.
4 [Optional] Rearrange the portal pages to group and organize pages or according to the
frequency of use.
Adding a Portlet
A portlet can be added to the active page at any time during a session. Except for the
Calendar portlet, multiple instances of a portlet can be added to a portal page.
1 In the portal, click Add Content.
2 Select a portlet from the submenus.
The portlet is added to the top of the left-most column.
3 [Optional] Reposition the portlet on the portal page by dragging it to another location.
Chapter 1 Teradata Viewpoint Basics
Teradata Viewpoint User Guide, Release 14.01 17
18. Filtering Portlets
Locate a portlet by using the keyword filter box and the SEARCH RESULTS list. This
method is also useful when you want to add a portlet to the active page and the list of portlets
is long.
1 Click in the keyword filter box, and begin typing the portlet name.
As you type, the SEARCH RESULTS list shows the portlets that match your filter
criteria. This field is not case-sensitive.
2 Click a portlet name in the SEARCH RESULTS list to add it to the page.
Resizing Portal Columns
Portlets that can be horizontally resized will expand to fill the width of the column. Portlets
that cannot be horizontally resized are not affected by resizing the portal columns.
1 Mouse over the column divider.
The cursor changes to a bidirectional arrow .
2 Drag the column divider to the left or to the right to resize the column width.
The portlets resize after the column divider is released.
Arranging Pages
Initially portal pages appear in the order in which they have been added from left to right.
Arranging pages does not change page content, and can be done at any time during your
Teradata Viewpoint session.
1 In the portal task bar, mouse over the tab you intend to move.
The cursor changes to a directional cursor.
2 Drag the tab to the left or to the right of its current position.
The tab aligns in the new position.
Adding a Shared Page
A shared page contains portlets that are applicable to your role. A shared page can be added
multiple times if it is not read-only. Mandatory shared pages automatically appear when you
log on and cannot be added from the Add Content menu.
You can create shared pages if your role has permissions.
1 In the portal, click Add Content.
2 Select Shared Pages.
3 Select a shared page from the submenu.
A new tab appears to the right of the last tab and becomes the active page.
Chapter 1 Teradata Viewpoint Basics
18 Teradata Viewpoint User Guide, Release 14.01
19. 4 [Optional] Add portlets from the Add Content menu if the shared page is not read-
only.
Refreshing a Shared Page
When the Teradata Viewpoint Administrator updates the contents of a shared page, an icon
in the tab indicates a new version of the page is available. You can keep your current
version by renaming the page or removing the out of date page and then adding the
refreshed page to the portal.
1 Rename or remove a shared page when a new version is available.
Option Description
Rename a. Click the page tab to highlight the page name.
b. Enter the new name up to 30 characters.
c. Press Enter.
The icon disappears from the tab after you rename the page.
Remove a. Click the out of date page tab indicated by .
b. Click to remove the page.
c. Click OK.
2 In the portal, click Add Content.
Mandatory shared pages automatically appear when you log on and cannot be added
from the Add Content menu.
3 Select Shared Pages.
4 Select the refreshed page from the submenu.
A new tab appears and becomes the active page.
5 [Optional] Add portlets from the Add Content menu if the shared page is not read-
only.
Deleting a Portlet
A portlet can be deleted from the active portal page at any time. Deleting a portlet resets
portlet information and deletes any custom settings set for that instance only. Other portlet
instances on the same page or on other pages are not affected.
1 On the active portal page, mouse over the portlet frame to activate the portlet.
The portlet does not need to be expanded if it is collapsed.
2 Click to remove the portlet from the portal page.
A confirmation message appears.
3 Click OK.
The portlet is removed from the active portal page.
Chapter 1 Teradata Viewpoint Basics
Teradata Viewpoint User Guide, Release 14.01 19
20. Deleting a Page
A portal page and its contents can be deleted from the portal at any time after it has been
defined and at any time during your Teradata Viewpoint session. One page tab must remain.
A mandatory shared page cannot be deleted.
1 Click the tab of the page you intend to delete to make it the active page.
2 Click to remove the portal page and its contents.
A confirmation message appears.
3 Click OK to delete the page.
The page is removed, and the remaining tabs shift to the left.
Working With Portlets in the Portal
After you select a portlet from the Add Content menu, it appears on the portal page. You
can use the filter to search for a specific portlet.
Generally, every instance of a portlet:
• Has a frame that appears when the cursor moves over any part of the portlet on the page
and disappears when the cursor moves off the portlet.
• Displays the portlet name or the current settings in the upper frame, depending on the
current activity.
Portlets that span two columns, such as the WORKLOAD DESIGNER portlet, cannot be
resized and always appear at the top of the portal page.
Most portlets can be resized horizontally, vertically, or both. Portlets have a minimum height
and can be resized vertically using the control at the bottom of the portlet.
Portlet Controls
The Teradata Viewpoint Administrator controls which portlets and what features you are
authorized to use. If a portlet or feature is not available, the Teradata Viewpoint
Administrator can assign permissions.
The following is a list of portlet controls:
Note: Not all portlets have all controls.
Adjust Height
Adjusts the vertical size for portlets that can be resized. Drag the control to resize the
portlet vertically. The portlet retains its new dimensions until you click the Restore
Height button.
Chapter 1 Teradata Viewpoint Basics
20 Teradata Viewpoint User Guide, Release 14.01
21. Back
Returns to the previous view.
Collapse
Toggles the portlet closed. This button appears only when the portlet is open. When
collapsed, only the upper and lower portlet frame sections are displayed.
Expand
Toggles the portlet open. This button appears only when the portlet is collapsed.
When expanded, the portlet returns to its normal size and position on the portal
page.
Maximize
Toggles the portlet to fill the portal page.
Minimize
Toggles the portlet to the default size of one column wide.
Pause, Resume
Pauses or resumes the data display for a portlet.
If rewind is on, you can select to Unlink from Rewind or Link to Rewind.
If rewind is off, you can select Refresh to bring the most current data from the
Teradata server to the portlet.
Portlet Frame
Contains the portlet name and portlet controls.
Portlet Name
Displays the portlet name. You can rename shareable portlets.
Preferences
Accesses portlet preferences and settings. Preferences are used to specify what
information is displayed, time intervals for reporting, and other features that help
you customize the portlet functions.
Remove
Removes the portlet and its settings from the active portal page.
Restore Height
Restores the portlet to its default height. This button appears only when you change
the default height of the portlet.
Rewind
Provides the following indications of the status of the rewind function for a portlet:
• indicates a portlet can participate in rewind.
• indicates the rewind feature is on.
Chapter 1 Teradata Viewpoint Basics
Teradata Viewpoint User Guide, Release 14.01 21
22. • indicates the portlet is unlinked from rewind.
Share Portlet
Captures a customized version of a portlet for use by other users. The Teradata
Viewpoint Administrator must make the customized portlet available for sharing.
Time Stamp
Displays the last time data was retrieved from the Teradata server. The time is based
on the time zone set in the Profile portlet.
Each portlet instance has its own settings and controls as well as the features common to all
portlets. A portlet can include any of the following features:
• Selection menus for accessing detailed information
• A toolbar with buttons for quick access to information
• Date-range slider for selecting start dates and end dates for analysis
• Information balloons to show detailed information when you mouse over the portlet
Teradata Database Logon Settings
Several portlets require you to log on to Teradata Database to take actions such as aborting a
query or session, changing a workload, changing a priority, or releasing a query from the
delay queue. Teradata Database logon information is stored with your session and does not
persist beyond the current session.
Chapter 1 Teradata Viewpoint Basics
22 Teradata Viewpoint User Guide, Release 14.01
23. The logon dialog box fields are listed below.
Field Name Description
username Name of the user account on Teradata Database and is authenticated
against a domain username that matches a Teradata Database username.
password Secret string of characters used to prove identity or gain access to a
resource and is authenticated against the domain password associated
with a domain username that matches a Teradata Database username.
account string Characteristics for profile member sessions in Teradata Database. An
account string identifies which account is charged for the space used by
the user and session and may include a priority-level Performance Group
prefix code which establishes the session priority.
authentication
mechanism
Method of identifying an account to the database. Options might include
TD2 or LDAP. If an authentication mechanism is not selected, the logon
uses the default authentication mechanism for the Teradata Database.
character set Character set the system uses to communicate with Teradata Database. If
not defined, Teradata Viewpoint uses Teradata Database system settings.
About the Rewind Feature
The rewind feature allows you to view data that corresponds to dates and times in the past
and compare it to data for a different date and time. You can rewind the data for some or all
portlets on a portal page to a previous point in time, such as when a job failed. Rewinding
portlet data is useful for identifying and resolving issues.
You can rewind data as far back as data is available. The rewind feature is not available for
portlets that have portlet-specific methods for reviewing data over time. The rewind feature
works uniquely in the QUERY SPOTLIGHT portlet. See the Query Spotlight topics for
further details.
Using the rewind toolbar, you can enter a specific date and time as well as scroll through the
data in increments of seconds, minutes, hours, or days. All portlets on the page that are
participating in rewind activities display data that corresponds to the selected rewind date
and time each time a selection is made.
If portlet data can be rewound, a rewind icon appears in the portlet frame.
Permission to use the rewind feature is granted to individual users based on their role and
portlet access. If the rewind toolbar does not appear on the portal page, you are not
authorized to use the feature. If the rewind icon does not appear in the portlet frame, the
rewind feature is not available for that portlet.
Rewinding a Portal Page
You can rewind data for some or all portlets on a portal page. Use rewind to see changes in
data over time among portlets displayed on the portal page.
1 In the upper right corner, click to turn on the rewind feature.
The rewind toolbar appears along the top of the portal page.
2 Click the Date and time fields to select a date from the calendar and enter a time.
Chapter 1 Teradata Viewpoint Basics
Teradata Viewpoint User Guide, Release 14.01 23
24. 3 Do any of the following:
• Click and drag left to scroll back in time or right to scroll forward through time.
• Click an increment arrow to adjust time by seconds, minutes, hours, or days.
• Click and hold an increment arrow to adjust time continuously.
Pausing Rewind for a Portlet
You can pause an individual portlet on a portal page while other portlets on the page display
rewound data. Pausing an instance of a portlet freezes the display of data at the moment the
portlet is placed in pause mode, allowing you to compare data for multiple rewound time
periods.
1 In the upper right corner, click to turn on the rewind feature.
2 Click in the portlet frame.
3 Click Pause.
Data displayed in the portlet freezes and does not change until you resume the portlet
refresh.
Resuming Rewind for a Portlet
You can resume using the rewind feature for an individual portlet that is in pause mode on a
portal page.
1 Click in the portlet frame.
2 Click Resume.
Data displayed in the portlet is updated to the selected rewind time and does not change
until the selected date or time for the rewind feature is changed.
Stopping Rewind Participation
You can prevent an individual portlet from participating in rewind when the portlet frame
displays .
1 In the upper right corner, click to turn on the rewind feature.
2 Click in the portlet frame.
The portlet can be in pause mode or actively responding to the rewind date and time
controls.
3 Click Unlink from Rewind.
The portlet no longer responds to rewind date or time controls and is updated to display
the most recent data available from the Teradata server.
Chapter 1 Teradata Viewpoint Basics
24 Teradata Viewpoint User Guide, Release 14.01
25. Restarting Rewind Participation
You can have an individual portlet not participating in rewind resume participation when
the portlet frame displays .
1 Click in the portlet frame.
2 Click Link to Rewind.
The portlet returns to the mode it was in when it was unlinked from participation in
rewind. For example, if the portlet was in pause mode when unlinked from rewind, it is
in pause mode when participation in rewind resumes.
Turning Off the Rewind Feature
You can turn off the rewind feature and resume display of current data in all portlets on the
portal page.
1 In the upper right corner of the page, click to turn off the rewind feature.
All portlets on the portal page that were participating in rewind activities end
participation and display the most recent data available.
About the Pause Feature
Any rewindable portlet can be paused from refreshing data. Pausing an instance of a portlet
freezes the display of data at the moment the portlet is placed in pause mode, allowing you
to compare data for different time periods. The rewind feature does not need to be active to
pause the portlet. When a portlet is in pause mode, the time stamp flashes, indicating that
the data in the portlet is no longer being refreshed.
Pausing Portlet Refresh
You can pause an individual portlet on a portal page.
1 Click in the portlet frame.
2 Click Pause.
Data displayed in the portlet freezes and does not change until you resume the portlet
refresh.
Resuming Portlet Refresh
You can resume the portlet refresh when the portlet is in pause mode.
1 Click in the portlet frame.
2 To resume the portlet refresh, do one of the following:
• Click Refresh to refresh portlet summary and detail data to the current date and
time, including data from the Teradata server.
• Click Resume to resume the portlet refresh.
About Shared Portlets
Use the SHARE PORTLET feature to make a customized or preconfigured version of a
Teradata Viewpoint portlet available to other users. When a shared portlet is added to a
portal page, all the preferences and settings you selected when you customized the portlet
are used.
Chapter 1 Teradata Viewpoint Basics
Teradata Viewpoint User Guide, Release 14.01 25
26. Any user can customize a shareable portlet and submit it for sharing. Depending on your
Teradata Viewpoint system configuration, the portlet is not available to authorized users
until the Teradata Viewpoint Administrator approves the request. Only the Teradata
Viewpoint Administrator can delete the shared portlet entirely. If deleted, existing instances
remain on your portal page. However, a warning message appears if you try to access the
portlet.
The Shared Portlets feature allows you to:
• Share customized views of a Teradata Viewpoint portlet with other users.
• Create different configurations of a portlet for different roles.
• Assign a preconfigured portlet to a role as a default instance of the portlet.
• Assign a name to the preconfigured portlet.
The portlet name appears in the Shared submenu of the Add Content menu. The Shared
submenu only appears when at least one shared portlet is enabled for the user who is logged
on.
Creating a Shared Portlet
Use the SHARE PORTLET feature to customize a Teradata Viewpoint portlet and make it
available to other users.
1 Add a portlet instance that you want to share to your portal page.
2 From the portlet frame, click to access the PREFERENCES view.
3 Customize the portlet using the available preference settings.
4 Click OK to save the settings.
5 Click to access the SHARE PORTLET dialog box.
6 Enter a name for the custom portlet using up to 25 characters.
Depending on your Teradata Viewpoint system configuration, the portlet may or may
not be available to authorized users until the Teradata Viewpoint Administrator
approves your request.
7 Click Save.
8 [Optional] Contact the Teradata Viewpoint Administrator to verify that the portlet has
been received for approval.
Chapter 1 Teradata Viewpoint Basics
26 Teradata Viewpoint User Guide, Release 14.01
27. CHAPTER 2
Profile
Profile
The Profile portlet provides tabs that allow you to set your personal user settings and
manage your Teradata Database profile information:
Personal Info
Change your name, password, email address, and locale, and select the time zone.
Teradata Accounts
Manage settings for each of your Teradata Database user profiles. Link your
Teradata profile to the Teradata Database systems you are authorized to access.
Access the Profile portlet from the Teradata Viewpoint portal.
About the Personal Info Tab
The Personal Info tab in the Profile portlet allows you to manage your Teradata Viewpoint
profile:
• Change the first and last name for the profile.
• Change your Email address.
• Change your Locale.
• Select the Time Zone.
Use the Personal Info tab to set your locale. Supported locales include:
• Chinese (China and Taiwan)
• English (US and UK)
• French
• German
• Japanese
• Korean
The locale you select is applied to the entire Teradata Viewpoint session and is maintained
in future sessions.
Changing a Name
You can change the first and last name for a Teradata Viewpoint profile.
1 From the Profile portlet, click the Personal Info tab.
Teradata Viewpoint User Guide, Release 14.01 27
28. 2 Change the name in the First Name field.
3 Change the name in the Last Name field.
4 Click Apply.
A confirmation message appears.
Setting a Contact Email Address
You can set your Email address using the Personal Info tab. This email address is used for
identification and communication in the Teradata Viewpoint system, including notifications
and reminders.
The email address cannot contain uppercase letters. Uppercase characters are automatically
converted to lowercase.
1 From the Profile portlet, click the Personal Info tab.
2 Enter your full address in the Email field.
3 Click Apply.
A confirmation message appears.
Managing Passwords
You can manage Teradata Viewpoint profile passwords. A password must be at least 4 and
no more than 25 characters.
A user cannot change their password if their profile is externally authenticated. The fields
required to change the password are not available when external authentication is used. To
change the password for an externally authenticated profile, follow your company policy for
password management.
1 From the Profile portlet, click the Personal Info tab.
2 Enter your current password in the Current Password field.
3 Enter a new password in the New Password field.
4 Confirm your new password by retyping it in the Re-enter New Password field.
5 Click Apply.
A confirmation message appears.
Setting the Locale
The locale is used to display the local language with the date, time, and number format
specific to the country. For example, if the locale is “English (US),” the system uses the
English language and displays the day in mm/dd/yy format. May 16, 2012 appears as
“5/16/12.” If the locale is “Japanese,” the system uses the Japanese language and displays the
day in dd/mm/yy format. May 16, 2012 appears as “16/05/12.”
The locale setting in the Profile portlet overrides the locale set by your Teradata Viewpoint
Administrator for your account.
1 From the Profile portlet, click the Personal Info tab.
2 Select the locale from the list.
Chapter 2 Profile
28 Teradata Viewpoint User Guide, Release 14.01
29. The Teradata Viewpoint application server locale is the default.
3 Click Apply.
A confirmation message appears.
Setting the Time Zone
You can adjust your local Teradata Viewpoint time zone setting to compensate for different
time zones. Select the local time zone to display all time and date information in the local
date and time, even if the Teradata Database system you are monitoring is located in a
different time zone.
The time zone you enter compensates for the time difference between the monitored system
location and the Teradata Viewpoint reporting location.
1 From the Profile portlet, click the Personal Info tab.
2 Select a time zone from the list.
Time zones shown are relative to Greenwich Mean Time (GMT) and include a reference
location. The Teradata Viewpoint application server time zone is the default. Use the
scroll bar to view more time zones.
3 Click Apply.
A confirmation message appears.
About the Teradata Accounts Tab
Use the Teradata Accounts tab in the Profile portlet to manage Teradata Database account
logon and profile information for each Teradata Database system. Teradata account
information is used by the My Queries portlet. For each Teradata Database system, you can:
• Add accounts
• Edit existing profiles
• Delete profiles
System profiles added using the Teradata Accounts tab must already exist on the monitored
system. The system validates the USERNAME, PASSWORD, ACCOUNT STRING, and
AUTHENTICATION fields prior to confirmation.
Chapter 2 Profile
Teradata Viewpoint User Guide, Release 14.01 29
30. Adding a User Profile
This task explains how to associate Teradata Database profiles with your Teradata Viewpoint
profile.
1 From the Profile portlet, click the Teradata Accounts tab.
2 Under Add Account, select a Teradata Database system from the list.
3 Enter the following information in the appropriate fields:
• Username
• Password
• [Optional] Account string
4 [Optional] Select an authentication mechanism from the list for use on the system.
5 [Optional] Click Test.
The icon appears if the operation is successful. The icon appears if the operation
fails; verify that the settings are correct, and try again.
6 Click Add.
Editing a User Profile
This topic explains how to edit a Teradata Database system user profile in Teradata
Viewpoint.
1 From the Profile portlet, click the Teradata Accounts tab.
2 Mouse over the row containing the user profile information for the Teradata Database
system you are updating.
The row is highlighted, and Edit and Delete appear.
3 Click Edit to the right of the row containing the user profile information.
4 Edit or change any of the following fields:
• PASSWORD
• ACCOUNT STRING
5 [Optional] Click Test to verify that the logon settings are correct.
A confirmation message appears.
6 Click Save to save your changes.
A confirmation message appears.
Deleting a User Profile
This task explains how to delete a Teradata Database system user profile from Teradata
Viewpoint.
1 From the Profile portlet, click the Teradata Accounts tab.
2 Mouse over the row containing the Teradata Database user profile information for the
system you are updating.
The row is highlighted, and Edit and Delete appear.
Chapter 2 Profile
30 Teradata Viewpoint User Guide, Release 14.01
31. 3 Click Delete to the right of the row containing the user profile information.
If the deletion is successful, a confirmation message appears.
Chapter 2 Profile
Teradata Viewpoint User Guide, Release 14.01 31
33. CHAPTER 3
System Administration
System Administration
Admin Portlets
The Teradata Viewpoint administrative portlets allow the Teradata Viewpoint
Administrator to provide access to Teradata Viewpoint resources and information.
You can access these portlets from the Admin menu in the Teradata Viewpoint portal if
your role has permission. You can access the Profile portlet directly from the Teradata
Viewpoint portal.
Alert Setup
Configure the alert delivery settings and actions.
Backup
Configure the backup of Teradata Viewpoint server data.
Certificates
Manage trusted certificate authorities and HTTPS certificates.
General
Configure Teradata Viewpoint settings.
LDAP Servers
Configure the LDAP servers for Teradata Viewpoint to authenticate users and
assign user roles.
Managed Servers
Configure the servers available to display in the Viewpoint Monitoring portlet.
Portlet Library
View the installed portlets and specify which portlets can be accessed.
Profile
Configure settings for your Viewpoint user account and associate Teradata
Database accounts.
Query Group Setup
Manage the sets of queries available to users in the Query Groups portlet.
Teradata Viewpoint User Guide, Release 14.01 33
34. Roles Manager
Manage roles and specify the level of access users are given.
Shared Pages
Manage shared pages and how they are viewed by users.
Teradata Systems
Configure the systems and data collectors that provide data to portlets.
User Manager
Manage user accounts and assign users to roles.
Security and Permissions
The Teradata Viewpoint administrative portlets allow the Teradata Viewpoint Administrator
to control portlet access at different levels by setting permissions for Teradata Viewpoint
users.
Global
Enable or disable access to portlets globally using the Portlet Library portlet. This
setting takes precedence over all other portlet permission levels.
Role
Assign permissions to classes of users called roles using the Roles Manager portlet.
Each tab controls access to features.
User
Assign available roles to users and set role precedence using User Manager portlet.
Roles assigned higher priority take precedence over lower-priority roles.
Backup
The Backup portlet allows you to enable automatic Teradata Viewpoint system backups and
configure the data retention settings.
The Backup portlet displays the backup process icon with either a successful completion or
an error for the last attempt and lists the last successful backup date and time. Use the
Backup portlet to:
• Enable and disable the daily backup process
• Store the backup files on the local system or at a network location
• Select the daily backup time
• Select how many days to keep the backup files
Chapter 3 System Administration
34 Teradata Viewpoint User Guide, Release 14.01
35. About Backup Errors
The BACKUP dialog box displays an out-of-service icon and the status message AN
ERROR HAS OCCURRED, if an error occurs during the backup process. To investigate the
error, you can view the backup log file: /opt/teradata/dcs/logs/backup.log. For
additional information, see the Teradata Viewpoint Configuration Guide.
Scheduling Viewpoint Backups
You can configure automatic backups, set a data retention length, and enable or disable the
backup process at any time.
1 [Optional] From the BACKUP view, do one of the following:
• Select the Enable backup check box to activate the backup process.
• Clear the Enable backup check box to disable the automatic-backup process.
2 Under Location, select one of the following options to set the location of the backup
files:
Option Description
Local Backs up Teradata Viewpoint databases to the local server.
Network Backs up Teradata Viewpoint databases to a networked file server to prevent data loss
in the event of a catastrophic failure.
• Enter a Host to specify the host system name.
• Enter a Path to specify the absolute path name where the backups are stored on
the host system.
• [Optional] Click Test to verify that the login settings are correct. The icon
appears if the operation is successful. The icon appears if the operation fails;
verify that the settings are correct, and try again.
3 From the Daily Backup Time list, select the daily start time of the backup operation.
4 From the Keep Backups For list, select the number of days to retain the backup data.
5 Click Apply.
The changes are saved and backup files are deleted when they are older than the
configured number of days.
Certificates
The Certificates portlet allows you to manage certificates on the Viewpoint Server.
Certificates are used to help secure communications to and from a Viewpoint server. You
can install a certificate to secure communication from a browser to the Viewpoint server
and from the Viewpoint server to external servers. You can install a trusted root certificate
for a Certificate Authority to be trusted by the Viewpoint server.
Chapter 3 System Administration
Teradata Viewpoint User Guide, Release 14.01 35
36. About Certificate Authorities
Certificate Authorities (CA) issue certificates. To initiate secure communications with an
external server (e.g., a corporate LDAP server), the Viewpoint server must trust the CA that
issued the certificate of the external server.
The root certificates of certain standard CAs are pre-installed on the Viewpoint server and
certificates issued by them are automatically accepted. However, if a non-standard CA issued
the certificate, then the root certificate of this CA must be installed on the Viewpoint server
for the certificate to be accepted.
You can install the root certificate of a trusted CA from the Certificate Authority view.
Installing Trusted Root Certificates
1 From the SETUP list, click Certificate Authority.
2 Click Install.
3 Enter an alias for the Certificate Authority, up to 30 characters.
4 Click Browse and select the trusted root certificate.
5 Click Install.
Deleting Trusted Root Certificates
1 From the SETUP list, click Certificate Authority.
2 Click next to the certificate you want to delete.
3 Click Delete.
About HTTPS Connections
HTTPS connections are secure connections between a browser and the Viewpoint server. To
enable HTTPS connections, the Viewpoint server needs an identifying certificate that
provides the public key used to decrypt the information it sends. This certificate may be
either self-signed or signed by a Certificate Authority (CA).
To install a new certificate from a CA, you must first generate a Certificate Signing Request
and submit it to a CA for signing. Once you receive the signed certificate from the CA you
can install it.
Creating a Self-Signed Certificate
A self-signed certificate can provide security for an internal site or serve as a temporary
measure while a fully authenticated certificate is obtained from a Certificate Authority.
Installing a certificate replaces the existing certificate. Once a certificate is replaced, it cannot
be reinstalled.
1 From the SETUP list, click HTTPS Config.
2 Click Create SSC and enter the certificate information.
Chapter 3 System Administration
36 Teradata Viewpoint User Guide, Release 14.01
37. Field Description
Common Name Domain name
Organizational Unit Business unit
Organization Company name
City or Locality Company address
State or Province Company address
Country Company address, 2 characters
Expiration Select an expiration period
3 Click Install.
Creating a Certificate Signing Request
A signing request is used to obtain an authenticated certificate for the server. Creating and
saving a new signing request replaces a pending request. If a pending request is replaced, the
signed certificate that comes from the request cannot be installed. Once created, the request
must be submitted to the Certificate Authority to be signed.
1 From the SETUP list, click HTTPS Config.
2 Click Create CSR and enter the request information.
Field Description
Common Name Domain name
Organizational Unit Business unit
Organization Company name
City or Locality Company address
State or Province Company address
Country Company address, 2 characters
3 Click Create.
4 Save the file using the browser options.
The file is saved to your download area or to a location that you specify, depending on
the browser settings.
Installing a Signed Certificate
After obtaining an authenticated certificate from a trusted Certificate Authority, you can
install the certificate to facilitate secure communications to the Viewpoint server. Installing
a certificate replaces the active certificate. Once an active certificate has been replaced, it
cannot be reinstalled.
1 From the SETUP list, click HTTPS Config.
2 Click Install.
3 Click Browse.
Chapter 3 System Administration
Teradata Viewpoint User Guide, Release 14.01 37
38. 4 Select the signed certificate.
5 Click Install.
Deleting Installed Certificates
A certificate can only be installed once.
1 From the SETUP list, click HTTPS Config.
2 Click next to the certificate you want to delete.
3 Click Delete.
General
The General portlet allows a Teradata Viewpoint Administrator to set the locale and session
timeout for a Teradata Viewpoint server. Users can choose a different locale in the Profile
portlet to override the default locale selection.
• The locale is used to localize content in the Viewpoint portal. Dates, times, and numbers
are displayed in Viewpoint portlets in the format used by the selected locale. If the
language pack for the selected locale is installed, then all content appears in the selected
language.
For example, the English (US) locale displays content in English and dates in a mm/dd/
yy format. If the language pack for the selected locale is not installed, content appears in
English and dates, times, and numbers appear in the format for the selected locale.
• The session timeout is the length of time a user account can remain idle before being
logged out of the system. The default setting is one hour and 30 minutes.
Setting General Options
1 Select a locale from the list.
2 Set a session timeout.
3 Click Apply.
LDAP Servers
The LDAP Servers portlet allows you to configure LDAP servers to authenticate users and
assign user roles in Teradata Viewpoint. The LDAP Servers portlet displays the names of
currently configured LDAP servers or is empty if an LDAP is not configured.
• Use next to SETUPS to add an LDAP server.
• Use the order buttons to adjust the evaluation order of the LDAP-server list.
• Use next to the server name to delete an LDAP server.
Chapter 3 System Administration
38 Teradata Viewpoint User Guide, Release 14.01
39. • Use the dialog box to enable and disable an LDAP server, and configure the LDAP to
automatically validate users against the LDAP directory with the auto-provisioning
feature or assign user roles with the role mapping feature.
What Is an LDAP Server?
Teradata Viewpoint uses a Lightweight Directory Access Protocol (LDAP) server to:
• Validate new user information by querying the LDAP for authentication. The binding
operation authenticates a username and a password.
• Automatically create a Teradata Viewpoint username with the auto-provisioning feature.
• Automatically assign users to a Teradata Viewpoint role with the Role Mapping feature.
Adding an LDAP Server
You can add an LDAP server to authenticate and assign roles to Teradata Viewpoint users.
1 Click next to SETUPS.
2 Enter a Nickname for the LDAP server up to 8 characters.
3 [Optional] Select the Enabled check box to activate LDAP upon successfully adding the
LDAP server to Teradata Viewpoint.
4 Enter a URL address.
One URL address is required. Use to delete, add, and move up or move down in
the evaluation order.
5 Select the Name Matching method from the following options:
• Select DN Pattern Bind to specify one or more patterns that represent a
distinguished name (DN) in the LDAP directory.
• Select User Search to search for a pattern in the base directory or subdirectories:
• [Optional] Enter a Service account DN and Service account password to search
with a specific account.
• [Optional] Leave Service account DN and Service account password blank to
connect to the LDAP as an anonymous user.
• Enter a Search pattern.
• Enter a Search base to specify a base directory for the search pattern.
• [Optional] Select the Search extent Recursive scan check box to include
subdirectories of the base directory in the search.
• [Optional] Under Search extent, clear the Recursive scan check box to limit the
search to the specified base directory.
6 Configure Key User Information:
• Enter the LDAP first name attribute.
• Enter the LDAP last name attribute.
• Enter the LDAP email attribute.
Chapter 3 System Administration
Teradata Viewpoint User Guide, Release 14.01 39
40. Every user has an email address. This default email domain is used if a valid email
address is not found in the LDAP directory during auto-provisioning.
7 [Optional] Test your settings:
a Click Test to display the LDAP test panel.
b Enter a Test username and Test password.
c Click Run.
The icon appears if the operation is successful. The icon appears if the operation
fails; verify that the settings are correct, and try again.
8 [Optional] Configure Auto-Provisioning:
a [Optional] Select the Turn on auto-provisioning check box to automatically validate
users against the LDAP directory.
b Select a role from the Automatically assign these roles menu. You can add or
remove roles.
c Enter a Default email domain to provide a notification email address.
Every user has an email address. This default email domain is used if a valid email
address is not found in the LDAP directory during auto-provisioning.
9 If the group role mapping method is specified, configure Role Mapping:
a Enter a Group search base.
b [Optional] Select the Group search subtree check box to include subtree directories
during the binding process.
c Enter a Group attribute name.
d [Optional] Click Add Role Mapping to add attribute or group settings so that you
can assign another role.
10 Click Apply.
The icon appears if the operation is successful. The icon appears if the operation
fails; verify that the settings are correct, and try again.
About Role Mapping
In Teradata Viewpoint, users are assigned roles to organize and control their access to
portlets, metrics, and features. You can use the Roles Manager portlet to assign permissions
to the roles. During the process of adding an LDAP configuration to Teradata Viewpoint, the
optional Role Mapping section in the LDAP Servers portlet allows you to assign a role
automatically to auto-provisioned users.
Use role mapping to:
• Assign roles for a new user.
• Add roles that were assigned to the user since the last user login.
• Remove roles that were removed since the last user login.
Chapter 3 System Administration
40 Teradata Viewpoint User Guide, Release 14.01
41. Consider the following:
• Only roles already defined using the Roles Manager portlet can be mapped.
• The Teradata Viewpoint Administrator can change a role at any time using the Roles
Manager portlet.
Role Mapping Use Cases
In the following use cases, the LDAP value represents the distinguished name (DN) of a
group. When the Type is Attribute, the attribute name field represents the user attribute
where the group DN is stored. When the Type is Group, the group attribute name field is
used for mapping and represents the group attribute where the user DN is stored.
The first use case assigns users to a Teradata Viewpoint role based on an attribute of the
user's record in LDAP. Assume you have a user with the following record in LDAP:
dn: cn=User1,ou=Users,dc=teradata,dc=com
memberOf: cn=USA,ou=Groups,dc=teradata,dc=com
In this case, the Group attribute name field is not relevant. To map User1 to the Teradata
Viewpoint role US Users, create the following role mapping:
• Type = Attribute
• Attribute name = memberOf
• LDAP value = cn=USA,ou=Groups,dc=teradata,dc=com
• Viewpoint role = US Users
The second use case assigns users to a Teradata Viewpoint role based on membership in
an LDAP group with the following structure:
dn: cn=DBAs,ou=Groups,dc=teradata,dc=com
uniqueMember: cn=User2,ou=Users,dc=teradata,dc=com
In this case, set the Group attribute name field to uniqueMember. To map User2 to the
Teradata Viewpoint role DBAs, create the following role mapping:
• Type = Group
• LDAP value = cn=DBAs,ou=Groups,dc=teradata,dc=com
• Viewpoint role = DBAs
Managed Servers
A managed server is a server in a Teradata cabinet that is monitored by the same Teradata
server management solution used to monitor TPA nodes. A managed server might be used
for storage, backup, or housing data collectors that provide portlet information and metric
data. Teradata Viewpoint monitors managed servers for system-level metrics and collects
information for Teradata Viewpoint portlets.
The Managed Servers portlet displays the names of currently configured managed servers or
is empty if no managed server is configured. Use next to SERVERS to add a managed
server. Use the dialog box to delete, enable, and disable a managed server for use by the
Teradata Viewpoint Data Collection Service (DCS).
Chapter 3 System Administration
Teradata Viewpoint User Guide, Release 14.01 41
42. Adding a Managed Server
You can add a managed server to Teradata Viewpoint. After a managed server is defined in
Teradata Viewpoint, you can test the configuration settings and enable the managed server
for use by the Data Collection Service (DCS).
1 Click next to SERVERS.
2 [Optional] Select the Server enabled check box to activate the managed server for the
DCS.
3 Enter values for these required fields:
• Managed Server Name up to eight characters.
• Hostname is the managed server IP address or domain name.
• Login is the user name and password.
The default values only need to be changed if you change the login and password settings
during the installation of TMS Monitor.
4 Do any of the following:
• Click Test to verify that the login settings are correct.
• Click Apply to update the managed server.
The icon appears if the operation is successful. The icon appears if the operation
fails; verify that the settings are correct, and try again. If you are unable to enable or
disable the managed server, contact the Teradata Viewpoint Administrator.
Deleting a Managed Server
You can delete a Teradata Viewpoint managed server. This is a permanent procedure that
differs from disabling the managed server from the Data Collection Service.
1 From the SERVERS list, click the managed server name you want to remove.
2 In the dialog box, click Delete Server.
A confirmation message appears.
3 Click OK.
Enabling or Disabling a Managed Server
After a managed server is defined in Teradata Viewpoint, you can enable it for use by the
Data Collection Service (DCS) or disable it.
1 From the SERVERS list, click the managed server name you want to update.
2 Do one of the following:
• Select the Server enabled check box to activate a managed server.
• Clear the Server enabled check box to disable a managed server.
When disabled, the DCS does not use the managed server. Any existing data about the
managed server can still be viewed.
Chapter 3 System Administration
42 Teradata Viewpoint User Guide, Release 14.01
43. 3 Do any of the following:
• Click Test to verify that the login settings are correct.
• Click Apply to update the managed server.
The icon appears if the operation is successful. The icon appears if the operation
fails; verify that the settings are correct, and try again. If you are unable to enable or
disable the managed server, contact the Teradata Viewpoint Administrator.
Portlet Library
The Portlet Library allows you to enable or disable portlets globally. This setting takes
precedence over every other portlet permission level.
The Manage Existing Portlets view allows you to manage the installed portlets, which are
grouped by category. Details about portlets are also provided:
• Parent portlet name
• Version number
• Publisher name
• Bundle name
• Installation date
• Whether the portlet is enabled
• Whether the portlet can be deleted
Portlets in the Admin category display N/A in the ENABLE column. These portlets cannot
be disabled and are included in the view only to provide version information.
A shared portlet is a user-defined version of a portlet. The Parent Portlet column identifies
the original portlet before its customization as a shared portlet. Only portlets in the Shared
Portlet category can be deleted.
Enabling or Disabling Portlets
The Teradata Viewpoint Administrator can use the Portlet Library to enable or disable
installed portlets for Teradata Viewpoint user access.
1 In the Manage Existing Portlets dialog box, click a name to expand a category.
2 For each installed portlet, do one of the following:
• Enable the portlet by selecting the corresponding check box.
• Disable the portlet by clearing the corresponding check box.
You can enable all the portlets by clicking the ENABLE column heading. Portlets in the
Admin category display N/A in the ENABLE column. These portlets cannot be disabled
and are included in the view only to provide version information.
3 Click Apply.
Chapter 3 System Administration
Teradata Viewpoint User Guide, Release 14.01 43
44. Deleting a Shared Portlet
The Teradata Viewpoint Administrator can use the Portlet Library to delete a shared portlet
so Teradata Viewpoint users can no longer access it.
1 In the Manage Existing Portlets dialog box, click Shared to expand the category.
2 Click under the DELETE column that corresponds to the shared portlet you want to
delete.
A confirmation message appears.
3 Click OK.
The portlet name no longer appears in the Add Content menu in the portal, and the
portlet is no longer available to Teradata Viewpoint users. Existing instances of a shared
portlet on a portal page remain on the page. However, a warning message appears if a
user tries to access the portlet.
Query Group Setup
The Query Group Setup portlet allows the Teradata Viewpoint Administrator to manage the
sets of queries that are available to users in the Query Groups portlet. You can create query
groups based on a set of criteria, assign users that can access the group, and delete query
groups.
Creating a Query Group
Create a query group in the Query Group Setup portlet to allow users to view their most
relevant queries in the Query Groups portlet. You create a query group to filter the queries
that are displayed and limit the users that have access to the group.
1 Select a system from the list of enabled systems.
A system cannot be changed after you create a query group.
2 Click next to GROUPS.
3 Enter a query group name up to 30 characters.
4 [Optional] Enter a description up to 256 characters.
5 In the Criteria tab, do one of the following:
Chapter 3 System Administration
44 Teradata Viewpoint User Guide, Release 14.01
45. • Select Every criteria below to match at least one value in each defined sub-tab.
Criteria on each sub-tab are joined by AND.
• Select Any criteria below to match at least one value in one or more of the defined
sub-tabs. Criteria on each sub-tab are joined by OR.
6 Select a criteria from the Add Criteria list.
7 [Optional] For account string, username, or workload name criteria, do any of the
following:
• In the Match string box, type a value to dynamically define criteria, and click to
move it to the Selected box. The value can contain ? to match exactly one character in
the position it occupies, * to match zero or more characters, or = at the beginning of
the string to match alpha and numeric characters literally.
• In the Match string box, type a value to filter the list of available values.
• Select a value from the Available box and click to move it to the Selected box.
8 [Optional] For Query Band criteria, do any of the following:
• Select a query band name from the list and a value from the Available values box,
and click to move it to the Selected box.
• Type a custom query band name and value pair, and then click to move it to the
Selected box.
9 In the Access tab, do any of the following:
• In the User list filter box, type a value to filter the list of available users. The value
can contain ? to match exactly one character in the position it occupies, * to match
zero or more characters, or = at the beginning of the string to match alpha and
numeric characters literally.
• In the Available users box, select one or more Viewpoint users and click to move
it to the Selected users box.
• In the Available roles box, select one or more Viewpoint roles and click to move
it to the Selected roles box.
Chapter 3 System Administration
Teradata Viewpoint User Guide, Release 14.01 45
46. 10 [Optional] Click Reset to clear the query group name, description, and the selections on
the Criteria and Access tabs.
11 Click Apply.
Viewing Query Groups
The Query Group Setup portlet allows you to view the query groups that have been created
for enabled systems. If a system is disabled in the Teradata Systems portlet, it does not
appear in the Query Group Setup portlet; however, the defined criteria is retained.
1 Select a system to view query groups related to that system.
2 [Optional] Click a row in the query group list to see the details for that group.
Editing a Query Group
Edit a query group when criteria or users require updating or if a user changes roles.
If a system is disabled in the Teradata Systems portlet, it does not appear in the Query
Group Setup portlet; however, the defined criteria is retained.
1 Select the system associated with the query group.
2 Click a row in the list for the query group you want to edit.
3 [Optional] Enter a new name or change the description.
4 [Optional] In the Criteria tab, do one of the following:
• Select Every criteria below to match at least one value in each defined sub-tab.
Criteria on each sub-tab are joined by AND.
• Select Any criteria below to match at least one value in one or more of the defined
sub-tabs. Criteria on each sub-tab are joined by OR.
5 For each criteria you select, do any of the following:
• Edit the criteria.
• Click to delete the criteria and associated values.
• Select unnecessary or obsolete criteria from the Selected box and click Remove.
6 In the Access tab, edit the list of Viewpoint users and roles that can view the query
group.
7 [Optional] Click Reset to revert the query group name and description, and any changes
made in the Criteria or Access tabs to the previously applied values.
8 Click Apply.
Filter Symbols
Use wildcard characters or symbols in a filter to expand or limit search criteria. Some
symbols are used for string filtering and others are used for numeric filtering. String filters
are not case sensitive and an asterisk wildcard is applied to the end of the filter string.
Chapter 3 System Administration
46 Teradata Viewpoint User Guide, Release 14.01