Documentation Guides
EPMware provides comprehensive documentation across seven main guides, each tailored for specific user roles and use cases.
Quick Start Guide
The Quick Start Guide provides high-level steps to rapidly deploy and configure your first EPMware application, perfect for getting started quickly.
Key Topics Covered: - Adding target application servers - Creating EPMware applications - Changing default Admin user security - Updating global settings (Email, Application, UDF) - Starting essential services - Creating workflows - Creating deployments
Target Audience: - New EPMware Users - System Administrators (Initial Setup) - POC/Trial Users - Teams needing rapid deployment
Administrator's Guide
The Administrator's Guide is essential for system administrators responsible for EPMware configuration, management, and maintenance.
Key Topics Covered: - System configuration - Security setup and user management - Application and dimension configuration - Workflow administration - System maintenance and troubleshooting - Performance optimization - Backup and recovery procedures
Target Audience: - System Administrators - IT Managers - Database Administrators - Security Administrators
User Guide
The User Guide provides end users with detailed instructions on using EPMware for daily metadata management tasks.
Key Topics Covered: - EPMware navigation and interface - Working with hierarchies and members - Managing properties and attributes - Creating and submitting requests - Running reports and analytics - Import/Export operations - Collaboration features
Target Audience: - Business Users - Data Stewards - Business Analysts - Department Managers
Logic Builder Guide
The Logic Builder Guide is designed for developers and technical users who need to extend EPMware functionality through custom scripts.
Key Topics Covered: - Logic script development - PL/SQL programming in EPMware - Event-driven architecture - API reference and usage - Custom workflow development - Integration patterns - Debugging and troubleshooting
Target Audience: - Developers - Technical Consultants - System Integrators - Advanced Administrators
Agent Installation Guide
The Agent Installation Guide provides detailed instructions for installing and configuring EPMware On-Premise Agents to enable integration between EPMware Cloud and on-premise target applications.
Key Topics Covered: - Agent architecture and requirements - Cygwin installation for Windows servers - Agent installation and configuration - REST API token management - Application-specific setup (HFM, Planning, PCMCS) - EPM Automate configuration - Scheduled task configuration - Troubleshooting and log analysis
Target Audience: - Infrastructure Engineers - System Administrators - Integration Specialists - Cloud Architects
REST API Guide
The REST API Guide provides comprehensive documentation for EPMware's RESTful API, enabling developers to programmatically interact with EPMware and build custom integrations.
Key Topics Covered: - API authentication and token management - Complete endpoint reference - Request/Response formats and examples - Data models and schemas - Pagination and filtering - Rate limiting and best practices - Error handling and status codes - Integration patterns and use cases
Target Audience: - API Developers - Integration Engineers - DevOps Teams - Automation Specialists
On-Premise Installation Guide
The On-Premise Installation Guide provides detailed instructions for installing EPMware components in your own data center, including database setup, application server configuration, and integration with target applications.
Key Topics Covered: - Hardware and software requirements - Oracle database installation and configuration - Tablespace and schema creation - Database object installation - Apache Tomcat installation and configuration - EPMware application deployment - JDBC properties configuration - Application-specific tasks (HFM, Planning, PCMCS) - Cygwin installation for Windows servers - Environment variable configuration
Target Audience: - Infrastructure Engineers - Database Administrators - System Administrators - IT Operations Teams
Open On-Premise Installation Guide
Quick Navigation Matrix
| Task | Quick Start | Administrator's Guide | User Guide | Logic Builder Guide | Agent Installation Guide | REST API Guide | On-Premise Install |
|---|---|---|---|---|---|---|---|
| Initial Setup | ✅ Primary | ✅ Configuration | ✅ Reference | - | ✅ Agent Setup | ✅ API Setup | ✅ Detailed |
| Database Setup | ✅ Overview | ✅ Reference | - | - | - | - | ✅ Primary |
| Application Server | ✅ Overview | ✅ Configuration | - | - | - | - | ✅ Primary |
| User Management | ✅ Basic | ✅ Primary | - | - | - | ✅ API Calls | - |
| Hierarchy Operations | - | ✅ Setup | ✅ Primary | ✅ Automation | - | ✅ API Endpoints | - |
| Property Management | - | ✅ Configuration | ✅ Primary | ✅ Validation | - | ✅ API Operations | - |
| Workflow Configuration | ✅ Basic | ✅ Primary | ✅ Usage | ✅ Customization | - | ✅ Automation | - |
| Custom Logic | - | - | - | ✅ Primary | - | - | - |
| Reporting | - | ✅ Setup | ✅ Primary | - | - | ✅ Data Retrieval | - |
| Troubleshooting | - | ✅ System | ✅ User Issues | ✅ Scripts | ✅ Agent Issues | ✅ API Errors | ✅ Installation |
| API Integration | - | ✅ Configuration | - | ✅ Primary | ✅ REST API | ✅ Primary | - |
| Security | ✅ Basic | ✅ Primary | ✅ Understanding | ✅ API Access | ✅ Token Management | ✅ Authentication | ✅ DB Security |
| Cloud Integration | - | ✅ Configuration | - | - | ✅ Primary | ✅ Cloud APIs | - |
| On-Premise Setup | - | ✅ Reference | - | - | ✅ Agent Setup | - | ✅ Primary |
| Automation | - | ✅ Scheduling | - | ✅ Scripts | - | ✅ Primary | - |
Learning Paths
For Quick Start Users
- Start with the Quick Start Guide - Overview
- Add target application server
- Create your first EPMware application
- Configure basic security
- Start essential services
- Create your first workflow
For Infrastructure Teams
- Start with the On-Premise Installation Guide - Prerequisites
- Install and configure Oracle database
- Set up Apache Tomcat application server
- Deploy EPMware application
- Configure application-specific integrations
For New Users
- Optionally review the Quick Start Guide for rapid overview
- Start with the User Guide - Getting Started section
- Learn basic navigation and hierarchy management
- Practice with property management
- Understand the request and workflow process
For Administrators
- Complete Quick Start Guide for initial setup
- Complete On-Premise Installation if applicable
- Review Administrator's Guide - Configuration
- Configure security and user access
- Set up applications and dimensions
- Learn maintenance procedures
For Developers
- Review Logic Builder Guide - Getting Started
- Understand the script structure and events
- Learn the API reference
- Practice with example scripts
For Integration Engineers
- Install EPMware using On-Premise Installation Guide
- Follow Agent Installation Guide - Prerequisites
- Install and configure the agent on target servers
- Set up application-specific configurations
- Configure scheduled tasks for continuous operation
- Test connectivity and monitor logs
For API Developers
- Begin with REST API Guide - Authentication
- Understand the API architecture and endpoints
- Learn request/response formats
- Practice with API testing tools
- Implement error handling and retry logic
- Build automated integrations
Documentation Standards
All EPMware documentation follows these standards:
- Consistent Structure - Each guide follows a logical progression from basic to advanced topics
- Visual Examples - Screenshots and diagrams illustrate key concepts
- Code Examples - Working examples with detailed explanations
- Best Practices - Industry-standard recommendations throughout
- Cross-References - Links between related topics across guides
- Version Specific - Documentation matches the current EPMware version
Feedback and Updates
We continuously improve our documentation based on user feedback. If you have suggestions or find any issues:
- Email: support@epmware.com
- Include the guide name and page/section
- Describe the issue or suggestion clearly
- Screenshots are helpful for reporting issues
Documentation Search
Use the search feature (🔍) in each guide to quickly find specific topics. The search indexes all content including code examples and API references.