Deployment¶

The Deployment module manages the automated deployment of approved metadata changes to target applications. It provides centralized control over when and how metadata is deployed, with comprehensive monitoring, scheduling, and multi-environment support.

Deployment module showing Manager, Monitor, and Schedule tabs

Overview¶

The Deployment module consists of three integrated components:

Deployment Manager - Create and configure deployment definitions
Deployment Monitor - Track deployment execution and status
Deployment Schedule - View and manage scheduled deployments

Key capabilities include:

Direct deployment to target applications
File-based deployment for manual processing
Interface table deployment for integrations
Pre and post-deployment scripting
Comprehensive email notifications

Quick Links¶

⚙️ Manager

Configure deployment types, scripts, and notifications

Manage Deployments →

📊 Monitor

Track deployment status and view logs

Monitor Status →

📅 Schedule

Configure automated deployment timing

Set Schedule →

🔄 Redeployment

Handle failed deployments and retries

Learn More →

Deployment Manager¶

Deployment Manager creates and manages deployment configurations that determine what, when, and how metadata is deployed.

Deployment Manager showing configured deployments

Deployment Components¶

Component	Description	Options
Name	Deployment identifier	User-defined
Description	Deployment purpose	Optional text
Type	Deployment scope	Application, Workflow, Request
Pre-Deployment Scripts	Scripts run before deployment	Logic Builder scripts
Post-Deployment Scripts	Scripts run after deployment	Logic Builder scripts
Email Templates	Success/error notifications	From Email Templates
Attachments	Files to include	Deployment files, logs
Environment	Target environment	Multi-environment only

Deployment Types¶

Application Deployment¶

Deploys all approved requests for an entire application: - Processes all pending requests - Batches changes together - Most efficient for regular updates - Typically scheduled

Workflow Deployment¶

Deploys approved requests from specific workflows: - Workflow-specific processing - Useful for different SLAs - Segregates by business process - Can have different schedules

Request Deployment¶

Deploys individual or grouped requests: - Selective deployment - Emergency changes - Failed request redeployment - Manual control

Creating Deployments¶

Add Deployment configuration dialog

Navigate to Deployment → Manager
Click the + icon
Configure deployment:
Click Save

Field	Required	Description
Deployment Name	Yes	Unique identifier
Description	No	Deployment purpose
Deployment Type	Yes	Application/Workflow/Request
Pre-Deployment Script	No	Logic Builder script to run before
Post-Deployment Script	No	Logic Builder script to run after
Email on Success	No	Success notification template
Email on Error	No	Error notification template
Attach Deployment Files	No	Include metadata files
Attach Log Files	No	Include execution logs
Enabled	Yes	Activate deployment
Environment	Conditional	For multi-environment setups

Example: Production Application Deployment¶

Name: PROD_HFM_Daily
Description: Daily HFM production deployment
Type: Application
Pre-Deployment Script: BACKUP_HFM_METADATA
Post-Deployment Script: REFRESH_ESSBASE_CALC
Email on Success: DEP_Success_Summary
Email on Error: DEP_Failed_Alert
Attach Deployment Files: ✓
Attach Log Files: ✓
Enabled: ✓

Editing Deployments¶

Deployment Properties edit dialog

Right-click on deployment row
Select Edit Properties
Modify configuration
Click Save

Request-Based Deployment¶

For selective or failed request redeployment:

Create Request-type deployment
Click Save
Click "Requests" link in grid
Select Ready for Deployment radio button
Choose specific requests
Click Save
Schedule deployment

Request selection for targeted deployment

Deployment Schedule¶

Configure when deployments execute automatically.

Schedule Deployment configuration options

Schedule Types¶

Auto (Immediate)¶

Deploys as soon as requests are ready: - Real-time processing - No delay - Best for urgent changes - Continuous monitoring

Daily¶

Runs at specified time each day:

Daily schedule configuration

Frequency: Daily
Time: 11:00 PM
Days: All days

Weekly¶

Runs on selected days of the week:

Weekly schedule with day selection

Frequency: Weekly
Days: Monday, Wednesday, Friday
Time: 10:00 PM

Monthly¶

Runs on specific day each month:

Monthly schedule configuration

Frequency: Monthly
Day: Last day of month
Time: 11:30 PM

One Time¶

Single execution at specified datetime:

One-time schedule configuration

Frequency: One Time
Date: 12/31/2024
Time: 11:59 PM

Hourly¶

Runs every specified number of hours:

Hourly schedule interval

Frequency: Hourly
Interval: Every 4 hours
Starting: 8:00 AM

By Minutes¶

Runs at minute intervals:

Minute-based schedule

Frequency: By Minutes
Interval: Every 15 minutes

Scheduling Process¶

Click schedule icon (📅) for deployment
Select schedule type
Configure parameters
Click Save

Schedule Best Practices

Production: Daily during maintenance window
UAT: Hourly or by minutes for testing
Development: Auto for immediate feedback

Deployment Monitor¶

Monitor deployment execution status and access logs.

Deployment Monitor showing execution history

Monitor Grid Columns¶

Column	Description	Information
Deployment Id	Unique execution ID	Click for details
Name	Deployment name	From Manager tab
Application	Application Name	App name
Start Time	Deployment start time	Timestamp
End Time	Deployment completion Time	Timestamp
Status	Deployment Status	Running/Completed/Pending
Message	Deployment message such as request id or error messgae	Deployment message
File	Download Deployment Files	Click for download
Log	Execution log	Click to view

Grid Controls¶

Filter¶

Filter deployments by criteria:

Deployment search and filter options

Date range
Deployment IDs / Range
Deployment Status
Deployment name
Application
Dimension
Request ID

Auto Refresh¶

Enable automatic grid updates:

Updates every 60 seconds (configurable)
Shows real-time status
Useful during deployments

Deployment Status Details¶

Click on Deployment ID to view detailed status:

Deployment Status showing request details

Column	Description
Request ID	Request identifier
Description	Request Description
Start/End Time	Processing times
Status	Deployment result

Status Icons¶

Icon	Status	Description
✅	Completed	Successfully deployed
❗	Pending	Awaiting action
⚠️	Partial	Some items failed
❌	Failed	Deployment failed
⚙️	Running	Currently executing

Redeployment¶

Handle failed or partial deployments through redeployment.

Redeployment Options¶

Full Deployment Retry¶

Redeploy all failed requests in a deployment:

Right-click on deployment row in Monitor
Select Redeploy
Failed requests return to deployment pool
Wait for next scheduled run

Individual Request Retry¶

Redeploy specific failed requests:

Click Deployment ID in Monitor
Right-click on failed request
Select Redeploy
Request queued for next run

Redeployment Behavior

Redeployed requests are added to the deployment pool and processed during the next scheduled execution.

Handling Partial Deployments¶

When deployment status shows Partial:

Identify Failed Items:
Click Deployment ID
Review failed request lines
Note error messages
Resolution Options:
Fix data issues and redeploy
Cancel failed lines
Manually close deployment
Prevention:
Add validation stages
Improve pre-deployment scripts
Test in lower environments

Deployment Schedule Tab¶

View all scheduled deployments in one place.

Deployment Schedule showing upcoming executions

Schedule Grid Information¶

Column	Description
Name	Deployment name
Description	Deployment purpose
Next Deployment Date	Next execution time
Frequency	Schedule type
Type	Deployment type

Managing Schedules¶

Modify: Change via Manager tab
Disable: Uncheck enabled in Manager
View History: Check Monitor tab
Upcoming: Sort by next deployment date

Best Practices¶

1. Deployment Strategy¶

Batch Similar Changes - Group related updates
Off-Peak Scheduling - Deploy during maintenance windows
Environment Progression - DEV → UAT → PROD
Backup First - Always backup before deployment
Test Scripts - Validate pre/post scripts

2. Schedule Optimization¶

Production - Daily at 11 PM or later
UAT - Multiple times daily
Development - Auto or frequent
Emergency - One-time deployments
Batch Size - Limit requests per deployment

3. Monitoring¶

Enable Auto-Refresh - During deployments
Check Logs - Review for warnings
Track Patterns - Identify recurring issues
Set Alerts - Email on failures
Archive Logs - Maintain history

4. Error Handling¶

Immediate Notification - Email on error
Log Attachment - Include in notifications
Redeploy Strategy - Define retry approach
Root Cause Analysis - Track failure patterns
Rollback Plans - Document procedures

Troubleshooting¶

Common Issues¶

Issue	Cause	Solution
Deployment not running	Not scheduled or disabled	Check schedule and enabled status
Stuck in Running	Timeout or system issue	Check logs, restart service
Partial deployment	Some requests failed	Review errors, redeploy failed
No requests found	Wrong type or filter	Verify deployment type configuration
Email not sent	Template not configured	Check email template assignment
Script error	Logic Builder issue	Debug script independently
Wrong environment	Mapping incorrect	Verify environment configuration

Deployment Logs¶

Access detailed logs:

Click log icon in Monitor grid
Review for:
- Error messages
- Warning indicators
- Processing times
- Request details

Service Management¶

Check deployment service:

Navigate to Administration → Services
Verify Deployment Service status
Start/stop as needed
Check service interval settings

Performance Tuning¶

Optimize deployment performance:

Global Settings → Application Settings:
- Maximum # of Minutes for Deployment: 180
- Deployment Service Sleep Interval: 5
- File Size Limits: Adjust as needed

Integration Points¶

Workflow Integration¶

Deploy stages in workflows: - Create deploy task - Assign to deploy stage - Configure environment - Link to deployment

Email Templates¶

Deployment notifications: - Success templates - Error templates - Custom variables - Table insertions

Logic Builder¶

Pre/post scripts: - Validation logic - Backup procedures - System integration - Custom processing

Multi-Environment¶

Environment configuration: - Infrastructure setup - Application mapping - Deployment order - Shell applications

Workflow Builder - Configure deploy stages
Email Templates - Deployment notifications
Logic Builder - Pre/post scripts
Infrastructure - Environment setup
Global Settings - Timeout and interval configuration
Services - Deployment service management