care systems analytics for epic installation and configuration guide · 2015-06-08 · care systems...

Care Systems Analytics for EpicInstallation and Configuration Guide

VMware Care Systems Analytics for Epic Management Pack for vRealize Operations Managerand vCenter Operations Manager

This document supports the version of each product listed andsupports all subsequent versions until the document is replacedby a new edition. To check for more recent editions of thisdocument, see http://www.vmware.com/support/pubs.

EN-001463-01

http://www.vmware.com/support/pubs

VMware, Inc.3401 Hillview Ave.Palo Alto, CA 94304www.vmware.com

2 VMware, Inc.

Care Systems Analytics for Epic Installation and Configuration Guide

You can find the most up-to-date technical documentation on the VMware Web site at:

http://www.vmware.com/support/

The VMware Web site also provides the latest product updates.

If you have comments about this documentation, submit your feedback to:

[email protected]

Copyright © 2014-2015 VMware, Inc. All rights reserved. Copyright and trademark information

http://www.vmware.com/support/

http://www.vmware.com/support

mailto:[email protected]

http://pubs.vmware.com/copyright-trademark.html

VMware, Inc. 3

Contents

About This Book 5

Introduction to Care Systems Analytics for Epic 7Installation and Configuration Requirements 7

Installation Component Overview 8

Installing the Care Systems Analytics for Epic Management Pack (Adapter) on vRealize Operations Manager 9

Install the Care Systems Analytics for Epic Management Pack in vRealize Operations Manager 9

Load Historical Data 10

Load Historical Data as you Create an Adapter Instance 10

Configuring Historic Data Collection for a New Adapter Instance on vRealize Operations Manager 10

Load Historical Data for an Existing Adapter Instance in vRealize Operations Manager 11

Configure a Care Systems Analytics for Epic Adapter Instance in vRealize Operations Manager 11

Clone and Share Dashboards in vRealize Operations Manager 13

Update the Epic Management Pack on vRealize Operations Manager 14

Configure User Group Permissions in vRealize Operations Manager 14

Migrate from vCenter Operations Manager to vRealize Operations Manager 15

Remove Duplicate Dashboards 16

Upgrading vRealize Operations Manager 16

Upgrade Care Systems Analytics for Epic Management Pack in vRealize Operations Manager 16

Installing the Care Systems Analytics for Epic Management Pack (Adapter) on vCenter Operations Manager 19

Install the Care Systems Analytics for Epic Management Pack in vCenter Operations Manager 19

Load Historical Data 20

Load Historical Data as you Create an Adapter Instance 20

Configuring Historic Data Collection for a New Adapter Instance on vCenter Operations Manager 20

Load Historical Data for an Existing Adapter Instance in vCenter Operations Manager 21

Create a Care Systems Analytics for Epic Adapter Instance in vCenter Operations Manager 21

Clone and Share Dashboards in vCenter Operations Manager 23

Update the Epic Management Pack in vCenter Operations Manager 23

Configure User Group Permissions in vCenter Operations Manager 24

Upgrading vCenter Operations Manager 25

Upgrade Care Systems Analytics for Epic Management Pack 25


4 VMware, Inc.

VMware, Inc. 5

The Care Systems Analytics for Epic Installation and Configuration Guide describes how to install and configure

the VMware Care Systems Analytics for Epic Management Pack on vRealize Operations Manager and vCenter

Operations Manager.

Intended AudienceThis information is intended for anyone who needs to install or configure the Care Systems Analytics for Epic

Management Pack.

This information assumes you are experienced with vRealize Operations Manager, vCenter Operations

Manager, Epic®, and Epic System Pulse. See VMware Epic System Pulse server, vRealize Operations Manager,

and vCenter Operations Manager documentation at: http://www.vmware.com/support/. See your Epic

documentation, as needed.

VMware Technical Publications GlossaryVMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions

of terms as they are used in VMware technical documentation go to http://www.vmware.com/support/pubs.

Document FeedbackVMware welcomes your suggestions for improving our documentation. If you have comments, send your

feedback to [email protected].

Technical Support and Education ResourcesThe following sections describe the technical support resources available to you. To access the current version

of this book and other books, go to http://www.vmware.com/support/pubs.

Online and Telephone Support

To use online support to submit technical support requests, view your product and contract information, and

register your products, go to http://www.vmware.com/support.

Customers with appropriate support contracts should use telephone support for the fastest response on

priority 1 issues. Go to http://www.vmware.com/support/phone_support.

Support Offerings

To find out how VMware support offerings can help meet your business needs, go to

http://www.vmware.com/support/services.

About This Book



mailto:[email protected]



http://www.vmware.com/support/phone_support.html

http://www.vmware.com/support/services


6 VMware, Inc.

VMware Professional Services

VMware Education Services courses offer extensive hands‐on labs, case study examples, and course materials

designed to be used as on‐the‐job reference tools. Courses are available onsite, in the classroom, and live

online. For onsite pilot programs and implementation best practices, VMware Consulting Services provides

offerings to help you assess, plan, build, and manage your virtual environment. To access information about

education classes, certification programs, and consulting services, go to http://www.vmware.com/services.

http://www.vmware.com/services/

VMware, Inc. 7

1

VMware® Care Systems Analytics for Epic is an IT management solution designed for healthcare

organizations that use the Epic® platform. The solution extracts system information from the Epic System

Pulse server and integrates it with VMware vRealize™ Operations Manager™ or VMware vCenter™

Operations Manager™ to create a single view of system performance across the electronic medical record

(EMR) platform and supporting infrastructure.

Care Systems Analytics for Epic is a management pack for the vRealize Operations Manager and vCenter

Operations Manager. These are intelligent operations management solutions from VMware. The Care Systems

Analytics for Epic solution improves visibility into the overall performance of the Epic system‐from

infrastructure to the point of care. It includes dashboards to visualize and analyze performance indicators

from the Caché environment, instances, hosts, Epic services on Windows hosts (Print, Interconnect, Clarity,

and Relay), and related infrastructure (physical and virtual). This transparency increases collaboration across

infrastructure, operations, and applications teams.

Installation and Configuration RequirementsBefore you install the Care Systems Analytics for Epic management pack, verify that your system meets the

listed requirements. See the Care Systems Analytics for Epic Release Notes for the most current information.

Introduction to Care Systems Analytics for Epic 1

NOTE For the purposes of this guide:

When a description applies to both the vRealize Operations Manager and vCenter Operations Manager, the

general term Operations Manager is used. When, appropriate, the specific Operations Manager is listed.

The terms Management Pack, Adapter, and Solution are used interchangeably and generally apply to Care

Systems Analytics for Epic use.


8 VMware, Inc.

Installation Component OverviewThe following two graphics illustrate the relationships between the Care Systems Analytics for Epic

Management Pack, the vRealize Operations Manager or vCenter Operations Manager, and Epic System Pulse

for Epic.

Figure 1-1. View of Care Systems Analytics for Epic Management Pack with the Operations Manager

Figure 1-2. Alternative View of the Management Pack, Operations Manager, and Epic System Pulse

VMware, Inc. 9

2

This section describes how to install the Care Systems Analytics for Epic management pack on the vRealize

Operations Manager.

Installation of management packs in general is described in the documentation for vRealize Operations

Manager. The procedures in this guide are specific to the Care Systems Analytics for Epic management pack.

Though the procedures between the vRealize Operations Manager and the vCenter Operations Manager, are

generally similar, the graphical user interface between the two is different. Please follow the procedures in this

chapter if you are using vRealize Operations Manager.

For additional information about vRealize Operations Manager, see the documentation at:

http://www.vmware.com/support/pubs. From the Support Resources list, select vRealize Operations

Manager.

Install the Care Systems Analytics for Epic Management Pack in vRealize Operations Manager

You install the Care Systems Analytics for Epic management pack on the vRealize Operations Manager using

a PAK file.

The Care Systems Analytics for Epic management pack is the part of the solution that you install. It contains

the dashboards.

Use the vRealize Operations Manager user interface to install the Care Systems Analytics for Epic

management pack. See the vRealize Operations Manager documentation for additional information.

Prerequisites

1 Download your Care Systems Analytics for Epic from my.vmware.com. Your My VMware account login

grants you access to the solutions you have purchased. The solution that you downloaded includes a PAK

file. For example: vmware-<opsmgr>-<om_ver>-EpicCareAdapter-<eca_ver>-<buildnumber>.pak.

2 Save that PAK file to a temporary folder on your local system.

Procedure

3 Use a supported browser to log in to the vRealize Operations Manager user interface with administrator

privileges.

For a current list of supported browsers, see the vRealize Operations Manager release notes.

4 In the left pane of vRealize Operations Manager, click the Administration icon and click Solutions.

Installing the Care Systems Analytics for Epic Management Pack (Adapter) on vRealize Operations Manager 2

NOTE The vRealize Operations Manager does not support uninstalling management packs. This includes the Care

Systems Analytics for Epic management pack. VMware recommends that you take a snapshot prior to

installing the Care Systems Analytics for Epic management pack.

my.vmware.com



10 VMware, Inc.

5 On the Solutions tab, click the green (+) plus sign.

a Browse to locate the temporary folder and select the PAK file.

For example, vmware-vrops-6.0-EpicCareAdapter-1.03-<buildnumber>.pak.

b Because existing dashboards are not overwritten by default, if you are performing a management

pack upgrade and you want to replace existing dashboards, select Reset out‐of‐the box content,

overwriting to a newer version provided by this update.

c Click Upload. After the file uploads, click Next.

d Read and accept the EULA and click Next.

Installation details appear in the window during the process. The installation might take several

minutes.

e When the installation is finished, click Finish.

The management pack is listed as a solution.

What to do next

1 You must configure your Care Systems Analytics for Epic Adapter instance.

2 If you have existing historical data, you can load that before you create your Care Systems Analytics for

Epic Adapter instance.

Load Historical Data When you enable Historic Data Collection, the vRealize Operations Manager learns the Dynamic Thresholds

for your environment faster. Instead of the usual 2‐6 weeks it takes for the vRealize Operations Manager to

collect enough data to determine appropriate Dynamic Thresholds, this feature enables you to pre‐load

historic data into the vRealize Operations Manager in for example, about 10 hours for 30 days of historic data.

Load Historical Data as you Create an Adapter Instance

If the adapter has not been installed, complete the procedure.

Procedure

1 Configure the historic data collection. See “Configuring Historic Data Collection for a New Adapter

Instance on vRealize Operations Manager” on page 10.

2 Proceed with creating the adapter instance. See “Configure a Care Systems Analytics for Epic Adapter

Instance in vRealize Operations Manager” on page 11.

Configuring Historic Data Collection for a New Adapter Instance on vRealize Operations Manager

Use this procedure to import existing historical data to your Care Systems Analytics for Epic adapter.

Procedure

1 Login to the vRealize Operations Manager virtual machine as root. For example, use an ssh command.

2 Open the epiccare.properties file in an editor.

/usr/lib/vmware-vrops/user/plugins/inbound/epiccare_adapter3/conf/epiccare.properties

3 Locate the control parameters at the end of the file. For example:

collectHistoricDataEnabled=falsehistoricDataToCollectInHours=0historicDataChunkCollectionInHours=1

collectHistoricDataEnabled controls whether historic data collection is enabled or not. It can

either be true or false. to enable Historic Data Collection, set this to true.

VMware, Inc. 11

Chapter 2 Installing the Care Systems Analytics for Epic Management Pack (Adapter) on vRealize Operations Manager

historicDataToCollectInHours is the number of hours to go back and start collection. This is

typically set to 30 days which is 720 hours.

historicDataChunkCollectionInHours is the number of hours of data to collect in every collect

cycle.

The default collect cycle for the adapter is 5 minutes and the adapter tries to collect

historicDataChunkCollectionInHours hours of data in every cycle. This can typically be set to 6 hours. Depending on your configuration of System Pulse, you can reduce this to 2 or 1 hour if 6 hours

causes too much load on System Pulse.

For example, the adapter configured for Historic Data Collection for the last 30 days using a chunk size

of 6 hours will have the following configuration:

collectHistoricDataEnabled=truehistoricDataToCollectInHours=720historicDataChunkCollectionInHours=6

4 Create an adapter instance. See “Configure a Care Systems Analytics for Epic Adapter Instance in

vRealize Operations Manager” on page 11.

Historic data should be available for viewing in about 10 minutes.

When the Historic Data Collection is current, the Care Systems Analytics for Epic Adapter continues

to collect the latest metrics from System Pulse.

Load Historical Data for an Existing Adapter Instance in vRealize Operations Manager

If the Care Systems Analytics for Epic adapter instance exists, complete the procedure below.

Procedure

1 Configure the Care Systems Analytics for Epic adapter instance. See “Configure a Care Systems Analytics

for Epic Adapter Instance in vRealize Operations Manager” on page 11.

2 Stop adapter collection.

From the Environment Overview tab, expand the Adapter Instances list, select the Care Systems

Analytics for Epic adapter instance list. In the list detail, select the Care Systems Analytics for Epic adapter

instance and click the Stop Collection icon.

Do not expand the Care Systems Analytics for Epic adapter instance list. You want to stop collection for

the entire Care Systems Analytics for Epic adapter instance.

3 Login to the vRealize Operations Manager virtual machine as root. For example, use an ssh command.

4 Delete the file,

/usr/lib/vmware-vrops/user/plugins/inbound/epiccare_adapter3/work/lastcollect.properties.

5 Configure Historic Data Collection. See “Configuring Historic Data Collection for a New Adapter

Instance on vRealize Operations Manager” on page 10.

6 Login to the vRealize Operations Manager and restart collection.

From the Environment Overview tab, expand the Adapter Instances list, select the Care Systems

Analytics for Epic adapter instance list. In the list detail, select the Care Systems Analytics for Epic adapter

instance and click the Start Collection icon.

Configure a Care Systems Analytics for Epic Adapter Instance in vRealize Operations Manager

To manage your Care Systems Analytics for Epic instances in vRealize Operations Manager, you must

configure an adapter instance for each Care Systems Analytics for Epic instance.


12 VMware, Inc.

When you configure the adapter, you must use one of the following URL formats:

IP address

FQDN (fully qualified domain name)

Prerequisites

Verify that you know the Epic System Pulse server details to connect and collect data.

Check that the Web service endpoint, Outgoing data services HTTP checkbox is enabled.

Download and install the Care Systems Analytics for Epic management pack. See “Install the Care

Systems Analytics for Epic Management Pack in vRealize Operations Manager” on page 9.

Procedure

1 In the left pane of vRealize Operations Manager, click the Administration icon and click Solutions.

2 If you are adding an additional adapter instance, click the plus sign on the lower pane toolbar.

3 Enter a Display name and Description for the adapter configuration.

For example, Epic System Pulse server 192.0.2.0.

4 In the Epic System Pulse server text box, enter the FQDN or IP address of the Epic System Pulse server

instance to which you are connecting.

The Epic System Pulse server FQDN or IP address must be reachable from all nodes in the vRealize

Operations Manager cluster.

Depending on your network configuration, you may:

Be able to just use the Hostname of the System Pulse server.

Have to update firewall rules to enable communication for the vRealize Operations Manager virtual

machine with the System Pulse server over ports 80 and 443.

5 Click Test Connection to validate the connection with your Epic System Pulse server instance.

A dialog box appears with the test result, click OK to close it.

6 Expand the Advanced Settings list and select a Collector from the list.

The collector you select determines which vRealize Operations Manager collector is used to manage the

adapter processes.

7 In the Basic Settings area, select true or false from the Auto Discovery drop‐down menu to enable or

disable auto‐discovery.

If you enable auto‐discovery, the data collection process discovers new resources and creates the resources

for you. If you disable auto‐discovery, you must use manual discovery to create resources. Manual

discovery is useful for restricting the resources that the management pack adds. You typically enable

auto‐discovery for the Care Systems Analytics for Epic management pack.

8 In the Basic Settings area, enter the name of a group in the Group Filter field.

This option filters resources based on their groups. If you do not enter a filter, resources from all groups

are discovered.

PRD is the convention used by Epic to denote production systems in the Caché Host/Instance and

Environment hierarchy. So you may use PRD as the group filter to monitor groups that only belong to the

Production installation.

VMware, Inc. 13


However, the Epic Windows‐based services hierarchy does not use the same group name convention. If

you know exactly which resource groups you want to monitor, you can enter all the groups separated by

commas, for example: PRD, Interconnect, EPS. Otherwise it is recommended to leave this field empty to

discover all resources and then delete the resources that you do not want to monitor.

To discover resources from multiple groups, enter the names of the groups, and separate them with

commas.

9 Click Save Settings to save the management pack instance.

10 Click OK in the Adapter instance successfully saved message box.

11 Click Close in the Manage Solution box.

The adapter instance is added to the list.

12 Click the home icon to return to the home screen and view your dashboards. Verify that the Epic

dashboards appear and display resources and metrics

It will take about 10 minutes to display the Epic adapter metrics.

vRealize Operations Manager begins collecting data from the Epic System Pulse server instance. Depending

on the number of managed objects, the initial collection can take more than one collection cycle. A standard

collection cycle begins every five minutes.

What to do next

Clone and share your Care Systems Analytics for Epic adapter dashboards.

Clone and Share Dashboards in vRealize Operations Manager

There are selected activities you can perform on entire dashboards. This includes: Edit, Clone, Interactions,

Delete, Create Template, Share, Export, and Import. The options are listed below the dashboard tabs.

After you install the Epic management pack for the first time, clone the dashboards and share them with

appropriate users. Cloning the dashboards ensures that you do not override user‐applied dashboard settings

when you update to a new management pack. In other words, all changes to settings made by users to their

cloned dashboards are preserved.

To clone a dashboard:

Procedure

1 In the left pane of vRealize Operations Manager, click the Content icon and click Dashboards.

2 Clone each Care Systems Analytics for Epic adapter dashboard.

a Select a Care Systems Analytics for Epic dashboard.

b Click the clone icon.

c Enter a new name for the cloned dashboard and click OK.

d Repeat for each Epic dashboard.

NOTE It is highly recommended that you, the vRealize Operations Manager administrator, clone and share the

default dashboards with the Epic application team and other individuals involved in the monitoring and

management of the Epic application.

Do this immediately after completing the Care Systems Analytics for Epic management pack installation.

This ensures that any changes to the configuration of the default dashboards for your environment are not

overwritten by updated default dashboards that might be downloaded as part of an update to either the

vRealize Operations Manager or the Care Systems Analytics for Epic management pack.


14 VMware, Inc.

Epic Printing Health

Epic Troubleshoot

Epic Overall Health

Epic Drilldown

3 Share the Care Systems Analytics for Epic dashboards.

a Click the gear icon menu and select Share Dashboards.

b From the list of dashboards, drag the Care Systems Analytics for Epic dashboards to the Epic group

on the left side.

See “Configure User Group Permissions in vRealize Operations Manager” on page 14.

c Click Save.

What to do next

See the Care Systems Analytics for Epic Users Guide for additional information on monitoring your Epic System

Pulse for Epic software.

Update the Epic Management Pack on vRealize Operations ManagerYou can update the Care Systems Analytics for Epic management pack to a newer version.

Prerequisites

Clone and share all your current dashboards to ensure your userʹs settings are preserved.

Procedure

1 Clone and share your dashboards.

See “Clone and Share Dashboards in vRealize Operations Manager” on page 13.

2 Install the Care Systems Analytics for Epic management pack.

See “Install the Care Systems Analytics for Epic Management Pack in vRealize Operations Manager” on

page 9.

Configure User Group Permissions in vRealize Operations ManagerYou must have privileges to access specific features in the vRealize Operations Manager user interface. The

roles associated with your user account determine the features you can access and the actions you can perform.

Each predefined role includes a set of privileges for users to perform create, read, update, or delete actions on

components such as dashboards, reports, administration, capacity, policies, problems, symptoms, alerts, user

account management, and adapters. The vRealize Operations Manager enforces which objects a user can see,

and the operations that they can perform on those objects, based on the access privileges and roles assigned to

the user by the administrator.

vRealize Operations Manager provides several predefined roles to assign privileges to users. You can also

create your own roles. The default Care Systems Analytics for Epic adapter user role is:

Administrator ‐ Includes privileges to all features, objects, and actions in vRealize Operations Manager.

A dashboard can be shared with any group but the dashboard is still owned by the user that shared the

dashboard, for example, the Administrator user. Other users cannot modify the shared dashboard. To

determine if you have permission to modify a dashboard, check for the key icon on the dashboard tab.

Prerequisites

Verify that you are logged in to the vRealize Operations Manager as an system administrator.

VMware, Inc. 15


Procedure

1 In the left pane of vRealize Operations Manager, click the Administration > Access Control, and click the

User Groups tab.

2 Import user groups.

You import user groups from an LDAP database on another machine so that you can use those groups in

vRealize Operations Manager. When you import user groups, vRealize Operations Manager creates user

records and assigns them to user groups.

a Click the gear icon on the User Groups toolbar.

b In the Import User Groups workspace, provide the details to import the user group. This includes:

Import From LDAP host machine

User Name and Password

Find user groups

Advanced import settings

c Provide details to import the user groups. This includes:

Members user names of each user

Role names assigned to users

Objects view associated with group

3 Add a user group.

a Click the plus sign in the User Groups toolbar.

b Select members, roles, and objects for the new user group.

4 Edit a user group.

a Click the pencil icon in the User Groups toolbar.

b After you add a user group, to change the role, user account, or objects associated with the user

group, you select a user group in the summary grid, and click the pencil icons in the panes of the

Details grid.

5 Share the dashboards with the groups.

What to do next

Create additional user accounts and assign users to the groups, as needed. See the vRealize Operations

Manager documentation for additional information on configuring and managing users.

Migrate from vCenter Operations Manager to vRealize Operations Manager

To migrate from vCenter Operations Manager to vRealize Operations Manager you:

1 Install vRealize Operations Manager.

After you deploy the vRealize Operations Manager nodes and complete the initial setup, you can import

from an earlier vCenter Operations Manager deployment by logging in for the first time and configuring

a few settings.

2 Migrate the vCenter Operations Manager data.

You can also migrate the data later, after the new installation of vRealize Operations Manager is

established or in production. Migrating and importing are synonymous.

To migrate a previous vCenter Operations Manager installation, log in to the target and complete a one‐time

wizard to license the product and import the source to your new deployment.


16 VMware, Inc.

See the vRealize Operations Manager documentation, at http://www.vmware.com/support/pubs, for specific

information on performing a migration.

Remove Duplicate Dashboards

When moving the Care Systems Analytics for Epic management pack from vCenter Operations Manager to

vRealize Operations Manager 6.0 the existing Care Systems Analytics for Epic management pack dashboards

are duplicated.

Procedure

1 Install the Care Systems Analytics for Epic Management Pack in the vRealize Operations Manager 6.x

environment.

2 From vRealize Operations Manager, navigate to Home > Administration, and select the Import Data tab.

3 Import your data from your vCenter Operations Manager 5.x environment. Provide the IP address of your

vCenter Operations Manager instance.

4 When migration is finished, return to Home.

Notice two sets of dashboards. For example Printing Dashboard and Printing Dashboard 1.

5 Delete all the duplicated dashboards. These are the dashboards with the trailing 1.

a Select each dashboard that has the trailing 1.

b From the drop down at the menu bar select Actions > Delete Dashboard.

The dashboards to be deleted:

Epic Drilldown 1

Epic Overall Health 1

Epic Troubleshoot 1

Epic Printing Health 1

Upgrading vRealize Operations ManagerIf you upgrade from an earlier version of vRealize Operations Manager, the previous Care Systems Analytics

for Epic management pack files are copied to the/usr/lib/vmware-vrops/user/plugins/.backup file in a folder with a with a date and time as the folder name.

Before migrating your data to your new vRealize Operations Manager instance:

Install any new adapters.

Clone any out of the box dashboards that you modified.

After migration, none of your adapter customizations are included in the migration, and you must reconfigure

them. All modifications done to the dashboards are removed after the vRealize Operations Manager upgrade.

Cloned dashboards are not overwritten.

Upgrade Care Systems Analytics for Epic Management Pack in vRealize Operations Manager

When you upgrade a Care Systems Analytics for Epic adapter on the vRealize Operations Manager, be sure to

make a clone of all your modified dashboards. All dashboards included with the Care Systems Analytics for

Epic management pack are overwritten in an upgrade.

Prerequisites

If you are currently importing historical data, wait until the Care Systems Analytics for Epic adapter

completes the importing process and starts collecting current data before you upgrade the Care Systems

Analytics for Epic adapter.


VMware, Inc. 17


Procedure

1 Clone all modified dashboards.

2 Install the new Care Systems Analytics for Epic management pack. See “Install the Care Systems

Analytics for Epic Management Pack in vRealize Operations Manager” on page 9.

3 Reconfigure migrated dashboards.

After migration, none of your adapter customizations are included in the migration, and you must

reconfigure them. All modified dashboards are replaced with the Care Systems Analytics for Epic

management pack upgrade. Cloned dashboards are not overwritten.

4 Re‐enable historical data collection and make any configuration changes you need.


18 VMware, Inc.

VMware, Inc. 19

3f

This section describes how to install the Care Systems Analytics for Epic management pack on the vCenter

Operations Manager.

Installation of management packs in general is described in the documentation for vCenter Operations

Manager. The procedures in this guide are specific to the Care Systems Analytics for Epic management pack.

Though the procedures between the vRealize Operations Manager and the vCenter Operations Manager, are

generally similar, the graphical user interface between the two is different. Please follow the procedures in this

chapter if you are using vCenter Operations Manager.

For additional information about your vCenter Operations Manager, see the documentation at:

http://www.vmware.com/support/pubs. From the Support Resources list, select vCenter Operations Manager.

Install the Care Systems Analytics for Epic Management Pack in vCenter Operations Manager

You install the Care Systems Analytics for Epic management pack on the vCenter Operations Manager using

a PAK file.

The Care Systems Analytics for Epic management pack is the part of the solution that you install. It contains

the dashboards, alerts definitions, policies, reports, and other content.

Use the vCenter Operations Manager user interface to install the Care Systems Analytics for Epic management

pack. See the vCenter Operations Manager documentation for additional information.

Prerequisites

1 Download your Care Systems Analytics for Epic from my.vmware.com. Your My VMware account login

grants you access to the solutions you have purchased. The solution that you downloaded includes a PAK

file. For example: vmware-vcops-6.0-EpicCareAdapter-1.0-<buildnumber>.pak.

2 Save that PAK file to a temporary folder on your local system.

Procedure

1 Use a supported browser to log in to the vCenter Operations Manager, Administration portal.

The URL to the Administration portal is https://<UI-VM>/admin/, where <UI-VM> is the IP address of the UI VM in the vCenter Operations Manager vApp.

Installing the Care Systems Analytics for Epic Management Pack (Adapter) on vCenter Operations Manager 3

NOTE The vCenter Operations Manager does not support uninstalling management packs. This includes the Care

Systems Analytics for Epic management pack. VMware recommends that you take a snapshot of the vCenter

Operations Manager vApp prior to installing the Care Systems Analytics for Epic management pack.

NOTE The management pack installation process restarts the vCenter Operations Manager Data is not collected while

the vCenter Operations Manager is restarting.

my.vmware.com



20 VMware, Inc.

For a current list of supported browsers, see the “vCenter Operations Manager Supported Browsers” in

the vCenter Operations Manager Installation Guide.

2 On the Update tab, click Browse to locate the temporary folder, select the PAK file, and click Open.

3 Click Update and click OK to confirm the update.

The Administration user interface uploads the PAK file. The upload might take several minutes.

4 Read and accept the EULA, and click OK.

5 Click OK to confirm and start the management pack installation process.

The installation might take several minutes. Status information appears on the Update tab when the

installation is finished.

6 Log in to the vCenter Operations Manager, Custom user interface as an administrator.

The URL format is https://<UI-VM>/vcops-custom/, where <UI-VM> is the IP address of the UI VM virtual machine in the vCenter Operations Manager vApp.

7 Select Admin > Support > Info tab, find the Adapters Info pane, and verify that the build number in the

Adapter Version column for the Care Systems Analytics for Epic management pack matches the build

number in the PAK file that you uploaded.

The Epic management pack is installed and ready for use.

What to do next

1 You must create your Care Systems Analytics for Epic Adapter instance.

2 If you have existing historical data, you can load that before you create your Care Systems Analytics for

Epic Adapter instance.

Load Historical Data When you enable Historic Data Collection, the vCenter Operations Manager learns the Dynamic Thresholds

for your environment faster. Instead of the usual 2‐6 weeks it takes for the vCenter Operations Manager to

collect enough data to determine appropriate Dynamic Thresholds, this feature enables you to pre‐load

historic data into the vCenter Operations Manager in for example, about 10 hours for 30 days of historic data.

Load Historical Data as you Create an Adapter Instance

If the adapter instance has not been created, complete the procedure.

Procedure

1 Configure the historic data collection. See “Configuring Historic Data Collection for a New Adapter

Instance on vCenter Operations Manager” on page 20.

2 Proceed with creating the adapter instance. See “Create a Care Systems Analytics for Epic Adapter

Instance in vCenter Operations Manager” on page 21.

Configuring Historic Data Collection for a New Adapter Instance on vCenter Operations Manager

Use this procedure to import existing historical data to your Care Systems Analytics for Epic adapter.

Procedure

1 Login to the vCenter Operations Manager UI virtual machine as root. For example, use an ssh command.

2 Open the epiccare.properties file in an editor.

/usr/lib/vmware-vcops/user/plugins/inbound/epiccare_adapter3/conf/epiccare.properties

3 Locate the control parameters at the end of the file. For example:

VMware, Inc. 21

Chapter 3 Installing the Care Systems Analytics for Epic Management Pack (Adapter) on vCenter Operations Manager

collectHistoricDataEnabled=falsehistoricDataToCollectInHours=0historicDataChunkCollectionInHours=1

collectHistoricDataEnabled controls whether historic data collection is enabled or not. It can

either be true or false. to enable Historic Data Collection, set this to true.

historicDataToCollectInHours is the number of hours to go back and start collection. This is

typically set to 30 days which is 720 hours.

historicDataChunkCollectionInHours is the number of hours of data to collect in every collect

cycle.

The default collect cycle for the adapter is 5 minutes and the adapter tries to collect

historicDataChunkCollectionInHours hours of data in every cycle. This can typically be set to 6 hours. Depending on your configuration of System Pulse, you can reduce this to 2 or 1 hour if 6 hours

causes too much load on System Pulse.

For example, the adapter configured for Historic Data Collection for the last 30 days using a chunk size

of 6 hours will have the following configuration:

collectHistoricDataEnabled=truehistoricDataToCollectInHours=720historicDataChunkCollectionInHours=6

4 Create an adapter instance. See “Create a Care Systems Analytics for Epic Adapter Instance in vCenter

Operations Manager” on page 21.

Historic data should be available for viewing in about 10 minutes.

When the Historic Data Collection is current, the Care Systems Analytics for Epic Adapter continues

to collect the latest metrics from System Pulse.

Load Historical Data for an Existing Adapter Instance in vCenter Operations Manager

If the Care Systems Analytics for Epic adapter instance exists, complete the procedure below.

Procedure

1 Create the Care Systems Analytics for Epic adapter instance. See “Create a Care Systems Analytics for

Epic Adapter Instance in vCenter Operations Manager” on page 21.

2 Stop adapter collection.

From the Environment Overview tab, select the Care Systems Analytics for Epic adapter instance and

click the Stop Collection icon.

3 Login to the vCenter Operations Manager Analytics virtual machine as root. For example, use an ssh command.

4 Delete the file,

/usr/lib/vmware-vcops/user/plugins/inbound/epiccare_adapter3/work/lastcollect.properties.

5 Configure Historic Data Collection. See “Configuring Historic Data Collection for a New Adapter

Instance on vCenter Operations Manager” on page 20.

6 Login to the vCenter Operations Manager Administrator UI and restart services.

Create a Care Systems Analytics for Epic Adapter Instance in vCenter Operations Manager

To start collecting data from the Epic System Pulse server in the Epic environment, you must create and

configure an instance of the Care Systems Analytics for Epic Adapter (management pack).


22 VMware, Inc.

Prerequisites

1 Verify that you are logged in to the vCenter Operations Manager as an administrator.

2 Verify that the Care Systems Analytics for Epic adapter appears in the Adapter Info pane. Select Admin

> Support on the vCenter Operations Manager menu. See “Install the Care Systems Analytics for Epic

Management Pack in vCenter Operations Manager” on page 19.

3 Locate the IP address of the Epic System Pulse server.

Procedure

1 Log into the vCenter Operations Manager Custom user interface as administrator.

2 Select Environment > Configuration> Adapter Instances.

3 Click the Add New Adapter Instance icon.

The Add Adapter Instance panel appears.

4 From the Collector drop‐down menu, select vCenter Operations Server.

5 From the Adapter Kind drop‐down menu, select EpicCare Adapter.

6 Type a name for the management pack instance in the Adapter Instance Name field.

7 Enter the IP address or fully qualified domain name of the Epic System Pulse server.

Depending on your network configuration, you may:

Be able to just use the Hostname of the System Pulse server.

Have to update firewall rules to enable communication for both the vCenter Operations Manager

Analytics virtual machine and vCenter Operations Manager UI virtual machine with the System

Pulse server over ports 80 and 443.

8 Select true or false from the Auto‐Discovery drop‐down menu to enable or disable auto‐discovery.

If you enable auto‐discovery, the data collection process discovers new resources and creates the resources

for you. If you disable auto‐discovery, you must use manual discovery to create resources. Manual

discovery is useful for restricting the resources that the management pack adds. You typically enable

auto‐discovery for the Epic management pack.

9 Enter the name of a group in the Group Filter field.

This option filters resources based on their groups. If you do not enter a filter, resources from all groups

are discovered.

PRD is the convention used by Epic to denote production systems in the Caché Host/Instance and

Environment hierarchy. So you may use PRD as the group filter to monitor groups that only belong to the

Production installation.

However, the Epic Windows‐based services hierarchy does not use the same group name convention. If

you know exactly which resource groups you want to monitor, you can enter all the groups separated by

commas, for example: PRD, Interconnect, EPS. Otherwise it is recommended to leave this field empty to

discover all resources and then delete the resources that you do not want to monitor.

To discover resources from multiple groups, enter the names of the groups, and separate them with

commas.

10 Click Test to test the management pack configuration.

11 Click OK to save the management pack instance.

12 Select the Dashboard. Verify that the Epic dashboards appears and displays resources and metrics.

What to do next

Clone and share your Care Systems Analytics for Epic adapter dashboards.

VMware, Inc. 23


Clone and Share Dashboards in vCenter Operations Manager

There are selected activities you can perform on entire dashboards. This includes: Edit, Clone, Interactions,

Delete, Create Template, Share, Export, and Import. The options are listed below the dashboard tabs.

After you install the Care Systems Analytics for Epic management pack for the first time, clone the dashboards

and share them with appropriate users. Cloning the dashboards ensures that you do not override user‐applied

dashboard settings when you update to a new management pack. In other words, all changes to settings made

by users to their cloned dashboards are preserved.

Procedure

1 Navigate to dashboard that you want to share.

2 Click Clone on the Dashboard Tools bar.

3 Enter a new name for the dashboard clone.

A tab for the cloned dashboard is added.

4 Click the new cloned dashboard tab.

5 Click Share on the Dashboard Tools bar.

6 Select the dashboard name in the Shared Dashboards pane and drag it to one or more user groups in the

Accounts Groups pane.

See “Configure User Group Permissions in vCenter Operations Manager” on page 24.

7 Click OK to save your changes.

After you share a dashboard, an icon ( ) on the dashboard appears, indicating that the dashboard is

shared with those users you defined.

When you install a new version of a management pack, any updates on the dashboard are automatically

applied and any new dashboards are installed.

What to do next

See the Care Systems Analytics for Epic Users Guide for additional information on monitoring your Epic System

Pulse for Epic software.

Update the Epic Management Pack in vCenter Operations ManagerYou can update the Care Systems Analytics for Epic management pack to a newer version.

Prerequisites

Clone and share all your current dashboards to ensure your userʹs settings are preserved.

NOTE It is highly recommended that you, the vCenter Operations Manager administrator, clone and share the

default dashboards with the Epic application team and other individuals involved in the monitoring and

management of the Epic application.

Do this immediately after completing the Care Systems Analytics for Epic management pack installation.

This ensures that any changes to the configuration of the default dashboards for your environment are not

overwritten by updated default dashboards that might be downloaded as part of an update to either the

vCenter Operations Manager or the Care Systems Analytics for Epic management pack.


24 VMware, Inc.

Procedure

1 Clone and share your dashboards.

See “Clone and Share Dashboards in vCenter Operations Manager” on page 23.

2 Install the Care Systems Analytics for Epic management pack.

See “Install the Care Systems Analytics for Epic Management Pack in vCenter Operations Manager” on

page 19.

3 Create the Care Systems Analytics for Epic adapter instance.

See “Create a Care Systems Analytics for Epic Adapter Instance in vCenter Operations Manager” on

page 21.

Configure User Group Permissions in vCenter Operations ManagerYou must have privileges to access specific features in the vCenter Operations Manager user interface. The

roles associated with your user account determine the features you can access and the actions you can perform.

Each predefined role includes a set of privileges for users to perform create, read, update, or delete actions on

components such as dashboards, reports, administration, capacity, policies, problems, symptoms, alerts, user

account management, and adapters.

By default, the vCenter Operations Manager has selected user groups, each with a default set of permissions.

Administrators ‐ Have full access to the system.

vCenter Operations Manager administrators can add themselves to the Operators group, using Admin >

Security.

Administrators can also create additional groups, assign permissions to the new groups, assign users to

the new groups, and share dashboards with the new group.

Operators ‐ Can manage the environment, but cannot manage users and user groups. Can clone and

modify the dashboard using the cog.

Users ‐ Can view the environment and the support Status tab, can move and resize widgets, and run

performance, behavior, and anomaly correlation reports.

A dashboard can be shared with any group but the dashboard is still owned by the user that shared the

dashboard, for example, the Admin user. Other users cannot modify the shared dashboard. To determine if

you have permission to modify a dashboard, check for the key icon on the dashboard tab.

Prerequisites

1 Verify that you are logged in to the vCenter Operations Manager as an administrator.

2 Verify that the Epic option appears in the Adapter Info pane. Select Admin > Support on the vCenter

Operations Manager menu.

Procedure

1 Log into the Custom user interface as administrator.

2 View the Admin > Security tab to perform the following steps, as needed.

3 Assign yourself, as the Admin user, to the Operators group.

4 Add a user group. Select User Management > Add New Group.

5 Configure access rights for a user group. Select Access Rights.

6 Assign a user to a user group. Select User Management.

7 Login as the new user.

8 Share the dashboard as the new user.

VMware, Inc. 25


The shared dashboard can be modified by any person logged in as the new user.

What to do next

Create additional user accounts and assign users to the groups, as needed. See the VMware vCenter Operations

Manager Administration Guide for additional information on configuring and managing users.

Upgrading vCenter Operations ManagerIf you upgrade from an earlier version of vCenter Operations Manager, the previous Care Systems Analytics

for Epic management pack files are copied to the /usr/lib/vmware-vcops/user/plugins/.backup file in a folder with a with a date and time as the folder name.

Before migrating your data to your new vCenter Operations Manager instance:

Install any new adapters.

Clone any out of the box dashboards that you modified.

After migration, none of your adapter customizations are included in the migration, and you must reconfigure

them. All modifications done to the dashboards are removed after the vCenter Operations Manager upgrade.

Cloned dashboards are not overwritten.

Upgrade Care Systems Analytics for Epic Management PackWhen you upgrade a Care Systems Analytics for Epic adapter on vCenter Operations Manager, be sure to

make a clone of all your modified dashboards. All dashboards included with the Care Systems Analytics for

Epic management pack are overwritten in an upgrade.

Prerequisites

If you are currently importing historical data, wait until the Care Systems Analytics for Epic adapter

completes the importing process and starts collecting current data before you upgrade the Care Systems

Analytics for Epic adapter.

Procedure

1 Clone all modified dashboards.

2 Install the new Care Systems Analytics for Epic management pack. See “Install the Care Systems

Analytics for Epic Management Pack in vCenter Operations Manager” on page 19.

3 Reconfigure migrated dashboards.

After migration, none of your adapter customizations are included in the migration, and you must

reconfigure them. All modified dashboards are replaced with the Care Systems Analytics for Epic

management pack upgrade. Cloned dashboards are not overwritten.

4 Re‐enable historical data collection and make any configuration changes you need.

care systems analytics for epic installation and configuration guide · 2015-06-08 · care systems...

Documents