2206 user 14.01

642 views
572 views

Published on

Published in: Technology, Business
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
642
On SlideShare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
29
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

2206 user 14.01

  1. 1. Teradata ViewpointUser GuideRelease 14.01B035-2206-112KOctober 2012
  2. 2. The product or products described in this book are licensed products of Teradata Corporation or its affiliates.Teradata, Active Enterprise Intelligence, Applications-Within, Aprimo, Aprimo Marketing Studio, Aster, BYNET, Claraview, DecisionCast,Gridscale, MyCommerce, Raising Intelligence, Smarter. Faster. Wins., SQL-MapReduce, Teradata Decision Experts, "Teradata Labs" logo,"Teradata Raising Intelligence" logo, Teradata ServiceConnect, Teradata Source Experts, "Teradata The Best Decision Possible" logo, TheBest Decision Possible, WebAnalyst, and Xkoto are trademarks or registered trademarks of Teradata Corporation or its affiliates in theUnited States and other countries.Adaptec and SCSISelect are trademarks or registered trademarks of Adaptec, Inc.AMD Opteron and Opteron are trademarks of Advanced Micro Devices, Inc.Apache, Apache Hadoop, Hadoop, and the yellow elephant logo are either registered trademarks or trademarks of the Apache SoftwareFoundation in the United States and/or other countries.Axeda is a registered trademark of Axeda Corporation. Axeda Agents, Axeda Applications, Axeda Policy Manager, Axeda Enterprise, AxedaAccess, Axeda Software Management, Axeda Service, Axeda ServiceLink, and Firewall-Friendly are trademarks and Maximum Results andMaximum Support are servicemarks of Axeda Corporation.Data Domain, EMC, PowerPath, SRDF, and Symmetrix are registered trademarks of EMC Corporation.GoldenGate is a trademark of Oracle.Hewlett-Packard and HP are registered trademarks of Hewlett-Packard Company.Hortonworks, the Hortonworks logo and other Hortonworks trademarks are trademarks of Hortonworks Inc. in the United States and othercountries.Intel, Pentium, and XEON are registered trademarks of Intel Corporation.IBM, CICS, RACF, Tivoli, and z/OS are registered trademarks of International Business Machines Corporation.Linux is a registered trademark of Linus Torvalds.LSI is a registered trademark of LSI Corporation.Microsoft, Active Directory, Windows, Windows NT, and Windows Server are registered trademarks of Microsoft Corporation in theUnited States and other countries.NetVault is a trademark or registered trademark of Quest Software, Inc. in the United States and/or other countries.Novell and SUSE are registered trademarks of Novell, Inc., in the United States and other countries.Oracle, Java, and Solaris are registered trademarks of Oracle and/or its affiliates.QLogic and SANbox are trademarks or registered trademarks of QLogic Corporation.Red Hat is a trademark of Red Hat, Inc., registered in the U.S. and other countries. Used under license.SAS and SAS/C are trademarks or registered trademarks of SAS Institute Inc.SPARC is a registered trademark of SPARC International, Inc.Symantec, NetBackup, and VERITAS are trademarks or registered trademarks of Symantec Corporation or its affiliates in the United Statesand other countries.Unicode is a registered trademark of Unicode, Inc. in the United States and other countries.UNIX is a registered trademark of The Open Group in the United States and other countries.Other product and company names mentioned herein may be the trademarks of their respective owners.The information contained in this document is provided on an "as-is" basis, without warranty of any kind, either expressor implied, including the implied warranties of merchantability, fitness for a particular purpose, or non-infringement.Some jurisdictions do not allow the exclusion of implied warranties, so the above exclusion may not apply to you. In noevent will Teradata Corporation be liable for any indirect, direct, special, incidental, or consequential damages, includinglost profits or lost savings, even if expressly advised of the possibility of such damages.The information contained in this document may contain references or cross-references to features, functions, products, or services that arenot announced or available in your country. Such references do not imply that Teradata Corporation intends to announce such features,functions, products, or services in your country. Please consult your local Teradata Corporation representative for those features, functions,products, or services available in your country.Information contained in this document may contain technical inaccuracies or typographical errors. Information may be changed orupdated without notice. Teradata Corporation may also make improvements or changes in the products or services described in thisinformation at any time without notice.To maintain the quality of our products and services, we would like your comments on the accuracy, clarity, organization, and value of thisdocument. Please e-mail: teradata-books@lists.teradata.comAny comments or materials (collectively referred to as "Feedback") sent to Teradata Corporation will be deemed non-confidential. TeradataCorporation will have no obligation of any kind with respect to Feedback and will be free to use, reproduce, disclose, exhibit, display,transform, create derivative works of, and distribute the Feedback and derivative works thereof without limitation on a royalty-free basis.Further, Teradata Corporation will be free to use any ideas, concepts, know-how, or techniques contained in such Feedback for any purposewhatsoever, including developing, manufacturing, or marketing products or services incorporating Feedback.Copyright © 2008 - 2012 by Teradata Corporation. All Rights Reserved.
  3. 3. Table of ContentsPreface...........................................................................................................................................................13Changes to This Book........................................................................................................................................13Related Documentation.....................................................................................................................................13Chapter 1:Teradata Viewpoint Basics........................................................................................................15Teradata Viewpoint Portal and Portlets..........................................................................................................15Getting Started.............................................................................................................................................15Setting Up the Portal for Portlets..............................................................................................................16Working With Portlets in the Portal........................................................................................................20Chapter 2:Profile.............................................................................................................................................................27Profile...................................................................................................................................................................27About the Personal Info Tab.....................................................................................................................27About the Teradata Accounts Tab............................................................................................................29Chapter 3:System Administration..................................................................................................................33System Administration......................................................................................................................................33Admin Portlets.............................................................................................................................................33Security and Permissions...........................................................................................................................34Backup..................................................................................................................................................................34About Backup Errors..................................................................................................................................35Scheduling Viewpoint Backups.................................................................................................................35Certificates...........................................................................................................................................................35About Certificate Authorities....................................................................................................................36About HTTPS Connections.......................................................................................................................36General.................................................................................................................................................................38Setting General Options.............................................................................................................................38LDAP Servers......................................................................................................................................................38Teradata Viewpoint User Guide, Release 14.01 3
  4. 4. What Is an LDAP Server?............................................................................................................................39Adding an LDAP Server..............................................................................................................................39About Role Mapping....................................................................................................................................40Managed Servers..................................................................................................................................................41Adding a Managed Server...........................................................................................................................42Deleting a Managed Server.........................................................................................................................42Enabling or Disabling a Managed Server..................................................................................................42Portlet Library......................................................................................................................................................43Enabling or Disabling Portlets....................................................................................................................43Deleting a Shared Portlet.............................................................................................................................44Query Group Setup.............................................................................................................................................44Creating a Query Group..............................................................................................................................44Viewing Query Groups................................................................................................................................46Editing a Query Group................................................................................................................................46Filter Symbols...............................................................................................................................................46Deleting a Query Group..............................................................................................................................47Roles Manager......................................................................................................................................................47About Roles...................................................................................................................................................48Example Roles...............................................................................................................................................48About the Roles Manager View..................................................................................................................49Adding a Role................................................................................................................................................49Editing a Role................................................................................................................................................50Copying a Role..............................................................................................................................................51Deleting a Role..............................................................................................................................................52Assigning Users to a Role............................................................................................................................52Removing Users from a Role......................................................................................................................53Portlet Preferences and Permissions.........................................................................................................53Enabling Portlets for a Role........................................................................................................................53Enabling Notifications for a Role...............................................................................................................54Configuring Default Portlet Settings.........................................................................................................54Granting Metric Permissions for a Role....................................................................................................55Granting Portlet Permissions for a Role...................................................................................................55Portlet Permissions......................................................................................................................................56Shared Pages.........................................................................................................................................................61About Shared Page Controls.......................................................................................................................62About Read-Only and Mandatory Shared Pages.....................................................................................63Creating a Shared Page................................................................................................................................63Copying a Shared Page................................................................................................................................64Editing Portlets on a Shared Page..............................................................................................................65Viewing All Shared Pages............................................................................................................................66Deleting a Shared Page................................................................................................................................66Teradata Systems.................................................................................................................................................66General...........................................................................................................................................................67Table of Contents4 Teradata Viewpoint User Guide, Release 14.01
  5. 5. Data Collectors........................................................................................................................................................72System Health..........................................................................................................................................................79Canary Queries.......................................................................................................................................................82Alerts........................................................................................................................................................................84Monitor Rates..........................................................................................................................................................93Log Table Clean Up................................................................................................................................................95Clean Up Schedule.................................................................................................................................................96Disk Usage...............................................................................................................................................................96User Manager.................................................................................................................................................................97About the User List View......................................................................................................................................97About the User Details View.................................................................................................................................98Chapter 4:Aster Completed Processes...............................................................................................................103Aster Completed Processes........................................................................................................................................103Aster Completed Processes View.......................................................................................................................103About Details View..............................................................................................................................................108Chapter 5:Aster Node Monitor....................................................................................................................................111Aster Node Monitor....................................................................................................................................................111Aster Node Monitor View...................................................................................................................................111About the Details View........................................................................................................................................116Chapter 6:Calendar................................................................................................................................................................119Calendar........................................................................................................................................................................119About the Calendar Week View.........................................................................................................................119About the Calendar Month View.......................................................................................................................120About the Calendar Event Details View............................................................................................................121Adding an Event...................................................................................................................................................122Editing an Event...................................................................................................................................................123Deleting an Event.................................................................................................................................................124Table of ContentsTeradata Viewpoint User Guide, Release 14.01 5
  6. 6. Chapter 7:Canary Response Times..............................................................................................................125Canary Response Times....................................................................................................................................125About the Canary Response Times View................................................................................................125About the Preferences View......................................................................................................................127Chapter 8:Capacity Heatmap.............................................................................................................................131Capacity Heatmap.............................................................................................................................................131About the Capacity Heatmap View.........................................................................................................131About the Capacity Heatmap Menus and Toolbar...............................................................................139About the Preferences View......................................................................................................................142Chapter 9:Elastic Performance........................................................................................................................145Elastic Performance...........................................................................................................................................145About the Elastic Performance View.......................................................................................................145About the Preferences View......................................................................................................................148Chapter 10:External Content.................................................................................................................................149External Content................................................................................................................................................149About the Preferences View......................................................................................................................149Chapter 11:Lock Viewer.............................................................................................................................................151Lock Viewer........................................................................................................................................................151About the Lock Viewer View....................................................................................................................151Table of Contents6 Teradata Viewpoint User Guide, Release 14.01
  7. 7. Chapter 12:Metrics Analysis............................................................................................................................................159Metrics Analysis...........................................................................................................................................................159About the Metrics Analysis View.......................................................................................................................159About the Preferences View................................................................................................................................165Chapter 13:Metrics Graph...................................................................................................................................................169Metrics Graph..............................................................................................................................................................169About the Metrics Graph View..........................................................................................................................169About the Metrics Graph Menus and Toolbar.................................................................................................177Chapter 14:My Queries..........................................................................................................................................................179My Queries...................................................................................................................................................................179About the My Queries View...............................................................................................................................179About the Details View........................................................................................................................................184About Managing Queries and Sessions.............................................................................................................189About the Preferences View................................................................................................................................192Chapter 15:Node Resources.............................................................................................................................................195Node Resources............................................................................................................................................................195About the Summary Views.................................................................................................................................195About the Table View..........................................................................................................................................201About the Details View........................................................................................................................................204About the Preferences View................................................................................................................................207Chapter 16:Productivity.......................................................................................................................................................209Productivity..................................................................................................................................................................209About the Productivity View..............................................................................................................................209About the Preferences View................................................................................................................................210Table of ContentsTeradata Viewpoint User Guide, Release 14.01 7
  8. 8. Chapter 17:Query Groups.........................................................................................................................................215Query Groups.....................................................................................................................................................215About the Query Groups View.................................................................................................................215About the Details View..............................................................................................................................222About Managing Queries and Sessions...................................................................................................227About the Preferences View......................................................................................................................229Chapter 18:Query Monitor.......................................................................................................................................231Query Monitor...................................................................................................................................................231About the Query Monitor View...............................................................................................................231About the Utility View..............................................................................................................................242About the Details View..............................................................................................................................242About Managing Queries and Sessions...................................................................................................248About the Preferences View......................................................................................................................251Chapter 19:Query Spotlight....................................................................................................................................255Query Spotlight..................................................................................................................................................255About the Query Spotlight View..............................................................................................................255About the Details View .............................................................................................................................260About the Preferences View......................................................................................................................266Chapter 20:Remote Console...................................................................................................................................269Remote Console.................................................................................................................................................269About the Remote Console View.............................................................................................................269About the Remote Console Menus and Toolbar...................................................................................271About Console Utilities.............................................................................................................................272About the Preferences View......................................................................................................................273Table of Contents8 Teradata Viewpoint User Guide, Release 14.01
  9. 9. Chapter 21:Space Usage......................................................................................................................................................275Space Usage..................................................................................................................................................................275About the Space Usage View..............................................................................................................................275About the Space Usage Details View.................................................................................................................284About the Preferences View................................................................................................................................285Chapter 22:SQL Scratchpad..............................................................................................................................................287SQL Scratchpad............................................................................................................................................................287About the Query Box...........................................................................................................................................287About Query Results............................................................................................................................................290About the Object Browser...................................................................................................................................292About the History Tab.........................................................................................................................................294About the Saved Tab............................................................................................................................................295Chapter 23:System Health.................................................................................................................................................297System Health...............................................................................................................................................................297About the System Health View...........................................................................................................................297About the System Health Details View.............................................................................................................298About the Preferences View................................................................................................................................300Chapter 24:Todays Statistics.........................................................................................................................................303Todays Statistics..........................................................................................................................................................303About the Todays Statistics View......................................................................................................................303About the Preferences View................................................................................................................................306Chapter 25:TVS Monitor.......................................................................................................................................................309TVS Monitor................................................................................................................................................................309TVS Monitor Concepts........................................................................................................................................309Table of ContentsTeradata Viewpoint User Guide, Release 14.01 9
  10. 10. Selecting a View..........................................................................................................................................310Viewing Cylinder Distribution by Grade................................................................................................310Viewing Historical Cylinder Distribution by Grade.............................................................................310Viewing Cylinder Allocation by Temperature and Grade...................................................................311Chapter 26:Viewpoint Monitoring....................................................................................................................315Viewpoint Monitoring......................................................................................................................................315About the Viewpoint Monitoring View..................................................................................................315About the Preferences View......................................................................................................................319Chapter 27:Workload Designer...........................................................................................................................323Workload Designer...........................................................................................................................................323Workload Designer Concepts..................................................................................................................323About the Workload Designer View.......................................................................................................324About Ruleset Options..............................................................................................................................325About the Ruleset General View..............................................................................................................330About Ruleset States...................................................................................................................................332About Classification Settings....................................................................................................................344About Ruleset Sessions..............................................................................................................................350About Ruleset Filters..................................................................................................................................356About Ruleset Throttles.............................................................................................................................358About Ruleset Workloads.........................................................................................................................361About Ruleset Exceptions.........................................................................................................................378Chapter 28:Workload Health.................................................................................................................................381Workload Health...............................................................................................................................................381Workload Health Concepts......................................................................................................................381About the Workload Health View...........................................................................................................382About the Workload Health Details View..............................................................................................384About the Preferences View......................................................................................................................387Table of Contents10 Teradata Viewpoint User Guide, Release 14.01
  11. 11. Chapter 29:Workload Monitor........................................................................................................................................389Workload Monitor......................................................................................................................................................389Workload Monitor Concepts..............................................................................................................................389Workload Monitor Views...................................................................................................................................391About the State Matrix.........................................................................................................................................394About the Dynamic Pipes View.........................................................................................................................395About the Static Pipes View................................................................................................................................397About the Distribution View..............................................................................................................................400About the Workload Details View.....................................................................................................................403About the Workload Group View......................................................................................................................405About the Request Details View.........................................................................................................................405About Managing Queries and Sessions.............................................................................................................410About the Preferences View................................................................................................................................412Table of ContentsTeradata Viewpoint User Guide, Release 14.01 11
  12. 12. Table of Contents12 Teradata Viewpoint User Guide, Release 14.01
  13. 13. PrefaceChanges to This BookDate and Release DescriptionOctober 201214.01Updated for the 14.01 release.Related DocumentationAccess the Teradata Information Products web site to view or download additionaldocumentation 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 IDTeradata Viewpoint Configuration GuideDescribes how to configure and upgrade a Teradata Viewpoint server.B035-2207Teradata Alerts User GuideDescribes how to set up and monitor alerts using Teradata Alerts portlets.B035-2210Teradata Alerts Installation and Configuration GuideDescribes how to configure Teradata Alerts on a Teradata Viewpoint server.B035-2211Teradata Data Lab User GuideDescribes how to use Teradata Data Lab portlets.B035-2212Teradata Viewpoint User Guide, Release 14.01 13
  14. 14. Preface14 Teradata Viewpoint User Guide, Release 14.01
  15. 15. CHAPTER 1Teradata Viewpoint BasicsTeradata Viewpoint Portal and PortletsThe Teradata Viewpoint portal is a framework where Web-based applications, known asportlets, are displayed. IT professionals and business users can customize their portlets tomanage and monitor their Teradata systems using a Web browser.Portlets enable users across an enterprise to customize tasks and display options to theirspecific business needs. You can view current data, run queries, and make timely businessdecisions, reducing the database administrator workload by allowing you to manage yourwork independently. Portlets are added to a portal page from a menu. The TeradataViewpoint Administrator configures access to portlets based on your role.Getting StartedLearn how to start and end a Teradata Viewpoint session, use the help, and use notifications.Logging OnLogging on to the Teradata Viewpoint portal starts your session so you can begin workingwith 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, theusername and password you enter are authenticated against your company-providedusername and password the first time you log on to Teradata Viewpoint. Automaticprofile creation is known as auto-provisioning.Using Viewpoint HelpThe Teradata Viewpoint Help provides information about how to use Teradata Viewpointto 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 hierarchyof topics contained in the help.2 Do any of the following:Teradata Viewpoint User Guide, Release 14.01 15
  16. 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) thecurrent topic in the content hierarchy.Using NotificationsTeradata Viewpoint uses notifications to communicate the status of Viewpoint operations.Notifications are displayed in the Teradata Viewpoint portal for 72 hours from the last statuschange.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 OffLogging off the Teradata Viewpoint portal ends your current session and returns you to theWelcome 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 openTeradata Viewpoint Help window is closed.Setting Up the Portal for PortletsTeradata Viewpoint provides portlets to manage and monitor systems. A portal page is avirtual work space where you decide which portlets to display and how to arrange them onthe page. Examples of ways to organize your work include defining a page for each systembeing monitored, or for each type of query or user. The currently selected page is called theactive page.A portal page has two columns that can be resized. After adding portlets to the portal, youcan drag and drop portlets into either column. You can resize the width of the portalcolumns on each page by dragging the column divider until the minimum size of a column isreached. 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 itsminimum size. Not all Viewpoint portlets and products support resizing or two-columnlayout.Chapter 1 Teradata Viewpoint Basics16 Teradata Viewpoint User Guide, Release 14.01
  17. 17. A shared page contains portlets that are applicable to your role. The Teradata ViewpointAdministrator controls the type of shared page you have access to and can discusslimitations you may have with read-only and mandatory pages. Your role may be preventedfrom adding portlets, deleting portlets, moving portlets on a page, as well as other functionsyou may have been accustomed to doing with regular portal pages.Adding a PageOrganize your portlets by adding pages to the Teradata Viewpoint portal. Multiple pagescan be added or removed. The newest page is always the active page unless you click anothertab.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 yourrole.A new tab appears and becomes the active page.2 [Optional] Add portlets from the Add Content menu.Naming a PageOne way you can customize the Teradata Viewpoint portal is by giving meaningful names tothe pages that display portlets. You can change the page name at any time during a TeradataViewpoint 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 thefrequency of use.Adding a PortletA portlet can be added to the active page at any time during a session. Except for theCalendar 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 BasicsTeradata Viewpoint User Guide, Release 14.01 17
  18. 18. Filtering PortletsLocate a portlet by using the keyword filter box and the SEARCH RESULTS list. Thismethod is also useful when you want to add a portlet to the active page and the list of portletsis 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 filtercriteria. This field is not case-sensitive.2 Click a portlet name in the SEARCH RESULTS list to add it to the page.Resizing Portal ColumnsPortlets that can be horizontally resized will expand to fill the width of the column. Portletsthat 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 PagesInitially 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 yourTeradata 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 PageA shared page contains portlets that are applicable to your role. A shared page can be addedmultiple times if it is not read-only. Mandatory shared pages automatically appear when youlog 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 Basics18 Teradata Viewpoint User Guide, Release 14.01
  19. 19. 4 [Optional] Add portlets from the Add Content menu if the shared page is not read-only.Refreshing a Shared PageWhen the Teradata Viewpoint Administrator updates the contents of a shared page, an iconin the tab indicates a new version of the page is available. You can keep your currentversion by renaming the page or removing the out of date page and then adding therefreshed page to the portal.1 Rename or remove a shared page when a new version is available.Option DescriptionRename 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 addedfrom 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 PortletA portlet can be deleted from the active portal page at any time. Deleting a portlet resetsportlet information and deletes any custom settings set for that instance only. Other portletinstances 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 BasicsTeradata Viewpoint User Guide, Release 14.01 19
  20. 20. Deleting a PageA portal page and its contents can be deleted from the portal at any time after it has beendefined 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 PortalAfter you select a portlet from the Add Content menu, it appears on the portal page. Youcan 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 pageand disappears when the cursor moves off the portlet.• Displays the portlet name or the current settings in the upper frame, depending on thecurrent activity.Portlets that span two columns, such as the WORKLOAD DESIGNER portlet, cannot beresized and always appear at the top of the portal page.Most portlets can be resized horizontally, vertically, or both. Portlets have a minimum heightand can be resized vertically using the control at the bottom of the portlet.Portlet ControlsThe Teradata Viewpoint Administrator controls which portlets and what features you areauthorized to use. If a portlet or feature is not available, the Teradata ViewpointAdministrator can assign permissions.The following is a list of portlet controls:Note: Not all portlets have all controls.Adjust HeightAdjusts the vertical size for portlets that can be resized. Drag the control to resize theportlet vertically. The portlet retains its new dimensions until you click the RestoreHeight button.Chapter 1 Teradata Viewpoint Basics20 Teradata Viewpoint User Guide, Release 14.01
  21. 21. BackReturns to the previous view.CollapseToggles the portlet closed. This button appears only when the portlet is open. Whencollapsed, only the upper and lower portlet frame sections are displayed.ExpandToggles 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 portalpage.MaximizeToggles the portlet to fill the portal page.MinimizeToggles the portlet to the default size of one column wide.Pause, ResumePauses 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 theTeradata server to the portlet.Portlet FrameContains the portlet name and portlet controls.Portlet NameDisplays the portlet name. You can rename shareable portlets.PreferencesAccesses portlet preferences and settings. Preferences are used to specify whatinformation is displayed, time intervals for reporting, and other features that helpyou customize the portlet functions.RemoveRemoves the portlet and its settings from the active portal page.Restore HeightRestores the portlet to its default height. This button appears only when you changethe default height of the portlet.RewindProvides 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 BasicsTeradata Viewpoint User Guide, Release 14.01 21
  22. 22. • indicates the portlet is unlinked from rewind.Share PortletCaptures a customized version of a portlet for use by other users. The TeradataViewpoint Administrator must make the customized portlet available for sharing.Time StampDisplays the last time data was retrieved from the Teradata server. The time is basedon the time zone set in the Profile portlet.Each portlet instance has its own settings and controls as well as the features common to allportlets. 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 portletTeradata Database Logon SettingsSeveral portlets require you to log on to Teradata Database to take actions such as aborting aquery or session, changing a workload, changing a priority, or releasing a query from thedelay queue. Teradata Database logon information is stored with your session and does notpersist beyond the current session.Chapter 1 Teradata Viewpoint Basics22 Teradata Viewpoint User Guide, Release 14.01
  23. 23. The logon dialog box fields are listed below.Field Name Descriptionusername Name of the user account on Teradata Database and is authenticatedagainst a domain username that matches a Teradata Database username.password Secret string of characters used to prove identity or gain access to aresource and is authenticated against the domain password associatedwith a domain username that matches a Teradata Database username.account string Characteristics for profile member sessions in Teradata Database. Anaccount string identifies which account is charged for the space used bythe user and session and may include a priority-level Performance Groupprefix code which establishes the session priority.authenticationmechanismMethod of identifying an account to the database. Options might includeTD2 or LDAP. If an authentication mechanism is not selected, the logonuses the default authentication mechanism for the Teradata Database.character set Character set the system uses to communicate with Teradata Database. Ifnot defined, Teradata Viewpoint uses Teradata Database system settings.About the Rewind FeatureThe rewind feature allows you to view data that corresponds to dates and times in the pastand compare it to data for a different date and time. You can rewind the data for some or allportlets on a portal page to a previous point in time, such as when a job failed. Rewindingportlet 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 forportlets that have portlet-specific methods for reviewing data over time. The rewind featureworks uniquely in the QUERY SPOTLIGHT portlet. See the Query Spotlight topics forfurther details.Using the rewind toolbar, you can enter a specific date and time as well as scroll through thedata in increments of seconds, minutes, hours, or days. All portlets on the page that areparticipating in rewind activities display data that corresponds to the selected rewind dateand 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 andportlet access. If the rewind toolbar does not appear on the portal page, you are notauthorized to use the feature. If the rewind icon does not appear in the portlet frame, therewind feature is not available for that portlet.Rewinding a Portal PageYou can rewind data for some or all portlets on a portal page. Use rewind to see changes indata 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 BasicsTeradata Viewpoint User Guide, Release 14.01 23
  24. 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 PortletYou can pause an individual portlet on a portal page while other portlets on the page displayrewound data. Pausing an instance of a portlet freezes the display of data at the moment theportlet is placed in pause mode, allowing you to compare data for multiple rewound timeperiods.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 portletrefresh.Resuming Rewind for a PortletYou can resume using the rewind feature for an individual portlet that is in pause mode on aportal 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 changeuntil the selected date or time for the rewind feature is changed.Stopping Rewind ParticipationYou can prevent an individual portlet from participating in rewind when the portlet framedisplays .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 timecontrols.3 Click Unlink from Rewind.The portlet no longer responds to rewind date or time controls and is updated to displaythe most recent data available from the Teradata server.Chapter 1 Teradata Viewpoint Basics24 Teradata Viewpoint User Guide, Release 14.01
  25. 25. Restarting Rewind ParticipationYou can have an individual portlet not participating in rewind resume participation whenthe 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 inrewind. For example, if the portlet was in pause mode when unlinked from rewind, it isin pause mode when participation in rewind resumes.Turning Off the Rewind FeatureYou can turn off the rewind feature and resume display of current data in all portlets on theportal 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 endparticipation and display the most recent data available.About the Pause FeatureAny rewindable portlet can be paused from refreshing data. Pausing an instance of a portletfreezes the display of data at the moment the portlet is placed in pause mode, allowing youto compare data for different time periods. The rewind feature does not need to be active topause the portlet. When a portlet is in pause mode, the time stamp flashes, indicating thatthe data in the portlet is no longer being refreshed.Pausing Portlet RefreshYou 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 portletrefresh.Resuming Portlet RefreshYou 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 andtime, including data from the Teradata server.• Click Resume to resume the portlet refresh.About Shared PortletsUse the SHARE PORTLET feature to make a customized or preconfigured version of aTeradata Viewpoint portlet available to other users. When a shared portlet is added to aportal page, all the preferences and settings you selected when you customized the portletare used.Chapter 1 Teradata Viewpoint BasicsTeradata Viewpoint User Guide, Release 14.01 25
  26. 26. Any user can customize a shareable portlet and submit it for sharing. Depending on yourTeradata Viewpoint system configuration, the portlet is not available to authorized usersuntil the Teradata Viewpoint Administrator approves the request. Only the TeradataViewpoint Administrator can delete the shared portlet entirely. If deleted, existing instancesremain on your portal page. However, a warning message appears if you try to access theportlet.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 Sharedsubmenu only appears when at least one shared portlet is enabled for the user who is loggedon.Creating a Shared PortletUse the SHARE PORTLET feature to customize a Teradata Viewpoint portlet and make itavailable 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 maynot be available to authorized users until the Teradata Viewpoint Administratorapproves your request.7 Click Save.8 [Optional] Contact the Teradata Viewpoint Administrator to verify that the portlet hasbeen received for approval.Chapter 1 Teradata Viewpoint Basics26 Teradata Viewpoint User Guide, Release 14.01
  27. 27. CHAPTER 2ProfileProfileThe Profile portlet provides tabs that allow you to set your personal user settings andmanage your Teradata Database profile information:Personal InfoChange your name, password, email address, and locale, and select the time zone.Teradata AccountsManage settings for each of your Teradata Database user profiles. Link yourTeradata profile to the Teradata Database systems you are authorized to access.Access the Profile portlet from the Teradata Viewpoint portal.About the Personal Info TabThe Personal Info tab in the Profile portlet allows you to manage your Teradata Viewpointprofile:• 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• KoreanThe locale you select is applied to the entire Teradata Viewpoint session and is maintainedin future sessions.Changing a NameYou 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. 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 AddressYou can set your Email address using the Personal Info tab. This email address is used foridentification and communication in the Teradata Viewpoint system, including notificationsand reminders.The email address cannot contain uppercase letters. Uppercase characters are automaticallyconverted 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 PasswordsYou can manage Teradata Viewpoint profile passwords. A password must be at least 4 andno more than 25 characters.A user cannot change their password if their profile is externally authenticated. The fieldsrequired to change the password are not available when external authentication is used. Tochange the password for an externally authenticated profile, follow your company policy forpassword 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 LocaleThe locale is used to display the local language with the date, time, and number formatspecific to the country. For example, if the locale is “English (US),” the system uses theEnglish 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 theday 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 ViewpointAdministrator for your account.1 From the Profile portlet, click the Personal Info tab.2 Select the locale from the list.Chapter 2 Profile28 Teradata Viewpoint User Guide, Release 14.01
  29. 29. The Teradata Viewpoint application server locale is the default.3 Click Apply.A confirmation message appears.Setting the Time ZoneYou can adjust your local Teradata Viewpoint time zone setting to compensate for differenttime zones. Select the local time zone to display all time and date information in the localdate and time, even if the Teradata Database system you are monitoring is located in adifferent time zone.The time zone you enter compensates for the time difference between the monitored systemlocation 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 referencelocation. The Teradata Viewpoint application server time zone is the default. Use thescroll bar to view more time zones.3 Click Apply.A confirmation message appears.About the Teradata Accounts TabUse the Teradata Accounts tab in the Profile portlet to manage Teradata Database accountlogon and profile information for each Teradata Database system. Teradata accountinformation is used by the My Queries portlet. For each Teradata Database system, you can:• Add accounts• Edit existing profiles• Delete profilesSystem profiles added using the Teradata Accounts tab must already exist on the monitoredsystem. The system validates the USERNAME, PASSWORD, ACCOUNT STRING, andAUTHENTICATION fields prior to confirmation.Chapter 2 ProfileTeradata Viewpoint User Guide, Release 14.01 29
  30. 30. Adding a User ProfileThis task explains how to associate Teradata Database profiles with your Teradata Viewpointprofile.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 string4 [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 operationfails; verify that the settings are correct, and try again.6 Click Add.Editing a User ProfileThis topic explains how to edit a Teradata Database system user profile in TeradataViewpoint.1 From the Profile portlet, click the Teradata Accounts tab.2 Mouse over the row containing the user profile information for the Teradata Databasesystem 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 STRING5 [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 ProfileThis task explains how to delete a Teradata Database system user profile from TeradataViewpoint.1 From the Profile portlet, click the Teradata Accounts tab.2 Mouse over the row containing the Teradata Database user profile information for thesystem you are updating.The row is highlighted, and Edit and Delete appear.Chapter 2 Profile30 Teradata Viewpoint User Guide, Release 14.01
  31. 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 ProfileTeradata Viewpoint User Guide, Release 14.01 31
  32. 32. Chapter 2 Profile32 Teradata Viewpoint User Guide, Release 14.01
  33. 33. CHAPTER 3System AdministrationSystem AdministrationAdmin PortletsThe Teradata Viewpoint administrative portlets allow the Teradata ViewpointAdministrator to provide access to Teradata Viewpoint resources and information.You can access these portlets from the Admin menu in the Teradata Viewpoint portal ifyour role has permission. You can access the Profile portlet directly from the TeradataViewpoint portal.Alert SetupConfigure the alert delivery settings and actions.BackupConfigure the backup of Teradata Viewpoint server data.CertificatesManage trusted certificate authorities and HTTPS certificates.GeneralConfigure Teradata Viewpoint settings.LDAP ServersConfigure the LDAP servers for Teradata Viewpoint to authenticate users andassign user roles.Managed ServersConfigure the servers available to display in the Viewpoint Monitoring portlet.Portlet LibraryView the installed portlets and specify which portlets can be accessed.ProfileConfigure settings for your Viewpoint user account and associate TeradataDatabase accounts.Query Group SetupManage the sets of queries available to users in the Query Groups portlet.Teradata Viewpoint User Guide, Release 14.01 33
  34. 34. Roles ManagerManage roles and specify the level of access users are given.Shared PagesManage shared pages and how they are viewed by users.Teradata SystemsConfigure the systems and data collectors that provide data to portlets.User ManagerManage user accounts and assign users to roles.Security and PermissionsThe Teradata Viewpoint administrative portlets allow the Teradata Viewpoint Administratorto control portlet access at different levels by setting permissions for Teradata Viewpointusers.GlobalEnable or disable access to portlets globally using the Portlet Library portlet. Thissetting takes precedence over all other portlet permission levels.RoleAssign permissions to classes of users called roles using the Roles Manager portlet.Each tab controls access to features.UserAssign available roles to users and set role precedence using User Manager portlet.Roles assigned higher priority take precedence over lower-priority roles.BackupThe Backup portlet allows you to enable automatic Teradata Viewpoint system backups andconfigure the data retention settings.The Backup portlet displays the backup process icon with either a successful completion oran error for the last attempt and lists the last successful backup date and time. Use theBackup 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 filesChapter 3 System Administration34 Teradata Viewpoint User Guide, Release 14.01
  35. 35. About Backup ErrorsThe BACKUP dialog box displays an out-of-service icon and the status message ANERROR HAS OCCURRED, if an error occurs during the backup process. To investigate theerror, you can view the backup log file: /opt/teradata/dcs/logs/backup.log. Foradditional information, see the Teradata Viewpoint Configuration Guide.Scheduling Viewpoint BackupsYou can configure automatic backups, set a data retention length, and enable or disable thebackup 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 backupfiles:Option DescriptionLocal Backs up Teradata Viewpoint databases to the local server.Network Backs up Teradata Viewpoint databases to a networked file server to prevent data lossin 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 onthe host system.• [Optional] Click Test to verify that the login settings are correct. The iconappears 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 theconfigured number of days.CertificatesThe Certificates portlet allows you to manage certificates on the Viewpoint Server.Certificates are used to help secure communications to and from a Viewpoint server. Youcan install a certificate to secure communication from a browser to the Viewpoint serverand from the Viewpoint server to external servers. You can install a trusted root certificatefor a Certificate Authority to be trusted by the Viewpoint server.Chapter 3 System AdministrationTeradata Viewpoint User Guide, Release 14.01 35
  36. 36. About Certificate AuthoritiesCertificate Authorities (CA) issue certificates. To initiate secure communications with anexternal server (e.g., a corporate LDAP server), the Viewpoint server must trust the CA thatissued the certificate of the external server.The root certificates of certain standard CAs are pre-installed on the Viewpoint server andcertificates issued by them are automatically accepted. However, if a non-standard CA issuedthe certificate, then the root certificate of this CA must be installed on the Viewpoint serverfor the certificate to be accepted.You can install the root certificate of a trusted CA from the Certificate Authority view.Installing Trusted Root Certificates1 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 Certificates1 From the SETUP list, click Certificate Authority.2 Click next to the certificate you want to delete.3 Click Delete.About HTTPS ConnectionsHTTPS connections are secure connections between a browser and the Viewpoint server. Toenable HTTPS connections, the Viewpoint server needs an identifying certificate thatprovides the public key used to decrypt the information it sends. This certificate may beeither self-signed or signed by a Certificate Authority (CA).To install a new certificate from a CA, you must first generate a Certificate Signing Requestand submit it to a CA for signing. Once you receive the signed certificate from the CA youcan install it.Creating a Self-Signed CertificateA self-signed certificate can provide security for an internal site or serve as a temporarymeasure while a fully authenticated certificate is obtained from a Certificate Authority.Installing a certificate replaces the existing certificate. Once a certificate is replaced, it cannotbe reinstalled.1 From the SETUP list, click HTTPS Config.2 Click Create SSC and enter the certificate information.Chapter 3 System Administration36 Teradata Viewpoint User Guide, Release 14.01
  37. 37. Field DescriptionCommon Name Domain nameOrganizational Unit Business unitOrganization Company nameCity or Locality Company addressState or Province Company addressCountry Company address, 2 charactersExpiration Select an expiration period3 Click Install.Creating a Certificate Signing RequestA signing request is used to obtain an authenticated certificate for the server. Creating andsaving a new signing request replaces a pending request. If a pending request is replaced, thesigned certificate that comes from the request cannot be installed. Once created, the requestmust 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 DescriptionCommon Name Domain nameOrganizational Unit Business unitOrganization Company nameCity or Locality Company addressState or Province Company addressCountry Company address, 2 characters3 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 onthe browser settings.Installing a Signed CertificateAfter obtaining an authenticated certificate from a trusted Certificate Authority, you caninstall the certificate to facilitate secure communications to the Viewpoint server. Installinga certificate replaces the active certificate. Once an active certificate has been replaced, itcannot be reinstalled.1 From the SETUP list, click HTTPS Config.2 Click Install.3 Click Browse.Chapter 3 System AdministrationTeradata Viewpoint User Guide, Release 14.01 37
  38. 38. 4 Select the signed certificate.5 Click Install.Deleting Installed CertificatesA 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.GeneralThe General portlet allows a Teradata Viewpoint Administrator to set the locale and sessiontimeout for a Teradata Viewpoint server. Users can choose a different locale in the Profileportlet to override the default locale selection.• The locale is used to localize content in the Viewpoint portal. Dates, times, and numbersare displayed in Viewpoint portlets in the format used by the selected locale. If thelanguage pack for the selected locale is installed, then all content appears in the selectedlanguage.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 inEnglish 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 beinglogged out of the system. The default setting is one hour and 30 minutes.Setting General Options1 Select a locale from the list.2 Set a session timeout.3 Click Apply.LDAP ServersThe LDAP Servers portlet allows you to configure LDAP servers to authenticate users andassign user roles in Teradata Viewpoint. The LDAP Servers portlet displays the names ofcurrently 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 Administration38 Teradata Viewpoint User Guide, Release 14.01
  39. 39. • Use the dialog box to enable and disable an LDAP server, and configure the LDAP toautomatically validate users against the LDAP directory with the auto-provisioningfeature 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 bindingoperation 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 ServerYou 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 theLDAP server to Teradata Viewpoint.4 Enter a URL address.One URL address is required. Use to delete, add, and move up or move down inthe evaluation order.5 Select the Name Matching method from the following options:• Select DN Pattern Bind to specify one or more patterns that represent adistinguished 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 searchwith a specific account.• [Optional] Leave Service account DN and Service account password blank toconnect 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 includesubdirectories of the base directory in the search.• [Optional] Under Search extent, clear the Recursive scan check box to limit thesearch 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 AdministrationTeradata Viewpoint User Guide, Release 14.01 39
  40. 40. Every user has an email address. This default email domain is used if a valid emailaddress 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 operationfails; 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 validateusers against the LDAP directory.b Select a role from the Automatically assign these roles menu. You can add orremove 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 emailaddress 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 directoriesduring the binding process.c Enter a Group attribute name.d [Optional] Click Add Role Mapping to add attribute or group settings so that youcan assign another role.10 Click Apply.The icon appears if the operation is successful. The icon appears if the operationfails; verify that the settings are correct, and try again.About Role MappingIn Teradata Viewpoint, users are assigned roles to organize and control their access toportlets, metrics, and features. You can use the Roles Manager portlet to assign permissionsto the roles. During the process of adding an LDAP configuration to Teradata Viewpoint, theoptional Role Mapping section in the LDAP Servers portlet allows you to assign a roleautomatically 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 Administration40 Teradata Viewpoint User Guide, Release 14.01
  41. 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 RolesManager portlet.Role Mapping Use CasesIn the following use cases, the LDAP value represents the distinguished name (DN) of agroup. When the Type is Attribute, the attribute name field represents the user attributewhere the group DN is stored. When the Type is Group, the group attribute name field isused 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 theusers record in LDAP. Assume you have a user with the following record in LDAP:dn: cn=User1,ou=Users,dc=teradata,dc=commemberOf: cn=USA,ou=Groups,dc=teradata,dc=comIn this case, the Group attribute name field is not relevant. To map User1 to the TeradataViewpoint 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 UsersThe second use case assigns users to a Teradata Viewpoint role based on membership inan LDAP group with the following structure:dn: cn=DBAs,ou=Groups,dc=teradata,dc=comuniqueMember: cn=User2,ou=Users,dc=teradata,dc=comIn this case, set the Group attribute name field to uniqueMember. To map User2 to theTeradata Viewpoint role DBAs, create the following role mapping:• Type = Group• LDAP value = cn=DBAs,ou=Groups,dc=teradata,dc=com• Viewpoint role = DBAsManaged ServersA managed server is a server in a Teradata cabinet that is monitored by the same Teradataserver management solution used to monitor TPA nodes. A managed server might be usedfor storage, backup, or housing data collectors that provide portlet information and metricdata. Teradata Viewpoint monitors managed servers for system-level metrics and collectsinformation for Teradata Viewpoint portlets.The Managed Servers portlet displays the names of currently configured managed servers oris empty if no managed server is configured. Use next to SERVERS to add a managedserver. Use the dialog box to delete, enable, and disable a managed server for use by theTeradata Viewpoint Data Collection Service (DCS).Chapter 3 System AdministrationTeradata Viewpoint User Guide, Release 14.01 41
  42. 42. Adding a Managed ServerYou can add a managed server to Teradata Viewpoint. After a managed server is defined inTeradata Viewpoint, you can test the configuration settings and enable the managed serverfor 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 theDCS.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 settingsduring 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 operationfails; verify that the settings are correct, and try again. If you are unable to enable ordisable the managed server, contact the Teradata Viewpoint Administrator.Deleting a Managed ServerYou can delete a Teradata Viewpoint managed server. This is a permanent procedure thatdiffers 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 ServerAfter a managed server is defined in Teradata Viewpoint, you can enable it for use by theData 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 themanaged server can still be viewed.Chapter 3 System Administration42 Teradata Viewpoint User Guide, Release 14.01
  43. 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 operationfails; verify that the settings are correct, and try again. If you are unable to enable ordisable the managed server, contact the Teradata Viewpoint Administrator.Portlet LibraryThe Portlet Library allows you to enable or disable portlets globally. This setting takesprecedence over every other portlet permission level.The Manage Existing Portlets view allows you to manage the installed portlets, which aregrouped 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 deletedPortlets in the Admin category display N/A in the ENABLE column. These portlets cannotbe 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 identifiesthe original portlet before its customization as a shared portlet. Only portlets in the SharedPortlet category can be deleted.Enabling or Disabling PortletsThe Teradata Viewpoint Administrator can use the Portlet Library to enable or disableinstalled 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 theAdmin category display N/A in the ENABLE column. These portlets cannot be disabledand are included in the view only to provide version information.3 Click Apply.Chapter 3 System AdministrationTeradata Viewpoint User Guide, Release 14.01 43
  44. 44. Deleting a Shared PortletThe Teradata Viewpoint Administrator can use the Portlet Library to delete a shared portletso 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 todelete.A confirmation message appears.3 Click OK.The portlet name no longer appears in the Add Content menu in the portal, and theportlet is no longer available to Teradata Viewpoint users. Existing instances of a sharedportlet on a portal page remain on the page. However, a warning message appears if auser tries to access the portlet.Query Group SetupThe Query Group Setup portlet allows the Teradata Viewpoint Administrator to manage thesets of queries that are available to users in the Query Groups portlet. You can create querygroups based on a set of criteria, assign users that can access the group, and delete querygroups.Creating a Query GroupCreate a query group in the Query Group Setup portlet to allow users to view their mostrelevant queries in the Query Groups portlet. You create a query group to filter the queriesthat 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 Administration44 Teradata Viewpoint User Guide, Release 14.01
  45. 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 definedsub-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 thefollowing:• In the Match string box, type a value to dynamically define criteria, and click tomove it to the Selected box. The value can contain ? to match exactly one character inthe position it occupies, * to match zero or more characters, or = at the beginning ofthe 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 theSelected 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 valuecan contain ? to match exactly one character in the position it occupies, * to matchzero or more characters, or = at the beginning of the string to match alpha andnumeric characters literally.• In the Available users box, select one or more Viewpoint users and click to moveit to the Selected users box.• In the Available roles box, select one or more Viewpoint roles and click to moveit to the Selected roles box.Chapter 3 System AdministrationTeradata Viewpoint User Guide, Release 14.01 45

×