Developing Ensemble Productions
[Home]  [Next]
InterSystems: The power behind what matters   
Class Reference   

Preface : 
Chapter 1: 
  1.1 Environmental Considerations
1.1.1 Ensemble-enabled Namespaces
1.1.2 Web Application Requirement
1.1.3 Reserved Package Names
1.2 A Look at a Production Definition
1.3 Development Tools and Tasks
1.3.1 Portal Tasks
1.3.2 Studio Tasks
1.4 Available Specialized Classes
1.5 Using Studio in Ensemble
1.5.1 Ensemble Features in Studio
1.5.2 Exporting and Importing Productions
1.5.3 Notes on Editing the Production Class
Chapter 2: 
  2.1 Introduction
2.2 Key Principles
2.3 Passing Values by Reference or as Output
2.3.1 Typical Callback Method
2.3.2 Typical Helper Method
2.4 Adding and Removing Settings
2.5 Specifying Categories and Controls for Settings
2.5.1 Category for a Setting
2.5.2 Control for a Setting
2.6 Specifying Default Values for Settings
2.7 Accessing Properties and Methods from a Business Host
2.8 Accessing Production Settings
2.9 Choosing How to Send Messages
2.9.1 Synchronous and Asynchronous Sending
2.9.2 Deferred Sending
2.10 Generating Event Log Entries
2.10.1 Generating Event Log Entries in ObjectScript
2.10.2 Generating Event Log Entries in Basic
2.11 Generating Alerts
2.12 Adding Trace Elements
2.12.1 Writing Trace Messages in ObjectScript
2.12.2 Writing Trace Messages in Basic
2.12.3 Writing Trace Messages in BPL or DTL
Chapter 3: 
  3.1 Introduction
3.2 Creating a Simple Message Body Class
3.3 Creating a Complex Message Body Class
Chapter 4: 
  4.1 Introduction
4.2 Key Principles
4.3 Defining a Business Service Class
4.4 Implementing the OnProcessInput() Method
4.5 Sending Request Messages
4.5.1 Using the SendRequestSync() Method
4.5.2 Using the SendRequestAsync() Method
4.5.3 Using the SendDeferredResponse() Method
4.6 Processing Only One Event Per Call Interval
Chapter 5: 
  5.1 Introduction
5.2 Comparison of Business Logic Tools
5.3 Key Principles
5.4 Defining BPL Business Processes
5.5 Defining Custom Business Processes
5.5.1 Implementing the OnRequest() Method
5.5.2 Implementing the OnResponse() Method
5.5.3 Methods to Use in OnRequest() and OnResponse()
Chapter 6: 
  6.1 Introduction
6.2 Key Principles
6.3 Defining a Business Operation Class
6.4 Defining a Message Map
6.5 Defining Message Handler Methods
6.6 Business Operation Properties
6.7 Sending Requests to Targets within the Production
6.7.1 The DeferResponse() Method
6.8 Suspending Messages
Chapter 7: 
  7.1 Background Information
7.2 Using a Simple Email Alert Processor
7.3 Using a Simple Outbound Adapter Alert Processor
7.4 Using a Routing Alert Processor
7.4.1 Defining the Alert Processor as a Routing Process
7.4.2 Defining the Business Operations
7.5 Adding Custom Code to Alert Management
7.5.1 Alert Manager
7.5.2 Notification Manager
7.5.3 Alert Monitor
7.5.4 Notification Operation
Chapter 8: 
  8.1 Introduction
8.2 Defining DTL Transformations
8.3 Defining Custom Transformations
Chapter 9: 
  9.1 Introduction to Ensemble Business Metrics
9.1.1 Business Metric Properties
9.1.2 Single- and Multi-instance Business Metrics
9.1.3 Business Metrics as Business Services
9.2 Defining a Single-instance Business Metric
9.2.1 Defining Simple Business Metric Properties
9.2.2 Defining Business Metric Properties with Autohistory
9.2.3 Specifying Other Parameters for Metric Properties
9.2.4 Assigning Values to Business Metric Properties
9.3 Defining a Multi-instance Business Metric
9.3.1 Defining a Static Set of Instance Names
9.3.2 Defining the Instance Names Dynamically
9.3.3 Assigning Values to Properties in a Multi-instance Metric
9.4 Other Options in Business Metrics
9.4.1 Defining Actions for Use in Dashboards
9.4.2 Implementing OnInit()
9.5 Adding Business Metrics to Dashboards
9.6 Adding Business Metrics to the Production Monitor
9.7 Setting and Getting Values Programmatically
9.7.1 Using the GetMetric() Method
9.7.2 Using the SetMetric() Method
9.8 About the Business Metric Cache
Chapter 10: 
  10.1 Overview
10.2 Defining the Message Bank Server
10.3 Adding a Message Bank Helper Class
10.4 Notes about the Message Bank
Chapter 11: 
  11.1 Overview
11.2 Creating and Editing a Record Map
11.2.1 Introduction
11.2.2 Getting Started
11.2.3 Common Control Characters
11.2.4 Editing the Record Map Properties
11.2.5 Editing the Record Map Fields and Composites
11.3 Using the CSV Record Wizard
11.4 Record Map Class Structure
11.5 Object Model for the RecordMap Structure
11.6 Using a Record Map in a Production
11.6.1 Sample Record Mapper Production
Chapter 12: 
  12.1 Overview
12.2 Creating and Editing a Complex Record Map
12.2.1 Getting Started
12.2.2 Editing the Complex Record Map Properties
12.2.3 Editing the Complex Record Map Records and Sequences
12.3 Complex Record Map Class Structure
12.4 Using a Complex Record Map in a Production
Chapter 13: 
Chapter 14: 
  14.1 Defining Custom Utility Functions
14.2 Rendering Connections When the Targets Are Dynamic
14.3 Using Ens.Director to Start and Stop a Production
14.4 Using Ens.Director to Access Settings
14.5 Invoking a Business Service Directly
14.6 Creating or Subclassing Inbound Adapters
14.6.1 Introduction to Inbound Adapters
14.6.2 Defining an Inbound Adapter
14.6.3 Implementing the OnTask() Method
14.7 Creating or Subclassing Outbound Adapters
14.7.1 Introduction to Outbound Adapters
14.7.2 Defining an Outbound Adapter
14.8 Including Credentials in an Adapter Class
14.9 Overriding Ensemble Credentials
14.10 Overriding Start and Stop Behavior
14.10.1 Callbacks in the Production Class
14.10.2 Callbacks in Business Host Classes
14.10.3 Callbacks in Adapter Classes
14.11 Programmatically Working with Lookup Tables
14.12 Defining a Custom Archive Manager
Chapter 15: 
  15.1 Correcting Production Problem States
15.1.1 Recovering a Suspended Production
15.1.2 Recovering a Troubled Production
15.2 Testing from the Management Portal
15.2.1 Using the Testing Service
15.3 Debugging Production Code
15.4 Enabling %ETN Logging
Chapter 16: 
  16.1 Overview of Deploying a Production
16.2 Exporting a Production
16.3 Deploying a Production on a Target System
Appendix A: 
  A.1 Life Cycle of a Production
A.1.1 Production Startup
A.1.2 Production Shutdown
A.2 Life Cycle of a Business Service and Adapter
A.2.1 Production Startup
A.2.2 Runtime
A.2.3 Production Shutdown
A.3 Life Cycle of a Business Process
A.3.1 Life Cycle in the Public Queue
A.3.2 Life Cycle in a Private Queue
A.4 Life Cycle of a Business Operation and Adapter
A.4.1 Production Startup
A.4.2 Runtime
A.4.3 Production Shutdown