administrator's guide - epmwareepmware.com/doclibrary/epmware administrator's...

Administrator's Guide

EPMWARE ®

Version 1.0

EPMWARE, Inc.

Published: July, 2015

Information in this document, including URL and other Internet Web site references, is

subject to change without notice. Unless otherwise noted, the example companies,

organizations, products, domain names, e-mail addresses, logos, people, places, and

events depicted herein are fictitious, and no association with any real company,

organization, product, domain name, e-mail address, logo, person, place, or event is

intended or should be inferred. Complying with all applicable copyright laws is the

responsibility of the user. Without limiting the rights under copyright, no part of this

document may be reproduced, stored in or introduced into a retrieval system, or

transmitted in any form or by any means (electronic, mechanical, photocopying,

recording, or otherwise), or for any purpose, without the express written permission of

EPMware Inc. EPMware, Inc. may have patents, patent applications, trademarks,

copyrights, or other intellectual property rights covering subject matter in this document.

Except as expressly provided in any written license agreement from EPMware, Inc., the

furnishing of this document does not give you any license to these patents, trademarks,

copyrights, or other intellectual property.

© 2015 EPMWARE, Inc. All rights reserved. www.epmware.com | 408-614-0442

EPMWARE is a registered trademark of EPMWARE, Inc. in the United States and/or

other countries.

All other trademarks are property of their respective owners.

Contents

Administrator's Guide ...................................................................................................... 1

Contents ............................................................................................................................. 3

Introduction ....................................................................................................................... 5

Configuration ..................................................................................................................... 6

Infrastructure .................................................................................................................... 6

Servers ......................................................................................................................... 6

Databases .................................................................................................................... 8

Applications ................................................................................................................... 11

Applications Configuration.......................................................................................... 11

Applications Properties ............................................................................................... 17

Dimensions .................................................................................................................... 18

Dimension Configuration ............................................................................................ 19

Dimension Properties ................................................................................................. 20

Dimension Mapping .................................................................................................... 22

Properties ...................................................................................................................... 24

Property Mapping ....................................................................................................... 24

Property Validation ..................................................................................................... 25

Property Derivation ..................................................................................................... 28

Email Templates ............................................................................................................ 30

Global Settings .............................................................................................................. 33

Email Settings ............................................................................................................ 33

Application Settings .................................................................................................... 35

Web Settings .............................................................................................................. 38

User Defined Settings ................................................................................................ 38

Lookups ........................................................................................................................... 39

Security ............................................................................................................................ 43

Security Model ............................................................................................................... 43

Security Rules ................................................................................................................ 44

Roles .............................................................................................................................. 44

Requestor ................................................................................................................... 44

Reviewer..................................................................................................................... 44

Approver ..................................................................................................................... 45

4

Default ........................................................................................................................ 45

Users.............................................................................................................................. 46

Groups ........................................................................................................................... 51

Security Classes ............................................................................................................ 55

Security Provisioning ..................................................................................................... 58

Modules ...................................................................................................................... 59

Workflow .......................................................................................................................... 59

Workflow Tasks ............................................................................................................. 60

Workflow Builder ............................................................................................................ 63

Workflow Stages ........................................................................................................ 66

Deployment ...................................................................................................................... 69

Deployment Manager .................................................................................................... 70

Deployment Monitor ....................................................................................................... 73

Monitor Grid ................................................................................................................ 74

Deployment Status ..................................................................................................... 75

Status Legend ............................................................................................................ 76

Deployment Schedule .................................................................................................... 76

Logic Builder ................................................................................................................... 77

Logic Builder Editor ........................................................................................................ 81

Services ........................................................................................................................... 81

ERP Import ....................................................................................................................... 82

EPR Import Builder ........................................................................................................ 82

EPR Import Mapping ..................................................................................................... 86

Header Section ........................................................................................................... 86

ERP Import Monitor ....................................................................................................... 89

5

Introduction

EPMware is a master data management and workflow tool that manages master data

and enforces your organization’s workflow around the everyday processes that surround

your metadata changes. By configuring shared dimensions in EPMware, users request

metadata once and our workflow engine routes the request to obtain approvals and

deploys the metadata to the participating target systems. This allows standardization and

rationalization of your metadata to evolve as your organization develops its master data

strategy. The EPMware dashboard allows users, managers, and application

administrators to monitor the status of metadata requests in real time. Follow a request

from the initial Create stage through its Review, Approve and Deploy stages. A graphical

representation of each request's status in the workflow allows users to identify any

bottlenecks in the metadata request process and determine if an escalation is required.

Seamless integration to Hyperion EPMA, Classic Hyperion Financial Management

(HFM), Classic Essbase and Classic Planning applications allows EPMware to deploy

metadata without manual intervention or file manipulation from an administrator.

Approved metadata is automatically deployed or scheduled for deployment using our built

in scheduler.

One-click import of your target system hierarchies allows users to clearly visualize how

metadata will appear in their production environments. A configurable security module

integrates with your current LDAP or Microsoft Active Directory (MSAD). Build, maintain

and scale task driven workflows. Administrators model, build and maintain fully dynamic

and scalable workflows using the Workflow Builder™. By using a combination of stages

and tasks, Workflow Builder™ enables creation of any number of workflows that visually

define your organization’s business process, and then enforces it. The Workflow

Builder™ includes reusable workflow tasks, rule based validations, exception handling,

email notifications for all workflow stages, custom functions and scripting for limitless

customizations. Centrally manage metadata deployments using the EPMware

deployment module. It manages how and when metadata requests are deployed. Load

metadata on demand or schedule a batch to run during off hours. Deployment metrics for

all your EPM applications are on one page. Monitor in real time as “one time” or batches

are deployed to their respective target applications. Create a recurring calendar for daily,

weekly or monthly metadata deployments. Audit reports log every transaction, sign-off &

deployment. EPMware maintains a complete audit trail of all transactions from request to

deployment. Every transaction can be queried using reports included in the Audit module.

6

Configuration

The configuration module is used by the Administrator for the initial configuration and the

ongoing administrative tasks of EPMware. The Configuration module is comprised of

the following components:

Infrastructure

Applications

Dimension

Property

Email

Misc

Infrastructure

Servers Server Configuration enables the administrator to enter the Server Names, User ID’s,

Passwords and Descriptions that EPMware will use to communicate with the target

systems (e.g. HFM, Essbase, Planning). By default, this page will initially render blank

until a row is added.

To Add a Server

1. Select the icon to display the Add Server popup box.

2. Input Server Name, User Name, Password and Description (Optional)

3. Select Save to add the server to the Server Grid.

7

To Edit a Server

1. Right click on a row and select Properties from the Menu to display the Server

Properties popup box.

2. Edit the properties as required.

3. Select Save to save the changes.

8

To Delete a Server

1. Right click on a row and select Delete from the Menu.

2. The following confirmation popup will display

3. Select OK to delete the Server.

Note: Only one Server can be deleted at a time.

Databases

Database Configuration enables the administrator to enter the Database Names, User

ID’s, Passwords, TNS entries and Descriptions for the target databases that EPMware

will use to connect to (EPMA, HFM, Planning, etc). By default, this page will initially

render blank until a row is added.

To Add a Database

1. Select the icon to display the Add Database popup box.

2. Input Database Name, User Name, Password, TNS entry and Description

(Optional)

9

3. Select Save to add the database to the Database Grid.

To Edit a Database

1. Right click on a row and select Properties from the Menu to display the

Database Properties popup box.



10

To Delete a Database



3. Select OK to delete the Database.

Note: Only one Database can be deleted at a time.

11

Applications Applications Configuration defines a target application. The grid will be blank until an

initial row is added. The Upload button in the row will be grayed out until the record is

saved. Application Configuration had two Tabs, Configuration and Properties. The

Configuration Tab contains all the general application information. The Properties Tab

contains detailed properties for the application.

Note: Select the Enabled check box in the Grid to enable the Application and select

to save the change.

Applications Configuration

To Add a Target Application

1. Select the icon to display the Add Application popup box.

2. Input or select the following fields:

● Application Name - User defined name for the application.

● Target Application - Input target application name.

● Application Type - Select target application type.

● Version - Selects the target application version.

● Security Class – Select a Security Class defined during security class

configuration.

● Deployment - Select Deployment Method: Direct, File, Interface Tables.

12

● Server Name - Select a Server defined during Server configuration.

● Database Name - Select a database defined during Database

configuration

● Target User Name - Input the target application user name.

● Target Password - Input the target application password.

To Import an Application

1. Select the icon in the Grid to import the application and display the

Application Import popup box.

13

2. Select Auto Import to import the Application from the Target Application

Server or select Manual Import to Browse for a file to import.

Essbase (Classic)

o Manual Import

.xml formatted file

Run the following script in EAS to generate the .xml file:

Export outline ASOALL.Basic all dimensions to xml_file "c:/temp/ASOALL02.xml";

Planning (Classic)

o Auto Import

o Manual – Compress the following files using WinZip

Create one .csv file for each dimension using the

Essbase Outline Load Utility

LCM extract file

HFM (Classic)

o Manual Import

.xml formatted file

Use Metadata Extract from the HFM Application

EPMA Application

o Auto Import

o Manual Import – Compress the following files using WinZip

LCM Export file system

14

3. The Application Progress Bar will display while the Import is running.

4. The Application Hierarchy Import Status popup will display when the import is

completed.

Note: Click the icon in the Grid to redisplay the Application Import Status

popup.

Note: If the Application Import is still running, the Cancel Import and View

Progress Bar buttons will be available on the Application Import Status popup.

15

To Edit an Application


Application Properties popup box.



16

To Delete an Application



3. Select OK to delete the Application.

Note: Only one Application can be deleted at a time.

17

Applications Properties

To Add a Property

1. Select the icon to display the Add Properties popup box.

2. Input the Property Name, Property Value and Description.

3. Select Save to save the record.

To Edit a Property


Application Properties popup box.



18

To Delete a Property



3. Select OK to delete the Property

Note: Only one Property can be deleted at a time.

Dimensions Dimension configuration defines dimensions imported from the target application and

how they will be managed in EPMware. Dimensions can be enabled and disabled,

assigned Security a Class, and alternate Dimension Labels can be assigned.

19

Dimension Configuration Select and Application from the dropdown list to view the Dimensions.

Grid Columns

● Dimension - List of dimensions imported from target application.

● Security Class - Assigns Security Classes to the Dimension

● Enabled- Enable or Disable the Dimension in EPMware

● Description - User defined description.

To Assign a Security Class

1. Double click in the Security Class field and select a Security Class from the

dropdown list.

2. Select to save the changes.

To Edit a Description

1. Double click in the Description field to switch to edit mode and edit the

Description.


20

Dimension Properties

Select an Application and a Dimension from the dropdown lists to view the Properties

for the Dimension.

To Add a Property

1. Select the icon to display the Add Dimension Properties popup box.

2. Input the Property Name, Property Value and Description.


21

To Edit a Property


Dimension Properties popup box.



To Delete a Property



3. Select OK to delete the Property.

Note: Only one Property can be deleted at a time.

22

Dimension Mapping

Dimension Mapping enables a Dimension in one Application to be associated with a

Dimension in another application. A Dimension is selected in a row, and mapped to an

associated Dimension in another Application. The Mapping can be Enabled or Disabled

by selecting the check box and selecting to save the record.

The column headers will display all Active Applications in EPMware. Double click on

the Dimension column field to display a dropdown list of all active Dimensions for that

Application.

Note: A minimum of two Dimension column values must be selected before the row

can be saved.

Caution: Dimension Types must match if two application columns are of type

EPMA and the Dimensions are Shared in the EPMA Dimension Library.

Note: A row in the Line Item Grid on the Request Page will be created for each

application Dimension that is configured with Sync, including EPMA applications

using the Shared Library. The properties for EPMA applications using the Shared

Library can be overridden with different properties for individual applications. If

properties are changed for an individual application and the application is an EPMA

application using the Shared Library, the properties for the other applications using

23

the Shared Library will be exported to EPMA as an Override.

To Create a Dimension Mapping

1. Select the icon to add a row to the top of the grid

2. Input a Dimension Label

3. Double click on the Dimension Field below the First application to be Mapped

and select a Dimension, then double click on the Options Field and select

Sync or select a Script.

4. Double click on the Dimension Field below the Next application to be Mapped

and select a Dimension and double click on the Options Field and select Sync

or select a Script.

5. Click to Save the row.

Dimension Mapping Example for mapping the Measures Dimension for BSO Demo

Classic and the Accounts Dimension for the BSOALL Application.

Note: The selection for the Options Column must be the same for the Mapped

Dimensions.

Caution: The new row or changes will not be committed to the database until the

Save icon is selected. After saving, the rows are automatically resorted

alphabetically.

24

Properties Property configuration defines how Properties are Mapped, Validated, and Derived

between Applications and Dimensions in EPMware. A Property map can be created for

any Dimension that is mapped in EPMware. Property Map definitions can be enabled and

disabled and alternate Dimension Labels can be assigned. Properties for EPMA

applications and Classic applications can also be shared.

Property Mapping When a Property is mapped it will automatically populate the corresponding shared

properties in the other applications and dimensions. The Reviewer of the corresponding

application that is sharing the property has the option to change the property. The

property will appear in EPMA as an override. The column headers will display all

Applications associated with the selected Dimension. Double click on the Property

column field to display a dropdown list of all Properties for the Dimension.

Note: A minimum of two Property column values must be selected before the row

can be saved.

Caution: Property Types must match if two application columns are of type

EPMA and the Dimensions are Shared in the EPMA Dimension Library.

Note: A row in the Line Item Grid on the Request Page will be created for each

application Dimension that is configured with Sync, including EPMA applications

using the Shared Library. The properties for EPMA applications using the Shared

Library can be overridden with different properties for individual applications. If

properties are changed for an individual application and the application is an EPMA

application using the Shared Library, the properties for the other applications using

25

the Shared Library will be exported to EPMA as an Override.

To Create a Property Map

1. Select the icon to add a row to the top of the Grid

2. Input a Property Label

3. Double click on the Property Field below the First application to be Mapped and

select a Property, then double click on the Options Field and select Sync or

select a Script.

4. Double click on the Property Field below the Next application to be Mapped and

select a Property and double click on the Options Field and select Sync or

select a Script.

5. Click to Save the row.

Property Mapping Example for mapping the Consolidation Property for BSO Demo

Classic and the Consolidation Property for the BSOALL Application.

Note: The selection for the Options Column must be the same for the Mapped

Dimensions.

Caution: The new row or changes will not be committed to the database until the

Save icon is selected. After saving, the rows are automatically resorted

alphabetically.

Property Validation

Property Validations provide a validation for a property in addition to the standard

validations inherent to the application. Property Validations are created at

ConfigurationPropertyValidations.

26

To Create a Property Validation

1. Select the icon to display the Create Property Validation popup box.

2. Select the Application Name

3. Select the Dimension Name

4. Select the Property Name

5. Select a Validation Script

6. Enable or Disable the Property Validation

7. Input a Description


27

Note: All Scripts are created and managed in the Scripts Module.

To Edit a Property Validation

1. Right click on a row and select Edit Properties from the Menu to display the

Edit Property Validation popup box.



To Delete a Property Validation



28

3. Select OK to delete the Property Validation.

Note: Only one Property Validation can be deleted at a time.

Property Derivation

Property Derivation provides a method of deriving a property value from a Script.

Property Derivations are created at ConfigurationPropertyDerivations. A

Derivation Script must be created in the Scripts Module to define the Property

Derivation. The Script can then be selected in the Script Name column.

To Create a Property Derivation

1. Select the icon to display the Create Derivation popup box.

2. Select the Application Name

3. Select the Dimension Name

4. Select the Property Name

5. Select a Derivation Script

6. Enable or Disable the Property Derivation

7. Input a Description


29

Note: All Scripts are created and managed in the Scripts Module.

To Edit a Property Derivation


Edit Derivation popup box.



30

To Delete a Property Derivation



3. Select OK to delete the Property Derivation.

Note: Only one Property Derivation can be deleted at a time.

Email Templates Email Templates are utilized in Workflows to notify Requestors, Reviewers and

Approvers of the actions taken during the Request and Workflow process. The Email

Template Grid displays all the available templates that have been created.

31

Email Template Grid

Variable Tags are available to customize the email templates and make them dynamic.

Variable Tags:

<REQUEST_ID>

<REQUEST _DESCRIPTION>

<REQUESTOR_FIRST_NAME>

<REQUESTOR_LAST_NAME>

<EPMWARE_URL>

<LINE_NUM>

<TASK_STATUS>

<USER_NAME>

To Add an Email Template

1. Select the icon to display the Email Template Properties popup box.

2. Input text and Variable Tags for all required fields.


32

Email Template Example

To Edit an Email Template

1. Right click on a row and select Properties from the Menu to display the Email

Template Properties popup box.



To Delete an Email Template



33

3. Select OK to delete the Email Template.

Note: Only one Email Template can be deleted at a time.

Global Settings Select ConfigurationMiscGlobal from the navigation menu to access Global

Settings. Configure Global Settings for the entire EPMware application.

Select a tab to configure:

Email Settings

Application Settings

Web Settings

User Defined Field Settings

Email Settings Email Settings contains all the Global Email Setting for EPMware application. The

following are the available settings:

Email Domain Name

Email Server Name

Email Timeout in ms

From Email Address

Maximum # of file attachments

Maximum length of the Email

Maximum size of the of the attached file

Non Production environment email prefix

Production Database Name

34

Global Email Settings Example

To Edit Email Settings

1. Double click on the Value or Description field to switch the field to edit mode



35

Application Settings

Application Settings contains all the Global Application Settings for the EPMware

application.

The following table contains all the available Application settings:

Application Setting Description

BPMA Server URL BPMA Server URL

Database Trace Identifier Debug database Trace identifier

Date Format Specify Date Display format (For

example MM/DD/RRRR)

Debug level Specify Debug Level (1-Error only, 2-

Warning,3-All)

Debug Purge Days Specify # of Days to retain Debug

information

Deployment Service Sleep Interval Deployment Service Sleep Interval

(Seconds)

EPMware Application URL Specify URL of the EPMWARE

application

Essbase Home Directory Specify Essbase Home directory

Files Archive DB Directory Specify DB directory to archive files

Hyperion Cluster Name Specify Cluster name

36

Hyperion Home Directory Specify directory for

EPMA/HYPERION Home

Organization Name Specify Organization name

SSH Port Specify port # for SSH

communications

SSH Timeout (in minutes) Specify SSH Timeout in minutes

Specify prefix for the Debug files Specify prefix for the Debug Files

Specify prefix for the Report Files Specify prefix for the Report Files

Stage DB Directory Specify DB directory for temporary

file generations

Temp DB Directory Specify DB directory for temporary

file generations

Turn On/Off debug messages Enable/disable debug messaging

Turn On/Off debug messages to be

inserted into debug table

Enable/disable debug messaging in

table

User Authentication Directory Type

(LDAP or MSAD)

User Authentication Directory Type

(LDAP or MSAD)

Workflow Service Sleep Interval Workflow Service Sleep Interval

(Seconds)

Workspace Server URL Workspace Server URL

37

Global Application Settings Example

To Edit Application Settings




38

Web Settings Web Settings contains all the Global Web Settings for the EPMware application.

To Edit Web Settings




User Defined Settings User Defined Settings define up to 3 custom User Defined Fields for the Request Page:

UD1, UD2 and UD3. The fields can be used to capture data on the Request for items

such as Request Type, Internal Ticketing Systems or other Tracking Systems.

User Defined Fields

39

User Defined Settings Description

Enabled On/Off

Display Type Input or Lookup

Display Label Description displayed on the Request

Data Type String, Numeric or Date

Lookup Reference to values defines in the

Lookup table.

Required On/Off – Identifies if the User

Defined Field is required.

To Edit User Defined Settings

1. Double click on a field in the column to switch the field to edit mode



Lookups

Select ConfigurationMiscLookups from the navigation menu. Configure items

populated in dropdown boxes throughout the entire EPMware application. Select a

Lookup by using Search by Name or Description or by scrolling using the arrow buttons

on the upper right.

40

To Add a Lookup

1. Select the icon in the header to display a new header record.

2. Input the Lookup Name and Description.

3. Select Save to save the header.

Note: The Lookup record must be saved before a Lookup Code can be added.

Caution: Seeded Lookups are not allowed to be edited or deleted. They are Read

only.

41

Lookup Code Settings Description

Enabled On/Off

Lookup Code Code to Reference Lookup

Meaning Description displayed on the Control

Description Description of the Lookup record

Display Seq.# To order the Lookup values

To Add a Lookup Code

1. Scroll to or Search for the Lookup record.

2. Select the icon to display the Add New Lookup Code popup box.

3. Input the required fields.


42

To Delete a Lookup Code



3. Select OK to delete the Lookup Code.

Note: Only one Lookup Code can be deleted at a time.

To Edit a Lookup Code

1. Right click on a row and select Properties from the Menu to display the Lookup

Code Properties popup box.



43

Security

The Security module is used by the Administrator for the initial configuration and for

ongoing administration of Security. The Security module is comprised of the following

sections:

Users

Groups

Classes

Provisioning

Security Model The Security model consists of three components:

● Roles

○ Requestor

○ Reviewer

○ Approver

44

○ Default

● Modules

○ Metadata

○ Logic

○ Audit

○ Security

○ Config

○ Workflow

○ Deployment

● Security Classes - Defined by Administrator

Users and Groups are provisioned for each component using Security Provisioning.

Security Rules The following rules are applied in the security engine to qualify menu, content and

operations that users perform in the application:

● Security classes are created by the Administrator to secure Applications and

Dimensions.

● Modules dictate which menu options are available to the User.

● Roles dictate the functions users perform.

Note: Modules and Roles are system defined and can’t be edited.

Roles Roles determine the functions that are performed by the user. A user must be assigned

at least one Role.

Requestor Users who are assigned this role create new Requests for metadata. The Requestor role

does not allow Review or Approval of requests.

Reviewer Users who are assigned this Role review metadata Requests. The Approve and Reject

menu items for Users Actions on the Request page are displayed for this role if following

conditions are met:

45

User has the Reviewer role.

User has Metadata module assigned.

User has access to Request level security constraints:

o Reviewer is assigned to this task OR in the Group assigned to this task.

See (Request Workflow Workflow TasksReview Task.)

o Request is in Pending Review Stage.

Note: When the Request is Submitted a snapshot of Users and Groups for the

Workflow that is selected for the Request are bound to the Request. Therefore,

Pending and Closed Requests are not impacted if the Workflow Task is changed.

Caution: Reviewers can only review Request Lines to which they have Security

access.

Approver Users who are assigned this Role Approve metadata Requests. The Approve and

Reject menu items for Users Actions on the Request page are displayed for this Role if

following conditions are met:

User has the Approver role

User has Metadata module assigned

User has access to Request level security constraints:

o Reviewer is assigned to this task OR in the Group assigned to this task.

See (Request Workflow Workflow TasksReview Task.)

o Request is in Pending Approval Stage.

Note: When the Request is Submitted a snapshot of Users and Groups for the

Workflow that is selected for the Request are bound to the Request. Therefore,

Pending and Closed Requests are not impacted if the Workflow Task is changed.

Caution: Approvers can only approve Request Lines to which they have Security

access.

Default The Default role is for Users not that are not Requestors, Reviewers or Approvers. For

example, this role can be assigned to a User that will only have read access or only

access to Explorer.

46

Users The Users page is for User administration of the EPMware application. Users can be

queried, added, deleted, disabled and assigned to Groups.

Note: Both Native and MSAD users can be assigned to Native Groups.

Note: Select the check box in the Inactive column to disable a User.

Caution: The grid Right Click Menu will not show the Delete option when the LDAP

radio button is checked.

To Add a Native User

1. Select the icon to display the Add Native User popup box.

2. Input Required Fields

3. Select Save to add the User.

47

To Edit a Native User

1. Right click on a row and select Edit User from the Menu to display the Edit User

popup box.

2. Edit the User profile as required.


Note: If Edit User is selected for an LDAP User, the input boxes will be grayed out.

48

To Delete a Native User



3. Select OK to delete the User.

Note: Only one User can be deleted at a time.

Caution: The Delete menu option will be grayed out if an LDAP User is selected.

49

To View Groups for a User

1. Right click on a row and select View Groups from the Menu to display the View

Groups popup box.

2. Select Close to close the window.

To Assign a Group to a User

1. Right click on a row and select Assign Groups from the Menu to display the

Assign Groups shuttle window.

2. Select a Group from the available Groups in the left pane

3. Select the Right Arrow and push the Group to the right pane to assign it to the

User.


50

To Un-assign a Group for a User

1. Right click on a row and select Assign Groups from the Menu to display the

Assign Groups shuttle window.

2. Select the Group to remove from the right pane.

3. Select the Left Arrow and push the Group to the left pane to un-assign it for the

User.


51

Groups The Groups page is used to Administer Groups for the EPMware application.

Note: Native and LDAP users can be assigned to Native Groups.

Note: Select the check box in the Inactive column to disable a Group.

To Add a Group

1. Select the icon to display the Add New Group popup box.

2. Input Name and Description

52

3. Select Save to add the Group.

To Edit a Group

1. Right click on a row and select Edit Group from the Menu to display the Edit

Group popup box.

2. Edit the Properties as required.


53

To Delete a Group



3. Select OK to delete the Group.

Note: Only one Group can be deleted at a time.

To View Users for a Group

1. Right click on a row and select View Users from the Menu to display the View

Users popup box.

2. Select Close to close the window.

54

To Assign a User to a Group

1. Right click on a row and select Assign Users from the Menu to display the

Assign Users shuttle window.

2. Select a User from the available Users in the left pane

3. Select the Right Arrow and push the User to the right pane to assign it to the

Group.


To Un-assign a User from a Group

1. Right click on a row and select Assign Users from the Menu to display the

Assign Users shuttle window.

2. Select the User to remove from the right pane.

3. Select the Left Arrow and push the User to the left pane to un-assign it for the

Group.


55

Security Classes Security Classes are used to secure Applications and Dimensions in EPMware.

Security Classes are created by the Administrator and are assigned to applications and

dimensions. Security Classes are Provisioned on the

ConfigurationSecurityProvisioning page. Provisioning assigns the Security Class

to a Security Group and assigns Read or Write access.

56

To Add a Security Class

1. Select the icon to display the Add Server popup box.

2. Input the Security Class Name and Description (Optional)

3. Select Save to add the Security Class.

To Edit a Security Class

1. Right click on a row and select Properties from the Menu to display the Class

Properties popup box.



57

To Inactivate a Security Class

1. Select the Inactivate check box on the row in the grid.


To Delete a Security Class



3. Select OK to delete the Security Class.

Note: Only one Security Class can be deleted at a time.

58

Security Provisioning Security Provisioning is used to assign access to Groups in the EPMware application. It

is a four tiered Security model consisting of Groups, Roles, Modules and Classes. At

least one selection from each tier is required to properly provision a Group. The Security

Provisioning grid will display the following three sections in the columns: Roles, Modules

and Classes. The rows of the grid display the Groups created in Security Groups.

Each intersection of the rows and columns has a checkbox or dropdown to define the

group’s access rights. The Roles Section has User Roles for EPMware, Requestor,

Reviewer, Approver and Default. The Modules Section controls access to the

EPMware Modules. The Workflow and Deployment columns of the Modules Section

have a dropdown to select Read, Write or None access. The Classes section displays

all the Security Classes created in EPMware. Each Security Class and Group

intersection has a dropdown to assign Read, Write or None access.

Note: See Security Groups, Security Roles and Security Classes for more

information on creating and administering Groups, Roles and Classes.

Caution: The Navigation Menu will not display Modules for

Users of a Group if the Group is not assigned access to that Module.

Page

Navigator

Group

Search

59

Modules Modules control access to the following EPMware elements:

Metadata - Grants access to Metadata Requests

Scripts - Grants access to Script Requests

Audit - Grants access to the Audit Module

Security - Grants access to Security Configuration

Config - Grants access to EPMware Configuration

Workflow - Grants access to the Workflow Module

Deployment - Grants access to the Deployment Module

To Provision or Edit a Group

1. Use the Group Search Box or the Page Navigator to display the Group.

2. Select at least one checkbox or dropdown value from the Roles, Modules and

Classes sections.

3. Select to save the Provisioning changes.

Workflow

The Workflow module is used by the Administrator for the initial configuration and the

ongoing maintenance of EPMware Workflows. The Workflow module is comprised of the

following components:

Workflow Tasks

Workflow Builder

A Workflow is comprised of a series of user defined Stages which contain Workflow

Task. Workflow Tasks are created and maintained at WorkflowTasks. Workflows

are created at WorkflowBuilder.

60

Workflow Tasks Tasks are individual operations which are then assigned to Stages. Tasks are associated

with an Email Template, Security Group and Custom Function.

A Task consists of the following components:

Name - User defined name for the Task

Description - A Description of the Task

Action:

o Review

o Approve

o Validate

o Deploy

o Notify

o Custom

Email Template - Email Templates created using Email Template Configuration

Security Group - Groups created using Group Configuration. (Only valid for

Review and Approve Actions).

Custom Function - A script defined in the Logic Bulder

# of Approvals – Defines how many Approvals are required for the Task. (Only

valid for Review and Approve Actions).

To Create a Workflow Task

1. Select the icon to display the Task Properties popup box.

2. Input the Task Name and Description (Optional)

3. Select an Action from the dropdown box.

61

4. Select an Email Template from the dropdown box.

5. Select a Security Group from the dropdown box

6. Input the # of Approvals.

7. Select Custom Function (only applicable if Action is Custom)

8. Select Save to save the Task.

To Edit a WorkFlow Task


Task Properties popup box.



62

To Delete a Workflow Task

1. Right click on a row and select Delete Task from the Menu.


3. Select OK to delete the Workflow Task.

Note: Only one Workflow Task can be deleted at a time.

63

Workflow Builder Workflows are created and configured by adding Stages to a Workflow. Stages are

comprised of a set of Tasks. Tasks are individual operations defined by the Administrator

using WorkflowTasks. The Tasks are then assigned to a Stage.

Note: Changing a Workflow will not affect Requests in progress. A snapshot of the

workflow is taken when the Request is created and is bound to the Request, so the

request will continue to use the workflow as it existed at the time the Request was

created.

Click on the green Start node to view the Workflow properties or click on a Stage node

to view the Stage properties in the Grid.

Workflow Properties:

● Name - User defined name

● Priority - Assigns a Priority to the Workflow

● Description - User defined description

● Security Class: Assigns a Security Class to the Workflow

● Enabled - Enable or Disable the Workflow

● Visible - Makes the Workflow visible in the drop down on the Request

● Metadata - Workflow is valid for Metadata Request

● Scripts - Workflow is valid for a Script Request

To Create a Workflow

1. Select the icon to display the Workflow Properties popup box.

64

2. Input the Workflow Name and Description (Optional)

3. Select a Priority from the dropdown box.

4. Select an Email Template from the dropdown box.

5. Select a Security Class from the dropdown box.

6. Select the Enabled, Visible, Metadata and Scripts checkboxes as required.

7. Select Save to save the Task.

To Edit a Workflow

1. Right click on the green Start node and select Edit Properties from the Menu to

display the Workflow Properties popup box.



65

To Delete a Workflow

1. Select the Workflow to delete from the Workflow drop down

2. Click on the Actions button and select Delete Workflow from the Menu.


4. Select OK to delete the Workflow.

66

Workflow Stages

Any combination of Workflow Stages can be added to a Workflow to meet company

requirements. Workflows are created and configured by adding Stages to a Workflow.

Stages are comprised of a set of Tasks. Tasks are individual operations defined by the

Administrator using WorkflowTasks. The Tasks are then assigned to a Stage.

Workflow Stage Properties:

● Stage # - Determines where the Stage is positioned in the workflow.

● Name – User defined name

● Description - User defined description

● Action:

o Review

o Approve

o Validate

o Deploy

o Notify

o Custom

To Add a Stage to a Workflow

1. Select the Workflow from the Workflow drop down

2. Click on the Actions button and select Create Stage from the Menu to display

the Stage Properties popup box.

3. Input a number for Stage # to define the order of the Stage in the Workflow.

4. Input the Stage Name and Description (Optional)

5. Select an Action for the Stage.

6. Select Save to add the Stage.

67

Note: The Stage # determines where the Stage is positioned in the workflow.

For example Stage# 20 will appear after Stage# 10 etc.

To Assign a Task to a Stage

1. Select a Stage node to display the Stage Configuration Grid

2. Click on the Actions button and select Assign Task from the menu to display

the Assign Tasks popup box.

3. Select the checkbox next to the Tasks to assign it to the Stage.

4. Select Save to assign the Task.

68

To Edit Task Properties from Workflow Builder

1. Select a Stage node to display the Stage Configuration Grid


Task Properties popup box.



69

Deployment

The Deployment module is used by the Administrator for the initial configuration and the

ongoing maintenance of EPMware Deployments to the target applications. The

Deployment module is comprised of the following Components:

Deployment Manager

Deployment Monitor

Deployment Schedule

Deployments are created by Application, Workflow or Request. Pre-Deployment and

Post-Deployment scripts may be added to customize the Deployment process.

70

Deployment Manager Deployments are created and managed with Deployment Manager.

A Deployment consists of the following components:

Name - User defined name for the Task

Description - A Description of the Task

Type:

o Application - Will deploy all approved Request the application

o Workflow - Will deploy all Approved Requests for the Workflow

o Request - Deploys and individual or group of Requests.

Pre-Deployment Scripts - A script created in Logic Builder which will run a Pre-

Deployment process before the metadata is deployed to the target application.

Post-Deployment Scripts - A script created in Logic Builder which will run a

Post-Deployment process after the metadata is deployed to the target

application.

Note: All scripts are created and managed in Logic Builder.

To Create a Deployment

1. Select the icon to display the Add Deployment popup box.

2. Input the Deployment Name and Description (Optional)

3. Select a Deployment Type.

4. Select a Pre-Deployment Script.

71

5. Select a Post-Deployment Script.

6. Select Save to save the Deployment

To Edit a Deployment


Deployment Properties popup box.



72

To Delete a Deployment

1. Right click on a row and select Delete Task from the Menu.


3. Select OK to delete the Workflow Task.

Note: Only one Deployment can be deleted at a time.

To Schedule a Deployment

1. Select the icon to display the Schedule Deployment popup box.

2. Select the frequency for the Deployment Schedule

3. Input or Select the parameters for the Schedule.

73

4. Select Save to save the Deployment Schedule.

Deployment Monitor The grid will display each Deployment instance that is generated based on the

Deployments defined on the Deployment Manager tab. To redeploy a deployment that

has a status of Failed or Partial in the Status column, right click on the row and select

Redeploy. This will place all un-deployed requests back in the pool for the next

scheduled deployment. To redeploy an individual Request, click on the Deployment ID

to display the Deployment Status popup then right click on a row and select Redeploy.

The redeployment for the individual Request will run on the next scheduled Deployment.

74

Monitor Grid

● Deployment Id - Unique ID assigned to the Deployment.

● Name - Name of Deployment as defined on Manager Tab.

● Description - Deployment description as defined on Manager Tab.

● Type - Deployment Type defined on the Manager Tab

○ Application

○ Workflow

○ Request

● Start Time - The date and time that the Deployment instance began running.

● End Time - The date and time that the Deployment instance completed.

● Status - Will display either Running or Completed

● Log - Will display the log file pertaining to this deployment instance.

Grid Filter

The Filter icon will display the Grid Filter popup

Filter Icon

75

Deployment Status

Note: The Deployment Status popup is displayed by clicking on the Request ID in

the Deployment Monitor Grid

76

Status Legend

Completed -This icon indicates the deployment has completed

successfully.

Pending - This icon indicates the deployment has an action pending, but the

deployment will finish once the pending action is complete.

Partial - A partial status is indicated when some metadata Request lines on a

Request have been deployed, but other lines have failed to deploy. To change

from Partial status to Complete, the failed line on the Request must be fixed and

the Deployment Redeployed or the Deployment must be manually Closed.

Failed - This icon will indicate the deployment has failed and will not finish

without user intervention.

Running -This icon will indicate the deployment does not have any actions

pending, and is currently running.

Note: Right clicking on a row in the Deployment Status popup will display

the menu option Redeploy. Selecting Redeploy will put the individual

Request in the eligible pool for the deployment engine to pick up on the next

run.

Deployment Schedule The grid displays all scheduled Deployments to target applications. It is used to monitor

future Deployments. Future Deployments can be changed on the Manager Tab by

modifying the Deployment's schedule.

Grid Columns:

● Name

● Description

● Next Deployment Date

● Frequency

● Type

77

Logic Builder

Logic Builder is used to create, delete, edit and validate scripts for use in other EPMware

Modules. A Logic Builder grid displays all the scripts. Left clicking on a row will display

the script in the pane below the grid. The script can then be validated, edited and saved.

If delete is selected, a popup will display to confirm deletion of the Script. A referential

integrity check is performed to ensure the script has not been assigned anywhere in the

application. If the script is being used, an error message displays notifying the user to

disassociate the script and then attempt to delete it again. Clicking the icon in the

editor pane will validate the script.

78

Note: Use the checkbox on the row to Enable or Disable a script. A script will not

appear in any modules if disabled.

To Create a Script

1. Select the icon to display the Create Script popup box.

2. Input the Script Name and Description (Optional)

3. Select a Script Type.

4. Input DB Function Name if applicable.

5. Select the Enabled checkbox to enable a script or uncheck to disable.

6. Select Save to save the script.

79

To Upload a Script File

1. Select the icon on a row in the grid.

2. Use the Browse button to select the script file.

3. Select the Upload button to upload the file or Cancel to cancel the upload.

Note: A script file can only be uploaded to an existing Script.

To Edit a Script’s Properties

1. Right click on a row and select Properties from the Menu to display the Edit

Script popup box.

80



To Delete a Script



3. Select OK to delete the Script.

81

Logic Builder Editor

The Logic Builder Editor is displayed when a script is selected in the grid by left clicking

on the row. The script is displayed in the Editor at the bottom of the page. The name of

the script is displayed in the blue box. Select the Save icon to save the changes.

To Edit a Script

1. Left click on the script in the grid to display it in the Logic Builder Editor.

2. Edit the script as required

3. Select the icon to validate the script.

4. Select the icon to save the changes.

Services

The Services page is located at AdministrationServices and has the current status

of the EPMware Services. The Workflow and Deployment services can be Stopped

and Started from this page.

82

ERP Import

The ERP Import module is used by the Administrator to import metadata from an

ERP source system into EPMware. This module also has an ERP Import Scheduler to

schedule imports. The ERP Import module is comprised of the following components:

ERP Import Builder

ERP Import Mapping

ERP Import Monitor

ERP Import Builder ERP Imports are created and managed with the ERP Import Builder. An EPMware

interface table is populated with data from the source ERP system via a SQL query.(See

Appendix A for the Interface table technical details.) The data in the EPMware interface

table is then mapped to the metadata Request attributes for the EPMware application.

The Request Header and the Request Line Items are then populated with the data from

the ERP Import and the Request is now ready for Review and Approval.

83

An ERP Import consists of the following components:

Interface Name - User defined name for the interface

Description – User defined description

Application - Target Application

Dimension - Target Dimension

Workflow Priority - Workflow Priority as deinfed in the Workflow module

Workflow - Workflow as defined in the Workflow module

Partial Allowed - Select if Partial Load is allowed

Enabled - Enable the ERP Import

Launch Workflow - Select if Workflow should launch after import

Interface Table Name - Define interface table name.

Pre-Execution - Run script before import

Post-Execution - Run script after import

Email Template (Success)

Email Template (On Error)

To Create an ERP Import

1. Select the icon to display the Create ERP Import popup box.

2. Input the Interface Name and Description (Optional)

3. Select an Application

4. Select a Dimension

5. Select a Workflow Priority

6. Select a Workflow

7. Select the Partial Allowed checkbox if partial loads are allowed.

84

8. Select the Enabled checkbox if the ERP Import should be visible to users.

9. Select the Launch Workflow checkbox if the Workflow should Launch

immediately after load.

10. Select Save to save the ERP Import

To Edit an ERP Import


Edit ERP Import popup box.



85

To Delete an ERP Import

1. Right click on a row and select Delete from the menu.


3. Select OK to delete the ERP Import.

86

ERP Import Mapping ERP Import Mappings are created and managed with the ERP Import Mapping screen.

The Mapping screen maps the Interface table columns with the Request attributes for the

EPMware application. The Request Header and the Request Line Items are then

populated with the data from the ERP Import and the Request is now ready for Review

and Approval.

Header Section This section will have a drop down list to select the ERP Import Name and radio button

to select a Header Mapping or a Line Mapping.

An ERP Import Mapping consists of the following components:

Column Name - Interface Table Column Name

Property Name - Only valid for Property Fields in Column Name

Mapping Type:

o Constant - Constant Value

o Derived - Calculated Value

o Import - Source Value

Custom Value - Input Custom Value

To Create a Header Mapping

1. Select ERP Import name from the drop down

87

2. Select Header radio button

3. Select the icon to display the Create Mapping popup box.

4. Select an Column Name from Interface Table

5. Select a Mapping Type:




6. Input Custom Value if applicable

7. Select Save to save the ERP Import Mapping

To Create a Line Mapping

1. Select ERP Import name from the drop down

2. Select Line mapping radio button

3. Select the icon to display the Create Mapping popup box.

4. Select an Column Name from Interface Table

5. Select an Property Name (Only Valid if Column Name is a Property)

6. Select a Mapping Type:




7. Input Custom Value if applicable

88

8. Select Save to save the ERP Import Mapping

To Edit a Mapping


Edit Mapping popup box.



89

To Delete an ERP Import

1. Right click on a row and select Delete from the menu


3. Select OK to delete the ERP Mapping

ERP Import Monitor The Monitor grid will display each ERP Import instance that is generated based on the

ERP Imports defined in the ERP Import Builder. Select a row to display the import

details in the bottom pane of the screen. Click on the Execution ID to display the Import

Status popup.

Import Monitor Grid

● Execution Id - Unique ID assigned to the Import

● Name - Name of the Import defined in ERP Import Builder.

● Start Time - The date and time that the Import instance began running.

● End Time - The date and time that the Import instance completed.

● Status - Will display either Running or Completed

● Message - Displays errors or warnings

● Log - Will display the log file pertaining to this Import instance.

90

Note: Click on the Log icon to display the log file.

ERP Import Execution Status

91

Note: The Status popup is displayed by clicking on the Execution ID in

the Monitor Grid

Status Legend

Completed -This icon indicates the Import has completed

successfully.

Pending - This icon indicates the Import has an action pending, but the

Import will finish once the pending action is complete.

Partial - A partial status is indicated when some metadata have been imported,

but other lines have failed to import. To change from Partial status to Complete,

the failed line on the import must be fixed and the Import ran again or the Import

must be manually Closed.

Failed - This icon will indicate the Import has failed and will not finish without

user intervention.

Running -This icon will indicate the import is currently running.

Grid Filter

The Filter icon will display the Grid Filter popup

Filter Icon

administrator's guide - epmwareepmware.com/doclibrary/epmware administrator's...

Documents