Administrator's Guide
EPMWARE ®
EPMWARE, Inc.
Updated: March, 2020
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.
Author: Tony Kiratsous, [email protected]
© 2020 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 ....................................................................................................................... 6
Configuration ..................................................................................................................... 7
Infrastructure .................................................................................................................... 7
Servers ......................................................................................................................... 7
Databases .................................................................................................................. 10
Applications ................................................................................................................... 13
Application Create and Import .................................................................................... 13
Application Properties ................................................................................................ 21
Dimensions .................................................................................................................... 29
Dimension Classes ..................................................................................................... 29
Dimension Configuration ............................................................................................ 31
Dimension Properties ................................................................................................. 33
Dimension Mapping .................................................................................................... 35
Dimension Hierarchy Actions ..................................................................................... 38
Member Properties ........................................................................................................ 40
Property Configuration ............................................................................................... 40
Property Categories ................................................................................................... 41
Property Mapping ....................................................................................................... 43
Property Derivation ..................................................................................................... 47
Email Templates ............................................................................................................ 50
Global Settings .............................................................................................................. 52
Email Settings ............................................................................................................ 53
Application Settings .................................................................................................... 55
Web Settings .............................................................................................................. 58
User Defined Settings ................................................................................................ 59
Configure (SAML) .......................................................................................................... 60
Download SAML XML File from EPMware ................................................................ 60
Generate XML File for EPMware ............................................................................... 60
Configure Global Setting for SAML ............................................................................ 60
Configure (MSAD) ......................................................................................................... 61
Configure Global Setting for MSAD ........................................................................... 62
4
Lookups ........................................................................................................................... 63
Security ............................................................................................................................ 67
Security Model ............................................................................................................... 67
Security Rules ................................................................................................................ 68
Roles .............................................................................................................................. 68
Requestor ................................................................................................................... 69
Reviewer..................................................................................................................... 69
Approver ..................................................................................................................... 69
Default ........................................................................................................................ 70
Users.............................................................................................................................. 70
Groups ........................................................................................................................... 76
Security Classes ............................................................................................................ 80
Security Provisioning ..................................................................................................... 83
Modules ...................................................................................................................... 84
Workflow .......................................................................................................................... 84
Workflow Tasks ............................................................................................................. 84
Workflow Builder ............................................................................................................ 88
Workflow Stages ........................................................................................................ 91
Deployment ...................................................................................................................... 94
Deployment Manager .................................................................................................... 95
Deployment Monitor ....................................................................................................... 98
Deployment Monitor Grid ........................................................................................... 99
Deployment Status ................................................................................................... 100
Status Legend .......................................................................................................... 101
Deployment Schedule .................................................................................................. 101
Logic Builder ................................................................................................................. 102
Logic Builder Editor ...................................................................................................... 106
Administration ............................................................................................................... 106
Services ....................................................................................................................... 107
Export Metadata .......................................................................................................... 107
Export Profile ............................................................................................................ 108
Export Details ........................................................................................................... 109
Export ....................................................................................................................... 110
Application Migration ................................................................................................... 111
Export ....................................................................................................................... 111
Import ....................................................................................................................... 112
Monitor...................................................................................................................... 114
5
ERP Import ..................................................................................................................... 115
ERP Import Builder ...................................................................................................... 115
ERP Import Mapping ................................................................................................... 119
Header Section ......................................................................................................... 119
ERP Import Monitor ..................................................................................................... 122
Appendix A: Oracle EPM Cloud Configuration Requirements ................................. 126
Oracle Planning and Budgeting Cloud Service (PBCS) .............................................. 126
Appendix B: EPMware API Reference ........................................................................ 131
Technical Details ......................................................................................................... 131
Authentication ........................................................................................................... 131
URL .......................................................................................................................... 131
Module: Task ............................................................................................................ 132
Module: ERP ............................................................................................................ 134
Module: Deployment ................................................................................................ 136
6
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.
7
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
• 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, PBCS). By default, this page will initially render
blank until a row is added. If the On-Premise Agent field is checked then the User
Name, Password and Identity Key are not required and hence these fields are greyed
out. The EPMware On Premise Agent uses the REST API to establish a connection to
the EPMware application. If the On-Premise Agent field is unchecked, which indicates
the On-Premise Agent is not installed on the server, then you must specify the User
Name and either the Password or Identity Key for the server. An Identity Key is a
private key that is used by the SSH protocol to grant access to servers.
Click on the Test Connection button to check the communication with Server.
Add a Server
1. Select the icon to display the Add Server popup box.
2. Input a Name (Label) for the Server
3. Input the Server Name for on-premise applications and any label for Cloud
applications.
8
4. Check On-Premise for on-premise servers or leave unchecked for Cloud
applications.
5. Input a Description (Optional)
6. Input a User Name and Password or Identity Key (Only needed if the On -
Premise agent is not installed on the server.)
Note: Click on the Test Connection button to check the communication with the
server.
9
Edit a Server
1. Right click on a row and select Edit Properties from the Menu to display the
Server Properties popup box.
2. Edit the properties as required.
3. Select Save to save the changes.
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.
10
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.
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)
3. Select Save to add the database to the Database Grid.
11
Edit a Database
1. Right click on a row and select Properties from the Menu to display the
Database Properties popup box.
2. Edit the properties as required.
3. Select Save to save the changes.
12
Delete a Database
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 Database.
Note: Only one Database can be deleted at a time.
13
Applications Application Configuration defines an EPMware application and links it to a target
application i.e. HFM, Planning etc.. The Upload button in the row will be grayed out until
the record is saved. Application Configuration has two Tabs, Configuration and
Properties. The Configuration Tab contains all the general application information. The
Properties Tab contains detailed target application properties.
The following is required to create an EPMware application, link it to a target application
and import the target application hierarchies to EPMware. (Application Import is only
applicable to pre-built EPMware integrations).
• Create an Application
• Configure Application Properties
• Import Application Hierarchies (Optional)
Note: Select the Enabled check box in the Grid to enable the Application and select
to save the change.
Note: The grid will be blank until an initial row is added.
Application Create and Import
Create an Application
1. Select the icon to display the Add Application popup box.
14
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 - Deploy metadata directly to target application
○ File - Deploy metadata to a file
○ Interface Table - Deploy metadata to a database table
● Import Server - Select a server defined during Server configuration.
● Database Name - Select a database defined during Database
configuration.
● Deployment Server - Select a server defined during Server
configuration
● Target Application User Name - Input the target application user name.
● Target Application Password - Input the target application password.
15
Import Target Application Hierarchies
1. Select the icon in the Grid to import the target application hierarchies and
display the Application Import popup box.
Note: An EPMware application must be created and Application Properties
configured before target application can be imported.
16
2. Select Auto Import to import the hierarchies from the Target Application
Server or select Manual Import to Browse for a file to import.
Import options by target application:
• Essbase (Classic)
o Auto Import
o Manual Import
▪ Run the following script in EAS to generate an .xml file:
Export outline ASOALL.Basic all dimensions to
xml_file "c:/temp/ASOALL02.xml";
▪ Import the .xml formatted file
• Planning (Classic)
o Auto Import
o Manual Import
▪ Create “LCM Extract .zip” file with the following artifacts:
17
• Import the “LCM Extract .zip” file
• HFM (Classic)
o Manual Import
▪ Use Metadata Extract file in .XML file from the HFM
Application export module.(.app file cannot be imported)
• Planning and Budgeting Cloud Service (PBCS) application
o Auto Import (See Appendix A for PBCS Configuration
Requirement)
• Oracle Analytics Cloud (OAC) Application
o Auto Import (See Appendix A for OAC Configuration
Requirement)
• Generic Application
o Manual Import – Compress the following files using WinZip
▪ <TARGET_APP_NAME>_Props.csv
▪ <TARGET_APP_NAME>_Dim_Classes.csv
▪ <TARGET_APP_NAME>_Dimensions.csv
▪ <TARGET_APP_NAME>_Dim_Props.csv
18
▪ <TARGET_APP_NAME>_Dim_Class_Props.csv
▪ <TARGET_APP_NAME>_<Dim_Name>_Hierarchies.csv
▪ <TARGET_APP_NAME>_<Dim_Name>_Members.csv
▪ <TARGET_APP_NAME>_Lookups.csv
Note: A Generic application can also be configured using Application,
Dimension and Property Configuration and no import is necessary.
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.
19
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.
To Edit an Application
1. Right click on a row and select Properties from the Menu to display the
Application Properties popup box.
2. Edit the properties as required.
3. Select Save to save the changes.
20
To Delete an Application
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 Application.
Note: Only one Application can be deleted at a time.
21
Application Properties
Configure HFM Classic Application Properties
1. Select the Properties tab
2. Select the Application Name to configure from the drop down
3. Right click on HYPERION_CLUSTER_NAME and select Edit Properties. Input
the Hyperion cluster name.
4. Right click on HYPERION_HOME and select Edit Properties. Input the Hyperion
Home path of the Hyperion application server.
Configure Planning Classic Application Properties
1. Select the Properties tab
2. Select the Application to configure from the drop down
3. Right click on EPM_INSTANCE_NAME and select Edit Properties. Input the
Hyperion instance name.
4. Right click on HYPERION_HOME and select Edit Properties. Input the Hyperion
Home path of the Hyperion application server.
5. Right click on PASSWORD_FILE and select Edit Properties. Input the Hyperion
path for the pwd.txt file.
6. Right click on PROJECT_FOLDER_NAME and select Edit Properties. Input the
name of the project folder for the Planning application in Shared Services.
22
Configure Essbase Classic Application Properties
1. Select the Properties tab
2. Select the Application to configure from the drop down
3. Right click on EPM_INSTANCE_NAME and select Edit Properties. Input the
Hyperion instance name.
4. Right click on ESSBASE_DATABASE_NAME and select Edit Properties. Input
the Essbase database name.
5. Right click on ESSBASE_TYPE_ENABLED and select Edit Properties. Input “Y”
if Typed Measures are enabled.
6. Right click on HYPERION_HOME and select Edit Properties. Input the Hyperion
Home path of the Hyperion application server.
Configure EPMA Application Properties
1. Select the Properties tab
23
2. Select the Application to configure from the drop down
3. Right click on BPMASERVERURL and select Edit Properties. Input the
server URL.
4. Right click EPM_INSTANCE_NAME and select Edit Properties. Input
the Instance name.
5. Right click on HYPERION_HOME and select Edit Properties Input the Hyperion
Home path of the Hyperion application server.
6. Right click on PROJECT_FOLDER_NAME and select Edit Properties. Input the
name of the project folder for the EPMA application in Shared Services.
7. Right click on WORKSPACEURL and select Edit Properties. Input the EPMA
Workspace URL.
Configure FDMEE Application Properties
1. Select the Properties tab
2. Select the Application to configure from the drop down
3. Right click on EPM_INSTANCE_NAME and select Edit Properties. Input the
Hyperion instance name.
4. Right click on FDMEE_DATA_FOLDER_NAME and select Edit Properties.
Input the FDMEE data path.
24
5. Right click on HYPERION_HOME and select Edit Properties Input the
Hyperion Home path of the Hyperion application server.
Configure Oracle EBS Application Properties
1. Select the Properties tab
2. Select the Application to configure from the drop down
3. Right click on Flex Code and select Edit Properties. Input the
GL#.
4. Right click on Flexfield Structure Code and select Edit Properties.
Input the Flexfield Structure Code.
Configure Oracle PBCS Application Properties
1. Select the Properties tab
2. Select the Application to configure from the drop down
3. Verify the PBCS_APP_NAME matches the target application name on the Oracle
cloud. For example, Vision
25
4. The Oracle REST API uses PBCS_APP_VERSION to communicate with the
PBCS application. Do not change the default value.
5. Verify that the default value for PBCS_DEPLOY_JOB_FILE_NAME matches the
Import Job .csv file name created in PBCS. (See PBCS Configuration)
6. Verify that the default value for PBCS_DEPLOY_JOB_NAME matches the Import
Job name created in PBCS. (See PBCS Configuration)
7. Verify that the URL for PBCS_DEPLOY_METADATA_URL is correct. It is the
URL that will be used by REST API to deploy metadata.
8. Verify the URL for PBCS_LCM_EXPORT_URL is correct. It is the URL that will
be used by the REST API to import metadata from PBCS.
9. Verify the default value for PBCS_LCM_SNAPSHOT_NAME matches the
Snapshot name created in PBCS. (See PBCS Configuration)
10. Do not change the default value for PBCS_PAYLOAD - Internal Use only.
11. Verify the value for PBCS_SERVER_URL matches the Oracle PBCS URL:
https://planning-<PBCS_TENANT_NAME>.pbcs.us2.oraclecloud.com or
https://planning-test-<PBCS_TENANT_NAME>.pbcs.us2.oraclecloud.com
12. PBCS_TENANT_NAME - Specify the tenant name for PBCS provided by Oracle.
Name Value
PBCS_APP_NAME Vision
PBCS_APP_VERSION 11.1.2.3.600
PBCS_DATA_CENTER Us6
PBCS_DEPLOY_JOB_FILE_NAME EW_IMPORT_<DIMENSION_NAME>.csv
PBCS_DEPLOY_JOB_NAME EW_IMPORT_<DIMENSION_NAME>
PBCS_DEPLOY_METADATA_URL <PBCS_SERVER_URL>/HyperionPlanning/rest/v3/applications/<PBCS_APP_NAME>/jobs
PBCS_LCM_EXPORT_URL <PBCS_SERVER_URL>/interop/rest/<PBCS_APP_VERSION>/applicationsnapshots/ <PBCS_LCM_SNAPSHOT_NAME>/migration?q={type:export}
PBCS_LCM_SNAPSHOT_NAME EW_LCM_EXPORT
PBCS_PAYLOAD {"jobType":"IMPORT_METADATA","jobName":"<PBCS_DEPLOY_JOB_NAME>","parameters": {"importZipFileName":"<PBCS_PAYLOAD_FILE_NAME>"}}
PBCS_SERVER_URL https://<PBCS_SERVICE_NAME>-<PBCS_TENANT_NAME>.pbcs.<PBCS_DATA_CENTER>.oraclecloud.com
26
PBCS_SERVICE_NAME Planning-test
PBCS_TENANT_NAME
Configure Oracle FCCS Application Properties
1. Select the Properties tab
2. Select the Application to configure from the drop down
3. The HFM_LEGACY_DIM_MAP_ACCOUNT property is only required for HFM to
FCCS conversions. Specify the name of the Account dimension in HFM
4. The HFM_LEGACY_DIM_MAP_CUSTOM1 property is only required for HFM to
FCCS conversions. Specify the name of the Account dimension in HFM
5. The HFM_LEGACY_DIM_MAP_CUSTOM2 property is only required for HFM to
FCCS conversions. Specify the name of the Account dimension in HFM
6. The HFM_LEGACY_DIM_MAP_ENTITY property is only required for HFM to
FCCS conversions. Specify the name of the Account dimension in HFM
7. The HFM_LEGACY_TOP_NODE_PREFIX property is only required for HFM to
FCCS conversions. Specify the prefix to be used for the HFM Legacy Node.
8. Verify the PBCS_APP_NAME matches the target application name on the Oracle
cloud. For example, Vision
9. The Oracle REST API uses PBCS_APP_VERSION to communicate with the
FCCS application. Do not change the default value.
10. Verify that the default value for PBCS_DEPLOY_JOB_FILE_NAME matches the
Import Job .csv file name created in FCCS. (See FCCS Configuration)
11. Verify that the default value for PBCS_DEPLOY_JOB_NAME matches the Import
Job name created in FCCS. (See FCCS Configuration)
12. Verify that the URL for PBCS_DEPLOY_METADATA_URL is correct. It is the
URL that will be used by REST API to deploy metadata.
13. Verify the URL for PBCS_LCM_EXPORT_URL is correct. It is the URL that will
be used by the REST API to import metadata from FCCS.
27
14. Verify the default value for PBCS_LCM_SNAPSHOT_NAME matches the
Snapshot name created in FCCS. (See FCCS Configuration)
15. Do not change the default value for PBCS_PAYLOAD - Internal Use only.
16. Verify the value for PBCS_SERVER_URL matches the Oracle FCCS URL:
https://planning3-<PBCS_TENANT_NAME>.pbcs.us2.oraclecloud.com>.pbcs.us2.oraclecloud.com
17. PBCS_TENANT_NAME - Specify the tenant name for FCCS provided by Oracle.
Name Value
HFM_LEGACY_DIM_MAP_ACCOUNT Account
HFM_LEGACY_DIM_MAP_CUSTOM1 Custom1
HFM_LEGACY_DIM_MAP_CUSTOM2 Custom2
HFM_LEGACY_DIM_MAP_ENTITY Entity
HFM_LEGACY_TOP_NODE_PREFIX HFM_Legacy_
PBCS_APP_NAME Vision
PBCS_APP_VERSION 11.1.2.3.600
PBCS_DEPLOY_JOB_FILE_NAME EW_IMPORT_<DIMENSION_NAME>.csv
PBCS_DEPLOY_JOB_NAME EW_IMPORT_<DIMENSION_NAME>
PBCS_DEPLOY_METADATA_URL <PBCS_SERVER_URL>/HyperionPlanning/rest/v3/applications/<PBCS_APP_NAME>/jobs
PBCS_LCM_EXPORT_URL <PBCS_SERVER_URL>/interop/rest/<PBCS_APP_VERSION>/applicationsnapshots/ <PBCS_LCM_SNAPSHOT_NAME>/migration?q={type:export}
PBCS_LCM_SNAPSHOT_NAME EW_LCM_EXPORT
PBCS_PAYLOAD {"jobType":"IMPORT_METADATA","jobName":"<PBCS_DEPLOY_JOB_NAME>","parameters": {"importZipFileName":"<PBCS_PAYLOAD_FILE_NAME>"}}
PBCS_SERVER_URL https://planning-<PBCS_TENANT_NAME>.pbcs.us2.oraclecloud.com
PBCS_TENANT_NAME <CHANGE_ME>
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.
28
To Edit a Property
1. Right click on a row and select Properties from the Menu to display the
Application Properties popup box.
2. Edit the properties as required.
3. Select Save to save the changes.
29
To Delete a Property
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 Property
Note: Only one Property can be deleted at a time.
Dimensions
Dimensions contain the hierarchies for the application and are comprised of the following
components:
• Dimension Classes
• Dimension Configuration
• Dimension Properties
• Dimension Mapping
• Hierarchy Actions
Dimension Classes
Dimension class are the highest level component of dimensions. A Dimension class can
contain one or many dimensions.
30
Select an Application from the drop down list to view the Dimension Classes.
To Edit a Dimension Class
1. Right click on a row and select Edit from the Menu to display the Dimension
Class Attributes popup box.
2. Edit the attributes as required
3. Select Save to save the changes
31
Dimension Configuration
Dimension configuration defines the dimension attributes for applications imported from
the target application or Generic applications created in EPMware.
Select an Application from the dropdown list to view the Dimensions.
32
Dimension Attributes
● Dimension Class - List of dimension classes
● Dimension - List of dimensions imported from target application
● Description - User defined description
● Security Class - Assigns Security Classes to the Dimension
● Enabled- Enable or Disable the Dimension in EPMware
● Default Alias - Dimension Alias
● Read Only - Makes the dimension read only
● Derived - Flags the dimension as derived. Derived dimensions are read only.
● Derived Root Member - Root member name for derived dimension
● Derived SQL – SQL script for derived dimension
To Edit a Dimension
1. Right click on a row and select Edit from the Menu to display the Dimension
Attributes popup box.
2. Edit the attributes as required
3. Select Save to save the changes
33
Dimension Properties
Select an Application and a Dimension from the dropdown lists to view the Properties
for the Dimension.
34
To Add a Dimension Property
1. Select the icon to display the Add Dimension Properties popup box.
2. Input the Property Name, Property Value and Description.
3. Select Save to save the record.
To Edit a Property
1. Right click on a row and select Properties from the Menu to display the
Dimension Properties popup box.
2. Edit the properties as required.
3. Select Save to save the changes.
35
To Delete a Property
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 Property.
Note: Only one Property can be deleted at a time.
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.
36
Dimension Mapping Options
● Sync – When a member is created in one application the same member will be
created in the mapped applications. The hierarchies in both applications must be
homogeneous.
● Smart Sync - When a member is created in one application, the same member
will be created in the mapped applications only if the parent member exists.
Therefore, the hierarchies may be heterogeneous.
● Script - User defined sharing of members across applications
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
37
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
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, Smart 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,
Smart 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.
38
Dimension Hierarchy Actions
Dimension Hierarchy Actions allows a Dimensions hierarchy action i.e. “Create Member”
to trigger a pre or post action script. The script is created in the Logic Builder module and
then selected in the Edit Hierarchy Actions Properties popup. A Security Class can be
optionally assigned to specific hierarchy actions associated with the dimension. If a
Security Class is assigned, then users with "Write" access to the security class are able
to perform those actions for that dimension. For example, the "Delete Member" action
can be restricted to certain users. The Hierarchy Actions can also be Enabled or
Disabled.
For example, a Pre Action script can position a member added to a primary hierarchy into
a specific location in a Shared hierarchy.
To Create a Hierarchy Action
1. Select the icon to add a row to the top of the Grid
2. Select the Hierarchy Action attributes
39
5. Click to Save the row.
Note: All Scripts are created and managed in the Logic Builder Module.
To Edit a Hierarchy Action
1. Right click on a row and select Edit Properties from the Menu to display the
Edit Hierarchy Action Properties popup box.
2. Edit the properties as required.
3. Select Save to save the changes.
To Delete a Hierarchy Action
1. Right click on a row and select Delete from the Menu.
2. The following confirmation popup will display
40
3. Select OK to delete the Hierarchy Action
Note: Only one Hierarchy Action can be deleted at a time.
Member Properties Member property configuration defines Property attributes, Categories and how
properties are Mapped, Validated, and Derived across Applications and Dimensions.
Properties for EPMA applications and Classic applications can also be mapped.
Member Properties are comprised of the following components:
• Property Configuration
• Property Categories
• Property Mapping
• Property Validations
• Property Derivations
Property Configuration Property configuration defines the Property attributes for applications imported from the
target application or Generic applications created in EPMware.
Select and Application, Dimension Class and Category from the dropdown list to view
the Properties.
41
Property configuration attributes are grouped into the following:
Property Attribute Groups
● General - General attributes
● Defaults - Default values
● Display - Attributes related to the display of the Property
● Deploy - Deployment attributes
Property Categories Property categories allow Properties to be grouped and assigned to a categories for
display on the Metadata Explorer and Metadata Request pages. This allows for filtered
viewing of Properties in the Property pane.
42
Select the Application and Dimension Class to view the Property Categories.
Right click on a Category to assign a property to it.
43
Property Mapping 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. 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.
44
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
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.
45
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
Configuration→Property→Validations.
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
46
7. Input a Description
8. Select Save to save the record.
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.
2. Edit the properties as required.
3. Select Save to save the changes.
47
To Delete a Property Validation
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 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 Configuration→Property→Derivations. 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.
48
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
8. Select Save to save the record.
49
Note: All Scripts are created and managed in the Scripts Module.
To Edit a Property Derivation
1. Right click on a row and select Edit Properties from the Menu to display the
Edit Derivation popup box.
2. Edit the properties as required.
3. Select Save to save the changes.
To Delete a Property Derivation
1. Right click on a row and select Delete from the Menu.
2. The following confirmation popup will display
50
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.
Email Template Grid
Variable Tags are available to customize the email templates and make them dynamic.
Variable Tags:
• <REQUEST_ID>
• <REQUEST _DESCRIPTION>
51
• <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.
3. Select Save to save the record.
Email Template Example
52
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.
2. Edit the properties as required.
3. Select Save to save the changes.
To Delete an Email Template
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 Email Template.
Note: Only one Email Template can be deleted at a time.
Note: You can specify a logo to appear in email notifications and audit reports under
Global Setting.
Global Settings Select Configuration→Misc→Global 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
53
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
54
Global Email Settings Example
To Edit Email Settings
1. Double click on the Value or Description field to switch the field to edit mode
2. Edit the properties as required.
3. Select to save the changes.
55
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
Application Import - Total Interval in
Seconds before TimeOut
Total Interval in Seconds for App Import to finish before TimeOut
Application Import - sleep interval in
Seconds
Wait Interval in Seconds for App Import
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
ERP Import Service Sleep Interval ERP Import Service Sleep Interval (Seconds)
File Archives DB Directory Specify DB directory to archive files
Organization Logo Height (Pixels) Specify Organization Logo Height (Pixels)
Organization Logo URL Specify Organization Logo URL
56
Organization Logo Width (Pixels) Specify Organization Logo Width (Pixels)
Organization Name Specify Organization name
SSH port for Agent Service SSH Port for Agent Service
Show # of nodes per page in Hierarchies Show # of nodes per page in Hierarchies in Metadata Explorer and
Request Pages
Show Member Description by default Y/N value to determine if member description to be displayed by
default or not
Show or Hide System Generated Request
lines
Y/N value to determine if system generated Request lines by default
should be by displayed or not.
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 deployment staging file generations
Temp DB Directory Specify DB directory for temporary file generations
Turn on/off Database Trace If enabled Database Tracing is turned on for the current session
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
Unzip - Sleep Interval in Seconds Wait Interval in Seconds for Unzip
Unzip - Total Interval in Seconds before
TimeOut
Total Interval in Seconds for Unzip to finish before TimeOut
User Authentication Directory Type (LDAP
or MSAD)
User Authentication Directory Type (LDAP or MSAD)
User Authentication Directory Type option
enabled or not
User Authentication Directory Type (LDAP or MSAD)
Workflow Service Sleep Interval Workflow Service Sleep Interval (Seconds)
57
Global Application Settings Example
To Edit Application Settings
1. Double click on the Value or Description field to switch the field to edit mode
58
2. Edit the properties as required.
3. Select to save the changes.
To Configure Company Logo – The logo will appear in Email Notifications
and Audit Reports
1. Double click on the Value or Description field to switch the field to edit mode
2. Set Organization Logo Height (Pixels)
3. Set Organization Logo URL
4. Set Organization Logo Width (Pixels)
5. Select to save the changes
Web Settings Web Settings contains all the Global Web Settings for the EPMware application.
To Edit Web Settings
1. Double click on the Value or Description field to switch the field to edit mode
2. Edit the properties as required.
3. Select to save the changes.
59
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
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
2. Edit the properties as required.
60
3. Select to save the changes.
Configure (SAML) EPMware supports Security Assertion Markup Language (SAML) authentication. The
following configuration is required to use SAML authentication in EPMware.
1. Download SAML XML file from EPMware
2. Generate XML file for EPMware.
3. Configuration EPMware
Download SAML XML File from EPMware Use the following URL to download the SAML XML file:
https://<EPMWARE URL>/saml/metadata
For example:
https://demo.epmwarecloud.com/saml/metadata
Provide this XML file to your Administrator who manages corporate users and groups.
Generate XML File for EPMware Using EPMWARE SAML XML file downloaded in the previous step your Administrator will
provide an XML file that EPMware will use for user authentication.
Email this XML file to [email protected] for configuration.
Configure Global Setting for SAML
Select Configuration→ Misc→ Global from the navigation menu to access Global
Settings. Select the Application tab.
1. Change the User Authentication Directory Type LDAP, MSAD Property to
SAML
2. Change the User Authentication Type Enabled Property to Y
3. Select to save the changes.
61
Configure (MSAD) If you are using MSAD as the User Authentication Directory type and if you are using a
secured port, for example port # 636, then you may need to import MSAD certificate into
Apache Tomcat. For more information, refer to standard documentation of Apache
Tomcat.
Note: In the EPMware Apache folder, LDAP configuration will need to specify “ldaps”
rather ldap.
Tomcat Apache EPMWARE Property file examples:
Example 1: Standard LDAP port (No certificate is needed)
62
Example 2: Secure LDAP port (Certificate needs to be imported in EPMWARE Tomcat
Apache)
Configure Global Setting for MSAD
Select Configuration→ Misc→ Global from the navigation menu to access Global
Settings. Select the Application tab.
1. Change the User Authentication Directory Type LDAP, MSAD or SAML
Property to MSAD
2. Change the User Authentication Type Enabled Property to Y
3. Select to save the changes.
63
Lookups
Select Configuration→ Misc→ Lookups 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.
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.
64
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.
65
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.
4. Select Save to save the record.
66
To Delete a Lookup Code
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 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.
2. Edit the properties as required.
3. Select Save to save the changes.
67
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
68
○ 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,
Dimensions and Properties.
● 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
69
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:
• 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 Tasks→Review 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 Tasks→Review 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,
70
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.
Users The Users page is for User administration of the EPMware application. Users can be
queried, added, deleted, disabled and assigned to Groups.
Note: Native, LDAP and SAML 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.
71
User are added individually or via an upload file for Native and SAML user.
To Add a Native or SAML User
1. Select the icon to display the Add User popup box.
2. Select Native or SAML user from the User Type drop down
3. Input Required Fields
4. Select Save to add the User.
To Edit a Native or SAML 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.
72
3. Select Save to save the changes.
Note: If Edit User is selected for an LDAP User, the input boxes will be grayed out.
To Delete a Native or SAML User
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 User.
73
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.
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.
74
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.
4. Select Save to save the changes.
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.
4. Select Save to save the changes.
75
REST API Token EPMware Agents on the on-premise servers use our REST APIs to perform tasks such
as Application Import and Deployments. The EPMware agent uses a 36 character
alpha-numeric token to login to the EPMware application using the REST
(Representational State Transfer) protocol. At least one User needs to be created and
assigned a REST token to complete the on-premise Agent installation for the on-premise
servers. Refer to the EPMware Agent Installation Guide for complete details of the Agent
configuration.
Configure a User with a REST Token for the On-Premise Agent
1. Right click on a the user record and select Generate Token from the menu.
2. Click the green Generate Button to generate the token.
3. Select Save to save the token and then select Close.
76
Groups The Groups page is used to Administer Groups for the EPMware application.
Note: Native, LDAP and SAML 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
77
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.
3. Select Save to save the changes.
78
To Delete a Group
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 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.
79
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.
4. Select Save to save the changes.
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.
4. Select Save to save the changes.
80
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
Configuration→Security→Provisioning page. Provisioning assigns the Security Class
to a Security Group and assigns Read or Write access.
81
To Add a Security Class
1. Select the icon to display the Add New Class 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.
2. Edit the properties as required.
3. Select Save to save the changes.
82
To Inactivate a Security Class
1. Select the Inactivate check box on the row in the grid.
2. Select to save the changes.
To Delete a Security Class
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 Security Class.
Note: Only one Security Class can be deleted at a time.
83
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
84
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 configured 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 Workflow→Tasks. Workflows
are created at Workflow→Builder.
Workflow Tasks Tasks are individual operations which are then assigned to Stages. Tasks are associated
85
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.
4. Select an Email Template from the dropdown box.
5. Select a Security Group from the dropdown box
86
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
1. Right click on a row and select Edit Properties from the Menu to display the
Task Properties popup box.
2. Edit the properties as required.
3. Select Save to save the changes.
87
To Delete a Workflow Task
1. Right click on a row and select Delete Task from the Menu.
2. The following confirmation popup will display
3. Select OK to delete the Workflow Task.
Note: Only one Workflow Task can be deleted at a time.
88
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 Workflow→Tasks. 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.
89
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.
2. Edit the properties as required.
3. Select Save to save the changes.
90
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.
3. The following confirmation popup will display
4. Select OK to delete the Workflow.
91
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 Workflow→Tasks. 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. Input a Description (Optional)
6. Select an Action for the Stage.
7. Select a Freeze (Optional) – Restricts Reviewer from adding members to a
Request
8. Select Save to add the Stage.
92
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.
93
To Edit Task Properties from Workflow Builder
1. Select a Stage node to display the Stage Configuration Grid
2. Right click on a row and select Edit Properties from the Menu to display the
Task Properties popup box.
3. Edit the properties as required.
4. Select Save to save the changes.
94
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.
95
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.
96
5. Select a Post-Deployment Script.
6. Select Save to save the Deployment
To Edit a Deployment
1. Right click on a row and select Edit Properties from the Menu to display the
Deployment Properties popup box.
2. Edit the properties as required.
3. Select Save to save the changes.
97
To Delete a Deployment
1. Right click on a row and select Delete Task from the Menu.
2. The following confirmation popup will display
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.
98
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.
99
Deployment 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
100
Deployment Status
Note: The Deployment Status popup is displayed by clicking on the Request ID in
the Deployment Monitor Grid
101
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
102
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.
103
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.
104
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.
105
2. Edit the properties as required.
3. Select Save to save the changes.
To Delete a Script
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 Script.
106
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.
Administration
The Administration module is used by the Administrator to monitor Services and create
metadata Export files. The Administration module is comprised of the following
Components:
• Export
• Services
107
Services
The Services page is located at Administration→Services and has the current status
of the EPMware Services. The Workflow and Deployment services can be Stopped
and Started from this page.
Export Metadata The Export page is located at Administration→Export and allows metadata to be
exported to a file. The Export page has three tabs which are used to create and execute
a metadata Export.
108
An Export consists of the following components:
• Export Profile – Defines the export name and format
• Export Details – Defines the applications, dimensions and properties to export
• Export – Executes the export and creates a row in the grid for each export
Export Profile
To Create an Export Profile
1. Select the Export Profile tab
2. Select the icon to display the Create Profile popup box.
3. Input the Profile Name and Description (Optional)
4. Select an Export Format
5. Input a Column Delimiter if the Export Format is “Custom File Format”
6. Input a Text Qualifier if the Export Format is “Custom File Format”
7. Select Save to save the Profile
109
Export Details
The Application and Dimension to be exported are configured using the Export Details
tab.
To Configure Export Details
1. Select the Export Details tab
2. Select the Export Profile
3. Select the icon to display the Export Details popup box.
4. Select an Application
5. Select an Dimension
6. Select the Properties hyperlink in the properties column to select specific
properties to export.
7. Select Save to save the Export Details
110
Export
Each export will have an Execution ID and display as a row in the grid.
To Execute the Export
1. Select the Export tab
2. Select the Export Profile
3. Click the Export button to execute the export
4. Click the icon in the row on the grid to download the file
The following progress bar will display while the Export is running
111
Application Migration The Migration module is located at Administration→Migration and allows applications
and application artifacts to be exported to an XML file. This provides the ability to migrate
applications and individual artifacts from one environment to another. The Migration page
has three tabs which are used to create and execute artifact exports.
The Migration module consists of the following components:
• Export – Artifacts are selected for export
• Import – Artifact files are uploaded, validated and imported
• Monitor – Monitor Export and Import jobs and download export files
Export
112
To Export Artifacts
1. Select the Export tab
2. Select the artifacts to export
3. Click the Export button to execute the export
4. Select the Monitor tab to check the status of the export and to download the
export file.
Import
To Import Artifacts
1. Select the Import tab
2. Choose Merge or Replace
3. Browse to select the xml file to import
4. Click the Upload button to upload the file
5. Click the Validate button to check the file for errors
6. Click the Import button to execute the import
7. Select the Monitor tab to check the status of the import
113
The artifacts to be imported can be viewed after the upload has completed
114
Monitor
Each Import and Export will have an Execution ID and display as a row in the grid.
To Download the Import or Export file
1. Select the download icon in the Output File column
2. Click the icon in the row on the grid to download the file
3. Click the icon in the Log column to download the Log file
115
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.
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
116
• 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.
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
117
To Edit an ERP Import
1. Right click on a row and select Edit Properties from the Menu to display the
Edit ERP Import popup box.
2. Edit the properties as required.
3. Select Save to save the changes.
118
To Delete an ERP Import
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 ERP Import.
119
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
120
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:
o Constant - Constant Value
o Derived - Calculated Value
o Import - Source Value
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:
o Constant - Constant Value
o Derived - Calculated Value
o Import - Source Value
7. Input Custom Value if applicable
121
8. Select Save to save the ERP Import Mapping
To Edit a Mapping
1. Right click on a row and select Edit Properties from the Menu to display the
Edit Mapping popup box.
2. Edit the properties as required.
3. Select Save to save the changes.
122
To Delete an ERP Import
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 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.
123
Note: Click on the Log icon to display the log file.
ERP Import Execution Status
124
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
125
126
Appendix A: Oracle EPM Cloud Configuration Requirements
The following are Oracle EPM Cloud configuration requirements to link EPMware to the
Cloud applications and to allow the hierarchies to be imported into EPMware using Auto
Import and Deployed Directly to PBCS.
Oracle Planning and Budgeting Cloud Service (PBCS)
Configure PBCS to Import Metadata to EPMware
1. Logon to Oracle PBCS cloud application
2. From the Desktop click Tools and then Migration
3. Click the Planning link
4. Select all the artifacts except Essbase Data and click on the Export icon.
127
5. Enter EW_LCM_EXPORT for the Export name.
This will create the metadata export job that EPMware Application Import will use
to import the PBCS hierarchies into EPMware.
Note: The Export Name must match the value assigned to Application Property
“PBCS_LCM_SNAPSHOT_NAME” in Application Configuration
Properties Tab in EPMware.
Configure PBCS to Enable Metadata Deployment from EPMware
A separate Job is required for each Dimension that metadata will be deployed to in
PBCS.
1. Logon to Oracle PBCS cloud application
128
2. From the Desktop click the Application icon and then Overview
3. Select the Dimensions tab
4. Click the Import icon.
129
5. Click on the Create icon to create and configure the Import Metadata Jobs.
6. Configure the Import Metadata Job.
a) Select the Inbox radio button
b) Select the Clear Members check box for Dimensions
c) Input an Import File name for each Dimension and UDA that will be
managed in EPMware.
130
Note: The Naming convention for the import files are:
For Dimensions: EW_IMPORT_<Dimension Name>.csv
For UDA’s: EW_IMPORT_UDA_<Dimension Name>.csv
Caution: The File name is case sensitive and must be entered in all UPPER
CASE. For example: EW_IMPORT_ACCOUNT.csv
d) Click on the Save as Job icon and Input the Job Name using the following
naming conventions.
For Dimensions: EW_IMPORT_<Dimension Name> or
For UDA’s: EW_IMPORT_UDA_<Dimension Name>
Note: Check the “Refresh Database if Import Metadata is successful” check box
Click on Save to save the Job.
Repeat this process for each Dimension that metadata will be deployed to in
PBCS.
131
Appendix B: EPMware API Reference
The purpose of this appendix is to provide details for the REST API implementation for
EPMWARE modules. Developers can connect to the EPMware application using the
REST API to perform various tasks triggered from external applications such as execute
ERP Import processes and run Deployment task.
Technical Details
Authentication
For authentication, you will need to generate token for a user in EPMWARE and pass it in
REST API header during every call.
The authentication header value should be:
Token <token generated in EPMWARE>
URL
The REST API URL format is:
http(s)://<EPMWARE_URL>/service/api/<module>/<action>
The EPMware_URL is different for every client and every instance. Refer to the following
list of Modules and actions allowed within each module:
Modules and their related Actions are as listed below. Actions are listed inside Modules.
Module Action Notes
Task Get_status Get status for a given task ID
Task Get_log_file Download Task Details
ERP Upload_file Upload Metadata file and load its data in ERP Import interface table.
132
ERP Run Execute ERP Import (one time scheduled)
Deployment Run Execute Deployment (one time scheduled
For example, https://demo.epmwarecloud.com/service/api.task/get_status
Module: Task
Action: get_status
URL Construct:
http(s)://<EPMWARE_URL>/service/api/task/get_status/{TASK_ID}
This API will return % Complete, Status and message. You may need to call this API
after other APIS which upon submission returns Task ID. API will return one of the
following three values for the status code. If status code is N, then it means task is not
complete yet and you may either need to wait or perform this check in a loop till status
becomes either S or E.
Example:
curl http://demo.epmwarecloud.com/service/api/task/get_status/244591 -H
“authorization: Token 15388ad5-c9af-4cf3-af47-8021c1ab3fb7”
Response:
{"message":"Load completed
successfully","percentCompleted":"100","status":"S","taskId":"244
591"}
Status Meaning Notes
N New This status code is the initial status applied when the task is
submitted in the queue.
S Success Task is completed successfully.
E Error Task completed but with Error. Check the “Message” value for
short Error Message. For complete task details, call “get_log_file”
REST API as explained in the next section.
133
Action: get_log_file
URL Construct:
http(s)://<EPMWARE_URL>/service/api/task/get_log_file/{TASK_ID}
This API will return task details (Logfile).
Example:
curl http://demo.epmwarecloud.com/service/api/task/get_log_file/244591 -H
“authorization: Token 15388ad5-c9af-4cf3-af47-8021c1ab3fb7” >
ew_task_244591_log.txt
Response:
The REST API will return log details for the given task ID as standard output on the
console which can be redirected to be saved into a local file as shown in the example
above.
25-NOV-2019 21:10:20 --> Task 244654 [ERP Import REST API] started
25-NOV-2019 21:10:20 --> Stage # 1 ASOALL_account - file id : 138
25-NOV-2019 21:10:20 --> Load File and Execute ERP Import for Interface : ASOALL_account
25-NOV-2019 21:10:20 --> Process file : ASOALL_Account.csv
25-NOV-2019 21:10:20 --> Load File and Execute ERP Import for Interface : ASOALL_account
25-NOV-2019 21:10:20 --> Column Separator ; ,
25-NOV-2019 21:10:20 --> Column Enclosed By : "
25-NOV-2019 21:10:20 --> Status : S - Message :
25-NOV-2019 21:10:20 --> Lines : 4
25-NOV-2019 21:10:20 --> Columns Count : 15
134
25-NOV-2019 21:10:21 --> Transfer Complete.
25-NOV-2019 21:10:21 --> Task status : Success
25-NOV-2019 21:10:21 --> Task 244654 Completed Successfully
Module: ERP
Action: upload_file
This API will upload local metadata file for a given ERP Import interface and return Task
ID which can be monitored for its status.
URL Construct: http(s)://<EPMWARE_URL>/service/api/erp/upload_file
REST API Parameters:
This call will return TASK_ID in return. User will use this TASK_ID to probe its status.
API structure:
curl http://<EPMWARE_URL>/service/api/erp/upload_file -H “authorization:
Token <TOKEN>” -H "content-type: multipart/form-data;" -F
file=@"<FILE_WITH_PATH>" -F name="<ERP_IMPORT_NAME>" -F
'delimiter_char=<COLUMN_DELIM_CHAR>' -F
'enclosing_char=<COLUMNS_ENCLOSED_BY_CHAR>'
Example:
curl http://demo.epmwarecloud.com/service/api/erp/upload_file -H
“authorization: Token 15388ad5-c9af-4cf3-af47-8021c1ab3fb7” -H "content-
Parameter Code Value Example
Name ERP Import configuration Name ASOALL_Account
delimiter_char File Delimiter character , (comma)
enclosing_char Fields enclosed by character “ (Double Quote)
135
type: multipart/form-data;" -F file=@"c:\test\ASOALL_Account.csv" -F
name="ASOALL_Account" -F 'delimiter_char=,' -F 'enclosing_char="'
Response : It is in JSON format
{"message":"Task Submitted Succesfully.","status":"S","taskId":"244659"}
Action: run
This action allows the user to run ERP Import interface task on demand. ERP Import
must be configured with “One Time Schedule” type in advance before calling this API.
Also, ERP Import Service must be running otherwise this API will return Error.
URL Construct: http(s)://<EPMWARE_URL>/service/api/erp/run
Parameters
This call will return TASK_ID in return. User will use this TASK_ID to probe its status.
API structure:
curl POST http://<EPMWARE_URL>/service/api/erp/run -H “authorization:
Token <TOKEN>” -H "content-type: application/json" -d '{ "name" :
"<ERP_IMPORT_NAME>", "timeout_min" : <WAIT_MINUTES>}'
Example
curl POST
http://demo.epmwarecloud.com/service/api/erp/upload_file -H
“authorization: Token 15388ad5-c9af-4cf3-af47-8021c1ab3fb7” -H
"content-type: application/json " application/json -d '{"name" :
"ASOALL_Account","timeout_min" : 60}'
Parameter Code Value Example
name ERP Import configuration Name ASOALL_Account
timeout_min # of minutes to wait for the
execution to complete
60 (Default)
136
Response:
It is in JSON format.
{"message":"Task Submitted Succesfully.","status":"S","taskId":"244659"}
Module: Deployment
Action: run
This action allows user to Deployment task on demand. Deployment must be configured
with “One Time Schedule” type in advance before calling this API. Also, “Deployment”
Service must be running otherwise this API will return Error.
URL Construct: http(s)://<EPMWARE_URL>/service/api/deployment/run
Parameters
This call will return TASK_ID in return. User will use this TASK_ID to probe its status.
Example:
curl POST http://demo.epmwarecloud.com/service/api/deployment/run
-H “authorization: Token 15388ad5-c9af-4cf3-af47-8021c1ab3fb7” -H
"content-type: application/json " application/json -d '{"name" :
"ASOALL","timeout_min" : 60}'
Response:
It is in JSON format.
{"status":"S","taskId":"244596"}
Parameter Code Value Example
Name Deployment Name “ASOALL”
timeout_min # of minutes to wait for the
execution to complete
60 (Default)
137