Care Systems Analytics for EpicInstallation and Configuration Guide

VMware Management Pack for 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

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:

docfeedback@vmware.com 

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

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 Epic Management Pack (Adapter) 9Install the Epic Management Pack 9

Load Historical Data 10

Load Historical Data as you Create an Adapter Instance 10

Load Historical Data for an Existing Adapter Instance 10

Configuring Historic Data Collection 10

Create an Epic Adapter Instance 11

Clone and Share Dashboards 12

Update the Epic Management Pack 13

Configure User Group Permissions 13

Care Systems Analytics for Epic Installation and Configuration Guide

4 VMware, Inc.

VMware, Inc. 5

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

the VMware vCenter Operations Management Pack for Epic.

Intended AudienceThis information is intended for anyone who needs to install or configure the Epic Management Pack. 

This information assumes you are experienced with vCenter Operations Manager, Epic®, and Epic System 

Pulse. See VMware vCenter server 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 docfeedback@vmware.com.

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

Care Systems Analytics for Epic Installation and Configuration Guide

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. 

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 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 vCenter Operations Manager, an intelligent 

operations management solution from VMware. The 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 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, the terms Management Pack and Adapter are used interchangeably and the 

terms VMware Care Systems Analytics for Epic and VMware vCenter Operations Management Pack for Epic 

are used interchangeably.

Care Systems Analytics for Epic Installation and Configuration Guide

8 VMware, Inc.

Installation Component OverviewThe following two graphics illustrate the relationships between the Epic Management Pack, vCenter 

Operations Manager, and Epic System Pulse for Epic.

Figure 1-1. View of Epic Management Pack with vCenter Operations Manager

Figure 1-2. Alternative View of vCenter Operations Management Pack for Epic and Epic System Pulse

VMware, Inc. 9

2

This section describes how to install the Epic management pack on vCenter Operations Manager.

Install the Epic Management PackYou install the Epic management pack on vCenter Operations Manager using a PAK file.

Prerequisites

Locate the installation package for the Epic management pack. Go to My.VMware.com. Downloading 

requires a My VMware account. 

Note the build number in the vmware-vcops-5.0.0-EpicCareAdapter-1.0-<buildnumber>.pak file name.

Procedure

1 Download the vmware-vcops-5.0.0-EpicCareAdapter-1.0-<buildnumber>.pak file to a temporary 

folder accessible to the vCenter Operations Manager.

2 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.

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

https://www.vmware.com/support/vcops/doc/vcops‐581‐vapp‐release‐notes.html. 

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

4 Click Update and click OK to confirm the update.

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

5 Read and accept the EULA, and click OK.

6 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.

7 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.

Installing the Epic Management Pack (Adapter) 2

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

while the vCenter Operations Manager is restarting.

This release of the Epic does not include an uninstall option. VMware recommends that you take a snapshot 

of the vCenter Operations Manager vApp.

Care Systems Analytics for Epic Installation and Configuration Guide

10 VMware, Inc.

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

Adapter Version column for the 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

You must create an Epic Adapter instance. If you have existing historical data, you can load that before you 

create your Epic Adapter instance.

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

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

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

into 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” on page 10.

2 Proceed with creating the adapter instance. See “Create an Epic Adapter Instance” on page 11.

Load Historical Data for an Existing Adapter Instance

If the adapter instance exists, complete the procedure below.

Procedure

1 Create the Epic adapter instance. See “Create an Epic Adapter Instance” on page 11. 

2 Stop adapter collection. From the Environment Overview tab, select the adapter instance and click the 

Stop Collection icon.

3 Login to the 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” on page 10.

6 Login to the vCenter Operations Manager Administrator UI and Restart Services.

Configuring Historic Data Collection

Use this procedure to import existing historical data to your Epic adapter.

Procedure

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

2 Open the following 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:

collectHistoricDataEnabled=falsehistoricDataToCollectInHours=0historicDataChunkCollectionInHours=1

VMware, Inc. 11

Chapter 2 Installing the Epic Management Pack (Adapter)

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 an Epic Adapter Instance” on page 11.

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

When the Historic Data Collection is current, the Epic Adapter continues to collect the latest metrics 

from System Pulse.

Create an Epic Adapter InstanceTo start collecting data from the Epic System Pulse server in the Epic environment, you must configure an 

instance of the Epic Adapter (management pack).

Prerequisites

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

2 Verify that the EpicCare Adapter appears in the Adapter Info pane. Select Admin > Support on the 

vCenter Operations Manager menu. 

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

Procedure

1 Log into the 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 and UI virtual machines 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.

Care Systems Analytics for Epic Installation and Configuration Guide

12 VMware, Inc.

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 Epic dashboards. 

Clone and Share Dashboards

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.

Procedure

1 Navigate to dashboard that you want to share.

2 Click Clone on the Dashboard Tools bar.

3 Enter a name for the dashboard clone. 

A tab for the cloned dashboard is added.

4 Click the new cloned dashboard tab.

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 vCenter Operations Management Pack for Epic 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 the vCenter 

Operations Management Pack for Epic.

VMware, Inc. 13

Chapter 2 Installing the Epic Management Pack (Adapter)

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.

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 PackYou can update the 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 Complete the steps in “Clone and Share Dashboards” on page 12.

2 Complete the steps in “Install the Epic Management Pack” on page 9.

3 Complete the steps in “Create an Epic Adapter Instance” on page 11.

Configure User Group PermissionsBy default, vCenter Operations Manager has three user groups, each with a default set of permissions.

Administrators ‐ Have full access to the system. 

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. 

Care Systems Analytics for Epic Installation and Configuration Guide

14 VMware, Inc.

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.

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.