Testing

Reuters Enterprise Platform
REUTERS ENTERPRISE PLATFORM (REP)
Reuters Enterprise Integration Engine (REIE) Reference Manual

Version 1.2.0
REP120REEIE.090 Date of Issue: 12 August 2009
Thomson Reuters 2009. All Rights Reserved. Thomson Reuters, by publishing this document, does not guarantee that any information contained herein is and will remain accurate or that use of the information will ensure correct and faultless operation of the relevant service or equipment. Thomson Reuters, its agents and employees, shall not be held liable to or through any user for any loss or damage whatsoever resulting from reliance on the information contained herein. This document contains information proprietary to Thomson Reuters and may not be reproduced, disclosed, or used in whole or part without the express written permission of Thomson Reuters. Any Software, including but not limited to, the code, screen, structure, sequence, and organization thereof, and Documentation are protected by national copyright laws and international treaty provisions. This manual is subject to U.S. and other national export regulations. Nothing in this document is intended, nor does it, alter the legal obligations, responsibilities or relationship between yourself and Thomson Reuters as set out in the contract existing between us.
Page ii
REP 1.2.0 - REIE Reference Manual REP120REEIE.090
Contents
Chapter 1: Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Common Terms and Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Logging In to REIE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 The System Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Signing Out of REIE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Closing REIE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
REIE Ribbon Bars and Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Home and Environment Ribbon Bars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Home Ribbon Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Environment Ribbon Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Minimizing the Ribbon Bars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Working with Multiple Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Working with Multiple Tab Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Quick Action Ribbon Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Refreshing the Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Selecting Items from a List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Ordering Elements on a Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Searching for Items in Long Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Displaying REIE Version and Release Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 2: Creating and Configuring the Environment and Areas . . . . . . . . . . . . . . . . .15

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Environment and Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Using Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Creating the Environment and Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Creating the Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Creating Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Assigning Services to an Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Deployment Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Assigning a Deployment Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Restarting and Stopping Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Page iii
Chapter 1 ChapterTitle
Restarting a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Stopping a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Changing the Application Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Changing te Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Chapter 3: Managing Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

About Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 About Business Transaction Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 About Adapter Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 About Routing Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Exporting Event Details to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Adding Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Adding a Business Transaction Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Adding an Adapter Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Adding a Routing Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Adding a Routing Event from the Message Type Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Adding a Routing Event from the Add/Edit Event Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Chapter 4: Managing Business Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
In this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 About Business Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Calling Business Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Designing Business Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

About the Business Transaction Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Selecting from the Element Toolbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Editing Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Executing Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Standard Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Chapter 5: Managing Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
In This Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 About Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Using Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Viewing Available Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Setting Up a New Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Editing Calendar Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Page iv
Deleting a Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Chapter 6: Managing Technology Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
In This Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 About Technology Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Types of Technology Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Receiver Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Sender Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Interceptor Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Configuring Technology Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Configuration Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Configuration Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Receiver Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Sender Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Interceptor Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Adding and Removing Adapter Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Using Property Configuration Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Adding Adapter Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Removing Adapter Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Property Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Chapter 7: Using Message Analysis and Schema Management . . . . . . . . . . . . . . . . . . .65

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
In This Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Using Message Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Using Schema Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Displaying the Schema List Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Using the Schema Information pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Using the View pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Using the Properties pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Creating a New Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Chapter 8: Managing Datasets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73

Viewing Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Registering Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Unregistering Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Page v
Chapter 9: Managing Applications, Message Types and Subscriptions . . . . . . . . . . . . .77

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
About Message Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 About this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
About Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Application Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
About Message Types and Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 The Message Types Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Creating a New Message Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Editing an Existing Message Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Deleting a Message Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Managing Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Viewing Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Creating a New Namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Editing a Namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Deleting a Namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Other Actions from the Namespaces Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Managing Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Adding a Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Chapter 10: Managing Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
About Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 About this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Understanding Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Environment and Area Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Local Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Restriction on Use of Tokenizing Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Defining Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Defining and Environment or Area Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Using Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Searching for Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Using Variables in Adapter Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Using Variables in Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Using Variables in Journal Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Page vi
Using Variables in Application Configuration Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Chapter 11: Using Data Analytics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
About Data Analytics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 About this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Data Analytics Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Displaying the Data Analytics Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Viewing Data Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Viewing Dashboard Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Viewing the Dashboard Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Using the Toggle Output Console and Refresh Toolbar buttons . . . . . . . . . . . . . . . . . . . . . . . . . 107
Data Part Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Displaying the Data Part List Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Previewing an Existing Data Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Creating a Data Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
About the Query Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Using the Query Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Specifying a Series for a Data Part Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Data Part Series - Mandatory Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Specifying a Filter for a Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Using functions and expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Chapter 12: Embedded Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
About Embedded Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 About this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Using Embedded Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 Accessing Embedded Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 Embedding a New Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 Downloading an Existing Embedded Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Adding an Embedded Resource by Using the Value Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Chapter 13: Managing Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
About Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 About this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Page vii
Using the Process Management Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Displaying the Process Management Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Adding a New Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Creating a New Aggregated Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Editing an Existing Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Changing the Events in a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Changing the Documents Assigned to a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Running a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Forcing a Process to End . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Deleting a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Tracking Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Launching the Process Instance Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 The View Process Instance Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Filter Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Process Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Document Content Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Searching for a Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Searching by Date Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Searching by Instance ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Searching by Process Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Refreshing the Process Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Chapter 14: Managing Process Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
About Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 About this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
The Document Management Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 Displaying the Document Management Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Viewing and Editing a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Saving a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Creating a New Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Specifying the Document Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Selecting shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Positioning a Shape or a Group of Shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Resizing a Shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Connecting Shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Deleting a Shape or a Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Customizing the Properties of a Shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Adding Text to a Shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Page viii
Associating a Shape with an Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Associating a Shape with a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Associating a Shape with a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Rotating a Shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Changing a Color Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Displaying Items in the Properties Panel Alphabetically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Viewing Your Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Other Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Updating Document Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Deleting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Exporting and Importing Document Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Chapter 15: Managing Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
About Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 About this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
The View Jobs Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Displaying the View Jobs Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Fields on the View Jobs screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Searching for Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Carrying out a Basic Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Searching by Date Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Searching by Event Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Carrying out an Advanced Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Resending a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Viewing Job Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 Viewing the Log Messages for a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 Updating Event Status for a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 Acknowledging a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Viewing Journal Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 Configuring the SQL Database Journal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Chapter 16: Managing Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
About the Loggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 About this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Using the Loggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 Managing the Loggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 Displaying the Loggers Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 Setting the Logging Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Page ix
Deactivating the Loggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 Setting the Timeout Value for MS SQL Database Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Viewing Log Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Viewing Log Messages from the View Log Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Displaying the View Log screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 Fields on the View Log Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 Symbols on the View Log Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 Moving from One Log Page to Another . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Searching the Log Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Searching for Log Messages by GUID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Searching for Log Messages by XML Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Searching for Log Messages by Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 Searching for Log Messages by Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Saving Log Messages to an Excel Spreadsheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 Viewing Log Messages from the Event Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Chapter 17: Importing and Exporting Configuration Data . . . . . . . . . . . . . . . . . . . . . . .185

About Importing and Exporting the Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 About this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Importing Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

Importing a Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Logical Structure of Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Configuration Import Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Resolving Conflicts on Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Exporting a Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Chapter 18: System Administration Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .195

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
About System Administration Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 About this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
About Access Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

Types of Access Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 Allocating Access Items to Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 Administrator Access Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Rules Relating to Access Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

User Permission Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 General Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Assigning Access Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Custom Security Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Creating and Managing User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Page x
Displaying the View Users Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Creating a New User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 Editing an Existing User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Assigning Access Items to a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Deleting User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Creating and Managing Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 Displaying the View Groups Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 Creating a New Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Editing a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 Assigning Users to a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 Deleting a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Appendix A: Adapter Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211

Receiver Adapter Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
EMS Receiver Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 File Receiver Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 FTP Receiver Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 HTTP Receiver Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 MQSeries Receiver Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 MS SQL Receiver Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 MSMQ Receiver Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 Oracle Receiver Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 Rendezvous Receiver Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 Replay Receiver Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 Scheduler Event Execution Receiver Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 SFTP Receiver Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Sender Adapter Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

EMS Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 File Move Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 File Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 FTP Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 MQSeries Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 MS SQL Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 MSMQ Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Null Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Oracle Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 Rendezvous Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 Router Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 Scheduler Event Execution Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 SFTP Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 SMTP Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Page xi
Text Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 TX Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 XML Sender Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Zip Sender Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Interceptor Adapter Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Command-line Interceptor Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 Duplicate Check Interceptor Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 MSMQ Interceptor Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 Sql-Value-to-Property Interceptor Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 Text-replace Interceptor Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 TX Interceptor Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 Validation Interceptor Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 XML Schema Interceptor Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 XML Tools Interceptor Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 XSLT Interceptor Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 Zip Interceptor Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Appendix B: Tokens. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239 Appendix C: Element Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241 Appendix D: Adapter Configuration Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245
Receiver Adapter Configuration Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
EMS Receiver Configuration Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 File Receiver Configuration Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 FTP Receiver Configuration Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 Rendezvous Receiver Configuration Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Sender Adapter Configuration Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

EMS Sender Configuration Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 File Sender Configuration Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 FTP Sender Configuration Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250 Rendezvous Sender Configuration Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Interceptor Adapter Configuration Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Validation Interceptor Configuration Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Page xii
Introduction
About This Manual

Purpose This Reference Manual provides the following information: An introduction to REIE An overview of the main components of REIE and how you can configure them to receive data, process it and route or send the data to its correct destination How to start and stop REIE and how to navigate around the screens How to create and configure the REIE environment Explanations of: The different types of events and how to create them Business transactions and how to build them The different types of adapters and how to configure them for use in events Message analysis and subscriptions
How to create calendars and use them to schedule activity How to use message types to define the way in which a file is manipulated and routed The different types of variable used by REIE and how to define your own variables How to chain events together to form processes and ensure that the processes run in the correct sequence to achieve the required business results How to create aggregated processes How to create documents to give a visual representation of the function of normal and aggregated processes How to manage the job messages that are optionally generated each time an event is run How logging works in REIE How to import and export an entire configuration or individual configuration entities How to carry out the system administration functions of managing users and user access rights
This manual has four appendices: Appendix A describes each adapter configuration property and gives an example. Appendix B lists all the available tokens and their values. Appendix C comprises definitions of the main REIE elements Appendix D describes sample adapter settings.
Page 1
Chapter 1 Introduction
Common Terms and Abbreviations
This manual uses the following terminology convention throughout: <root drive>: The installation drive; i.e., the drive on which you installed or configured the application software. Feed: A proprietary channel over which the REP receives market data Universe: The set of all securities and associated data being managed by RRDS GUI: Graphical user interface KB: Kilobyte(s) REIE: Reuters Enterprise Integration Engine REP: Reuters Enterprise Platform RRDS: Reuters Reference Data System DACS: Data Access Control System
Related Documentation
This Reference Manual is one of a series of manuals describing the architecture and use of REP. For further information refer to the following manuals: Feed Handler Administration Guide Feed Handler Operations Guide REP Installation Guide REP System Architecture and Product Overview Guide Reuters Enterprise Integration Engine Installation Guide REP Getting Started Guide REP Common User Guide Reuters Reference Data System (RRDS) System Administration Guide RRDS User Guide RRDS User Reference Guide
Page 2
Getting Started
Overview This section helps you to orientate yourself within the product. It includes the following topics: How to start and stop REIE The functions of the Home and Environment ribbon bars and how these work together with the Quick Actions ribbon bar How the REIE screens work together
This chapter assumes that you have already installed the product. For information on how to install REIE refer to the REIE Installation Guide. Logging In to REIE This section explains how to log in to REIE. To log in to REIE 1. From the Start menu select Start > All Programs > Thomson Reuters > Reuters Enterprise Platform > REIE Manager. The REIE Login screen is displayed.
2. Enter your user name and password as supplied by your System Administrator. Your password is case-sensitive. 3. Click Sign In. Your user name and password are authenticated.
Note: If you see a message indicating that your sign-on credentials could not be authenticated, check the information provided. Passwords are case sensitive.
Page 3
If the authentication is successful, the Reuters Enterprise Integration Engine opens with a blank screen showing the Home ribbon bar, as shown in the figure below.
The System Menu
The system menu is displayed when you click the sphere symbol in the top left-hand corner of the screen and gives access to the main areas of REIE. The system menu is shown in the figure below.
The functions you will use most often are the final three functions as these are not available elsewhere. For more information, refer to the sections listed below: Sign Out: refer to Signing Out of REIE on page 5. About: refer to Displaying REIE Version and Release Information on page 13.
Page 4
Signing Out of REIE
Exit: refer to Closing REIE on page 5.
To sign out of REIE: 1. Click the sphere image at the top left of the Reuters Enterprise Integration Engine screen. The system menu is displayed. 2. Click Sign Out. The current session of REIE closes immediately. The Login screen is displayed. You can now: Log on to another environment of REIE by selecting a different server location Log on to the same environment using a different user name and password
Warning: All open tabs within REIE are closed. You are not prompted to save your work. You may lose unsaved work if you do not save your work before closing the current session of REIE.
Closing REIE To close REIE: 1. Click the sphere image at the top left of the Reuters Enterprise Integration Engine screen. The system menu is displayed. 2. Click Exit. REIE closes immediately.
Warning: All open tabs within REIE are closed. You are not prompted to save your work. You may lose unsaved work if you do not save your work before closing the current session of REIE.
Page 5
REIE Ribbon Bars and Screens

Overview the following topics explain how to work with the ribbon bars and screens. Ribbons are a convenient way of grouping the items on a ribbon bar by function. When you select an item on a ribbon bar, one of the following happens: A screen is displayed. A menu is displayed. Select a menu item to: Display a screen from which you can carry out one or more functions Carry out a function directly
Note: The actions available within REIE will depend on the permissions that have been configured for your user profile. Some items on the ribbon bars may be unavailable. For example, if you do not have permission to use logs, the Logs item on the Home ribbon bar will be unavailable.
Home and Environment Ribbon Bars
This topic lists the functions available from the Home and Environment ribbon bars. To make the Environment ribbon bar visible: Click the Environment tab. The Environment ribbon bar is brought to the front and you can select the available actions from it. Home Ribbon Bar The Home ribbon bar has four groups: Administration Manage Routing Reporting
The functions available from the Home ribbon bar are listed in the following table.
Item Process Jobs Screen View Process Instances View Jobs Available Actions Search for processes by date and time or by the instance ID View available jobs Search for jobs by date and time when job activity occurred Logs View Log View available log entries Search for log entries by date and time
Table 1: Items on Home Ribbon Bar
Page 6
Item Calendars
Screen View Calendars
Available Actions View available calendars Create new and edit existing calendars Delete calendars Export calendars
Manage Processes Events
Process Management
View available processes Display View Process Detail screen to manage a specific process
Event List
View available events. Display the Event Viewer screen to manage a specific event
Documents
Document Management
View available documents Create new documents Edit documents Remove documents
Users
View Users
View current users Create new users Edit user details Remove users
Groups
View Groups
View current user groups Create new user groups Edit user group details Remove user groups
Adapters > All Adapters Adapters > Receivers Adapters > Senders Adapters > Interceptors Message Types
Adapter List Adapter List Adapter List Adapter List Message Types
View all available adapters View all adapters of type Receiver View all adapters of type Sender View all adapters of type Interceptor View available message types Add new message types Remove message types
Routing > Routes Routing > Namespaces
Event List showing only Routing events Namespaces
Manage routing events View current name spaces Create new name spaces Edit name space details Remove name spaces
Data Analytics Dashboard
Dashboard URL
View Dashboard
Table 1: Items on Home Ribbon Bar (Continued)
Page 7
Environment Ribbon Bar The Environment ribbon bar is available behind the Home ribbon bar. The Environment ribbon bar has three groups: Manage Data Analytics Quick Links
The functions available from the Environment ribbon bar are listed in the following table.
Item Environment Settings > Configuration Screen Configuration Management Available Actions Register and de-register services Assign services to areas Restart services Stop services Environment Settings > Areas Areas Management View current areas Create new areas Edit area details Remove areas Environment Settings > Journals Environment Settings > Loggers Environment Settings > Application Configuration Variables Journals View available journals Display the Edit Journal screen to edit journal configurations Loggers View available loggers Display the Logger Viewer screen to edit logger configurations Application Configuration Sets Variables View and edit the centralised application configuration parameters View current system variables Create new system variables Edit system variables Remove system variables Embedded Resources Embedded Resources View current embedded resources Add new embedded resources Remove embedded resources Business Tx Business Tx Management Create transactions View transactions Control the management services for which the transactions are valid Import transactions Remove transactions Import Import Environment Configuration Wizard Import a configuration file
Table 2: Items on Environment Ribbon Bar
Page 8
Item Export Application Management
Screen Export Environment Configuration Wizard Applications
Available Actions Export your configuration data to a file View current source/destination (TBC) applications Create new source/destination (TBC) applications Delete source/destination (TBC) applications
Schema Management
Schema List
View current schemas Create new schemas Edit existing schemas Remove schemas
Data Store Management Data Part Configuration
Dataset Explorer Data Part List
Register datasets Unregister datasets View all data parts Preview data parts Edit existing data parts Remove data parts
Refresh
Applicable to all screens
Refreshes the current screen
Table 2: Items on Environment Ribbon Bar (Continued) Minimizing the Ribbon Bars To increase the size of your working space, you can hide the buttons on the ribbon bar at any time. To hide the buttons on the ribbon bar 1. Right-click any of the ribbon bar tabs. The prompt Minimise the Ribbon is displayed.
2. Click Minimise the Ribbon. The buttons on the ribbon bars are hidden. You can also redisplay the buttons at any time. To redisplay the buttons on a ribbon bar: Right-click any of the ribbon bar tabs and reclick Minimise the Ribbon. The buttons are redisplayed.
Page 9
Working with Multiple Screens
You can have more than one screen open at any one time. The screens display one on top of another. The title of each screen is shown on a tab. The figure below shows REIE with a number of screens open.
There is no limit on the number of screens you can have open at any one time. If the number of open screens means that the tab bar cannot display all the tabs at once, a Previous and a Next arrow are added to the tab bar to the left of the Close button.
You can also, if required, create groups of screens that are tiled vertically or horizontally.
Note: With some screens, for example View Process or View Logs, you can have more than one instance of the screen open at any one time. With other screens, for example Document Management or the Event Viewer for a particular event, you can have only one instance of the screen open at one time. If you attempt to open another instance of the screen, the currently open instance becomes the active screen.
To bring a screen to the front: Click the screens title tab. The selected screen is brought to the front. If you have a number of screens open at any one time, you may need to close screens to make it clear what event or process you are working on. You can close a screen from the title tab:
Page 10
To close a screen from the title tab: 1. Right-click the title tab of the screen. 2. Select Close from the right-click menu. The screen closes. You can also close a screen from the Close button. To close a screen from the Close button: 1. Click the title tab of the screen. The screen displays at the front and becomes the currently active screen. 2. Click the Close button on the far right of the tab bar. The screen closes. Working with Multiple Tab Groups You can create three or more vertical or horizontal tab groups and move screens between adjacent tab groups if required. The figure below shows three vertical tab groups.
To create a tiled tab group of screens: 1. Right-click a screen title tab. 2. Select the option New Horizontal Tab Group or New Vertical Tab Group as appropriate from the right-click menu. A new tab group is created. The tab groups are tiled vertically or horizontally depending on the option selected. The selected screen is moved to the new tab group. To move a screen to the adjacent tab group: 1. Right-click the screens title tab. 2. Select the option Move to Next Tab Group or Move to Previous Tab Group as appropriate from the right-click menu. The selected screen is moved to the new tab group. Quick Action Ribbon Bar You can select actions from the Quick Actions ribbon bar. If a screen has a Quick Actions ribbon bar, this is always displayed in front of the Home and Environment ribbon bars when the screen is the currently active screen.
Page 11
Refreshing the Screen
Many screens have a Refresh button on the Quick Actions ribbon so that you can always see the latest configuration. The View Calendars and View Logs screens have a Refresh button at the bottom of the screen.
Selecting Items from a List
On a number of screens, including Process Management and the Event List, you will select the item you want to work with from a list. To select an item from a list: Click the item once. The selected item is indicated by a highlight, an arrow symbol and a border.
Ordering Elements on a Screen
You can order elements that are displayed on screens by any field on the screen. To reorder screen elements: 1. On the screen, click any column header. The elements are ordered by the values in that column in alphabetical order or numerically from lowest to highest. 2. Click the column header a second time to reverse the message order.
Searching for Items in Long Lists
To enable you to search for particular entities in a long list, many screens have a search field or a filter field. This field may have a different name on different screens; for example on the View Jobs screen the search field is called Event Name. Search fields and filter fields behave in basically the same way, except that with search fields, you must click a Search button before the filter is applied. To search for entities using a search field: 1. Enter a character string in the Search field. 2. Click the Search button. Only those entities with names that contain the specified string are displayed. 3. To redisplay the full list of entities, clear the Search field and click Search again. To search for entities using a filter field: 1. Enter a character string in the Filter field. As you enter the characters, the list of entities is continually refreshed to show only those entities that contain the specified string. 2. To redisplay the full list of entities, clear the Filter field.
Page 12
Displaying REIE Version and Release Information
To display version and release information about the version of REIE you are using: 1. Click the sphere image at the top left of the Reuters Enterprise Integration Engine screen. The system menu is displayed. 2. Click About. A message box is displayed which gives information about the current version and release of REIE.
3. Click OK to close the message box.
Page 13
Page 14
Creating and Configuring the Environment and Areas
Overview
Environment and Areas The REIE application can be easily configured to solve your business problems. One of the most important aspects of configuration is setting up the environment and areas. You must do this first, directly after installing the product. This chapter contains the following information: Creating the environment Creating an area Registering services to an area Restarting services after changing an aspect of the configuration that affects that service Changing the application configuration properties
The environment is the name given to a complete deployment of a solution. When implementing a solution it is common to migrate between many environments. At each stage, testing and sign off is typically given, until finally the configurations are deployed to the production environment. REIE allows for environments to be named within the configurations to make it easy for users to determine which environment they are working in. Areas are logical groupings of configuration sets. It is through this grouping that configuration sets are deployed. Logical groupings typically resemble all the configurations required to interface with an application. In the example where data is received and sent to an application called AppA, you could create an area called AppA. In this way you will be able to group all the configurations, making it easy to migrate these configurations between environments. Using Areas Areas may be used to spread the processing load across multiple services. You can assign multiple services to a single area if the events within that area require substantial processing capabilities. In the same way, you can assign multiple areas to a single service if the events within that area are not process hungry or are executed at different times. An area is a sub-division of an environment and may be used to spread the processing load across multiple services. Each service must be registered to an area and each event must also be associated with an area. You can assign multiple services to a single area if the events within that area require substantial processing capabilities. In the same way, you can assign multiple areas to a single service if the events within that area are not process hungry.
Page 15
Chapter 2 Creating and Configuring the Environment and Areas
Creating the Environment and Areas

Creating the Environment The simplest way to create a new environment is to export an existing environment and import it into a clean REIE installation. REIEs import and export facilities allow you to import an entire environment or individual entities within it. For more information on exporting and importing a configuration, refer to Chapter 17, Importing and Exporting Configuration Data However, it is sometimes necessary to create an environment from scratch. To create the environment: 1. On the Environment ribbon bar click the Environment Settings button. The Environment Settings menu is displayed. 2. Select Configuration. The Configuration Management screen is displayed as shown in the figure below. It lists the services that have been installed on each server.
3. In the Environment field, enter the name of the environment. You can enter a maximum of 50 characters. The environment name typically reflects the name of the business or the area of the business in which REIE is being used. 4. In the Description field, enter a brief description of the environment. 5. Register the services with the environment. In the Registered column, select the check box next to each service that you want to register. 6. When you have registered the services you require, click Save to create the environment. Creating Areas To create an area: 1. Click the Environment Settings item on the Environment ribbon bar. The Environment Settings menu is displayed. 2. Select Areas. The Areas Management screen is displayed, as shown in the figure below.
Page 16
3. Click New Area. The Add Area screen is displayed, as shown in the figure below.
4. In the Name field, enter the name of the area. You can enter a maximum of 50 characters. 5. In the Description field, enter a brief description of the area. 6. Click Save to save your changes. Assigning Services to an Area
To assign services to an area: 1. Click the Configuration Management tab. 2. Click the Refresh button. A new column for each added area appears to the right of the Configuration Management screen. The Configuration Management screen becomes active. 3. Select the check box next to each service that you want to assign to the area.
Note: The ASH, BTH, and Scheduler Service should always be registered to the environment. In addition, the ASH and BTH can be assigned to specific areas.
Page 17
The figure above shows an environment with one area and an ASH and BTH assigned to that area. 4. Click Save to register your registrations. You have now completed the initial REIE setup. You should now go on to create an event. For information on creating an event, refer to Chapter 3, Managing Events
Note: You can create more areas for the environment and assign services to it at any time.
Page 18
Deployment Transactions
Overview Deployment transactions are business transactions that are executed during the start up of an ASH Server. Deployment transactions are executed in one of three ways Everytime the ASH is started or restarted When the ASH is registered
Some examples of deployment transactions include but are not limited to, business transactions which automatically create all required working directories on the file system during the initial setup of an environment, run executables and others which run SQL scripts to update or create database resources. Deployment transactions can be assigned to any area in your environment using the Area Editor screen. Assigning a Deployment Transaction
To assign a deployment transaction: 1. On the Environment ribbon bar click the Environment Settings button. The Environment Settings menu is displayed. 2. Select Areas. The Areas Management screen is displayed. It lists all the existing areas created in the environment. 3. Select and edit an existing area e.g. Documentation Area. The Area Editor - (Documentation Area) screen is displayed as shown in the figure below. It details the properties of the selected area.
4. Click on the Select button. The Business TX Management window appears as shown in the figure below. Locate and assign your choice of the available transactions for use as the deployment transaction. Click Select to return to the Area Editor - (Documentation Area) screen.
Page 19
5. In the Area Editor - (Documentation Area) screen, specify how the deployment transaction should be executed by the ASH(s) assigned to its area by using the Type as shown in the figure below. The options include: Everytime the ASH is started or restarted When the ASH is registered
6. When you have configured the deployment transaction, click Save to keep your changes.
Page 20
Restarting and Stopping Services

Overview You need to restart a service each time you change any aspect of the configuration that affects that service. In practice you will never need to restart the Scheduler, but you will need to restart ASH if you make changes to the following: Environment variables Area variables Message types and match sets Adapter configuration properties - this includes changes to events, including Business Transaction events The application configuration sets
If you import transactions that are defined for a BTH, you will need to restart that BTH. Similarly, if you import transactions that are defined for the Scheduler or for the ASH, you will need to restart that ASH. When you restart a service, a brand new configuration set is retrieved from the database. Restarting a Service To restart a service: 1. On the Environment ribbon bar click the Environment Settings button. The Environment Settings menu is displayed. 2. From the Environment Settings menu select Configuration. The Configuration Management screen is displayed. 3. From the list of services, select the service you want to restart. 4. On the Quick Links ribbon bar, click the Restart Service button. A restart message is displayed like the one shown below.
5. Click Yes to restart the service. Messages are displayed in the system log. 6. On the Home ribbon bar, click the Logs button to display the View Log screen.
Page 21
The figure below shows an example of the messages that may be displayed when a service is restarted.
There is no additional data associated with the messages shown in black. For more information on logging, refer to Chapter 16, Managing Logging. Stopping a Service To stop a service: 1. On the Environment ribbon bar click the Environment Settings button. The Environment Settings menu is displayed. 2. From the Environment Settings menu select Configuration. The Configuration Management screen is displayed. 3. From the list of services, select the service you want to restart. 4. On the Quick Links ribbon bar, click the Force Service End button. A request message is displayed like the one shown below.
5. Click Yes to stop the service. Messages are displayed in the system log.
Page 22
Changing the Application Configuration

Overview An application configuration set is a set of configuration properties that are delivered to a server when the server starts. There are two application configuration sets: Default which contains default configuration properties for the ASH Fail Over which contains properties that allow the Scheduler Service to manage redundancy
Changing te Configuration
To change the application configuration: 1. On the Environment ribbon bar click the Environment Settings button. The Environment Settings menu is displayed. 2. Select Application Configuration. The Application Configuration Sets screen is displayed. 3. Click the + sign next to the name of an application configuration set to display its properties.
4. Configure the application configuration sets as required. For information on editing configuration properties, refer to the section Adding and Removing Adapter Properties on page 60. If required, you can include user-defined variables in the application configuration. For more information on creating variables, refer to Chapter 10, Managing Variables. 5. When you have finished configuring the application configuration sets, click Save to
Page 23
register your changes.
Page 24
Managing Events
About Events
Overview Now that you have set up the environment and the areas, the next step is to create events to monitor the actions within your system. This chapter explains the different types of events and how to create them. The final section of this chapter explains how to export event information to Excel. Events are configurations which instruct REIE on how to monitor for a particular activity. You can configure three different types of event: About Business Transaction Events Business Transaction events Adapter events Routing events
Business Transaction events expose business transactions (TX) as invocable events through direct API calls and provide the ability to schedule their execution through the Scheduler. For more information on business transactions, refer to Chapter 4, Managing Business Transactions Adapter events leverage the adapter framework within REIE to monitor technology sources for an event. Once the event occurs, the technology adapter submits a payload to REIE for processing. In the data flow within REIE multiple actions can be taken against the payload, until eventually the event completes. Adapter events are used for monitoring real-time activity. Routing events are used in conjunction with the routing capability. These types of events allow for multiple steps of execution. For more information about routing, refer to Chapter 9, Managing Applications, Message Types and Subscriptions A Business Transaction event runs a specific transaction and determines how and when the transaction will run.
About Adapter Events
Adapter events receive information and move it from one place to another, based on certain criteria. The Receiver adapter receives the information, and one or more Sender adapters move the information along to its destination. If required, one or more Interceptor adapters may be used to act on the data once it has been received.
Page 25
Chapter 3 Managing Events The following figure shows an example of an Adapter event.
About Routing Events
Routing events are similar to Adapter events but they do not require a Receiver adapter. A Routing event is essentially a single route that a message takes when identified by the Router Sender technology adapter. A Routing event can have zero or many Interceptor adapters to act on the data but it must have a single Sender adapter as the destination. The Router Sender adapter identifies a message (also referred to as the payload) and performs a series of actions to the payload before delivering it to its final destination. Each unique payload is referred to as a message type that can be identified by one or more match sets or rules. The series of actions and final destination is referred to as a route. One or many routes can be associated with a message type. For more information on message types and match sets refer to Chapter 9, Managing Applications, Message Types and Subscriptions When processing a message, each route may create a job. If you unselect the Create Job checkbox on the Add/Edit Event screen so that the Routing event will not create a job, the event will fall under the job of the parent Router Sender adapter. When one of the jobs fails, the main event fails.
Page 26
Chapter 3 Managing Events The following figure shows an example of a Routing event.
Exporting Event Details to Excel
To export the event list to Excel: 1. With the Event List screen active, on the Quick Actions ribbon, click the Export to Excel button. The Save spreadsheet dialog is displayed. This behaves like a standard Windows Save As dialog. 2. Save the event list content as an Excel file. The figure below shows an example of event list information as exported to Excel.
Note: Only those events that are visible on the current page are exported.
Page 27
Chapter 3 Managing Events
Adding Events
Adding a Business Transaction Event
To add a Business Transaction event: 1. On the Home ribbon bar click the Events item. The Event List screen is displayed. 2. On the Quick Actions ribbon, click New Event. A context menu is displayed, showing the different types of event. 3. From the context menu, select Business Transaction Event. The Add Event screen for Business Transaction events is displayed.
4. In the Name field, enter the name of the event. The event name should reflect the function of the event, for example Deliver Success Result. 5. In the Description field, enter a brief description of the event. 6. From the Area drop-down list, select the area to which you want to assign the event. 7. In the bottom right of the screen click Save to save your newly-created event. 8. If you want the event to be active and ready to run as soon as you have finished creating it, select the Enabled check box.
Page 28
Note: Generally, you should enable an event only when you are ready to run the event or test it. If you attempt to run an event when everything is not in place for the event to be a success, for example if you configure a receiver adapter without configuring a corresponding sender adapter, you will see errors when you attempt to save the event.
9. If you do not want a job to be created when the event is run, unselect the Create Job check box. By default the Create Job check box is selected. This means that a job will be created each time the event is run. The job is a log of the event. For more information about jobs, refer to Chapter 15, Managing Jobs 10. On the Schedule tab, click the Select Transaction button. The Transaction Management screen is displayed, showing all the available transactions which meet the filtering criteria specified in the Filter Results By block.
The transactions listed in the figure above include the standard transactions provided with REIE.
Note: If other transactions have been created for this environment these will also appear in the list. For more information on writing transactions, refer to the section About Business Transactions on page 41. If the list of transactions is long and you cannot easily find the transaction you want to use, use the search facility to limit the list. Type any character string into the ID field to display only those transactions with identifiers that contain the string you entered. To redisplay the entire list of transactions, click Search again when the ID field is blank.
11. Click the transaction you want to call and then click Select.
Page 29
Chapter 3 Managing Events The transaction you selected is shown below the Calendar field.
12. On the Schedule tab, select the schedule for your transaction. The In effect from option allows you to specify the start and end dates that the event will be available and then select the calendar from the drop-down list. The calendar contains the rules that determine when the event will be run during its period of availability.
Note: An event that is scheduled by a calendar can still run as part of a chain of events.
13. Click the Dependencies tab. The Dependencies screen is displayed. On this screen you set up the dependency chain for an event. A dependency chain is required when a Business Transaction event is required to be invoked on the completion of another Business Transaction event. A simple example of a dependency is when the Business Transaction event BTEventA invokes the event BTEventB if it is successful and BTEventC if it fails. Another thing to bear in mind about dependencies is as follows: If BTEventD is dependent on the events BTEventA and BTEventB, and BTEventA and BTEventB have never run, BTEventD may still be invoked by another event. If however BTEventA and BTEventB have been run at some time and there is still data in the database relating to these events, BTEventD will check the database before starting and will run or not run depending on the status of BTEventA and BTEventB.
Note: Dependencies are not mandatory. They are purely a user-defined rule-set.
14. Click the New button. The Dependency Viewer dialog is displayed.
15. From the Dependency Type drop-down list, select Event or Process as the type of the first dependency in the chain. 16. From the Dependent on drop-down list, select the event or process that is the first event or process in the chain.
Note: If you selected Event as the dependency type, all the events created for the environment are displayed, irrespective of their type or the area to which they are assigned.
Page 30
Chapter 3 Managing Events 17. From the Event Status drop-down list, select the termination status of the event (or of the final event in the process). The event statuses are described below. New: An Adapter or a Routing event has started but has not yet been picked up. This status should not be used. NewFromChain: A Business Transaction event has started but has not yet been picked up. Started: A Business Transaction event has been picked up by the Scheduler or ASH. RequestSent: A direct REIEcall has been made on an event. For more information on direct REIE calls, go to step 24. ProcessRunning: The process is running. ProcessingUpdate: Not used. ProcessingSuccess: A Business Transaction event has succeeded. ProcessingFailure: A Business Transaction event has failed. ProcessingAsyncSuccess: An Adapter or a Routing event has succeeded. ProcessingAsyncFailure: An Adapter or a Routing event has failed.
18. Click Save to return to the Dependencies screen with the first dependency in the chain. 19. Follow steps 14 to 18 to set up more dependencies in the chain. The figure below shows a chain of three dependencies.
When you have finished setting up the dependency chain, you are ready to specify the result codes for the event. 20. Click the On Fail Dependency tab.
Page 31
Chapter 3 Managing Events The On Fail Dependency screen is displayed.
21. Click Add Result Code. The Result Code Editor dialog is displayed.
22. From the drop-down list, select the result code that is to be displayed when the event fails.
Note: The list of result codes is a standard list supplied with REIE. For Business Transaction events the result code will typically be as follows: count(//error)(@message!=Failed conditional execution)) = 0 or count(//error)(@message!=Failed conditional execution))!= 0. The result code is not a true result code. It is only a query to execute against the acknowledgement of success/failure.
23. Click Apply. The result code is added to the event.
A right-click menu associated with the result code allows you to carry out the following actions: Edit Result Code: Redisplays the Result Code Editor dialog so that you can select a new result code in the same way as you did in steps 21 to 23 above. Delete Result Code: Displays a message asking you to confirm that you want to delete the result code. Click Yes to delete the result code or No to cancel the deletion.
Page 32
Chapter 3 Managing Events Add Transaction Call: Allows you to call a transaction directly on receipt of the result code. Go to step 24. Add Event Chain: Allows you to chain to another event in the event of the failure of this event. Go to step 25. Right-click on the result code and select Add Transaction Call. The Edit Transaction Call screen is displayed. Click Select Transaction. The Transaction Management screen is displayed showing the list of available transactions. Double-click a transaction from the list to see the transaction selected in the Edit Transaction Call screen. On the Edit Transaction Call screen, click Save to finish your direct transaction call.
24. To call a transaction directly:
The figure below shows an example of a direct transaction call.
25. To chain to another event: Right-click on the result code and select Add Event Chain.The Event Chain Editor dialog is displayed. From the Chain to Event drop-down list, select the next event in the chain. You can select only Business Transaction events. On the Event Chain Editor dialog, click Add to set up the chain to your selected event.
The figure below shows an example of an event call.
26. In the same way as you did in steps 21 to 25 above, specify result codes for the On Update situation. A result code for On Success and On Error will be provided by default. Additional result codes can be added to the defaults. 27. Click Save to save the event. It is at this point that the event is allocated a unique identifier. Event identifiers are sequential starting from 100001. From now on, whenever you see the event listed on the Event List screen or review the event detail on the Event Viewer screen, you will always see the event identifier.
Page 33
Adding an Adapter Event
To add an Adapter event: 1. On the Home ribbon bar, click the Events item. The Event List screen is displayed. 2. On the Quick Actions ribbon, click New Event. A context menu is displayed, showing the different types of event. 3. From the context menu, select Adapter Event. The Add/Edit Event screen for an Adapter event is displayed.
4. Follow steps 4 to 9 of the procedure for adding a Business Transaction event. These steps are common to all events. 5. Configure the Receiver adapter that is to be associated with the event. This Receiver adapter must be unique to the event. For information on how to configure a Receiver adapter, refer to the section Configuring Technology Adapters on page 57.
Note: You can use an existing Receiver adapter for an event, but that adapter may not be associated with any other event. Once a Receiver has been associated with an event, it must be explicitly removed from the event (by clicking Clear Adapter) before it can be reused.
6. Configure the Sender adapter that is to be associated with the event. The Sender adapter does not need to be unique so if required you can use an existing Sender configuration rather than configuring a new Sender. To use an existing Sender adapter configuration, go to step 7 of this procedure. To configure a Sender adapter, refer to the section Configuring Technology Adapters on page 57. 7. Click the Sender tab.
Page 34
Chapter 3 Managing Events The Sender screen is displayed, as shown in the figure below.
8. Under the list of Assigned Senders, click Add Existing. The AdapterList screen is displayed, showing all the available Sender adapters.
The selected adapter is shown by an arrow An example is shown in the figure above.
to the left-hand side.
9. Click the Sender adapter you want to use and click the Select button. The selected Sender adapter is added to the list of Assigned Senders and its properties
Page 35
Chapter 3 Managing Events are displayed in the fields to the right of the Sender screen.
10. Configure the Sender adapter as required. For information on how to configure a Sender adapter, refer to the section Configuring Technology Adapters on page 57. When you have finished configuring the adapter, click Save to save your changes. If required, you may include an Interceptor adapter in your event. The Interceptor adapter does not need to be unique so if required you can use an existing Interceptor configuration rather than configuring a new Interceptor. You do this in the same way as you did when you configured an existing Sender adapter in steps 7 to 10. For information on how to configure a Interceptor adapter, refer to the section Configuring Technology Adapters on page 57. 11. Click Save to register your changes to the adapter configuration. When you have finished configuring the adapters, you are ready to specify the result codes for the event. 12. A result code for On Success and On Error will be provided by default. Additional result codes can be added to the defaults. Click the On Success tab. The On Success screen is displayed.
13. Click Add Result Code.
Page 36
Chapter 3 Managing Events The Result Code Editor screen is displayed.
14. From the drop-down list, select the result code that is to be displayed when the event terminates successfully.
Note: The list of result codes is a standard list supplied with REIE. For most Adapter and Routing events, you should use only the first two items in the list.
15. Click Apply. The result code is added to the event.
16. In the same way as you did in steps 13 to 15 above, specify result codes for the On Update and On Error situations. 17. When you have specified the required result codes, click Validate. The system checks the adapter configuration. Any errors are listed on the Validation screen. The figure below shows an example of configuration errors.
18. Correct any validation errors. 19. When clicking Validate produces no errors, click Save to save the event. It is at this point that the event is allocated a unique identifier. Event identifiers are sequential starting from 100001. From now on, whenever you see the event listed on the Event List screen or review the event detail on the Event Viewer screen, you will always see the event identifier.
Page 37
Adding a Routing Event
Note: Although it is possible to add Routing events from the Add/Edit Events screen, as each Routing event is an extension of a message type, you generally add Routing events from the Message Type screen, where you can clearly see the message type associated with the route.
Adding a Routing Event from the Message Type Screen To add a Routing Event from the Message Type screen: 1. On the Home ribbon bar, click the Message Types item. The Message Types screen is displayed, listing all available message types.
2. Select the message type for which you want to add a Routing event. 3. Double-click the selected message type. The Message Type (TypeName) screen is displayed. TypeName is the name of the message type in the list of message types.
The tree structure on the left-hand side of the screen shows that this message type comprises one match set. 4. In the tree structure, click Routes. 5. On the Quick Actions ribbon, click Add Routes. A context menu is displayed. 6. From the context menu, select New Route.
Page 38
Chapter 3 Managing Events Fields are displayed for you to add a Routing event.
7. Follow steps 4 to 9 of the procedure To add a Business Transaction event: on page 28. These steps are common to all events. 8. To complete the procedure for adding a Routing adapter, follow the procedure To add an Adapter event: on page 34, starting from step 7 where you configure the Sender. The one way in which the process of adding a Routing event differs from the process of adding an Adapter event is that a Routing event can have more than one interceptor. Adding a Routing Event from the Add/Edit Event Screen To add a Routing event from the Add/Edit event screen: 1. On the Home ribbon bar, click the Events item. The Event List screen is displayed. 2. On the Quick Actions ribbon, click New Event. A context menu is displayed, showing the different types of event. 3. From the context menu, select Routing Event.
Page 39
Chapter 3 Managing Events The Add/Edit Event screen for a Routing event is displayed.
Warning: The message type screen would normally show the message type associated with this Routing event. When you add a Routing event in this way, there is no way to associate the event with a message type. You associate a Routing event with a message type on the Message Type screen by selecting Add Route > Existing Route. For more information, refer to the sub-topic Adding a Routing Event from the Message Type Screen on page 38.
4. Follow steps 4 to 9 of the procedure for adding a Business Transaction event. These steps are common to all events. 5. To complete the procedure for adding a Routing adapter, follow the procedure To add an Adapter event: on page 34, starting from step 7. The process of adding a Routing event differs from the process of adding an Adapter event is that a Routing event does not have a Receiver but can have more than one interceptor.
Page 40
Managing Business Transactions
Overview
In this Chapter This chapter covers the following topics: What business transactions are How you execute business transactions How you design business transactions
It also gives examples where business transactions satisfy REIE business requirements. About Business Transactions A Business Transactions (TX) is a set of execution instructions with logical path descriptions which are processed by REIE. A business transaction can be used to perform a series of complex tasks in either a synchronous or an asynchronous manner. A Business transaction is contained in a single XML file that is a logical collection of units of work. Inside each logical unit of work are one or more physical steps. Calling Business Transactions Transactions never run spontaneously. They must always be called. A transaction is called by one of the following: A chain of events A dependency Being forced run From the Business Transaction Host (BTH) as a web service Being embedded in a Sender or an Interceptor technology adapter
Page 41
Chapter 4 Managing Business Transactions
Designing Business Transactions

About the Business Transaction Designer REIEs Business Transaction Designer allows you to design customized business transactions by selecting from a toolbox of standard elements and customizing them to suit. The transactions are stored in a database that is specific to your environment. You can easily retrieve the transactions from the database for testing or editing. You can also specify the services for which the transactions are valid. The figure shows an example of using the Business Transaction Designer.
Selecting from the Element Toolbox
When designing transactions you can select from three categories of element: Conditions: Allow you to express a conditional statement Units: Represent the execution of an actual business activity or a grouping of activity methods. Each unit may contain one or more steps Steps: Define an action
The units available from the toolbox offer a wide range of functions including: Database operations Sending and receiving messages using email or SMS Pinging remote servers Executing applications on the local host including file manipulation operations Sending messages to external platforms
Page 42
Chapter 4 Managing Business Transactions XML file operations FTP file operations
Each type of element has properties that you can customise to suit your particular needs. Moreover, you can also create custom units and save them as templates for later reuse. Editing Transactions There are two ways in which you can edit transactions: In the Designer view (shown in the figure below) you can build transactions by: Executing Transactions Standard Transactions Dragging and dropping elements from the toolbox into the design area Moving the elements around until they best replicate your business activity Customizing the element properties Validating your transaction against the standard schema
In the XML view you can manually edit the XML text
You can execute your transaction at any time for test purposes, but you may want to hard code some files before testing to avoid working with live data. A small number of standard transactions are included in the release: The business transactions demo:noobject and demo:object are included for testing purposes and can be deleted if desired.
wt_getCache is a special transaction that outputs the business transaction library and
should not be deleted.
Page 43
Chapter 4 Managing Business Transactions
Page 44
Managing Calendars
Overview
In This Chapter This chapter explains calendars and gives procedures for the following: Viewing the available calendars Setting up a new calendar Editing an existing calendar Deleting a calendar
It also explains how to set up a hierarchical calendar structure to manage your schedules efficiently. About Calendars Calendars allow you to specify schedules for Business Transaction events. A default calendar called never has already been set up. A calendar comprises one or more rules. Each rule may be: A positive instruction: An event is to run on a certain day and/or at a certain time, or the event is to run according to rules specified by another calendar A negative instruction: An event is not to run on a certain day and/or at a certain time, or the event is not to run according to rules specified by another calendar
Positive instructions are shown by the keyword add. Negative instructions are shown by the keyword subtract.
Page 45
Chapter 5 Managing Calendars The example below shows a simple calendar, EndOfDay, with two rules: Run events at 7.00 pm (1900 hours) Run events according to the schedule set by the calendar Weekdays.
Page 46
Chapter 5 Managing Calendars
Using Calendars
Overview Although it is possible to use one calendar to schedule a number of events, to keep each calendar as simple and as easy to maintain as possible you are recommended to set up a hierarchy of calendars with some calendars containing basic rules that will not change and other calendars containing rules that may be subject to change. At the lower level, you may have a set of calendars called for example: Weekdays, Weekends and Public Holidays specifying that events are run only on Mondays to Fridays, only on Saturdays and Sundays, or only on public holidays. At the higher level you may then include calendars that specify the time at which events are to be run, for example: End of Day Processing which runs at 7.00 pm from Monday to Friday, but not on public holidays. These calendars and their rules are shown in the following figure:
An example of how to specify the first rule in calendar End of Day Processing is shown below.
Page 47
Tip: To specify that a transaction is to be executed weekly, specify one rule with the day of the week. To specify that a transaction is to be executed monthly, specify a rule for each month and then another rule for the day of the month.
Page 48
Viewing Available Calendars
To view the available calendars: 1. On the Home ribbon bar, click the Calendars button. The View Calendars screen is displayed. This screen lists all the calendars you are allowed to access.
2. Expand and collapse the rule details for a calendar by clicking the + and - symbols next to the calendar entry.
Note: If you are a member of more than one user group, you can select a user group from the Group filter drop-down list to view those calendars that are available to that user group. Tip: If the list of calendars is too long for you to be able to find the calendar you are looking for, you can use the Filter feature to limit the list. Type any sequence of letters into the Filter field to display only those calendars with names that contain that sequence.
Page 49
Setting Up a New Calendar
To set up a new calendar: 1. On the View Calendars screen, click the Add New button. The Edit Calendar screen is displayed.
2. In the Calendar Name field, enter the name of your new calendar. Calendar names may have a maximum of 50 characters. 3. Click New Rule.
Page 50
Chapter 5 Managing Calendars The Edit Calendar Rule dialog is displayed.
4. Specify the dates and/or times when Business Transaction events associated with this calendar will or will not run. The Specify Calendar option allows you to call one calendar from another calendar. In this way you can schedule events using a hierarchy of calendars. For more information, refer to Using Calendars on page 47. 5. Each time you add a new calendar rule, click Save to add your rule to the list. 6. When you have finished adding rules, on the Edit Calendar screen click Save and Close. The Edit Calendar screen closes and you are returned to the list of calendars on the View Calendar screen.
Tip: In the Specify minute and Specify hour fields, you specify an exact number of minutes or hours and not a frequency. Therefore to specify that a transaction is to be executed every five minutes, you need to add a calendar rule for every time that the transaction is to be executed, for example: Add 00, Add 05, Add 10 and so on, ending with Add 55.
Editing Calendar Rules
To edit a calendar: 1. On the View Calendars screen, select the calendar you want to delete and click Edit. The Edit Calendar screen is displayed listing the rules for the selected calendar. 2. Do one of the following: Click New Rule to add a rule for the calendar. Select a rule and then click Edit Rule to change the selected rule. Select a rule and then click Delete Rule to delete the selected rule.
Page 51
Deleting a Calendar To delete a calendar: 1. On the View Calendars screen, select the calendar you want to delete. 2. Click the Delete button. A message is displayed asking you to confirm that you want to delete the calendar. 3. Click Yes to confirm the deletion.
Note: If the calendar you selected is still being used to schedule events, you will see the following message:
Click OK to close the message box. You are returned to the View Calendars window and the calendar is not deleted.
Page 52
Managing Technology Adapters
Overview
In This Chapter This chapter explains the following: About Technology Adapters How technology adapters work Gives a brief description of each type of technology adapter How to configure technology adapters How you can create variables for use when configuring adapters
REIE interacts with the application infrastructure through a framework of technology adapters. Technology adapters are accessed in one of two ways; Hosted as part of the event-driven Adapter Services Host (ASH) Invoked directly as part of a business transaction
There are three types of technology adapter: Receivers, which pick up message data Senders, which send message data to a specific destination Interceptors, which carry out an action on the data after it has been received and before it is sent to its destination
Within these groupings there are specific adapters that carry out specific tasks. For example: The File Receiver searches for the appearance of a particular file in a local or a network folder and then sends either the content of the file or information about the file to a new location for processing The MSMQ Sender adds a message to a Microsoft message queue The Validation Interceptor validates the payload against the specified XSD schema
Technology adapters are generic but when they are used in events you can configure them to carry out business-specific functions. For example, you can configure the File Receiver to search for the Customer file in the folder \Input Files\Customers and move it to the folder \To Be Processed\Customers.
Page 53
Types of Technology Adapter

Receiver Adapters Receiver adapters pick up message data. They are used only in Adapter events. Each Adapter event must have one Receiver adapter.
Note: Configured Receivers may not be reused among Adapter events. If you want to use a Receiver adapter with the same configuration in two or more different Adapter events, you must ensure that at least the adapter names are different.
The function of each Receiver technology adapter is described briefly in the table below.
Receiver Adapter Type EMS Receiver Function Monitors a specific queue or a broadcast topic on an Tibco EMS server for messages. The receiver handles text messages and map messages. Monitors a local or a network folder for a file. Once found, the contents and details of the file will be sent through the ASH for processing and archived to a separate folder. Polls an FTP site for a file, downloads the file and sends the local location of the downloaded file to the ASH. Download transfers may be secured using SSL. By default, the adapter removes the file from the FTP site once it has downloaded it, but you can select to leave the file on the site. Processes a web page to extract a message that will be sent to the ASH for processing. Listens for messages on a queue managed by IBMs Websphere MQseries queue manager. Uses a query to monitor for data in a Microsoft SQL Server database. Listens for messages on a Microsoft Message Queue (MSMQ) server queue. Uses a query to retrieve data from the specified database. Uses a query to retrieve data from the specified database. Uses a query to monitor for data in an Oracle database. Receives messages generated by Tibcos Rendezvous messaging product. Processes any messages that have been requeued for resending. Used in conjunction with the Scheduler Event Execution Sender to process scheduled or chained events. Similar to the FTP receiver but uses the secure SSH protocol to poll and retrieve files.
File Receiver
FTP Receiver
HTTP Receiver MQSeries Receiver MS SQL Receiver MSMQ Receiver ODBC Receiver OLEDB Receiver Oracle Receiver Rendezvous Receiver Resend Receiver Scheduled Event Execution Receiver SFTP Receiver
Table 3: Receiver Technology Adapters
Page 54
Sender Adapters
Sender adapters send message data to a specific destination. The function of each Sender technology adapter is described briefly in the following table:
Sender Adapter Type EMS Sender File Move Sender File Sender FTP Sender MQSeries Sender MS SQL Sender MSMQ Sender Null Sender Function Sends a message to a specific queue or broadcasts a message with a topic on an EMS server. Used in conjunction with the HTTP Receiver. Moves a file from one location to another. Writes the payload to the target file. The file name may be the same, or the file may be written under a different name. Uploads a specified file to a folder on an FTP site. Upload transfers may be secured using SSL. Adds a message to an IBM Websphere MQSeries message queue. Executes a series of SQL statements against a given SQL database. Adds a message to a Microsoft message queue. Does not send the payload. In other words it terminates the event. Used with Business Transaction events and the Replay Receiver only. Executes SQL statements against a given database. Executes SQL statements against a given database. Executes a series of SQL statements against a given Oracle SQL database. Broadcasts a message to a specific subject over a Tibco Rendezvous messaging system. Identifies a message that may follow one or more routes. Each route is a Routing event. Used in conjunction with a Scheduler Event Execution Receiver to process scheduled events. Uploads a file to a folder on a secure FTP site. Upload transfers may be secured using SSL. Sends an email message. Chunks or splits .csv files and sends each chunk to another Sender adapter for processing. Executes a transaction as the final step in an event. Chunks or splits XML files and sends each chunk to another Sender adapter for processing. Extracts files from a specified zip archive to a folder.
ODBC Sender OLEDB Sender Oracle Sender Rendezvous Sender Router Sender Scheduler Event Execution Sender SFTP Sender SMTP Sender Text Sender TX Sender XML Sender Zip Sender
Table 4: Sender Technology Adapters
Page 55
Interceptor Adapters
Interceptor adapters carry out an action on the data after it has been received and before it is sent to its destination. The function of each Interceptor technology adapter is described briefly in the table below.
Interceptor Adapter Type Command Line Interceptor Compiled Code Interceptor Duplicate Check Interceptor Function Executes a Windows executable file or batch file. An interceptor which allows a custom code file to be compiled and used in processing during an event. Performs a duplicate check on one of the following: MSMQ Interceptor Sql-Value-to-Property Interceptor Text-Replace Interceptor TX Interceptor File Info reference Content hash Actual file content
Performs checks against a specific message type. Adds a message on to an MSMQ. Extracts a value from an SQL query and inserts it in the properties collection. Replaces text in the payload. Executes a transaction against the payload. The transaction can act upon the payload if required. Passes the transformed payload back to the sender, that is, it keeps the transaction in the pipeline. Provides a mechanism for validating received message payloads against pre-determined criteria. A Validation interceptor may be associated with a receiver when messages received by the receiver are required to be validated. Validates the payload against the specified XSD schema. Escapes and formats an XML message. Provides the ability to transform data using industry standard XSL transforms in memory or streamed from disk. Zips the payload.
Validation Interceptor
XML Schema Interceptor XML Tools Interceptor XSLT Interceptor Zip Interceptor
Table 5: Interceptor Technology Adapters
Page 56
Configuring Technology Adapters

Configuration Procedure
Note: The procedure below assumes that you are creating an Adapter or a Routing event and have arrived at the stage where you need to configure a technology adapter. The adapter configuration process is the same for each type of adapter.
To configure a technology adapter: 1. Follow the procedure To add an Adapter event: on page 34. On the Add/Edit Event screen, click the tab that corresponds to the type of adapter you want to configure. 2. In the Type drop-down list, select the type of adapter to be configured. The adapter type reflects the type of information that the adapter is to receive. The adapter types are listed in the tables above. 3. On the bottom right of the screen, click New Adapter. In the case of Interceptor and Sender adapters, clicking the New Adapter field enables the Type, Name and Description fields. 4. In the Name field, enter the name of the adapter. The adapter name should reflect the function of the adapter and the event that uses it. 5. In the Description field, enter a brief description of the function of the adapter.
Note: Steps 6 and 7 apply to Receiver adapters only. If you are configuring an Interceptor or a Sender adapter, go to step 8 at this point.
6. Select the Active check box to make journaling active for the event associated with this Receiver adapter. 7. From the Journal drop-down list, select SQL Database Journal. SQL Database Journal is the journal into which log information will be written when the event is run. By default, SQL Database Journal is always active. You should not need to edit the default configuration but you can do so if required. For more information on configuring SQL Database Journal, refer to Configuring the SQL Database Journal on page 172.
Warning: If you do not specify journaling for a job, you will not be able to resend the job. For more information on resending a job, refer to Resending a Job on page 166.
8. Configure the adapter properties. The properties vary according to the type of adapter you are configuring. Some properties have default settings and some may have tokens, or variable values. An exclamation symbol denotes a mandatory property. The properties of each type of adapter are explained in the Adapter Reference Manual. 9. Click Save to save your adapter configuration. You have now successfully configured a technology adapter.
Page 57
Chapter 6 Managing Calendars 10. Go back to the procedure To add an Adapter event: on page 34. Rejoin the procedure at step 13. Configuration Examples This topic gives a configuration example for each type of technology adapter. Receiver Adapter The figure below shows an example of a configured Receiver adapter.
Sender Adapter The figure below shows an example of a configured Sender adapter for an Adapter event, where more than one Sender is permitted.
Page 58
Chapter 6 Managing Calendars Interceptor Adapter The figure below shows an example of a configured Interceptor adapter.
Warning: If you change the configuration of an Interceptor adapter from within an event, this change is reflected in all the events that use this adapter.
Page 59
Adding and Removing Adapter Properties

Overview When you are configuring adapters, it is possible to add and remove properties as well as configuring them. You add properties in order to exploit the additional advanced functionality of an adapter. You remove properties to reduce the number of properties that you need to configure. This may be useful if you are interested in monitoring only the behavior of two or three particular properties. Three features have been provided to aid the property configuration exercise. They are: Tool Tips which describe the attributes of each item
Using Property Configuration Features
The Value Editor which allows you to enter property values from a predefined list of Variables, Tokens and Resources. For additional information on how to add resources, refer to the section Using Embedded Resources on page 126 A Browse option which launches the Windows Explorer window
Adding Adapter Configuration Properties
To add an adapter configuration property: 1. With the list of configuration properties displayed for an adapter, click the Add Property button. A new line is added to the property list. The exclamation symbol add a property name. shows that you must
2. Click the property Name field and enter a name for the new property. 3. Click the Value field and enter a value for the new property. 4. If required, click in the Extended Data field and add any extended data that is required by the property. 5. When you have finished adding the property, click Save to save your changes.
Page 60
Note: If the adapter cannot handle the property you have added, it ignores it. The adapter runs without taking the property into account.
Removing Adapter Configuration Properties
This topic explains how to remove an adapter configuration property. To remove an adapter configuration property: 1. With the list of configuration properties displayed for an adapter, click one of the properties in the list. 2. Click Remove Property to remove the selected property. The selected property is removed from the list. You are not asked if you want to confirm the deletion.
Note: You can remove only those parameters that are not mandatory. Attempting to remove a mandatory parameter will have no effect. Similarly, you cannot remove a parameter for which the Name field is blank.
One example of an adapter configuration property you may want to add is generateHash, which is valid only for Receiver adapters. A hash is a short, manageable identifier for a payload of any size. Hashes are used to identify whether a payload has been changed. If the payload property is set to content, generateHash hashes the payload of the message. If the payload property is set to fileInfo, generateHash hashes the file that is being referenced. Property Mapping Property mapping is an optional feature that may be applied only to (XML-based) Sender adapter properties. Property mapping allows you to: Rename a property and take the value of this property from the XPath query Rename a property but keep the original value of the property Add a new property and take the value of this property from the XPath query
Note: Property mapping is available only for Sender adapters.
To use property mapping, do the following: 1. With the list of configuration properties displayed for an adapter, click the View Property Mappings button. The Property Mapping Editor dialog is displayed. 2. On the Property Mapping Editor dialog, click Add Property.
Page 61
Chapter 6 Managing Calendars A row is created for you to add a property mapping.
3. In the Original Property Name field, do the following: If you are renaming an existing property, enter the original name of the property. If you are adding a new property, enter the new name of the property. If you are renaming an existing property, enter the new name of the property. If you are adding a new property, leave this field blank. If you want to use an XPath query to obtain the value of the property, enter the XPath query. If you want to use the existing value of the property, leave this field blank.
4. In the New Property Name field, do the following:
5. In the XPath field, do the following:
6. Repeat steps 2 to 5 to add more property mappings as required. 7. When you have finished adding property mappings, click Save to register your mappings. You are returned to the adapter configuration screen.
Page 62
Chapter 6 Managing Calendars The following figure shows some examples of property mapping.
Page 63
Page 64
Using Message Analysis and Schema Management
Overview
In This Chapter Message Analysis and Schema Management provide the ability to define schemas and automatically register data elements for analysis purposes. This chapter explains the following: Using Message Analysis The concept of Message Analysis in REIE How the Schema Management functionality works
Message Analysis in REIE refers to the process of profiling a message to identify and understand the Data Elements contained within. An overview of the process is provided in the figure below:
A Data element refers to any user defined item and its attributes (fields) identified from a processed message or payload. In the figure above, the data element Trade and its attributes DealNumber, Identifier, Exchange, Quantity, Price and Trader have been identified from the incoming message.
Page 65
Chapter 7 Using Message Analysis and Schema Management
Using Schema Management

Overview Schema Management is based on the normalised (XML view) of all processed data. Schema Management allows you to anayse and define the data elements contained in all XML data files. This section explains how to display the Schema List and Schema Management screens. From these screens you can do the following: Displaying the Schema List Screens Create new schemas Edit existing schemas Delete existing schemas
To display the Schema List screen: On the Environment ribbon bar, click the Schema Management button. The Schema List screen is displayed.
The Schema List screen shows the list of existing schemas set up in the environment. To display the Schema Management screen: Select an existing schema and click on the Edit button or click on the New Schema button.
Page 66
Chapter 7 Using Message Analysis and Schema Management The Schema Management screen is displayed.
The Schema Management screen has three panes. These include the Schema Information, View and Properties panes. Using the Schema Information pane The Schema Information pane shows a summary of the schema and its component data elements and associated fields. The buttons at the bottom of the pane allow you to add or remove a field or element depending on whether the Schema Name, Data Element or Field is selected. An overview is displayed in the figure below.
Depending on your selection, right clicking on the Schema Name, Data Element or Field allows you to choose from either of the following options:
Page 67
Chapter 7 Using Message Analysis and Schema Management New Element New Field
These options are displayed in thefollowing figure:
To escape these options, click on the Schema Management screen. Using the View pane The View pane shows a tree view of the selected schema. Use the + sign to drill through the data elements and fields within the schema. The View pane display changes depending on if a Schema Name, Data Element or Field has been selected in the Schema Information pane. The icon highlights the selected field or fields associated with the selected data element. An overview is displayed in the following figure.
Right clicking on any of the Data Elements or Fields allows you to choose from the following options: New Element New Field Add Data Element with child fields
These options are displayed in the figure below.
Page 68
Using the Properties pane
The Properties pane shows the corresponding details of the selected Schema, Data Element or Field in the Schema Information pane. Examples of these details are displayed in the following figure.
The Schema, Data Element or Field properties can be edited using the Properties pane. The Schema properties include: Name - The schema name. A schema name must always be supplied Sample File - The sample file represents an indicative structure of the xml data which will be processed. The size of any sample file used should be less than 2Mb Header XPath - The xpath to the header contents of the xml file represented by the schema. The xpath is used to identify specific portions of XML documents Header Start Element -This flag indicates if details supplied for the Header XPath represent either a closed node or the last node of header information. Default setting of this property: Not Selected
The Data Element properties include: Name -The Data Element name. A Data Element name must always be supplied Node XPath - This property represents the outer node of the element in the XML document which represents the Data Element within the schema Persist -This flag indicates if the Data Element needs to be stored in the underlying DataAnalytics database. Default setting of this property: Selected
Page 69
Chapter 7 Using Message Analysis and Schema Management The Field properties include: Name -The Field name. A Field name must be supplied in order to add a field to the data element Value XPath - This is an xpath relative to the Node XPath which specifies the value of the field Data Type - This property specifies the type of values expected for the field. All values for the field are validated against the specified type. The Data Element is processed via the exception route if any data type conflicts occur. Default setting of this property: String.The other supported data types are detailed in the following figure:
Max Length - When the data type: string is selected, you can specify a maximum number of expected characters. Default setting of this property: 8000 Precision - When the data type: decimal number is selected, you can specify the total number of digits, both before and after the decimal point. The Data Element is processed via the exception route if any precision conflicts occur.Default setting of this property: 1 Scale - When the data type: decimal number is selected, you can specify the number of decimal places. The Data Element is processed via the exception route if any scale conflicts occur. Default setting of this property: 18 Allow NULL Values - This property indicates if empty values are expected for the field. If empty values are enountered whilst the flag is set to not allow null values, the Data Element will be processed via the exception route. Default setting of this property: True
Creating a New Schema
This topic describes how to create a new schema. On the Environment ribbon bar, click the Schema Management button. How to add a new schema 1. On the Environment ribbon bar, click the Schema Management button followed by the New Schema button
Page 70
Chapter 7 Using Message Analysis and Schema Management The Schema Management screen is displayed.
Note: Ideally, a sample file should be used when setting up a new schema.
2. Enter a name for the new schema. 3. Upload a sample file using the Browse button. 4. Specify the Header Xpath, by selecting your preferred node in the View Pane and clicking on An example is provided in the following figure:
Note: The flag Header Start Element indicates if the Header XPath represents either a closed node or the last node of header information.
5. To add a Data Element, click on the Add Element button. Specify the NodeXpath, by selecting your preferred node in the View Pane and clicking on
Note: The flag Persist allows you to store the Data Element in the underlying database.
6. To add a Field, select a Data Element, click on the Add Element button. Specify the ValueXpath, by selecting your preferred node in the View Pane and clicking on 7. Repeat Steps 5 and 6, to add additional data elements and fields as needed. 8. Click on the Save button, to save your changes.
Page 71
Page 72
Managing Datasets
Datasets in REIE DataTrans refer to any collection of tabular data. The Message Analysis and Schema Management functionality described in Chapter 7, Using Message Analysis and Schema Management allows for the automated registration of data elements as datasets. This chapter covers the following topics: How to view a dataset How to register a dataset How to unregister a dataset
Page 73
Chapter 8 Managing Datasets
Viewing Datasets
This section explains how to view all datasets in REIE DataTrans. To display the Dataset Explorer screen: On the Environment ribbon, click the Data Store Management item shown in the figure below.
The Dataset Explorer screen is displayed as shown in the figure below.
Datasets can be registered or unregistered. Click the + sign to view the list of existing registered or unregistered datasets.
Page 74
Registering Datasets
This section explains how to register a dataset. Registering a dataset, means the dataset can be used by other REIE DataTrans components and/or other users of the REIE DataTrans application. To register a dataset: Select an unregistered dataset in the Dataset Explorer screen as shown below:
On the Quick Actions ribbon, click Register Dataset. Click Save to keep your changes.
Page 75
Unregistering Datasets
This section explains how to unregister a dataset. Unregistering a dataset, prevents other REIE DataTrans components and/or other users of the REIE DataTrans application from using the dataset. To unregister a dataset: Select a registered dataset in the Dataset Explorer screen as shown in the following figure:
Selecting a registered dataset allows you to preview its data.
Page 76
Managing Applications, Message Types and Subscriptions
Overview
About Message Types The most common request across all organisations is to identify the most efficient way of moving information from one application to another. In REIE message types are used to define the way in which information is manipulated and routed. You can also: About this Chapter Define subscriptions to various data sources or applications based on your preferred data element(s) Perform advanced user defined filtering on in-flight data using data elements
This chapter explains the following: How applications are managed in REIE How to manage message types from the Message Types screen How to manage namespaces How to manage filters and subscriptions How message types, filters, subscriptions and namespaces work together
Page 77
Chapter 9 Managing Applications, Message Types and Subscriptions
About Applications
Overview Applications refer to any system which either provides or consumes data. All applications which interface with REIEDataTrans can be managed using the Application screen. To access the Application screen, on the Environment ribbon bar, click the Application Management button. Application Tasks To access the Application screen, on the Environment ribbon bar, click the Application Management button. From the Application screen you can carry out the following actions: Create a new application Delete applications View applications (and associated data elements where applicable) Manage Areas Remove Areas Export application details to Microsoft Excel
The Manage Areas and Remove Area buttons are used for assigning and unassigning applications to REIE areas.
Page 78
About Message Types and Namespaces

Overview A message type is made up of one or more of the following entities: Applications Match sets Routing events Data elements
When information is routed it is first cross-referenced against a number of user-defined match sets to determine which specific route it should take. Match sets can be relatively explicit with regards to the criteria that needs to be matched in each message. If any of the match sets defined for a message type are evaluated as true (OR condition), a message is matched to a message type. If all the matches defined for a match set are evaluated as true (AND condition), the match set is evaluated as true. Match sets are made up of matches. A match is an XPath query that is carried out on the payload passed to it using a RegEx (regular expression). An example of an XPath query is //Header/Value/text(). An example of a regular expression is
/bFirst Value/b.
Router Sender adapters and match sets both use namespaces. When the Router Sender routes a message towards its destination, the message type uses namespaces to interpret the payload. If the namespace specified for the Router Sender matches one of the namespaces specified for a match in the match set, then the message is routed accordingly. Messages on match sets can share namespaces. The Message Types Screen This section explains how to display the Message Types screen. From this screen you can do the following: Create new message types Edit existing message types Delete message types View and edit routing events View and edit namespaces
To display the Message Types screen: 1. On the Home ribbon bar, click the Message Types button. The Message Types screen is displayed.
Page 79
The Message Types screen shows the message types that have been set up for the environment. The message types are listed in alphabetical order. For each message type, the number of associated match sets and routes is given.
Note: The Search field acts as a filter to help you find a particular message type in a long list. Type a string of characters in the Search field to see only those message types with names that contain the specified string. The search is not case-sensitive.
When you select a message type, the Message Types Quick Actions ribbon gives information about that message type.
2. Click the + sign next to a message type name to see the route(s) that have been assigned to that message type. For each route, the number of associated interceptor adapters and the destination is given.
Creating a New Message Type
To create a new message type: 1. With the Message Types screen active, on the Quick Actions ribbon bar click the New Message Type button. The New Message Type dialog is displayed.
Page 80
2. In the Name field enter the name of the message type. This must be unique within the system. 3. In the Description field, enter a brief description of the function of the message type. 4. Click Save. The message type is created. The Message Type (MessageTypeName) screen is displayed. The Message Type screen shows the components of the message in a tree structure. The Message Type (MessageTypeName) screen has its own Quick Actions ribbon. This ribbon (not to be confused with the Message Types ribbon) provides options to configure all aspects of the message type and navigate to other areas within REIE.
5. To add existing applications to the Message Type, select your preferred applications from the Application Selection panel The selected application(s) are automatically added underneath the Application node of the Message Type as shown in the following diagram:
Page 81
Note: Assigning applications to a message type, implies the message type will only be used when data from or to any of the assigned applications is processed.
6. To add a MatchSet, on the Quick Actions ribbon bar click the New Match Set button. The New Match Set dialog is displayed.
You can define more than one match set for a message type. The rules relating to matching messages are as follows: For a message to be matched to a message type, any of the match sets may evaluate as true (OR condition) For a match set to be evaluated as true, all the matches within a match set must be evaluated as true (AND condition)
7. In the Name field, enter the name of the match set. 8. Click Add New to add a match to the match set. The New Match dialog is displayed.
Page 82
9. From the Namespace drop-down list, select the namespace that is appropriate to the match from the list of namespaces that have been specified for the environment. For more information on creating namespaces refer to the section Managing Namespaces on page 88. The Default Namespace is used if no namespace is required. There is a default namespace defined for each environment which cannot be deleted or changed. 10. In the XPathQuery field, enter an element to query a specific field in the payload. 11. In the Regular Expression field, enter a regEx value to match against the value returned from the XPath query. 12. In the Match Description field, enter a brief description of the function of the match. 13. Click OK. The New Match dialog closes and the data is copied to the New Match Set dialog. 14. Repeat steps 8 to 13 to add multiple matches to the match set.
Note: The Sample Header XML field is a notepad where you can enter example code if required. This XML data is for information only and will not form part of the match evaluation.
The figure below shows a match set with two matches.
Page 83
Chapter 9 Managing Applications, Message Types and Subscriptions 15. When you have added all the required matches for the message type, click the OK button on the New Match Set window. The newly created match set is shown in the tree structure of the Message Type (MessageTypeName) screen.
Note: The match set has not been saved at this point. To associate the match set with the message type, click the Save button on the Message Type screen
16. On the Message Type (MessageTypeName) screen on the Quick Actions ribbon, click the Add Route button. The Add Route menu is displayed. 17. Do one of the following: Click New Route to associate a new Routing event with the message type. For more information on adding a new Routing event, refer to the topic Adding a Routing Event on page 38. Click Existing Route to associate an existing Routing event with the message type.
When you select to associate an existing Routing event with the message type, the Choose Routes dialog is displayed, listing all the existing routing events.
18. Select the checkboxes next to those Routing events you want to associate with the message type and click OK. The Routing events are shown in the tree structure of the Message Type (MessageTypeName) screen.
Page 84
19. To add existing Data Elements to the Message Type, specify a schema and select the associated data elements from the DataElement Selection panel The selected data element(s) is automatically added underneath the Data Element node of the Message Type as shown in the following figure:
20. Click Save on the Message Type (MessageTypeName) screen to complete the association of Applications, Match sets, Routing events and Data Elements with the message type. You have now set up the message type.
Page 85
Editing an Existing Message Type
To edit an existing message type: 1. On the Message Types screen do one of the following: Double-click a message type. Click once to select a message type and then click the Edit Message Type button.
The Message Type (MessageTypeName) screen is displayed. The name and description of the message type are displayed in the pane on the right of the screen. 2. Edit the message name and description as required. 3. To edit a match set, click the + sign next to the Match Sets node in the tree structure. The matches in the match set are displayed. 4. Click the match set you want to edit. The matches in the match set are displayed in the pane on the right of the screen. 5. Select the match you want to edit and click the Edit button. The Edit Match dialog is displayed. 6. Make changes to the match properties as required. 7. Click OK to register your changes. You are returned to the Message Type (MessageTypeName) screen with your changes displayed in the list of matches. 8. To remove a match from a match set, select a match in the tree view and click the Delete button. A confirmation message is displayed.
9. Click Yes to delete the selected match. You are returned to the Message Type (MessageTypeName) screen with the match removed from the list of matches. 10. Follow steps 8 and 9 to remove additonal match sets from the message type as required. 11. To remove a Routing event from the message type, select the route you want to remove and click the Remove Route button A confirmation message is displayed.
Page 86
Note: When you remove a Routing event from a message type, only the relationship between the message type and the event is removed; the event is not permanently deleted.
12. To remove Applications from the message type, uncheck applications as required using the Application Selection panel 13. To remove Data Elements from the message type, uncheck data elements as required using the DataElement Selection panel 14. When you have finished editing the message type, click Save on the Message Type (MessageTypeName) screen to register your changes.
Warning: Routes are shared by message types so take care when editing a route on a message type. If you make changes to a route on a message type this will also affect other message types that reference this route. You are strongly recommended to make changes to routes from the Event Viewer (Event Id) screen. You must save your changes on the Message Type (MessageTypeName) screen, otherwise the changes will not be saved when the screen is no longer active. Tip: To discard your changes before saving, on the Message Type Quick Action ribbon click Refresh. The Name and Description fields, as well as all other configurations for this message type, will be reloaded.
Deleting a Message Type
To delete a message type: 1. On the Message Types screen select the message type you want to delete. 2. Click the Delete Message Type button. A confirmation message is displayed.
3. Click Yes to delete the selected message type. You are returned to the Message Types screen with the message type removed from the list.
Note: When a message type is deleted any match sets associated with the message type are also deleted. However the Routing events associated with the message type are not deleted.
You can also delete a message type from the Message Type (MessageTypeName) screen.
Page 87
Managing Namespaces
Overview Namespaces must be used with an XML schema. When a payload is being routed the match set with the required route uses the relevant namespace to interpret the payload and determine whether the payload passes or fails the match. You can create as many namespaces as you wish. This section explains how you do the following: Viewing Namespaces To see the namespaces that have been defined for the environment: 1. On the Home ribbon bar, click the Routing button. The Routing menu is displayed. 2. Select Namespaces. The Namespaces screen is displayed. View namespaces Create namespaces Edit namespaces Delete namespaces
The Namespaces screen lists all the namespaces defined for the environment. 3. Select a namespace from the list. The Namespaces Quick Actions ribbon associated with this screen is displayed. This ribbon gives information about the currently selected namespace and allows you to carry out a number of actions on namespaces.
Page 88
4. To search for a namespace in a long list of namespaces, enter a character string in the Search field and click Search. Only those namespaces with names that contain the specified string are displayed. 5. To redisplay the list of namespaces, clear the Search field and click Search again. Creating a New Namespace
To create a namespace: 1. On the Namespaces Quick Actions ribbon, click New Namespace. The New Namespace dialog is displayed.
2. In the Name field, enter a unique name for the namespace. 3. In the XML Namespace Prefix field enter the namespace prefix that is being used in the XML payload. 4. In the XML Namespace field enter what the namespace represents. 5. In the XML Header Tag field enter what represents the header tag. 6. In the XML Message Body Tag field enter a tag that represents the XML body in the payload. 7. Click the Save button to save the new namespace. The newly created namespace is added to the list on the Namespaces screen.
Page 89
Editing a Namespace To edit an existing namespace: 1. On the Namespaces screen do one of the following: Double-click a namespace. Click once to select a namespace and then click the Edit Namespace button.
The Edit Namespaces dialog opens.
2. Edit the namespace parameters as required. 3. Click the Save button to save all changes to the namespace. Deleting a Namespace To delete a namespace: 1. On the Namespaces screen Click once to select a namespace and then click the Edit Namespace button. A confirmation message is output.
2. Click Yes to delete the namespace. All the matches that referenced this namespace will point to the default namespace.
Note: Take care when deleting namespaces as deleting a namespace affects all message types and Router Sender adapters that reference the namespace within its match criteria.
Page 90
Other Actions from the Namespaces Screen
The remaining actions that are available from the Namespaces screen are listed in the following table.
Button Message Types Routes Action Displays the Message Types screen so that you can create or edit message types. Displays the event list with the Event Type filter fixed to display only Routing events, for you to edit these events. For More Information, Refer to: Creating a New Message Type on page 80 Adding a Routing Event on page 38
Table 6: Other Actions Available from the Namespaces Screen
Page 91
Managing Subscriptions
Overview Subscriptions allow users to extract specific data of interest from routed messages, using simple to complex user defined queries. The rules engine will work through all of the rules assigned to the route event being executed. If the rules are conjoined with ANDS only and a rule fails then no more rules will be processed, however if rules are conjoined by a combination of ANDS and ORS it may need to evaluate all applicable rules before logically comparing all the results. All details of the evaluation process used by the rules engine are logged. Adding a Subscription To add a subscription: 1. On the Message Type (MessageTypeName) screen: Select a Data element Click the Add Subscription button
The Message Type (MessageTypeName) screen is refreshed as shown below:
2. In the General panel, enter a Name for the new subscription. 3. In the General panel, specify the Source Application using the drop down list
Note: The drop down only shows a list of the currently active applications.
4. In the Batch Criteria panel, specify the type of payload to be sent down the subscription route. The options include:
Page 92
Chapter 9 Managing Applications, Message Types and Subscriptions Full - The entire payload (message) will be sent when the first data element passes the subscriptions filter conditions. If no data elements meet the criteria, the message is not dispatched to that subscription route Partial - Data elements that pass the subscriptions filter conditions, are queued and batched using parts of the original message associated with the data element as reconstructed payloads before being dispatched Maximum Amount - This represents the total number of elements queued in the partial payload. The payload is dispatched to the subscription route when the specified number (maximum amount) of elements are accrued Maximum Size (KB) - This represents the total file size of the data elements in the partial payload. The payload is dispatched to the subscription route when the total size of data elements contained in the queue reaches or breaches the specified limit (maximum size) Click Select Existing Route to associate an existing Routing event with the subscription Click Create New Route to associate a new Routing event with the subscription. For more information on adding a new Routing event, refer to the topic Adding a Routing Event on page 38.
The data elements are queued based on the choices described below:
5. Do one of the following, to specify a route for the Destination Filter:
When you choose to associate an existing Routing event with the message type, the Choose Routes dialog is displayed, listing all the existing routing events. The Routing events are shown in the tree structure of the Message Type (MessageTypeName) screen.
6. Select the checkboxes next to those Routing events you want to associate with the message type and click OK. 7. Select the Exception Filter tab and repeat steps 5 to 7 to specify a route for the Exception
Page 93
Chapter 9 Managing Applications, Message Types and Subscriptions Filter 8. Click the Save button to save all subscription changes to the message type.
Note: The filtering criteria used in the Destination and Exception filters can be enhanced by using the the embedded query design shown below.
For more information on the query designer, refer to the topic Using the Query Designer in Chapter 11, About the Query Designer.
Page 94
10 Managing Variables
Overview
About Variables Variables provide a level of abstraction between the implantation configurations and the environment onto which they are deployed. There are four types of variable: Global variables Environment variables Area variables Local variables
These types of variable are described below. About this Chapter This chapter describes the different types of variable used by REIE and how you can define your own variables for use in: Adapter configuration parameters Transactions Journal configurations Application configuration sets
Note: Tokens are an additional type of variable. Tokens may be used in adapter configuration properties only and are tokenised by $. Variables are read and replaced by the MSL while tokens are read and replaced by the adapters. All the available tokens and the values with which they will be replaced when an event is run are listed in Appendix B, Tokens.
Page 95
Chapter 10 Managing Variables
Understanding Variables
Global Variables Global variables cannot be created or extended by users and are replaced automatically. They are tokenised by #. There are three standard global variables: Environment and Area Variables
dtScheduleDsn: Connection string to the dtSchedule database dtLogDsn: Connection string to the dtLog database dtJournalDsn: Connection string to the dtJournal database
Environment variables may be used throughout the environment, while area variables apply to a specific area. Environment and area variables are tokenised by #. Environment variable names must be unique for each environments and across all areas. Area variable names need be unique only to a particular area. You define your own environment and area variables from the Variables screen. For more information refer to the next section.
Note: A user will be able to see only those area variables for the areas that he or she is able to access.
Local Variables
Local variables cannot be created or extended by users and are replaced automatically. Local variables are tokenised by ^. There are three standard local variables:
InstallDir: The name of the folder in which the application or service is installed HostName: The name of the machine on which the application or service is installed ApplicationName: The name of the application or service
Restriction on Use of Tokenizing Characters
The characters # and ^ may be used only to tokenize variables and nowhere else in the adapter configuration properties or business transactions.
Page 96
Defining Variables
Overview You define environment and area variables from the Variables screen. The figure below shows an example of the Variables screen with some variables created.
Defining and Environment or Area Variables
To define an environment or an area variable: 1. On the Environment ribbon click the Variables button. The Variables screen is displayed. 2. Click Add Variable. A new row is added for you to define the variable. By default Use is set to Environment. 3. Click the Variable field and enter the name of the variable. 4. Click the Value field and enter a value for the variable. The exclamation symbol shows that it is mandatory to enter a variable name.
Note: As shown in the figure above, a variable value can contain a reference to another variable. If this is the case, the referenced variable is enclosed by # symbols, for example: #RootDir#\Archive.
5. If you are defining an area variable, click the Area field and from the drop-down list, select the area with which the variable is to be associated. 6. Click Save to save your changes.
Page 97
Note: You can click Remove Variable at any time to remove a variable from the list.
Page 98
Using Variables
Searching for Variables The fields at the top of the Variables screen allow you to search for variables. These fields and their function are described in the table below.
Field Use Description By default this field contains All, so that all variables are listed. If required you can select: Area Variable Value Environment to list only environment variables Area to list only area variables
Select an area from the drop-down list to display only those variables associated with the selected area. Enter a string to display only those variables with names that contain the specified string. Enter a value to display only those variables that are set to the specified value.
Table 7: Search Fields on the Variables Screen
Using Variables in Adapter Configurations
The figure below shows variables used in an adapter configuration.
Figure 1: Variables Used in an Adapter Configuration
For more information on configuring adapter properties, refer to the section entitled Adding and Removing Adapter Properties on page 60.
Page 99
Using Variables in Transactions
The figure below shows a variable used in a transaction.
Figure 2: A Variable Used in a Transaction
For more information on writing transactions, refer to Chapter 4, Managing Business Transactions. Using Variables in Journal Configurations The figure below shows the global variable #dtJournalDsn# used in the configuration of the SQL Database Journal.
Figure 3: A Global Variable Used in a Journal Configuration
For more information on configuring journals refer to the section Configuring the SQL Database Journal on page 172.
Page 100
Using Variables in Application Configuration Sets
The figure below shows the use of environment variables in the application configuration sets.
Figure 4: Using Environment Variables in the Fail Over Configuration Set
For more information on configuring the application configuration sets refer to the section Changing the Application Configuration on page 23.
Page 101
Page 102
11 Using Data Analytics

Overview
About Data Analytics About this Chapter Data Analytics refers to the ability to extract, filter and report on data processed by REIE. This chapter covers the following REIE components: The Data Analytics Dashboard Data Part Configuration The Query Designer
Page 103
Chapter 11 Using Data Analytics
Data Analytics Dashboard

Overview The Data Analytics Dashboard provides end users with a Silverlight web based data part (widget) driven graphical display of data. This section explains how to display the Data Analytics website. From this website, you can do the following: Displaying the Data Analytics Dashboard View Data Parts Edit Layouts Save Layouts Delete Layouts Refresh the Toolbar Toggle Output Console
To display the Data Analytics Dashboard: On the the Home ribbon bar, click the Data Analytics Dashboard button. The Data Analytics Dashboard is displayed.
The homepage of the dashboard is defined by the value given to the dashboardUrl variable. This value is shown as the screen name e.g. http://I009QAAPPS03/ DataAnalyticsDashboard
Page 104
Viewing Data Charts To view data charts: Click the dataparts shown in the left hand pane. The respective charts are displayed in the main pane.
You can use the following buttons , , , or close charts and panes within the dashboard. Viewing Dashboard Layouts
and
to minimise, expand and/
To view the Dashboard layouts Click Layouts in the left hand pane. This alters the current view to a list of layouts. The layouts define how a collection of data parts should be displayed. Layouts are shared by all users of the system. The data parts can be dragged to the preferred position within the main pane. Changes to the layout can be saved by using the Update Current Layout button under Controls. For more details, see the procedure called To view the Dashboard controls:
Page 105
Viewing the Dashboard Controls
To view the Dashboard controls: Click Controls in the left hand pane. This alters the current view to a list of supported controls.
Page 106
Using the Toggle Output Console and Refresh Toolbar buttons
To use the Toggle Output Console and Refresh Toolbar buttons Click the Toggle Output Console button. The view is altered to display a status pane which shows regular updates of ongoing processing.
Clicking the Refresh Toolbar option, refreshes the current view and shows the Toolbar Refreshed confirmation as shown in the figure above. The data parts are refreshed at the interval configured for each part.
Page 107
Data Part Configuration

Overview Data Parts refer to the underlying user defined groups of data which drive the graphical display (charts) shown in the DataAnalytics Dashboard. This section explains how to access and use the Data Part List screen. From this screen, you can do the following: View Data Parts Edit Data Parts Create new Data Parts Delete Data Parts Preview Data Parts
Note: Data parts have no correlation with data elements or subscriptions. They represent the source data on which the charts shown in the Data Analytics Dashboard are based.
Displaying the Data Part List Screen
To display the Data Part List screen On the the Environment ribbon bar, click the Data Part Configuration button. The Data Part List screen is displayed.
The chart type of each data part along with its Active/Inactive status, is also displayed on the Data Part List screen.
Page 108
Previewing an Existing Data Part
To preview an existing Data Part: 1. Select a data part from any listed in the Data Part List screen. 2. Click the Preview Data Part button. The preview dialog is displayed.
Creating a Data Part To create a new Data Part: 1. On the the Environment ribbon bar, click the Data Part Configuration button 2. Click the New Data Part button The Add Data Part screen is displayed.
Page 109
Chapter 11 Using Data Analytics 3. Enter a Name for the new data part. 4. Specify the automated refresh frequency in the Updates (in s) field.
Note: If the update interval specified is 0 seconds, the datapart will only be updated the first time it loads.
5. Choose a Chart Type from the dropdown list. The list is displayed below:
6. Specify a Title for the new chart. 7. To add a new series and/or filter, click the Add Series button. Additional detail is provided in the section About the Query Designer. An example of the final screen after a series and has been added is displayed below. Click the OK button to return to the Add Data Part screen
8. Define your X-axis, Y-axis, Segments or Values (if required). This depends on the chart type chosen in step 5.
Note: The contents of the drop down lists used to define the X-axis, Y-axis, Segments or Values fields are populated with the aliases of the columns chosen when adding a series in the previous step.
Page 110
Chapter 11 Using Data Analytics 9. Click the Save button to finalise your changes and return to the Data Part List screen. The newly created data part is listed. Click the Refresh button if required.
Page 111
About the Query Designer

Overview The Query Designer functionality is used for: The creation of a data part The creation of a filter rules for a subscription
Note: When the query designer is used during the creation or management of a data part, the entire window (including the Columns and Filters panels) is displayed. However, during the configuration of a subcription, only the relevant Filters panel is provided.
This section covers the following: Using the Query Designer The basics of the query designer How to use the query designer to specify a series for a data part chart How to use the query designer to specify filter conditions for a subscripton An overview of the supported functions/expressions used within the query designer
When the query designer is used during the creation or management of a data part, the entire window (including the Columns and Filters panels) is displayed as shown below. For details on creating and managing data parts, please refer to the procedure described in the procedure called Specifying a series for a data part chart:
When the query designer is used during the configuration of filters for a subscription, only the Filters panel is provided. For details on creating and managing subscriptions, please refer to the
Page 112
Chapter 11 Using Data Analytics section Managing Subscriptions
The options provided in the Source fields of the Columns and Filters panels include: Column - A field in the underlying dataset can be specified in the Value field. Constant - A user defined string can be specified in the Value field.
Note: When the Constant option is chosen, clicking the elipsis button in the Value field brings up the Expressions window. You can specify the type of constant from a choice of String, Boolean, Date/ Time, Decimal Number, Integer, Large Integer and Real Number
Function - This enables a user to pass parameters as inputs in the Value field.
Note: When the Function option is chosen, clicking the elipsis button in the Value field brings up the Expressions window. The supported set of expressions for functions are detailed in the topic Using functions and expressions.
Query Value - Uses the scalar value of the output of the query specified in the Value field.
Note: When the Query Value option is chosen, clicking the elipsis button in the Value field brings up another Query Designer window. This supports the nesting of several queries.
Page 113
A summary of the additional options provided in the Columns panel is provided below: Any number of columns can be added using the Add Column button Columns can be removed using the Remove Column button The Alias field is a user defined label attached to the output for each query/series The Is Grouped field is used to specify how query results should be grouped The In Output field specifies which results should be used for downstream processing The Order By field is used to sort in ascending or descending order The Order By Position field indicates the sequenced used when sorting
A summary of the additional options provided in the Filters panel is provided below: The Add AND button is used to add mandatory conditions to subscription filters and queries The Remove AND button is used to remove mandatory conditions to subscription filters and queries The Add OR button is used to add optional conditions to subscription filters and queries
The Advanced tab of the Query Builder allows you to specify your queries and subscription filter rules in XML as shown in the figure below.
Page 114
Tip: The Validate expression button can be used to check the XML code for correctness.
Specifying a Series for a Data Part Chart
Specifying a series for a data part chart: 1. In the Add Data Part screen, click the Add Series button. A new series row is displayed.
Page 115
Chapter 11 Using Data Analytics The chart type determines the list of mandatory fields for each series. For details, refer to Data Part Series - Mandatory Fields on page 116. 2. Alter the default series name (if required) 3. Click the ellipsis button in the Query column.
This displays the Query Designer window. 4. Select the source for your data part using the dropdown list in the Source panel 5. On the Output panel, you have the options to: Specify the return of only distictly unique rows Specify the maximum row count either as an absolute value or as a precentage
6. Click the Add Column button, to specify which columns from the table chosen in Step 4, will be used to populate the data part. Alter the default Aliases (if required)
Note: The Aliases will be used as the names of either the X or Y axis, Segment or Value.
Note: There is no limit on the number of columns which can be added.
7. Click the Add AND and/or OR button, to specify the filter conditions
Note: Any combination of ANDs/ORs can be used when specifying the filter rules.
8. Click the OK button to return to the Add Data Part screen. Data Part Series Mandatory Fields
Chart Type Name Query X-Axis Y-Axis Segments Values
Bar Column Grid
X X X
X X X
X X
X X
Table 8: Data Part Series - Mandatory fields per chart type
Page 116
Chart Type
Name
Query
X-Axis
Y-Axis
Segments
Values
Line Pie Scatter
X X X
X X X
X X
X X X X
Table 8: Data Part Series - Mandatory fields per chart type Specifying a Filter for a Subscription
To specify a filter for a subscription: Refer to Managing Subscriptions on page 92.
Using functions and expressions
When Function is specified as the source when creating either data parts or subscription filters, clicking on the ellipsis in the Value form brings up the Expression window
Clicking on the Parameters button allows you to specify the parameters for the chosen function.
Page 117
Chapter 11 Using Data Analytics An overview of all supported expressions is provided in the following table.
Function Name Description Sums two values together Left Right Parameters Output & Constraints This operation returns a number that is the sum of the two parameters. Requires both parameters to be numeric scalar types
Add
And
Determines whether two arguments are both true
Left Right
This operation returns a boolean true value if both arguments are true, else it returns false. Requires both parameters to be boolean types
Average
Aggregation function. Takes the mean of a parameter over the group of records.
Parameter
This operation returns the average of all the values of the parameter over the group Requires a single numeric parameter
Cast
Changes the type of a value
Left Right
This operation returns the value specified as the first parameter to the type specified in the second parameter The first parameter can be any value of any type, while the second parameter must be a String
Concatenate
Concatenates all the parameters together into one string value.
Left Right
This operation returns a string value of all the parameters concatenated into one string Requires at least two string parameters, but can take any number (more than two) of string parameters
Count
Aggregation function. Returns the number of records in the group of records.
Parameter
This operation returns an integer that is the number of records in the group Requires one parameter (any column of the set)
Table 9: Supported Functions
Page 118
Function Name
Description Divides one value by another Left Right
Parameters
Output & Constraints This operation returns a number that is the first (left) parameter divided by the second (right) parameter. Requires two parameters, both numeric scalar types. Note that the second (right) parameter may not evaluate to zero
Divide
Greater than
Determines whether the first (left) parameter is greater in value than the second (right) parameter
Left Right
This operation Return true if the first (left) parameter is greater in value than the second (right) parameter Requires two parameters, a first (left) and second (right) parameter. Both parameters must be comparable e.g. numeric, date/time, etc.
In Set
Determines whether a specific value exists in a set of values
Left Right
This operation returns a boolean true if the value was found in the set of values, false if the value was not found in the set Requires two parameters, first (left) the value to look up, and second (right) the data set to search. The first parameter must be a scalar value, while the second parameter must evaluate to a data set
Is Equal
Determines whether two values are equal
Left Right
This operation returns true if the two values have the same values Requires two scalar values to be checked
Is False
Asserts whether a value is false.
Parameter
This operation returns true if the specified value is false Requires a single boolean parameter to check
Is Not Equal
Determines whether two values differ
Left Right
This operation returns true if the two values differ Requires two scalar values to be checked
Page 119
Function Name
Description Determines whether a variable contains a value
Parameters Parameter
Output & Constraints This operation returns true if the variable contains a value (is not null) Requires a single parameter that will be checked for a value
Is Not Null
Is Null
Determines whether a variable is empty
Parameter
This operation returns true if the variable does not contain a value (is null) Requires a single parameter that will be checked for a value
Is True
Asserts whether a value is true.
Parameter
This operation returns true if the specified value is true Requires a single boolean parameter to check
Less Than
Determines whether the first (left) parameter is less in value than the second (right) parameter
Left Right
This operation Return true if the first (left) parameter is less in value than the second (right) parameter Requires two parameters, a first (left) and second (right) parameter. Both parameters must be comparable e.g. numeric, date/time, etc.
Like
Determines whether the text to match conforms to the match criteria. Use % to match any text of any length and _ to match a single character. Use the ! character as an escape character. e.g: to match values containing the text 10%, use %10!%% Aggregation function. Takes the maximum off a parameter over the group of records
Text to Match Match Criteria
This operation returns true when the text to match contains a match with the specified criteria Requires two scalar string values
Maximum
Parameter
This operation returns the maximum of all the values of the parameter over the group Requires a single parameter that will evaluate to a numeric scalar value
Page 120
Function Name
Description Aggregation function. Takes the minimum off a parameter over the group of records
Parameters Parameter
Output & Constraints This operation returns the minimum of all the values of the parameter over the group. Requires a single parameter that will evaluate to a numeric scalar value
Minimum
Minus
Subtracts one value from another.
Left Right
This operation returns a number that is the second (right) parameter subtracted from the first (left) parameter. Requires two parameters, both numeric scalar types
Multiply
Multiplies two parameters. Left Right
This operation returns a number that is the product of the two parameters Requires two parameters, both numeric scalar types
Now
Gets the current date/ time. The value of this function will get the date/ time of the internal clock of the machine the expression is evaluated on Determines whether any of the two arguments are true
None
This operation returns the current date/time This function does not take any parameters
Or
Left Right
This operation returns a boolean true value if one or both of the arguments are true else it returns false. Requires two parameters, both boolean types
Set
Creates a set of values to use in place of a query
Parameter
This operation returns a non-scalar set of values in one column Requires any number of values, to be used as the values in the set
Single
Gets the scalar result of a non-scalar set
Parameter
This operation returns a scalar value that is the value of cell in the data set Requires one parameter that is the set to be inspected. The set may have only one column, and only one row
Page 121
Function Name
Description Returns a substring of the source string Start Length
Parameters Source
Output & Constraints This operation returns a string which is the substring requested Requires three parameters, First a source string, second an integer which is the zero-based index into the source string, and third an integer which is the length to return This operation returns the sum of all the values of the parameter over the group. Requires a single parameter that will evaluate to a numeric scalar value
Substring
Sum
Aggregation function. Takes the sum off a parameter over the group of records
Parameter
Page 122
12 Embedded Resources
Overview
About Embedded Resources Embedded Resources refer to the ability to store any resources required for orchestrations as part of the REIE configuration. These resources may be anything from executables to XSL transforms and are included in the exported configuration to allow for easy client deployments. This chapter explains: How to embed resources to the REIE configuration How to use embedded resources in the REIE application
About this Chapter
Page 123
Chapter 12 Embedded Resources
Using Embedded Resources

Overview Embedded resources can be used during the configuring of a techonogy adapter when creating or modifying an REIE event. This section describes how embedded resources can be accessed and added to the REIE application. It also describes how embedded resources can be added to and/or employed in the REIEDataTrans application. Accessing Embedded Resources
To access the embedded resources: Click the Embedded Resources button on the Environment ribbon bar. The Embedded Resources screen is displayed.
From this screen, you can edit, add or delete embedded resources. Embedding a New Resource To embed a new resource: 1. With the Embedded Resources screen displayed, click the New button. The Add Embedded Resources screen is displayed.
Page 124
2. Enter the Name and Description of the new embedded resource. 3. Click the ellipsis button to upload the resource from the file system.
4. Click the Save button to confirm changes. Downloading an Existing Embedded Resource
To download an existing embedded resource: Double click an embedded resource from the list provided on the Embedded Resources screen. The Embedded Resource Editor screen is displayed.
Click the Download button, to save the selected embedded resource to disk.
Page 125
Adding an Embedded Resource by Using the Value Editor
To use the Value Editor to add an embedded resource: 1. In the Event Viewer screen, select the property of the adapter to be configured/altered.
2. Click the
button.
This displays the Value Editor window.
Page 126
3. Select the Resources tab. 4. Double click your chosen resource The value and preview of the selected resource are shown.
5. Click the OK button to confirm changes. The Value Editor window closes and the value of the embedded resource is assigned to the property.
Page 127
Chapter 12 Embedded Resources The assigned resource is deployed into a cache for each service and the adapter property reference is updated to use this file. For additional information on how to fully configure adapters, refer to the section Configuring Technology Adapters on page 57.
Page 128
13 Managing Processes
Overview
About Processes A set of events that combine to carry out a specific task may be combined to form a process. Similarly, a set of processes can be combined as an aggregated process. There is no mandatory requirement to either combine events into processes or processes with each other, but these groups can provide a number of clear advantages: It is easier to track messages as they move through the REIE runtime environment; this in turn makes it easier to apply complex validation, enrichment and routing routines It is easier to define dependencies within the Events Manager as a dependency can be defined on completion of one or more processes You can link one or more documents to a process or aggregated process to provide a graphical overview of all the activities in a configuration. For more information on creating documents, refer to Chapter 14, Managing Process Documents.
About this Chapter
This chapter explains the following: The concept of a process How to view and add processes How to add events to a process How to add processes to an aggregated process How to track process instances from the Process Administration screen
Page 129
Chapter 13 Managing Processes
Using the Process Management Screen

Overview The Process Management screen is the main screen for managing processes. From this screen you can carry out the following actions: Displaying the Process Management Screen Run a process Force the end of a process Edit an existing process Create a new process Delete processes Assign events to a process
This topic explains how to display the Process Management screen. To display the Process Management screen: On the Home ribbon, click the Manage Processes item. The Process Management screen is displayed as shown in the figure below.
Click the + sign next to a process to see the events and documents assigned to that process. Adding a New Process This topic explains how to add a new process. To add a new process: 1. On the Process Management screen, click the New Process item.
Page 130
Chapter 13 Managing Processes The New Process Detail screen is displayed.
2. In the Name field, enter the name of the process. 3. In the Description field, enter a brief description of the process. 4. Select the Allow multiple instances check box if you want a new process instance to be created each time a start event type is initiated.
Note: If you leave the Allow Multiple Instances check box deselected, a new process instance is created only when no other processes of the same type are running.
5. Click Save to create the process. Events and documents can now be assigned to the new process using the View Process Detail (ProcessIdentifier) screen.
Page 131
Chapter 13 Managing Processes The Unassigned Events list shows all those events that are not currently assigned to a process. As an event can exist only within one process, the Unassigned Events list excludes events that have already been allocated to other processes. 6. In the Unassigned Events list, click the first event you want to assign to the process. 7. Click the left arrow to move the selected event to the Assigned Events list. 8. Repeat steps 6 and 7 until you have assigned all the required events to the process.
Note: To re-order the events in the Assigned Events list, click an event and then click the Move Up or Move Down button repeatedly until the events are in the correct order.
The Sequence column is purely an indication of the order of events within the panel and is for display purposes only. It does not reflect the sequence in which the events will execute within the process. The sequence of events within the process is determined by event chaining or by actions being carried out on the server; for example, the movement of files. By default the Type of event is set to Normal. You must specify at least one start event and one end event for the process. Normal events are logged in the same process instance as that created by the start event. If there are multiple instances of the process running (due to Allow Multiple Process and a succession of start process instances without end process instance events) then a Normal event will always be added to the most recent process, even if the intention is for it to have been part of another process instance. 9. Each entry in the Type column is a drop-down list. To specify a start event, click the down arrow and select Start from the drop-down list. If required, specify one end event by selecting End from the drop-down list in the same way.
Page 132
Note: If an event is of type Start, this means that the event can start the process. It is possible to have a scenario where more than one event may start a process. For example, consider a process that imports three types of customer data into a system: Names Addresses Account details
The process contains an event that receives each type of data. Any type of data may arrive first, so any one of the three receive events must be able to start the process. A process may only ever have one end event.
10. On the View Process Detail (ProcessIdentifier) screen, click the Documents tab. The Documents screen is displayed.
The Unassigned Documents list shows those documents that have been created but not yet assigned to a process.
Note: When you are creating a process you have the opportunity to assign one or more documents to the process. A document is a flowchart which gives a graphical view of one or more events. Assigning documents to a process is not mandatory, but you are strongly recommended to do as it makes the process function clearer for others to understand and the process flow easier to visualise. You can create a document from within REIE or export a document created using Microsoft Visio. It is a good idea to create the document before you create the process, but if necessary, you can go back to the process and add documents at a later time. For more information on creating documents, refer to Chapter 14, Managing Process Documents.. For more information on importing documents, refer to the section Exporting and Importing Document Files on page 159. For more information on editing processes, refer to the topic Editing an Existing Process on page 138.
11. In the Unassigned Documents list, click the document that you want to assign to the process. Documents may be assigned to multiple processes, therefore the documents in the Unassigned list together with the documents in the Assigned list must represent the total collection of documents in the system. This is unlike events where the events assigned to other processes are not shown. 12. Click the left arrow to move the selected document to the Assigned Documents list. 13. Repeat steps 6 and 7 until you have assigned all the required documents to the process.
Page 133
Chapter 13 Managing Processes 14. Click Save to save your changes to the process. When you return to the Process Management screen, the process is shown in the list. The process is allocated a unique identifier. Like event identifiers, process identifiers are sequential starting from 100001. From now on, whenever you see the process listed on the Process Management screen or review the events in the process on the View Process Detail screen, you will always see the event identifier. You have now created the process and it is ready to run.
Page 134
Creating a New Aggregated Process
This topic explains how to add a new aggregated process. To add a new aggregated process: 1. On the Process Management screen, click the New Aggregate Process item. The New Aggregate Process Detail screen is displayed.
2. In the Name field, enter the name of the aggregated process. 3. In the Description field, enter a brief description of the process. 4. Select the Allow multiple instances check box if you want a new aggregated process instance to be created each time a start event type is initiated.
Note: If you leave the Allow Multiple Instances check box deselected, a new aggregated process instance is created only when no other processes of the same type are running.
5. Click Save to create the aggregated process. Events, processes and documents can now be assigned to the new process using the View Aggregate Process Detail (ProcessIdentifier) screen.
Page 135
The Unassigned Events and Processes list shows all those events that are not currently assigned to a process. As an event can exist only within one process, the Unassigned Events and Processes list excludes events and processes that have already been allocated to other processes/aggregated processes. 6. In the Unassigned Events and Processes list, click the first event/process you want to assign to the process. 7. Click the left arrow to move the selected event to the Assigned Events and Processes list. 8. Repeat steps 6 and 7 until you have assigned all the required events and/or processes to the aggregated process.
Note: To re-order the events in the Assigned Events and Processes list, click an event and then click the Move Up or Move Down button repeatedly until the events are in the correct order.
Page 136
Chapter 13 Managing Processes The Sequence column is purely an indication of the order of events and processes within the panel and is for display purposes only. It does not reflect the sequence in which either the events or processes will execute within the aggregated process. The sequence of events and/or processes within the aggregated process is determined by event chaining or by actions being carried out on the server; for example, the movement of files. By default the Type of event or process is set to Normal. You must specify at least one start event or process for the aggregated process. Normal events or processes are logged in the same process instance as that created by the start event or start process. If there are multiple instances of the aggregated process running (due to Allow Multiple Process and a succession of start process instances without end process instance events/ processes) then a Normal event or process will always be added to the most recent instance of the aggregated process. 9. Each entry in the Type column is a drop-down list. To specify a start event or process, click the down arrow and select Start from the drop-down list. If required, specify one end event or process by selecting End from the dropdown list in the same way.
Note: If an event or process is of type Start, this means that the event/process can start the aggregated process. It is possible to have a scenario where more than one event or process may start an aggregated process. For example, consider an aggregated process that imports three types of customer data into a system: Names Addresses Account details
The aggregated process contains events and/or processes that receive each type of data. Any type of data may arrive first, so any one of the three receive events and/or processes must be able to start the aggregated process.
10. On the View Aggregate Process Detail (ProcessIdentifier) screen, click the Documents tab. The Documents screen is displayed.
The Unassigned Documents list shows those documents that have been created but not
Page 137
Chapter 13 Managing Processes yet assigned to a process.

Note: When you are creating a process you have the opportunity to assign one or more documents to the process. A document is a flowchart which gives a graphical view of one or more events or processes. Assigning documents to a process is not mandatory, but you are strongly recommended to do as it makes the process function clearer for others to understand and the process flow easier to visualise. You can create a document from within REIE or export a document created using Microsoft Visio. It is a good idea to create the document before you create the process, but if necessary, you can go back to the process and add documents at a later time. For more information on creating documents, refer to Chapter 14, Managing Process Documents.. For more information on importing documents, refer to the section Exporting and Importing Document Files on page 159. For more information on editing processes, refer to the topic Editing an Existing Process on page 138.
11. In the Unassigned Documents list, click the document that you want to assign to the process. Documents may be assigned to multiple processes, therefore the documents in the Unassigned list together with the documents in the Assigned list must represent the total collection of documents in the system. This is unlike events where the events assigned to other processes are not shown. 12. Click the left arrow to move the selected document to the Assigned Documents list. 13. Repeat steps 6 and 7 until you have assigned all the required documents to the process. 14. Click Save to save your changes to the process. When you return to the Process Management screen, the aggregated process is shown in the list. The process is allocated a unique identifier. You have now created the aggregated process and it is ready to run. Editing an Existing Process This topic explains how you can edit an existing process. Editing a process involves any of the following actions: Changing the name and/or the description of the process Changing the status of the Allow Multiple Instances check box Adding events to or removing events from a process Adding documents to or removing documents from a process
To change the process details: 1. On the Process Management screen, select the process you want to edit. 2. Click the Edit Process button on the Quick Actions ribbon. The Edit Process dialog is displayed, showing: The name and description of the process The current status of the Allow Multiple Instances check box
Page 138
Chapter 13 Managing Processes 3. Change the process name, description and Allow Multiple Instances check box status as required. 4. Click Save to save your changes. Changing the Events in a Process
To change the events in a process: 1. On the Process Management screen, select the process you want to edit. 2. Click the View Details button on the Quick Actions ribbon. The View Process Detail (ProcessIdentifier) screen is displayed. The Events tab is currently active. The Assigned Events list shows the events that are currently assigned to the process while the Unassigned Events list shows the list of events that have not yet been assigned to a process. 3. Use the green left and right arrows to move events between the two lists until the Assigned Events list shows those events that are required to be in the process. 4. Use the Move Up and Move Down buttons to ensure that the events in the Assigned Events list are in the correct order. 5. Ensure that the correct type is set for each event. If necessary, select the correct type from the Type drop-down list.
Changing the Documents Assigned to a Process
To change the documents assigned to a process: 1. On the Process Management screen, select the process you want to edit. 2. Click the View Details button on the Quick Actions ribbon. The View Process Detail (ProcessIdentifier) screen is displayed. 3. Click the Documents tab The Documents tab becomes active. The Assigned Documents list shows the documents that are currently assigned to the process while the Unassigned Documents list shows the documents that have not yet been assigned to a process. 4. Use the green left and right arrows to move documents between the two lists until the Assigned Documents list shows those documents that are required to be associated with the process.
Running a Process
Note: You can run a process only if the process has a start event defined that is a Business Transaction event. If that Business Transaction event needs to find specific messages in a specific folder, you can run the process only if the folder exists and the messages are in the folder.
To run a process: 1. On the Process Management screen, select the process you want to edit. 2. Click the Run Process button on the Quick Actions ribbon.
Page 139
Chapter 13 Managing Processes An instance is created for the process and the start event is executed. You can view the status of the process execution from the View Process screen. For more information refer to the section Tracking Process Instances on page 141. Forcing a Process to End Forcibly ending a process means that the events within the process are stopped and the chain of events is broken. Once a process is running you can monitor it from the View Process screen. Refer to the section Tracking Process Instances on page 141 for more information. You can force the end of the process at any time while the process is running. To force a process to end: On the Process Management screen, click the Force Process End button on the Quick Actions ribbon. The process is terminated and the chain of events is broken. Deleting a Process This topic explains how to delete a process. To delete a process: 1. On the Process Management screen, select the process you want to delete. 2. Click the Delete Process button on the Quick Actions ribbon. A message is displayed asking you to confirm the deletion of the process. 3. Do one of the following: Click OK to delete the process. Click Cancel to cancel the deletion.
If you click OK, the relationships between the process, events and documents are removed and the process is deleted.
Page 140
Tracking Process Instances

Launching the Process Instance Screen
To display the View Process Instances screen: On the Home ribbon bar, click the Process button. The View Process Instances screen is displayed.
The View Process Instance Screen
You can track each instance of a process from the View Process Instances screen. The View Process Instances screen lists process instances and their related events or subprocesses.
The screen is divided into three panels. Filter Pane The Filter pane allows you to specify search criteria for process instances. It has Auto Hide and Close buttons on the title bar so that you can display more of the process grid. When the Auto Hide facility is off, you can shrink the filter pane by positioning the mouse pointer on the boundary between the pane and the process grid and dragging to the left.
Note: Once you have closed the Filter pane, you cannot reopen it. By default, when you open a new instance of the View Process screen, the Filter pane is visible.
You can also dock and undock the Filter pane by moving it with the mouse pointer. If required you can dock the pane across the top of the View Process Instances screen.
Page 141
To hide the Filter pane: 1. Click the Auto Hide button on the Filter pane title bar. The symbol changes from vertical to horizontal. A Filter tab appears at on the left-hand side of the screen. 2. Move the mouse pointer away from the Filter pane. The Filter pane slides away to the side of the screen.
3. To redisplay the Filter pane, move the mouse pointer over the Filter tab. Process Grid The process grid lists the process instances for the specified search criteria. You can reveal or hide the events or sub-processes in each instance by clicking on + or - next to the process entry. The event details and the last run status are displayed. Each process instance is displayed in a colour that denotes its termination status: Green: terminated successfully Blue: running or forced to end Red: failed
The number next to the shape associated with an event indicates how many jobs have been created for that event in the current process. Therefore, this value updates only if the Create Job checkbox is selected for that event. When you select a process in the grid, the Process ribbon becomes active. From this ribbon you can carry out a number of process management actions, including: Run a process Force a process to end Change the name and description of a process Create a new process Delete a process Assign events or documents to a process Exporting a process
For more information, refer to the sections earlier in this chapter. For information on exporting a process, refer to Chapter 17, Importing and Exporting Configuration Data. When you select an event in the grid, the Events ribbon becomes active. From this ribbon you can carry out the following event management actions:
Page 142
Chapter 13 Managing Processes Run an event Edit an existing event Create a new event Delete an event
For more information refer to Chapter 3, Managing Events. Document Content Pane The document content pane shows the document(s) assigned to the selected process. The document symbols change colour to reflect the termination status of their associated process instance.
Tip: You can resize the document pane by positioning the mouse pointer between the process grid and the document pane under the Refresh Rate, and dragging the pane.
Searching for a Process Instance
You can locate a process on the View Process screen by searching for the process in the Filter pane. You can search by: Date range Instance ID Process name
Searching by Date Range To search for a process instance by date range: 1. Select a start date from the From drop-down list. 2. Select an end date from the To drop-down list. The process grid displays those process instances which ran during the specified date period. The document associated with the currently selected process is shown in the document area. Searching by Instance ID To search for a process instance by instance ID: 1. Enter the required instance ID in the Search by Instance ID field. 2. Click the Search button. The process with the specified instance ID is displayed in the process grid. The first document associated with the process is shown in the document area. If there is no process with the specified ID, the process grid is empty. Searching by Process Name To search for a process instance by process name: Select a process name from the tree structure.
Page 143
Chapter 13 Managing Processes The process grid will display only the process instances for the selected process. The first document associated with the process is shown in the document area. Refreshing the Process Grid Setting the Refresh Rate enables the process grid to refresh regularly to show the latest process instances running. The default refresh rate is 0 seconds, which means that the screen does not refresh automatically. The figure below shows a refresh rate of 5 seconds.
To specify a refresh rate for the process grid: 1. Click the up arrow next to the refresh rate to set an initial refresh rate of 5 seconds. 2. Click the up arrow repeatedly to decrease the refresh rate by increments of 5 seconds. Once you have set a refresh rate, clicking the down arrow increases the refresh rate by increments of 5 seconds. You can specify the refresh rate by entering a numeric value into the text field without using the arrow buttons.
Page 144
14 Managing Process Documents

Overview
About Documents Documents are associated with processes. A document gives a visual representation of the function of one or more of the events in the process. Documents are very similar in look and feel to Microsoft Visio flowcharts. You can create documents using the Document Manager or import flowcharts created using Visio. You can make the documents as simple or as complex as you like. Like Visio flowcharts, documents are made up of shapes including: Process flow symbols Arrows Miscellaneous symbols including cones, cubes and circles.
Linking a shape with an event means that when an instance of the process is running, when you view the process instance on the View Process screen, you will see the shape change colour to represent the current status of the event. Shapes can be linked to: Documents Events Processes
Creating one or more documents for a process can make it easier to understand the function of the process and how that process works with the other processes to which it is chained. It is not mandatory to create documents for a process, but you are strongly recommended to do so. About this Chapter This chapter provides the following information: What documents are How you create documents using the Document Manager How you assign documents to processes
Page 145
Chapter 14 Managing Process Documents
The Document Management Screen

Overview You manage documents from the Document Management screen. When you first display the Document Management screen, the display area is blank. The Documents tree to the left of the screen lists all the documents that have already been saved, grouped by type. Currently the only supported document type is Diagram View.
The figure below shows the Document Management screen with a document selected.
The different areas of the Document Management screen are described below: Toolbox panel: Allows you to select the shapes that make up the document Drawing pad: The area in which you create the document Properties panel: Displays the properties of the currently selected shape
Note: The Document Manager has no automatic save feature. If you close the Document Management screen without saving your work, or if you select to work on another document while you have a document open, you will lose any changes that you made since you last saved the content of the current document.
Page 146
Displaying the Document Management Screen
To display the Document Management screen: On the Home ribbon bar, click the Documents button. The Document Management screen is displayed.
Viewing and Editing a Document
To view and edit a document: In the Documents tree view, click the document to want to see. The document is shown in the display area. The document creation tools are available for you to edit the document.
Saving a Document To save a document: Do one of the following: On the Quick Actions ribbon bar, click the Save Content button. Click the Save button on the Document Manager toolbar.
Page 147
Creating a New Document

Overview The process of creating a new document may be broken down into the following stages: Specifying the document details Placing the shapes on the drawing pad, resizing shapes where required and connecting shapes together Customizing the shape properties Viewing your document
Note: To allow you to make the drawing pad as large as possible, the Documents, Toolbox and Properties panels have an Auto Hide feature like the Filter pane on the View Process screen. For more information, refer to the sub-topic Filter Pane on page 141. There is no undo facility on the drawing pad. If you make a mistake, you will need to delete and start again.
Specifying the Document Details
To specify the document details: 1. While the Document Management screen is active, on the Quick Actions ribbon click the New Document button. The Add New Document dialog is displayed. 2. Leave the Document Type as Diagram View, as this is the only document type currently supported. 3. In the Name field, enter the name of the document. This will typically reflect the name of the process with which the document is to be associated. 4. In the Description field, enter a brief description of the document. 5. Leave the Viewable and Editable checkboxes selected. If the Viewable checkbox is selected, this means that the document will be visible in the document content pane when the process is selected on the View Process screen. For more information refer to the sub-topic Document Content Pane on page 143. The Editable checkbox is not used.
Page 148
Chapter 14 Managing Process Documents The figure below shows an example of the Add New Document dialog.
6. Click OK. The document is created and is added to the Documents tree. Selecting shapes To select a shape: 1. In the Documents tree, click the document name. You can now start to create the document. The Toolbox panel displays three different types of shape: Process Flow symbols: Shapes you would typically include in a flow chart Arrows: A range of arrow connectors Misc: More shapes for use as required including cones, a star, a circle and an actor.
2. Click the appropriate button at the bottom of the Toolbox panel to display the shapes belonging to the selected category. 3. Click a shape.
Page 149
Chapter 14 Managing Process Documents The selected shape is shown with a highlight.
4. Holding down your left-hand mouse button, drag the shape to the drawing pad. 5. Release the mouse button to drop the shape in its current position. 6. Repeat steps 2 to 4 as required to place more shapes on the drawing pad. Positioning a Shape or a Group of Shapes
To reposition one shape: 1. Click the shape once. The connector points on the shape are circled in red and the mouse pointer becomes a pointing finger.
2. Click the shape again. The mouse pointer becomes a cross-hair. 3. Drag the shape into position.
Page 150
To reposition a group of shapes 1. Holding down the left-hand mouse button, drag the mouse pointer over the shapes that you want to keep together. The shapes are highlighted. 2. Select one of the shapes in the group. 3. Move the shape. All the shapes in the group move.
Note: The shapes remain grouped until you click the mouse pointer away from the group.
Resizing a Shape To resize a shape: 1. Click a shape once to select it. 2. Move the mouse pointer to the edge of the shape. The mouse pointer becomes a double-headed arrow. 3. Holding down your left-hand mouse button, drag the shape to its new size.
Tip: Position the mouse pointer at the corner of a shape to resize the shape and retain its proportions.
Figure 1:
Connecting Shapes To connect two shapes: 1. Click a shape once.
Page 151
Chapter 14 Managing Process Documents The connector points on the shape are circled in red and the mouse pointer becomes a pointing finger. 2. Position the mouse pointer on a connection point and drag towards the shape you want to connect to. A connection line is created between the two shapes.
The type of connector is determined by the values that are currently selected in the Select connector types drop-down lists. The first list allows you to select the shape of the arrow head. The figure below shows a Pentagon arrow head.
The second list allows you to select the type of line: Polyline is a straight line Bezier allows you to drag the connecting line into a curve Perpendicular allows you to connect shapes using right-angled lines
The figure below shows Bezier and Perpendicular connections.
Tip: Instead of using connectors, you can also use the arrow shapes that are available. You can resize these arrows if required.
Page 152
Deleting a Shape or a Connector
To delete a shape or a connector: 1. Click a shape or connector to select it. 2. Press the DELETE key on your keyboard. The selected shape or connector is removed from the drawing pad.
Customizing the Properties of a Shape
When you select a shape by double-clicking (the mouse pointer is a cross hair) the properties of the shape are displayed in the Properties panel.
You can edit the properties of the shape as required. The area at the bottom of the panel gives a brief description of the currently selected property. This sub-topic explains how to do the following: Adding Text to a Shape Add text to a shape Associate a shape with an event Rotate a shape Change a colour property for a shape Change the way in which the properties are presented
To add text to a shape: 1. Click a shape to display its properties in the Properties panel. 2. In the Properties panel in the Text category, click the field next to Text.
Page 153
Chapter 14 Managing Process Documents 3. Type the text that you want to display on the shape. 4. If required, change the alignment of the text. Click the Text Align field. A down-arrow appears to the right of the field. 5. Click the arrow to display the rotation options. The default alignment is Center, but the other choices are: Near: The text is left-aligned. Far: The text is right-aligned.
6. Select the required alignment. 7. Click off the Properties panel. The text is displayed on the shape.
Tip: To change the font type and size, click the Font field to display a standard Windows Font properties dialog.
Associating a Shape with an Event
To associate a shape with an event: 1. Click a shape to display its properties in the Properties panel. 2. In the Properties panel, click the Action Type dropdown.
3. Select Link ToEvent 4. In the Action Properties panel, click the Event ID field. 5. Enter the identifier of the event that you want to associate with the shape. When you run the process that contains the event, the shape changes colour depending on the current status of the event.
Page 154
Associating a Shape with a Process
To associate a shape with a process: 1. Click a shape to display its properties in the Properties panel. 2. In the Properties panel, click the Action Type dropdown.
3. Select Link ToProcess 4. In the Action Properties panel, click the Process ID field. 5. Enter the identifier of the process that you want to associate with the shape. When you run the aggregated process that contains the sub-process, the shape changes colour depending on the current status of the events within the sub-process.
Associating a Shape with a Document
To assoicate a shape with a document: 1. Click a shape to display its properties in the Properties panel. 2. In the Properties panel, click the Action Type dropdown.
3. Select Link ToDocument 4. In the Action Properties panel, click the Document Name field. 5. Enter the name of the document you want to associate with the shape. The specified document will be used when the associated process is executed. 6. In the Action Properties panel, click the Process ID field. 7. Enter the identifier of the process that you want to associate with the shape. When you run the aggregated process that contains the sub-process, the shape changes
Page 155
Chapter 14 Managing Process Documents colour depending on the current status of the events within the sub-process.
Rotating a Shape To rotate a shape: 1. Double-click a shape to display its properties in the Properties panel. 2. In the Properties panel, click the Rotation field. This currently shows NoRotation. A down-arrow appears to the right of the field. 3. Click the arrow to display the rotation options. 4. Select the required option. The shape is rotated by the number of degrees specified.
Tip: If your image has text, you may want to set RotateText to True, so that the text rotates with the shape.
Changing a Color Property
To change a colour property (shape fill, shape border, shape shadow, or text): 1. Double-click a shape to display its properties in the Properties panel. 2. Click a colour field. A down-arrow appears to the right of the field. 3. Click the arrow to display a set of colour palettes. You can select a colour from any one of these palettes. Click the name of a palette to make it active. 4. On the active colour palette, click a colour. The colour palette closes and the colour change is applied to the shape.
Page 156
Tip: If you know the exact RGB value of the colour you want to apply, you can type the value directly into the property field.
Displaying Items in the Properties Panel Alphabetically
To display the properties in the Properties panel alphabetically: Click the Alphabetical button on the Properties panel toolbar.
The properties are displayed alphabetically.
To redisplay the properties in categories, click the Categorized button Viewing Your Document
The Document Manager toolbar buttons above the Toolbox panel all affect how you see your document. The function of each buttons is explained in the table below.
Button Tool Tip Fit to Page Function Enlarges your document so that it occupies the entire drawing pad area.
Table 1: Zoom Buttons on the Document Manager Toolbar
Page 157
Button
Tool Tip Zoom In Zoom Out Zoom to Original (100%)
Function Gradually increases the size of your document Gradually decreases the size of your document. Restores your document to its original size of 100%.
Table 1: Zoom Buttons on the Document Manager Toolbar
Page 158
Other Tasks
Updating Document Details
To update the details of a document: 1. In the Documents tree view, click the document you want to edit. The document is shown in the display area. 2. On the Quick Actions ribbon, click the Update Details button. The Add Process View dialog is displayed. 3. Update the document name and description and the settings of the Viewable and Editable checkboxes as required. 4. Click OK to register your changes.
Deleting Documents To delete a document: 1. In the Documents tree view, click the document you want to delete. The document is shown in the display area. 2. On the Quick Actions ribbon, click the Remove Document button. A confirmation message is displayed.
3. Click Yes to delete the document and all its related process associations. Exporting and Importing Document Files The remaining buttons on the Document Manager toolbar use standard Windows Open and Save As functionality to allow you to import and export document files.
Note: You can import from Visio only the shapes contained in the figure below. These are shapes that are common to both the Document Manager and Visio.
Page 159
These buttons and their functionality is described in the table below.

Button Function Imports a Visio XML file (.vdx). The imported file is displayed in the Document Manager window for editing. Exports the current document file to a Visio XML file. Imports a DataTrans Process Diagram file (.dpd). The imported file is displayed in the Document Manager window for editing. Exports the current document to a DataTrans Process Diagram file (.dpd). Export the current document file to a JPEG file (.jpg).
Table 2: Import and Export Options for Document Files
Page 160
15 Managing Jobs
Page 161
Overview
About Jobs A job is an instance of an event as it is executed within the system. A single event can be executed multiple times and therefore an individual job is captured for each occurrence or instance of that event. For example, an event is configured to monitor a file location so that when a file arrives it is processed. When ten files are dropped into this file location, ten individual job entries will be created to represent the event being executed for each file it receives. Each job will contain all the logging entries relevant to that instance of the event and will indicate whether the instance succeeded or failed. From the View Jobs screen you can see those jobs that match specified search criteria. About this Chapter This chapter explains how to do the following: Display the View Jobs screen Search for a job using basic or advanced search criteria Replay a job See the log messages related to a job Update job status Acknowledge a job to indicate that a job failure is being investigated View journal information generated for a job
The final section of this chapter explains how to view the configuration of the SQL Database Journal and edit the configuration if required.
Page 162
The View Jobs Screen

Displaying the View Jobs Screen The figure below gives an example of the View Jobs screen. By default, all the jobs created for events run on the current day are listed. The status of an event is indicated by the colour of the job message: Jobs created for events that terminated successfully are shown in green Jobs created for events that are still running are shown in blue Jobs created for events that failed are shown in red
View Jobs Screen With a Job Selected When the View Jobs screen is active the contextual Jobs ribbon becomes available. The Jobs ribbon: Gives information about the currently selected job Allows you to see the log messages related to a job From the Navigation ribbon, provides shortcuts to other areas of the system such as the details of the event
Note: The Jobs ribbon gives the GUID of the currently selected job. Click this GUID to copy it to the clipboard.
To display the View Jobs screen: On the Home ribbon bar, click the Jobs button.
Page 163
Chapter 15 Managing Processes The View Jobs screen is displayed. Fields on the View Jobs screen The fields on the View Jobs screen are described in the table below.
Field Job id Event Id Name Added Started Finished Last status Time Taken (s) Process Instance Id Description The unique job identifier, allocated when the job is run. By default the jobs are listed in order of Job Id, with the most recent jobs highest in the list. The identifier of the event for which the job was created. The name of the event for which the job was created. The date and time on which the event was created. The date and time on which the instance of the event was started. The date and time on which the instance of the event finished. The most recent status of the instance of the event. The total time taken in seconds for the event to run. The instance identifier of the process to which the job belongs. If this field is blank, the job does not belong to a process.
Table 3: Fields on the View Jobs Screen
Page 164
Searching for Jobs

Carrying out a Basic Search You can search for jobs on the View Jobs screen using basic or advanced search criteria. The basic search criteria are date range and event name. Searching by Date Range
Note: The date range overrides the event name. When you search for jobs based on the event name, the search is restricted to those events run during the currently specified date range.
To search for jobs by date range: 1. On the View Jobs screen, select a start date from the From drop-down list. 2. Select an end date from the To drop-down list.
Tip: When you display the View Jobs screen, the From and To dates are shown as TodaysDate 00:00 and TodaysDate 23:59 respectively. Click the down arrow next to the date field to display a calendar showing the current month.
Click a date to close the calendar and display the date in the From or To field. If necessary, use the right and left arrows to move forwards and backwards through the months. To change the start time or end time, click the hour or minute field as required and use the up arrow or down arrow key on your keyboard to move the hour or minute forwards or backwards by one.
3. Click the Search button. The jobs list is refreshed to show the jobs created for events run during the specified date range. Searching by Event Name To search for jobs by event name: 1. On the View Jobs screen, in the Event Name field, enter a string of characters. 2. Click the Search button. The jobs list is refreshed to show the jobs created for those events with names that contain the specified string.
Page 165
Carrying out an Advanced Search
You can also search for jobs using the Advanced Options on the View Jobs screen.
These options are described below. To search for jobs using the advanced search options: 1. On the View Jobs screen, click the + sign next to Advanced Options. The advanced options are displayed. 2. Use the advanced options to help you search for jobs: In the GUID field, enter a valid GUID to see the job with that GUID. Right-click the field to paste in a GUID. Select or unselect the status filter checkboxes as required to display only those jobs created for events that terminated successfully, only those jobs created for events that failed, only those jobs created for events that are running, or any mix of statuses as required Select an Area from the list of available areas to display only those jobs created for events associated with that area Select an Event from the list of available events to display only those jobs created for the selected event Select a Process from the list of available processes to display only those jobs created for events in the selected process Select Acknowledged or Unacknowledged from the Acknowledged list to display only acknowledged or unacknowledged events as required. For more information on acknowledged events, refer to the topic Acknowledging a Job on page 171.
3. Click Search to activate your search.

Note: In general you can combine different advanced search options to achieve the result you want. However, if you enter a GUID as a search criterion, the other advanced search options are cleared and the filter is applied using the GUID only. The specified date range overrides all other searches.
Resending a Job
If required for troubleshooting reasons you can resend the selected job. The Resend Wizard enables you to resend the original message to the originally configured endpoints, using a copy of the original configurations as stored in the journal file. Journaling is available only for Receiver technology adapters. Therefore you can resend only jobs
Page 166
Chapter 15 Managing Processes generated for Adapter and Routing events.

Note: You can resend a job only if journaling was active when the event was run. For more information on specifying journaling for an event, refer to the topic Configuration Procedure on page 57.
To resend a job: 1. On the View Jobs screen, select the job you want to resend. 2. On the Quick Actions ribbon, click the Resend button. The Resend Wizard starts.
3. Select the destination to which the message is to be sent. When you have selected the destination, the sample preview of the XML code associated with the destination is displayed. 4. Click Next to move on to Step 2.
Page 167
5. Step 2 allows you to preview the payload and journal configuration XML code. Modify the configuration if required. 6. If you have made changes to the configuration, click Apply Changes to register your changes. Otherwise skip this step. 7. Click Next to move on to the final step. 8. On screen 3 of the Replay Wizard, click Submit Messages to manually resend the job with the selected configuration. An output message will state that the job has been submitted for processing.
9. Click Close to exit. 10. You are returned to the View Jobs screen.
Page 168
Chapter 15 Managing Processes 11. Refresh the screen to see the updated job status.
Page 169
Viewing Job Details

Overview This section explains how to do the following: Viewing the Log Messages for a Job View the log messages associated with a job Manually update the status of a job Acknowledge a job. This indicates to other users of REIE that a job failure is being investigated Viewing the journal information for a job
To see the log messages generated for a job: On the Jobs Quick Action ribbon, click the View Job Details button. The View Job Detail (Job Id) screen is displayed, showing the log messages generated when the job was run.
Updating Event Status for a Job
To manually update the event status of a job: 1. On the View Job Detail screen, ensure that the Status History tab is active. 2. From the Select status: drop-down list, select the event status to apply to the job.
Page 170
Note: You should select ProcessingSuccess or ProcessingFailure for Business Transaction events and ProcessingAsyncSuccess or ProcessingAsyncFailure for Adapter or Routing events.
3. Click the Update Status button. The Update Status dialog is displayed.
4. Enter a comment to explain your reasons for the status change. The comment is added to the job Acknowledgement History. Refer to the topic Acknowledging a Job on page 171. 5. Click OK. You are returned to the Status History tab. The new job status is shown in the status history.
Acknowledging a Job
Acknowledging a job is a way of commenting on the job to indicate to other users of REIE that a failure is being investigated. This feature is useful if a team of people are managing jobs. To acknowledge a job: 1. On the View Job Detail screen, ensure that the Acknowledgement History tab is active.
2. Click the Acknowledge button. The Acknowledge Job dialog is displayed.
Page 171
Chapter 15 Managing Processes 3. Enter a comment to explain why you need to acknowledge the job. The comment is added to the job Acknowledgement History. Viewing Journal Information Journaling is a more in-depth form of logging. Jobs can be replayed only if a journal was active for the event when the job was originally run. To see the journaling information for a job: 1. Ensure that a job is selected on either the View Jobs or the View Job Detail screen. 2. On the Quick Actions ribbon, click the View Journal button. The journaling information relating to the selected job is displayed.
Configuring the SQL Database Journal
The SQL Database Journal is the journal into which log information is written when any event is run for which journaling has been specified. You should not need to change the default configuration of SQL Database Journal but the process is included here for completeness. To configure the SQL Database Journal: 1. On the Environment ribbon bar click the Environment Settings button. The Environment Settings menu is displayed. 2. Select Journals. The Journals screen is displayed as shown in the figure below. It shows that the SQL Database Journal is active. 3. Double-click the SQL Database Journal row. The Edit Journal screen is displayed.
Page 172
4. Configure the SQL Database Journal as required. For information on editing configuration properties, refer to the section Adding and Removing Adapter Properties on page 60. If required, you can include user-defined variables in the journal configuration. For more information on creating variables, refer to Chapter 10, Managing Variables.. 5. When you have finished configuring the SQL Database Journal, click Save to register your changes.
Page 173
Page 174
16 Managing Logging
Overview
About the Loggers REIE has a flexible logging framework which allows for logging information to be written using any one of the logging adapters. By default the database and event loggers are configured. Filtering thresholds can be set to limit the amount of logging messages. About this Chapter This chapter explains the following: How the REIE loggers generate log messages How to manage the loggers, including reducing the logging level so that only the more significant messages are generated Where you can view logging messages and how to search for them
Page 175
Chapter 16 Managing Logging
Using the Loggers

Overview REIE has three loggers: MS SQL Database Logger Event Log Logger MSMQ Logger
The MSMQ Logger is not currently used. Both the MS SQL Database Logger and the Event Log Logger log the same information and record it in the same way but they send the information to different destinations: The MS SQL Database Logger sends information to the REIE SQL database dtLog. You can view the log messages from within REIE on the View Log screen. The Event Log Logger sends information to the Windows Event Viewer. You can view the log messages through the Control Panel.
If the system is busy and there is a time out set for database access, not all messages may be written to dtLog. All messages are written to the Event Viewer however.
Note: A logger needs to be active in order to generate log messages.
Managing the Loggers
Managing the loggers involves the following: Setting the logging level Deactivating the loggers Setting the time out value (MS SQL Database Logger only)
You manage loggers from the Loggers screen. This section explains how to display the Loggers screen and how to carry out the logger management activities.
Page 176
Displaying the Loggers Screen
To manage the loggers: 1. On the Environment ribbon bar, click the Configuration Settings button. The Environment Settings menu is displayed. 2. Select the Loggers item. The Loggers screen is displayed.
The MS SQL Database Logger and the Event Log Logger are both active. The default logging level is 15. The MSMQ Logger is not used. Setting the Logging Level The level of severity of logging messages ranges from 1 (the highest) to 15 (the lowest). Severity level 1 is usually reserved for exception messages. The default logging level is 15, which means that all possible log messages are generated, even the most verbose. Reducing the logging level to generate only the more important log messages may be a useful way to improve system performance. To reduce the logging level: 1. On the Logging screen, double-click a logger. The Logger Viewer screen is displayed for that logger. The Logger Viewer for the MS SQL Database Logger is shown below.
If, as is shown here, the Description field is blank, you may want to enter a brief description of the function of the logger.
Page 177
Chapter 16 Managing Logging 2. The Level field shows the current logging level. To reduce the logging level do one of the following: Repeatedly click the down arrow next until the logging level is sufficiently reduced In the Level field, enter the new logging level directly.
3. Click Save to register your change. 4. Restart any affected services. For more information on restarting services, refer to Restarting and Stopping Services on page 21. Deactivating the Loggers If system performance is critical, you may want to deactivate one or both loggers to prevent the generation of log messages altogether, but this is not good practice. To deactivate a logger: 1. On the Loggers screen, double-click a logger. The Logger Viewer screen is displayed for that logger. 2. Unselect the Active check box. 3. Click Save to register your change. The logger will generate no further messages until you reactivate it. Setting the Timeout Value for MS SQL Database Logger MS SQL Database Logger has two variables associated with it; dsn and timeOut. You are strongly recommended not to change dsn as this affects the connection to the database. However, if the payload on the system is particularly busy, you may want to increase the timeOut value to allow the logger longer to connect to the database before time out occurs. The default timeOut value is 30 seconds. To increase the TimeOut Value: 1. On the Logging screen, double-click the MS SQL Database Logger. The Logger Viewer screen is displayed for that logger. 2. Click the Value field for timeOut and enter a new value in seconds for the timeOut property. 3. Click Save to register your change.
Page 178
Viewing Log Messages

Overview Log data is very useful when troubleshooting. If a job fails your first port of call should be the log messages for that job. This section explains how to view log messages: Viewing Log Messages from the View Log Screen From the View Log screen in From the Events Viewer
An example of the View Log screen is shown below.
If the log message that is currently selected in the list has associated XML data, this is shown in the XML area below the message list.
Tip: The top area (in green) displays special log messages that are visible in the current page and is intended to highlight important events. The currently supported events include successfully completed or failed jobs etc.
From the View Log screen you can do the following: Search for log messages by GUID, XML Data or Message Search for log messages by date Move from one page to another Save the log messages to an Excel spreadsheet
Page 179
Chapter 16 Managing Logging Displaying the View Log screen To display the View Log screen: On the Home ribbon bar, click the Logs button. The View Log screen is displayed. Fields on the View Log Screen The fields on the View Log screen are described in the table below.
Field Timestamp Instance Guid Message Message ID Data Application Severity Sequence Data Description Every log message is prefixed by a timestamp in the format: dd/mm/yyyy hh:mm:ss The source of the log messages for example the Scheduler Service or dtwsi3.4, the installed instance of the ASH. (Many instances of the ASH may be installed). Messages that are job-related are identified by a GUID. More general messages are not identified by a GUID. One of a number of standard logging messages. Each standard message has a unique identifier. If a log message has XML data associated with it, this field shows the start of the data. Select the message to see the XML. The REIE application that generated the log message. The severity level of the message. The most severe messages level one messages which are errors shown in red. Shows the order in which the messages were generated. By default log messages are listed in sequence, with the latest messages at the top of the list. If a log message has XML data associated with it, this field shows a blue text icon . Select the message to see the XML preview. Double click the icon to launch the XML Viewer window.
Table 4: Fields on the View Log Screen Symbols on the View Log Screen The symbols in the left-hand column of the View Log screen show which component of REIE generated the message. These symbols are explained in the table below.
Symbol Description The log message is generated by the ASH. The log message is generated by an adapter. The log message is generated by the Scheduler Service.
Table 5: Symbols on the View Log Screen
Page 180
Chapter 16 Managing Logging Moving from One Log Page to Another The View Log screen displays the log messages in pages. Page 1 shows the most recent messages. An indicator on the screen shows which page you are looking at.
Buttons on the screen allow you to move between pages. These buttons are shown in the table below.
Button Go to first page. Function
Go to previous page.
Go to next page.
Go to last page.
Table 6: Page Navigation Buttons on the View Log Screen Searching the Log Messages This topic explains how to search for log messages by GUID and date. Searching for Log Messages by GUID To search for log messages by GUID: 1. On the View Log screen, in the Search by: field enter a sequence of numbers or letters representing all or part of the GIUID. The sequence may include hyphens if required and does not have to be the start of the GUID. 2. Click the Search button. Only those log messages with a GUID that contains the specified string are listed on the screen. 3. To redisplay all the messages in the log, remove the string from the Search by: field and click Search again. Searching for Log Messages by XML Data To search for log messages by XML Data: 1. On the View Log screen, in the Search by: field enter a sequence of numbers or letters. The sequence may include hyphens if required and does not have to be the start text.
Page 181
Chapter 16 Managing Logging 2. Click the Search button. Only those log messages with XML Data that contains the specified string are listed on the screen. 3. To redisplay all the messages in the log, remove the string from the Search by: field and click Search again. Searching for Log Messages by Message To search for log messages by Message 1. On the View Log screen, in the Search by: field enter a sequence of numbers or letters. The sequence may include hyphens if required and does not have to be the start text. 2. Click the Search button. Only items in the log with messages that contains the specified string are listed on the screen. 3. To redisplay all the messages in the log, remove the string from the Search by: field and click Search again. Searching for Log Messages by Date By default log messages are displayed for the current day only, that is From Day dd Mon yyyy 00:00 To Day dd Mon yyyy 23:59. However, by changing the From and To dates and times you can restrict the list of messages to display only those messages generated during the date range. You search for log messages by date range in the same way as you search for process instances. For more information refer to the sub-topic Searching by Date Range on page 143. Saving Log Messages to an Excel Spreadsheet You may find it useful to export log messages to an Excel spreadsheet if you need to send them to another user for analysis.
Note: Only the log messages on the current page are exported to Excel. XML data is ignored for reasons of security and length.
To save log messages to an Excel spreadsheet: On the View Log screen, click the button.
The Save spreadsheet dialog opens. It behaves like a standard Windows Save As dialog and allows you to save messages to an Excel spreadsheet. Viewing Log Messages from the Event Viewer The Event Viewer is found in the Administrative Tools category of the Control Panel. To view log messages from the Event Viewer: From the tree structure to the left of the Event Viewer screen select Application. The log messages generated by applications are displayed. The log messages are
Page 182
Chapter 16 Managing Logging identified by their source: DataTrans Logging. Double-click a message to display the Event Properties dialog which gives more information about the message. An example of these messages is shown in the figure below.
Page 183
Page 184
17 Importing and Exporting Configuration Data

About Importing and Exporting the Configuration
Overview Configuration can be easily exported from an environment and imported into another. The process of migrating configuration sets includes the ability to resolve environmental conflicts. This chapter explains how to import and export an entire configuration or individual configuration entities.
About this Chapter
Page 185
Chapter 17 Importing and Exporting Configuration Data
Importing Configuration Data

Importing a Configuration
To import an environment configuration: 1. On the Environment ribbon bar, click the Import button. The Import Environment Configuration Wizard starts. 2. On the Import Environment Configuration Wizard welcome screen, click Next. The Select Import File screen is displayed. 3. Click the Browse button. A Windows Open dialog is displayed. 4. Select the configuration file you want to import. 5. Click Next. The Select Import Data screen is displayed.
6. Do one of the following: To import the entire set of configuration data, go to step 7. To select the entities to be imported, go to step 9.
7. Leave the Everything radio button selected.
Page 186
Chapter 17 Importing and Exporting Configuration Data 8. Go to step 12. 9. Select the Custom Selection radio button. The list of entities is enabled to allow you to select the entities you want to import. 10. Click the + sign next to an entity type to see the available child entities of that type. The logical structure of the configuration data is explained in the topic Logical Structure of Configuration Data on page 190. An example is shown in the figure below.
11. Select the checkbox next to each entity you want to import, bearing in mind the rules which take into account the relationships between entities. These rules are explained in Configuration Import Rules on page 190. 12. Click Next. The first Resolve Conflicts screen is displayed.
Page 187
Once you have selected the database entities to import, a comparison is made between the data that is to be imported and the target database and any potential naming conflicts are identified. A Resolve Conflicts screen is displayed for each entity type for which there are naming conflicts. 13. Deal with the conflicts for each entity using the most appropriate method of those described in the topic Resolving Conflicts on Import on page 191. Once you have resolved all the potential conflicts, the Finish screen is displayed.
Page 188
This screen provides a log of the import process. The following items are logged: Addition and removal of related data based on the items you have selected and deselected Cancelled row conflict resolutions and associated data removal Use Existing conflict resolutions Values in columns that have changed as a result of conflict resolution Events that were disabled during validation Any validation errors
14. Click Finish to complete the import process.
Page 189
Logical Structure of Configuration Data
The tree-view control displays the configuration data in the following logical structure:
Parent Entity Areas Events Business Transaction Events Adapter Events Routing Events Adapters Receivers Interceptors Senders Message Types Transactions Processes Documents Calendars Environment Variables Area Variables Ribbon Extension Application Configuration Sets BTD Templates Custom Image Sets Embedded Resources Data Analytics Applications XML Schemas Data Elements Subscriptions Data Parts Data Part Layouts Users Child Entities
Table 7: Parent and Child Entities for Import Configuration Import Rules The configuration entities shown in the custom selection tree-view may be implicitly associated with other entities. If you select to import data items that have implicit relationships, you must also select the related data items for import. These related items may in turn be related to other items which you must then also select for import. The built-in relationships, imply custom selections can result in a cascading selection of implicitly related data.
Page 190
Warning: If you do not wish to import this related data, you can unselect any data item that is visible in the tree-view. However, if you select a data item and implicitly its related data items, subsequent deselection and reselection of a related data item means that the two data items will be imported, but the relationship between them will be severed.
Resolving Conflicts on Import
There are three ways in which you can resolve potential naming conflicts between the imported database entities and the target database: Cancel the import of the entity Change the name of the entity to be imported Use the existing entity: the parent entity is not imported but the child entities are imported and are mapped to refer to the equivalent parent entity in the target database
Note: You cannot change the names of transactions or message types. To resolve naming conflicts when importing transactions, you must select either to cancel the import or to map the transaction to be run by an equivalent Business Transaction event in the target database. To resolve naming conflicts when importing message types, you must select either to cancel the import or to map the routes and match sets to refer to an equivalent message type in the target database.
Conflicts are resolved for each entity type on a Resolve Conflicts screen. When conflicts occur, Resolve Conflicts screens may be displayed for the following entity types: Areas Events Interceptors Senders Receivers Message types Transactions Processes Documents BTD Templates Custom Image Sets Application Configuration Sets Data Parts Data Part Layouts Data Analytics Dataset registrations XML Schemas Embedded Resources Applications
Page 191
To resolve naming conflicts for an entity type when importing a configuration: 1. On the Resolve Conflicts screen for an entity type, select one of the following options for each entity: To cancel the import of an entity, select the Cancel Import checkbox next to the entity. To cancel the import of all entities of a particular type, select the Cancel Import checkbox in the column header. To map the child entities to the equivalent parent entity in the target database, select the Use Existing checkbox next to the entity. To map the all child entities to the equivalent parent entities of this type, select the Use Existing checkbox in the column header. To change the name of an entity, click the field that contains the Name of the entity and enter the new name.
2. When all the conflicts have been resolved for an entity, click the Refresh button to display the Resolve Conflicts screen for the next entity type. When all the naming conflicts have been resolved, the Finish screen is displayed. Exporting a Configuration
To export an environment configuration: 1. On the Environment ribbon bar, click the Export button. The Export Environment Configuration Wizard starts. 2. On the Export Environment Configuration Wizard welcome screen, click Next. The Select Export Data screen is displayed. 3. Do one of the following: To import the entire set of configuration data, go to step 4. To select the entities to be exported, go to step 6.
4. Leave the Everything radio button selected. 5. Go to step 9. 6. Select the Custom Selection radio button. The list of entities is enabled to allow you to select the entities you want to import. 7. Click the + sign next to an entity type to see the available child entities of that type. The logical structure of the configuration data is explained in the topic Logical Structure of Configuration Data on page 190. An example is shown in the figure below. 8. Select the checkbox next to each entity you want to export, bearing in mind the rules which take into account the relationships between entities.
Page 192
These rules are explained in Configuration Import Rules on page 190. 9. On the Select Export Data screen, click Next. The Select Export Location screen is displayed. 10. Click the Browse button. A dialog is displayed. This dialog behaves like a standard Windows Open dialog. 11. Navigate to the folder in which you want to save the configuration. 12. Enter the name of the XML file you want to contain the exported configuration data. 13. Click Save. You are returned to the Select Export Location screen with the full pathname of the export file in the entry field. 14. Click Next. The environment is exported to the specified file. The Finish screen is displayed with the message that the export process has completed successfully. 15. Click the Finish button. 16. The Export Environment Configuration Wizard closes. You can now open the export file to view the environment configuration information. The information is displayed in clear text XML.
Page 193
Page 194
18 System Administration Functions

Overview
About System Administration Functions In the interests of system security, REIE allows administrators to do the following: Create user accounts and allocate access items to individual users Group a variety of access items together
When a user account is created, an administrator can assign a group of access rights to a user, thus granting the user all the permissions within the group. About this Chapter This chapter deals with the system administration functions of managing users and user access rights. This chapter explains: The different types of access item, the rules relating to access items and how access items are used How to create and manage user accounts How to create and manage groups of access items
Page 195
Chapter 18 System Administration Functions
About Access Items

Types of Access Item User profiles can be restricted down to a particular feature referred to as an access item. There are two types of access item: Data entity access items Group access items
Examples of data entity access items include calendars, documents, events and processes. These may be entities created by the user themselves or entities created by another user and assigned to the first user by an administrator. Group access items are related to specific areas of the REIE Manager. Examples of group access items include: The right to view the list of log messages The right to create events The right to view processes
Group access items are available to be allocated to any user. For a user to be able to carry out any action in REIE, the access items relating to that action must be allocated to the user. If a user logs on to REIE with no access items assigned, he or she will be able to see and do nothing. All the buttons and menu items will be disabled. Allocating Access Items to Users Administrators allocate access items to a user from the Edit User Permissions dialog as part of the process of creating a user or amending a user account. The figure below gives an example of the access items allocated to a user.
Page 196
Figure 2: Access Items Allocated to a User
The Included list shows those access items allocated to the user LizJ. The Excluded list shows those access items that are not allocated to her. Examples of data entity access items include:
(document) 4 - DSS and RDMS File Transfer - all - write (event) 100010 - File Moving Event - all -write
Examples of group access items include:

(object) Adapters - all - read (object) Documents - all - exec
The access items allocated to user LizJ show that this user is able to view create and where applicable run all the main system entities. However, she has no access to any areas of the environment configuration and she cannot carry out any import or export functions. Most significantly, she is not a system administrator, as she has no access to the Users and Groups objects.
Page 197
Administrator Access Items
The administrator access items are:

(object) Users - all - read (object) Users - all - write (object) Groups - all - read (object) Groups - all - write
Users with no access to the Users objects can see the entities created by other users only if an administrator assigns those entities to them. Otherwise, they have access only to the entities they have created themselves.
Page 198
Rules Relating to Access Items

User Permission Levels The user permissions are based on three levels: General Rules Read: view only Write: add/update/delete Exec: run
The rules relating to access items are as follows: When an item in a list has related items attached to it in a tree view they are said to have a parent-child relationship Without read access to a particular entity, a user will not be able to see those item types. For example: Without read access to events the Events button on the Home ribbon bar is disabled. If a user has read only access to an entity they may view the items related to that entity, but items that are children of that parent item will be filtered in accordance with the users rights to view those items. For example: If a user has only read access to a particular process, the documents and events listed underneath that process on the View Process screen will be displayed only if the user has explicitly been given read access to those items. All quick actions for the item will be disabled. When a user has write access to an entity and write access to an individual entity item, the quick actions are enabled when the user selects that item on the View screen. This allows the user to add, update or delete that item.
Assigning Access Rights
The rules related to assigning access rights are as follows: When a user is assigned write access to an entity, the children items are automatically assigned to the user with read rights when the cache is refreshed. For example: For example: If a user is assigned write access to a process, the user will be assigned read access to the events for that process. Users that are not able to create user accounts will not be able to view the read/write/exec access items on the View Groups screen when assigning items to a group. Only users that are able to create user accounts are able to assigning and deassign access items to users
Custom Security Rules
Some rules in REIE are custom business rules. These rules are as follows: If an event does not have a call, the run now functionality is disabled. If a process does not have a start event the run process functionality is disabled.
Page 199
Creating and Managing User Accounts

Displaying the View Users Screen
To display the View Users screen: 1. On the Home ribbon bar, click the Users button. The View Users screen is displayed.
2. To find a particular user in the list, start typing a sequence of letters in the Filter field. As you type, the list of users is refreshed to show only those users whose Username or real Name contains that sequence.
Page 200
Creating a New User Account
To create a new user account: 1. On the View Users screen, click the Add New button. The Edit Users dialog is displayed.
2. In the Username field, delete username and replace it with a valid user name. 3. Add one or more valid First Names and a valid Surname and Email address for the user. 4. Select the Active checkbox. This activates the users account.
Note: Inactive users are shown in the user list in red. They are unable to log on to REIE
5. Click Set Password. The Set Password dialog is displayed.
6. In the New Password field, enter the new users password.

Note: Passwords are case-sensitive and must have at least six characters.
7. In the Repeat New Password field, retype the password. 8. Click OK. The Set Password dialog closes. 9. If you want to set user permissions, click Edit Security. For more information on setting user permissions, refer to the topic Assigning Access Items to a User on page 203. 10. Click Save and Close.
Note: If you click Close instead of Save and Close, the Edit User dialog closes and the new user account is not created.
Page 201
Chapter 18 System Administration Functions The new user is shown on the list of users. The following confirmation message is displayed:
11. Click OK to signal a reload of the configuration. All security information is held in a central location in the database. Reloading the configuration updates the security data and ensures that other users can see your changes. Until you reload, no one else knows about the new user. Editing an Existing User Account
To edit the account of an existing user: 1. On the View Users screen, do one of the following: Double-click a user. Click once to select a user and then click Edit.
The Edit User dialog is displayed, showing the users details. 2. From the Edit User dialog you can carry out any of the following actions as required: Amend the users details Reset the password Reactivate or deactivate the users account
3. If access items have already been allocated to the user, you can change these access items. The most common reason for doing this is to allow a user access to entities created by other users. For more information on allocating access items, refer to the topic Assigning Access Items to a User on page 203.
Page 202
Assigning Access Items to a User
To assign access items to a user: 1. On the Edit User dialog, click the Edit Security button. The Edit User Permissions screen is displayed.
2. To grant access rights to a user: In the Excluded list, select one access item or a set of access items. Click the Include Groups/Items arrow .
The access items are moved from the Excluded list to the Included list. The user has been granted the access rights associated with these access items. 3. To remove access rights from a user: In the Included list, select one access item or a set of access items. Click the Exclude Groups/Items arrow .
The access items are moved from the Included list to the Excluded list. The access rights associated with these access items have been removed from the user.
Note: Both the Included and Excluded lists allow multiple selection. In the same way as you do in Windows, you can use the SHIFT key to select a set of access items and the CTRL key to randomly select multiple access items.
4. To find a particular access item in the list, start typing a sequence of letters in the Filter field. As you type, the list of access items is refreshed to show only those access items that
Page 203
Chapter 18 System Administration Functions contain that sequence. 5. Click Apply and Close to apply the access rights. You are returned to the Edit User dialog. 6. Click Save and Close on the Edit User dialog to finally make the access rights effective. Deleting User Accounts
To delete a user account: 1. On the View Users screen, click once to select a user. 2. Click Delete. A message is displayed like the one shown below asking you to confirm the deletion.
3. Click Yes to delete the user account. The user disappears from the user list.
Note: Once a user account has been deleted it cannot be reinstated. You are advised to deactivate a users account rather than deleting it and to delete a the account only when you are sure that all the entities assigned to the user have been assigned to other users in the system. For information on deactivating a users account refer to the topic Creating a New User Account on page 201.
Page 204
Creating and Managing Groups

Overview REIE gives administrators with the correct access rights the ability to group access items together. A group may contain both data entity and group access items. This group of access items can then be assigned to a user or to a group of users, thus granting these users all the rights within this group. Groups apply to an environment. This section explains how to work from the View Groups screen to: Set up a group of access rights Edit a group Assign users to a group Delete a group
Page 205
Displaying the View Groups Screen
To display the View Groups screen: 1. On the Home ribbon bar, click the Groups button. The View Groups screen is displayed. This screen lists the groups that have been defined for this environment.
2. Click the + sign next to the name of a group to expand the group so that you can see the permissions in the group. 3. To find a particular group in the list, start typing a sequence of letters in the Filter field. As you type, the list of groups is refreshed to show only those groups with a name that contains that sequence.
Page 206
Creating a New Group To create a new group: 1. On the View Groups screen, click the Add New button. The Edit Group dialog is displayed.
2. In the Group Name field, enter a name for the group. The access items that are assigned to the group are listed in the Included list. 3. To assign access items to the group: In the Excluded list, select one access item or a set of access items. Click the Include Groups/Items arrow .
The access items are moved from the Excluded list to the Included list. These access items have been assigned to the group.
Note: Both the Included and Excluded lists allow multiple selection. In the same way as you do in Windows, you can use the SHIFT key to select a set of access items and the CTRL key to randomly select multiple access items.
4. To find a particular access item in the list, start typing a sequence of letters in the Filter field. As you type, the list of access items is refreshed to show only those items that contain that sequence. 5. Click Save and Close to assign the access items to the group. You are returned to the View Groups window.
Page 207
Editing a Group To edit an existing group: 1. On the View Groups screen, select the name of a group or one of the access items assigned to the group. 2. Click the Edit button. The Edit Group dialog is displayed.
3. From this dialog you can change the group name if required and change the access items assigned to the group. 4. To remove access items from a group: In the Included list, select one access item or a set of access items. Click the Exclude Groups/Items arrow .
The access items are moved from the Included list to the Excluded list. These access items have been removed from the group. 5. Click Save and Close to save your changes to the group.
Page 208
Assigning Users to a Group
To assign users to a group: 1. On the View Groups screen, select the name of a group or one of the access items assigned to the group. 2. Click the Edit Users button. The Edit Group User dialog is displayed.
The users that are assigned to the group are listed in the Included list. 3. To assign users to the group: In the Excluded list, select one user or a set of users. Click the Include Groups/Items arrow .
The selected users are moved from the Excluded list to the Included list. These users have been assigned to the group. 4. To remove users from a group: In the Included list, select one user or a set of users. Click the Exclude Groups/Items arrow .
The users are moved from the Included list to the Excluded list. These users have been removed from the group.
Page 209
Note: Both the Included and Excluded lists allow multiple selection. In the same way as you do in Windows, you can use the SHIFT key to select a set of permissions and the CTRL key to randomly select multiple users.
5. To find a particular user in the list, start typing a sequence of letters in the Filter field. As you type, the list of users is refreshed to show only those users whose usernames contain that sequence. 6. Click Save and Close to assign the users to the group. You are returned to the View Groups window. Deleting a Group To delete a group: 1. On the View Groups screen, select the name of a group or one of the access items assigned to the group. 2. Click the Delete button. A message is displayed like the one shown below asking you to confirm the deletion.
3. Click Yes to confirm the deletion of the group. The group and its attributes are permanently removed from the environment.
Note: Deleting a group does not remove its associated access items or users from the system.
Page 210
Appendix A: Adapter Configuration Properties

This appendix describes each adapter configuration property with examples. The descriptions begin on the following page.
Page 211
Receiver Adapter Configuration Properties
Page 212
Mandatory Yes Yes admin 123eer Queue1 Queue 2000 1000 Yes Yes Yes No This value is used to define the frequency in milliseconds at which the specified queue is polled. Topic or Queue The name of the topic or the queue that the EMS Receiver is monitoring The password required to log on to the Tibco EMS Server. The username required to log on to the Tibco EMS Server. The name of the server that hosts the Tibco EMS Server. Description Default Value Example tcp://localhost:7222 Mandatory Yes Description The string that will be used to identify the file to be received. Default Value *.*, denoting that all files will be received Example *.xml if payload is set to content *.txt if payload is set to fileInfo Yes $0:u$ $guid$ $0:u$.xml $guid$.txt c:\temp\IN c:\archive 1000 2000 The mask that will be applied to the file to be received. This may be used for archive location and may contain tokens if necessary. The folder that will be monitored for incoming files. The folder into which the file will be moved. The frequency at which the folder is polled for a file with a name that corresponds to the specified filter. This value is specified in milliseconds. Yes content: The full content of the file is passed through as the payload. This is the default value. fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access content fileInfo Yes Yes Yes
EMS Receiver Configuration Properties
Property
hostname
username
password
topicOrQueueName
emsType
Chapter A Adapter Configuration Properties
pollingInterval
Table 8: EMS Receiver Configuration Properties
File Receiver Configuration Properties
Property
filter
fileNameMask
folderPath
moveTo
pollingInterval
payLoad
Table 9: File Receiver Configuration Properties
Property No False True #dtScheduleDsn# No The connection string to the dtSchedule database. This is required only if loadBalanced is set to True to synchronise access to files between the different File Receivers. True if you want to overwrite the moveTo location, otherwise False. False True *.txt Additional filter to apply in addition to the filter property that can be expressed using regular expressions. True if another File Receiver adapter is monitoring the same folder, otherwise False.
Mandatory
Description
Default Value
Example
loadBalanced
dsn
enableArchiveOverwrite Yes
No

Mandatory Yes No No No No No Password for access to the FTP site The folder on the FTP site that is to be monitored. The root folder will be monitored if this property is not specified. The string that will be used to identify the file to be downloaded. The default value is *.*, denoting that all files in the specified folder will be downloaded. The folder on the local machine into which files will be archived. The transfer type to be used when files are downloaded. Possible values are: Yes b: Binary False True a: ASCII b User name for access to the FTP site The FTP port to be used. TCP/IP address of the FTP site. 21 Description Default Value Example 192.168.5.50 33 ftptest ftptest c:\Messages\IN *.* No No C:\Walkthrough1976\Archive a Passive data connection. If set to True, the client initiates the data connection. If set to False, the server initiates the data connection. No No The frequency in milliseconds at which the folder is polled for a file with a name that corresponds to the specified filter. Number of times that connection to the FTP site will be retried when an FTP exception occurs. 30000 3 5000 5
regexFilter
Table 9: File Receiver Configuration Properties (Continued)
FTP Receiver Configuration Properties
Property
host
port
username
password
directory
filter
archiveLocation
transferType
passive
waitPeriod
retryTimes
Page 213
Table 10: FTP Receiver Configuration Properties
Property No 60000 fileInfo content 30000 No content: The full content of the file is passed through as the payload fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access. No False True #dtScheduleDsn# No The connection string used when isLoadBalanced is set to True to synchronise access to files between the different FTP Receivers. Timeout period for the connection in milliseconds. 0 False True If set to True (the default, an SSL connection will be used. If set to False, an SSL connection will not be used. No If set to False, the file is deleted from the FTP server. No The mask that will be applied when the new file name is created. This may be used for archive location and may contain tokens if necessary. $0:u$ $guid$.bak If set to True, the file is copied from the FTP server. False 5000 True When set to True, sets the receiver to load balanced operation. The frequency in milliseconds at which the connection to the FTP site is retried following an FTP exception.
Mandatory
Description
Default Value
Example
Page 214
No No Mandatory Yes Description References the scrape file to be used. The scrape file is an XML file that may contain login details, configuration settings and other information about the URL to be scraped. Defines how often the HTTP Receiver is executed. The value is expressed in milliseconds. If set to True, the payload is passed to a Sender adapter for processing. If set to False, the payload is not passed to a Sender adapter. 10000 False Default Value Example C:\Temp\ScrapeFile.xml Yes Yes 5000 True
retryWait
payload
isLoadBalanced
dsn
connectionTimeout
useSSL
preserveFile
archiveFileName Mask
Table 10: FTP Receiver Configuration Properties (Continued)
HTTP Receiver Configuration Properties
Property
scrapeFile
pollingInterval
passPayload
Table 11: HTTP Receiver Configuration Properties
MQSeries Receiver Configuration Properties

Description The name of the queue to be monitored Test.OUT RM_Test S_swift/TCP/192.168.10.76 (1417) The queue manager identification A string that contains connection details for the MQ channel. The format of the MQ channel name is ChannelName/ConnectionName. Default Value Example
Property
Mandatory
mqName
Yes
mqManager
Yes
mqChannel
Yes

Mandatory Yes No No XML XML CSV F:\temp\VARS 10000 True 5000 No No No File location for persistence of variables between calls to the MS SQL Sender adapter. Defines how often the MS SQL Receiver is executed. The value is expressed in milliseconds. True: the Receiver assumes that the SQL statements which follow have to be run against the database. The extended attributes dataType and test must be set. If dataType is not set, the Receiver will assume a numeric evaluation is required. An SQL statement to be run against the SQL database specified by the dsn string. The format in which the dataset result is sent to the ASH. outputFormat may be set to either: Refer to the entry for condition below. CSV The SQL Server connection string required to access the database to be queried. Description Default Value Example DataSource=<SQLSERVERNAME>;uid=sa; pwd=sa;initial catalog=<DBNAME>; Yes select * from...
Table 12: MQSeries Receiver Configuration Properties
MS SQL Receiver Configuration Properties
Property
dsn
test
outputFormat
storeValuesInFile
pollingInterval
condition
exec
Table 13: MS SQL Receiver Configuration Properties
Page 215
Page 216
Mandatory Yes Yes System.Messaging.Xml MessageFormatter. The formatter that is used to deserialize an object from the body of a message read from the queue. The default formatter is System.Messaging.XmlMessageFormatter. The only alternative value for this field is activex. This means that the formatter System.Messaging.ActiveXMessageFormatter will be used. Yes Yes 10000 Defines how often the MSMQ Receiver is executed. This value is expressed in milliseconds. True 5000 activex The location of the message queue. Description Default Value Example c:\MSMQ\Queue Mandatory Yes No Description The Oracle Server connection string required to access the database to be queried. True: the Receiver assumes that the SQL statements which follow have to be run against the database. The extended attributes dataType and test must be set. If dataType is not set, the Receiver will assume a numeric evaluation is required. Refer to the entry for condition above. The format in which the dataset result is sent to the ASH. outputFormat may be set to either: XML CSV c:\Program Files\Vars.config 10000 5000 No File location for persistence of variables between calls to the Oracle Sender adapter. Defines how often the Oracle Receiver is executed. This value is expressed in milliseconds. XML CSV True Default Value Example DataSource=<ORACLESERVER>; uid=<>;pwd=<>; No No Yes
MSMQ Receiver Configuration Properties
Property
MSMQDefinition
FormatterType
transactional
pollInterval
Table 14: MSMQ Receiver Configuration Properties
Oracle Receiver Configuration Properties
Property
dsn
condition
test
outputFormat
dataType
storeValuesInFile No
pollingInterval
Table 15: Oracle Receiver Configuration Properties
Property Yes select * from... An SQL statement to be run against the SQL database specified by the dsn string.
Mandatory
Description
Default Value
Example
exec
Table 15: Oracle Receiver Configuration Properties (Continued)
Rendezvous Receiver Configuration Properties

Mandatory Yes Yes Yes 1 Yes Refer to the Rendezvous Receiver concepts documentation. Yes Yes UDP TCP A port number topicB -1 Yes Yes Yes 0: no wait 1: wait indefinitely 12 11 11: network 12: intra-process The name of the network if the machine is configured to run on multiple networks. The service type if a specific network service is to be used. May take the values: lan0;;224.1.1.6 UDP The embedded license for connecting to a secure daemon. 3: response 2: request 1: pub/sub The type of interaction to be used. May take the following values: The daemon name if connecting to a remote daemon process. Defines how often the Rendezvous Receiver interrogates the internal queue. This value is expressed in milliseconds. 2000 Description Default Value 500 purple_host:6555 1 Example
Property

Refer to the Rendezvous Receiver concepts documentation. The subject to be monitored for messages. The timeout in seconds for waiting on the internal queue for new messages. 0 The type of transport to be used. May take the following values:
pollingInterval
net.daemon
interaction
net.license.ticket
net.network
net.service
subject
timeout
transport
Table 16: Rendezvous Receiver Configuration Properties
Page 217
Page 218
Mandatory Yes 10000 replay resend #dtScheduleDsn# ReplayArea 5000 Yes Yes No The name of the area to which the Replay Receiver is linked. The connection string to the dtSchedule database. Specifies whether the message is to be replayed or resent. May take the value replay or resend. Defines how often the Replay Receiver is executed. This value is expressed in milliseconds. Description Default Value Example Mandatory Yes Yes Description The name of the area with which the Scheduler Event Execution Receiver is associated with. Defines how often the Replay Receiver is executed. This value is expressed in milliseconds. 10000 Default Value Example TestArea 5000 Mandatory Yes No No No No No Description TCP/IP address of the secure FTP site. The FTP port to be used. If you do not specify a port number, the default value is 21. User name for access to the secure FTP site Password for access to the secure FTP site The folder on the secure FTP site that is to be monitored. The root folder will be monitored if this property is unspecified. The string that will be used to identify the file to be downloaded. *.*, denoting that all files in the specified folder will be downloaded Default Value Example 145.678.45.67 23 sadmin spassword C:\temp\MONITOR *.txt
Replay Receiver Configuration Properties
Property
pollingInterval
itemType
journalDSN
clusterName
Table 17: Replay Receiver Configuration Properties
Scheduler Event Execution Receiver Properties
Property
clusterNameFilter
pollingInterval
Table 18: Scheduler Event Execution Receiver Configuration Properties
SFTP Receiver Configuration Properties
Property
host
port
username
password
directory
filter
Table 19: SFTP Receiver Configuration Properties
Property No C:\Download\IN b a No Yes False If set to False, the server initiates the data connection. No 30000 The frequency at which the folder is polled for a file with a name that corresponds to the specified filter. This value is expressed in milliseconds. Number of times that connection to the secure FTP site will be retried when an FTP Exception occurs. 3 60000 The frequency at which the connection to the secure FTP site is retried following an FTP exception. This value is expressed in milliseconds. content: The full content of the file is passed through as the payload fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access No No True if another SFTP Receiver adapter is monitoring the same folder, otherwise False. The connection string to the dtSchedule database. This is required only if isloadBalanced is set to True to synchronise access to files between the different SFTP Receivers. Timeout period for the connection. 0 False True #dtScheduleDsn# fileInfo 10000 Passive data connection. If set to True, the client initiates the data connection. True b: Binary a: ASCII The transfer type to be used when files are downloaded. Possible values are: The folder on the local machine into which files will be downloaded.
Mandatory
Description
Default Value
Example
archiveLocation
transferType
passive

No No 2 20000 No fileInfo 20
waitPeriod
retryTimes
retryWait
payload
isLoadBalanced
dsn
connectionTimeout No
Table 19: SFTP Receiver Configuration Properties (Continued)
Page 219
Sender Adapter Configuration Properties
Page 220
Mandatory Yes Yes admin 123eer TopicA Queue Topic Yes Yes No Topic or Queue The name of the topic or the queue that the EMS Receiver is monitoring The password required to log on to the Tibco EMS Server. The username required to log on to the Tibco EMS Server. The name of the Tibco EMS Server. Description Default Value Example tcp://localhost:7222 Mandatory Yes No Yes Yes The folder into which the file will be moved. File name mask to be specified only if you want to change the file name. The name of the destination folder, if a new folder is to be created. True if a new destination folder is to be created, otherwise False. Note: There is no default value. If you leave this property blank, an error will occur. No True if a copy of the file is to be kept in its original location after the move, otherwise False. True False Description Default Value Example C:\Temp\OUT $guid$_moved.txt C:\Temp\OUT True or False Mandatory Yes No Description The path of the folder into which the message is to be written. The mask to be applied to the resulting file. This determines the name of the file. $0:u$ + $guid$. Default Value c:\temp $0:u$.xml Example
EMS Sender Configuration Properties
Property
hostname
username
password
topicOrQueueName
emsType
Table 20: EMS Sender Configuration Properties
File Move Sender Configuration Properties
Property
moveTo
changedFileName
moveToFolder
createFolder
keepCopy
Table 21: File Move Sender Configuration Properties
File Sender Configuration Properties
Property
filePath
fileNameMask
$guid$.txt
Table 22: File Sender Configuration Properties
Property No content fileInfo fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access No Required if payload is set to fileInfo. If the message payload contains XML with namespace set this value to the applicable namespace for the XPath searches. Required if payload is set to fileInfo. Must contain the Xpath to interrogate the argument to Send() method to get the file name containing the message. xmlns:ABC='http:// namespace.ABC.net/common' //FullPath/text() content: The full content of the file is passed through as the payload
Mandatory
Description
Default Value
Example
payLoad
messageNamespace

Yes Mandatory Yes Yes Yes No No No The FTP port to be used. The folder on the FTP site into which the message is to be uploaded. The string that will be used to identify the file to be downloaded. The transfer type to be used when files are downloaded. Possible values are: No b: Binary 5000 3000 a: ASCII Password for access to the FTP site 21 Root folder *.*, denoting that all files in the specified folder will be downloaded b User name for access to the FTP site TDP/IP address of the FTP site. Description Default Value Example 192.134.55.67 ftpadmin mypassword 23 c:\messages\UPLOAD *.txt No a The frequency at which the folder is polled for a file with a name that corresponds to the specified filter. This value is expressed in milliseconds Number of times that connection to the FTP site will be retried when an FTP Exception occurs. No No 3 2 $guid$
fileNameXpath
Table 22: File Sender Configuration Properties (Continued)
FTP Sender Configuration Properties
Property
host
username
password
port
directory
filter
transferType
waitPeriod
retryTimes
fileNameMask
The file name mask used to generate the remote file name.
Page 221
Table 23: FTP Sender Configuration Properties
Property No $newguid$.xml 0 True c:\Moved ChangedName$guid$.xml False 1 No No If set to False, an SSL connection will not be used. No No File name mask to be specified only if you want to change the file name. The target location into which the files must be moved. If set to True, an SSL connection will be used. Timeout period for the connection. The mask used to rename the file once it has been uploaded to the target location.
Mandatory
Description
Default Value
Example
Page 222
Mandatory Yes Yes Yes A string that contains connection details for the MQ channel. The format of the MQ channel name is ChannelName/ ConnectionName Name of the queue to send the reply-to along with the message Name of the queue manager to which the reply-to will be sent. The queue manager identification The name of the queue to be monitored Description Default Value Test.IN RM_Test S_swift/TCP/192.168.10.76 (1417) Test.IN RM_Test Example No No Description The SQL Server connection string required to access the database to be queried. The format in which the dataset result is sent to the ASH. outputFormat may be set to either: XML CSV True False XML Default Value Example DataSource=<SQLSERVERNAME>; uid=sa;pwd=sa; initial catalog=<DBNAME>; CSV True if any double quotes need to be replaced by a single quote in the payload. Otherwise False.
renameMask
connectionTimeout
useSSL
moveTo
changedFileName
Table 23: FTP Sender Configuration Properties (Continued)
MQSeries Sender Configuration Properties
Property
mqName
mqManager
mqChannel
mqReplytoName
mqReplyToManager
Table 24: MQSeries Sender Configuration Properties
MS SQL Sender Configuration Properties
Property
Mandatory
dsn
Yes
outputFormat
No
escapePayload
No
Table 25: MS SQL Sender Configuration Properties
Property Value in seconds after which the Sender will time out and stop trying to execute the SQL statements. 30 False True Indicates whether or not the Sender message is to be interpreted so that its results may be used in the SQL exec statements: True: the Receiver assumes that the SQL statements which follow have to be run against the database. The extended attributes dataType and test must be set. If dataType is not set, the Receiver will assume a numeric evaluation is required. True False An SQL statement to be run against the SQL database specified by the dsn string. False: the message is not to be interpreted True: the message is to be interpreted 20
Mandatory
Description
Default Value
Example
timeout
No
interpretXML
No
condition
No

.select * from.. Mandatory Yes No The location of the message queue. The formatter that is used to deserialize an object from the body of a message read from the queue. The default formatter is System.Messaging.XmlMessageFormatter The only alternative value for this field is activex. This means that the formatter System.Messaging.ActiveXMessageFormatter will be used. string Description Default Value Example .\Private$\Test activex Mandatory No Description The text of an exception message that may be generated during the send. Used for testing purposes only. If you do not specify a value, the event always succeeds. If you specify a value, the event always fails with the values you specify. Default Value Example
exec
No
Table 25: MS SQL Sender Configuration Properties (Continued)
MSMQ Sender Configuration Properties
Property
MSMQDefinition
FormatterType
Table 26: MSMQ Sender Configuration Properties
Null Sender Configuration Properties
Property
sendExceptionMessage
Table 27: Null Sender Configuration Properties
Page 223
Property No If you do not specify a value, the event always succeeds. If you specify a value, the event always fails with the values you specify. The text of an exception message that may be generated during the reply. Used for testing purposes only.
Mandatory
Description
Default Value
Example
Page 224
Mandatory The Oracle Server connection string required to access the database to be queried. The format in which the dataset result is sent to the ASH. outputFormat may be set to either: XML XML CSV True 30 False False 20 True True if any double quotes need to be replaced by a single quote in the payload. Otherwise False. Value in seconds after which the Sender will time out and stop trying to execute the SQL statements. Indicates whether or not the Sender message is to be interpreted so that its results may be used in the SQL exec statements: True: the message is to be interpreted False: the message is not to be interpreted True CSV Description Default Value Example DataSource=<ServerName>;uid=sa; pwd=sa;initial catalog=<DBName>; True: the Receiver assumes that the SQL statements which follow have to be run against the database. The extended attributes dataType and test attributes must be set. If dataType is not set, the Receiver will assume a numeric evaluation is required. An SQL statement to be run against the SQL database specified by the dsn string. select * from...
replayExceptionMessage
Table 27: Null Sender Configuration Properties
Oracle Sender Configuration Properties
Property
dsn
Yes
outputFormat
No
escapePayload
No
timeout
No
interpretXML
No
condition
exec
Table 28: Oracle Sender Configuration Properties
Rendezvous Sender Configuration Properties

Mandatory No 11 12 No 1 2 No Yes No Yes Yes Yes Yes The name of the network if the machine is configured to run on multiple networks. The service type or port number if a specific network service is to be used. The daemon name if connecting to a remote daemon process The embedded license for connecting to a secure daemon. Refer to the Rendezvous Receiver concepts documentation Defines how often the Rendezvous Sender is executed. This value is specified in milliseconds. The subject to be monitored for messages. 2000 Value in seconds after which the Sender will time out and stop trying to execute the SQL statements 3: response 20 topicB 500 lan0;;224.1.1.6 UDP purple_host:6555 2: request 1: pub/sub The type of interaction to be used. May take the following values: 12: intra-process 11: network The type of transport to be used. May take the following values: Description Default Values Example
Property
transport

Mandatory Yes Yes No Description Xpath for data/tag to pass through The connection string to the dtSchedule database. Leave this property blank if you want to use the default namespace, otherwise specify a namespace Required only if payload is set to fileInfo. If the message payload contains XML with a namespace set this value to the applicable namespace for the XPath searches. Default Value //Header #dtScheduleDsn# xmlns:ABC='http:// namespace.ABC.net/common' Example/Body/Text() Example
interaction
timeout
subject
pollingInterval
net.network
net.service
net.daemon
net.license.ticket
Table 29: Rendezvous Sender Configuration Properties
Router Sender Configuration Properties
Property
headerXpath
dsn
namespace
messageNamespace No
Page 225
Table 30: Router Sender Configuration Properties
Property No content fileInfo fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access content: The full content of the file is passed through as the payload
Mandatory
Description
Default Value
Example
Page 226 This sender must be used in conjunction with the Scheduler Event Execution Receiver. The sender has no properties and takes its settings from the receiver. Refer to the topic Scheduler Event Execution Receiver Properties on page 218.
Mandatory Yes Yes Yes No No No The FTP port to be used. The folder on the secure FTP site that is to be monitored. The string that will be used to identify the file to be downloaded. Password for access to the secure FTP site 21 Root folder *.*, denoting that all files in the specified folder will be downloaded. b User name for access to the secure FTP site TDP/IP address of the secure FTP site. Description Default Values Example 124.452.45.78 ftpadmin mypassword 24 C:\temp\MONITOR *.txt No No b: Binary 60000 40000 a: ASCII The transfer type to be used when files are downloaded. Possible values are: a The frequency at which the folder is polled for a file with a name that corresponds to the specified filter. The value is expressed in milliseconds. Number of times that connection to the secure FTP site will be retried when an FTP Exception occurs. The frequency at which the connection to the secure FTP site is retried following an FTP exception. The default wait interval is 60000 milliseconds or 1 minute. No No 3 5 40000
payload
Table 30: Router Sender Configuration Properties
Scheduler Event Execution Sender Configuration Properties
SFTP Sender Configuration Properties
Property
host
username
password
port
directory
filter
transferType
waitPeriod
retryTimes
retryWait
Table 31: SFTP Sender Configuration Properties
Property No $guid$ No No No True c:\Moved ChangedName$guid$.xml False If set to False, an SSL connection will not be used. No No File name mask to be specified only if you want to change the file name. The target location into which the files must be moved. If set to True, an SSL connection will be used. Timeout period for the connection. The mask used to rename the file once it has been uploaded to the target location.
Mandatory
Description
Default Values
Example
fileNameMask
The file name mask used to generate the remote file name.
renameMask
connectionTimeout
useSSL
moveTo
changedFileName

Description Full pathname of the SMTP email server Sender of the email message Recipient of the email message The subject of the email message. The expected format of the body of the email message. This may be either text or html. Any files attached to the email message. html Default Value Example localhost/servername testsend@mail.com recipient@email.com Exception_Msg text Description Full pathname of the file to be chunked Required only if payload is set to fileInfo. Xpath expression used to isolate the file path from the payload. The number of chunks/pieces in a delimiter Default Value Example \\FullPath\FileInfo\text() \\FullPath\FileInfo\text() 3
Table 31: SFTP Sender Configuration Properties (Continued)
SMTP Sender Configuration Properties
Property
Mandatory
smtpserver
Yes
from
Yes
to
Yes
subject
No
format
No
attachment
No
Table 32: SMTP Sender Configuration Properties
Text Sender Configuration Properties
Property
Mandatory
xmlFilePath
No
FilePathXpath
No
setSize
Yes
Table 33: Text Sender Configuration Properties
Page 227
Property True if the file has a header, otherwise False. False Note: There is no default value. If you leave this property blank, an error will occur. The escape character to break on $utf:27$ <endpoint endpointID="Chunk Sender" library= "FileAdapterSender" className="ABC.Class. Common.Adapters.File.Sender"><config item= "filePath"> C:/Test/ChunkedLocation</config> <config item="fileNameMask">$changedFileName$_ $newguid$.xml</config> <config item="payload">content</config> </endpoint> fileInfo content Leave this property blank but complete the extended attributes
Mandatory
Description
Default Value
Example
Page 228
content: The full content of the file is passed through as the payload fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access Mandatory Yes Yes Yes No Name of the transaction. The version number of the transaction. Transactions can be versionised on import. True if the properties are to be included, otherwise False. False The location of the XCCache folder. Description Default Value Example C:\walkthrough 1457\destination demo:noobject 1 True
hasHeader
Yes
delimiter
Yes
senderXML
Yes
payload
No
Table 33: Text Sender Configuration Properties (Continued)
TX Sender Configuration Properties
Property
location
transactionID
transactionVersion
includeProperties
Table 34: TX Sender Configuration Properties
XML Sender Configuration Properties

Description Required if payload is set to fileInfo. Path of the file that needs to be chunked \\FullPath\FileInfo\text() \\FullPath\FileInfo\text() Required if payload is set to fileInfo. The Xpath that must be used to extract the file path from the payload. The element to break on Row Any number greater than or equal to 1 <endpoint endpointID="Chunk Sender" library= "FileAdapterSender" className="ABC.Class. Common.Adapters.File.Sender"><config item= "filePath"> C:/Test/ChunkedLocation</config> <config item="fileNameMask">$changedFileName$_ $newguid$.xml</config><config item= "payload">content</config> </endpoint> fileInfo content The number of elements that will be chunked into a single file. Contains the XML configuration of a second sender that is to be instantiated and to which the results are to be sent Default Values Example
Property
Mandatory
xmlFilePath
No
FilePathXpath
No

content: The full content of the file is passed through as the payload fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access Mandatory No No Description The folder into which the files will be extracted. The string that will be used to identify the files to be extracted from the zip file. The folder where the zip file is located. *.*, denoting that all files in the zip file will be extracted Default Value Example C:\temp\EXTRACT2 *.txt C:\temp\ZIP
chunkElement Name
Yes
setSize
Yes
senderXML
Yes
payload
No
Table 35: XML Sender Configuration Properties
Zip Sender Configuration Parameters
Property
extractToDirectory Yes
filter
moveTo
Page 229
Table 36: Zip Sender Configuration Properties
Interceptor Adapter Configuration Properties
Page 230
Mandatory No False True False: The message is not to be interpreted. If the tag exists the message is interpreted, if the tag does not exist the message will not be interpreted. Yes Defines the command line program/script to run. The value of 'command' item is the program/script to run and it's arguments. The 'command' item has extended values that can be specified. content: The full content of the file is passed through as the payload content fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access No Must contain the Xpath to interrogate the argument to Send() method to get the file name containing the message. No Required if payload is set to fileInfo and fileName is empty. The Xpath query used to extract the new filename for the transformed XML file from the FileInfo XML document. N N N Required if payload is set to fileInfo.The namespace used to extract the Xpath values. Required if payload is set to fileInfo. The name of the file that contains the message. The new name of the XML file after it has been transformed. concat('c:\walkthrough5\dtwsi3.4\ encryption-working-dir\',' $guid$.enc') Required if payload is set to fileInfo and fileName is empty. //FullPath/text() fileInfo $[encryptionCmd]$ $fileName$ $newFileName$ True: The message is to be interpreted so that its results may be used in the SQL exec statements. Description Default Value Example Yes Example/Body/Text() C:\Test Files\Valfile.txt example.txt
Command-line Interceptor Configuration Properties
Property
interpretXML
command
payload
fileNameXpath
newFileNameXpath
messageNamespace
fileName
newFileName
Table 37: Command-line Interceptor Configuration Properties
Duplicate Check Interceptor Configuration Properties

Mandatory Yes content fileInfo: Not supported Yes The connection string for the dtRouting database in which the Duplicate Check Interceptor will store a history of message type payloads, hashes and their relevant artefact data which it will use to perform duplicate checks. The UNC path that the Interceptor will use to write out failed duplication checks against message payloads. The type of message against which the duplicate check will be executed. Use this property to differentiate payload/message types. If you do not supply a message type, a duplication check will be performed against all other messages without a message type ID. #dtRoutingDsn# content: The full content of the file is passed through as the payload fileInfo Description Default Value Example
Property
payload
dsn

Yes Yes c:\failed 112 Description The full pathname of the queue. Default Value Example .\Private$\Test.queue Mandatory Yes Description The SQL Server connection string required to access the database to be queried Value in seconds after which the Interceptor will time out and stop trying to process the message. The SQL query to execute against the database. Only the first result from the first row will be retrieved. Default Values Example DataSource=<SQLSERVERNAME> ;uid=sa;pwd=sa; initial catalog=<DBNAME>; 30 insert into ... No Yes
failedLocation
messageTypeId
Table 38: Duplicate Check Interceptor Configuration Properties
MSMQ Interceptor Configuration Properties
Property
Mandatory
queuePath
Yes
Table 39: MSMQ Interceptor Configuration Properties
Sql-Value-to-Property Interceptor Configuration Properties
Property
dsn
timeout
sql
Page 231
Table 40: Sql-Value-to-Property Interceptor Configuration Properties
Property Yes TabProp $0:d$ No The format to be applied to the result if the result is a date or a time. Name of table property in SQL database to add or set.
Mandatory
Description
Default Values
Example
Page 232
Mandatory Yes Required if payload is set to fileInfo. Must contain the Xpath to interrogate the argument to Send() method to get the file name containing the message. The character to search for The character that is to replace the character that is being searched for content: The full content of the file is passed through as the payload fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access Yes The mask that will be applied to the file to be processed. This may be used for the archive location and may contain tokens if necessary. Location of the archived file. You must specify the location if a new archive file is to be created $newguid$.txt Archived $guid$.txt content Description Default Value Example //FullPath/text() Yes Yes Yes findme replacewiththis fileInfo Yes C:\Archive\IN Mandatory Yes Yes Yes Description Property is not used. Any value you enter will be ignored. Transaction name The version number of the transaction. demo:noobject 1 SendSMS 2 Default Value Example
propertyName
dateTimeFormat
Table 40: Sql-Value-to-Property Interceptor Configuration Properties
Text-replace Interceptor Configuration Properties
Property
fileNameXpath
searchFor
replaceWith
payload
archiveFileNameMask
archiveLocation
Table 41: Text-Replace Interceptor Configuration Properties
TX Interceptor Configuration Properties
Property
location
transaction
version
Table 42: TX Interceptor Configuration Properties
Property Yes //message xmlns:ABC='http:// namespace.ABC.net/common' No XML namespace to be used when applying the Xpath (returnXpath) query. The Xpath that must be executed to obtain the necessary result subset.
Mandatory
Description
Default Value
Example
returnXpath
transactionResultNamespace
Table 42: TX Interceptor Configuration Properties

Mandatory No A list of assembly paths and their associated fully qualified custom validator type names. The assembly path is separated from its type name by a comma. Each assembly path-type name pair is separated by a semi-colon. If payload is blank, this is the name of the file to be validated. If payload is fileinfo, this is the XPath to the file name. If the message payload contains XML with namespace, this value must be set to the applicable namespace for the XPath searches. If the message payload contains the file information, this property must be set to fileInfo. If the message payload does not contain the file information, leave this value blank and specify a value for fileName. No The list of path names of the schema files to be used in validation. Each path name is separated by a semicolon. C:\MyXmlSchema.xsd; C:\MyCustomSchema.xml //FileInfo/FullPath xmlns:ABC='http://ABC.net/namespace' Description Default Values Example myLibrary.Validators.dll, myLibrary.Validators.CustomValidator1; myLibrary.MoreVals.dll, myLibrary.MoreVals.CustomValidator5 No No No No fileInfo
Validation Interceptor Configuration Properties
Property
customValidationTypes
fileName
fileNameXPath
messageNamespace
payload
schemaFilePaths
Table 43: Validation Interceptor Configuration Properties
Page 233
Property No C:\Temp\ABCFiles The folder in which files are temporarily stored during custom validation. If you leave this parameter blank the folder c:\temp will be used. You must assign Write / Delete permissions to the account under which the Adapter Services Host (ASH) is running.
Mandatory
Description
Default Values
Example
Page 234
Mandatory Yes Yes Required if payload is set to fileInfo. Must contain the Xpath to interrogate the argument to Send() method to get the file name containing the message. If the message payload contains XML with namepsace set this value to the applicable namespace for the XPath searches. content: The full content of the file is passed through as the payload fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access content The name of the schema file. Description Default Value Example C:\Temp\Schema.xml //FullPath/text() No No xmlns:ABC='http:// namespace.ABC.net/common' fileInfo
workingFolder
Table 43: Validation Interceptor Configuration Properties (Continued)
XML Schema Interceptor Configuration Properties
Property
schemaFileName
fileNameXPath
messageNamespace
payload
Table 44: XML Schema Interceptor Configuration Properties
XML Tools Interceptor Configuration Properties

Description Instructions to perform against the message: unescape: Creates a security element from an XML-encoded string and encapsulate the result in unescape tag escape: Replaces invalid XML characters in a string with their valid XML equivalent removehead: Remove the XML header comment: Encapsulate the message in XML strings cdata: Encapsulate the message in CDATA tags escape Default Value Example
Property
Mandatory

Mandatory Yes No content: The full content of the file is passed through as the payload fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access. Yes Required if payload is set to fileInfo. Must contain the Xpath to interrogate the argument to Intercept() method to get the file name containing the message. Required if payload is set to fileInfo. The Xpath query used to extract the new filename for the transformed XML file from the FileInfo XML document. No If the message payload contains XML with namepsace set this value to the applicable namespace for the XPath searches. The name of the file before it is transformed. //FullPath/text() The physical UNC path of the XSLT stylesheet to be used for the transformation of the payload. content Description Default Value C:/... fileInfo Example No concat('c:\walkthrough5\dtwsi3.4\ encryption-working-dir\', ' $guid$.enc') xmlns:ABC='http:// namespace.ABC.net/common' $guid$.xml No
escape
Yes
Table 45: XML Tools Interceptor Configuration Properties
XSLT Interceptor Configuration Properties
Property
styleSheetPath
payload
FileNameXpath
newFileNameXpath
messageNamespace
fileName
Page 235
Table 46: XSLT Interceptor Configuration Properties
Property No $newguid$.xml False False True True No No True if support is required for the XSLT Script function, otherwise False. True if support is required for the XSLT Document function, otherwise False. The new name of the file after it has been transformed.
Mandatory
Description
Default Value
Example
Page 236
Mandatory No No Required only when interceptFrom is set to file. The full pathname of the file once it has been compressed or uncompressed. content: The full content of the file is passed through as the payload fileInfo: Only information about the file is passed through as the payload. This information includes: file name; full path name; length; date and time of creation; date and time of last access. No If the message payload contains XML with a namepsace set this value to the applicable namespace for the XPath searches. Required only when: interceptFrom is set to file payload is set to fileInfo xmlns:ABC='http:// namespace.ABC.net/standard' //FullPath/text() content Required only when interceptFrom is set to file. The full pathname of the file to be compressed or uncompressed. Description Default Value Example c:\ArchiveFile1.txt c:\Archived No fileInfo No The Xpath to use when extracting the path to the file to read when compressing from the payload No Required only when: interceptFrom is set to file payload is set to fileInfo xfullpath\filename\text() The Xpath to use when extracting the path to the file to compress into from the payload. Yes string: Compress from a message. file: Compress from a file string
newFilename
enableDocument
enableScript
Table 46: XSLT Interceptor Configuration Properties (Continued)
Zip Interceptor Configuration Properties
Property
file
archiveFile
payload
messageNamespace
fileXpath
archiveFileXpath
interceptFrom
Table 47: Zip Interceptor Configuration Properties
Property Yes string zip file: Compress to a file Yes Instruction to compress (zip) or decompress (unzip) string: Compress to a message.
Mandatory
Description
Default Value
Example
interceptTo
interceptOperation
REP 1.2.0 - REIE Reference Manual REP120REEIE.090 Chapter A Adapter Configuration Properties
Table 47: Zip Interceptor Configuration Properties (Continued)
Page 237
Page 238
Appendix B: Tokens
Tokens represent variables that may be specified as values for adapter parameters. When an event is run and the adapter configuration parameters are read, the token values are replaced by actual values. The table below lists all the available tokens and the values with which they will be replaced at runtime.
Token $changedFileName$ Description The name of the file which raised the event from the receiver. Note: This is not available when used in conjunction with the Routing events, the text Sender and the XML Sender The globally unique identifier for the current job A new globally unique identifier that is not related to a job Short date Long date Timestamp with full date and short time expression Timestamp with full date and full time expression Timestamp with short date and short time expression Timestamp with short date and long time expression Month and day Date in words and time with time zone Date with year first and long time expression Short time with AM/PM Full time expression Universal or sortable timestamp Date in words and full time expression Month and year Number of month Full name of day A sequence of hexadecimal digits 3F2504E0-4F89-11D3-9A0C0305E82C3301 A sequence of hexadecimal digits 3F2504E0-4F89-11D3-9A0C0305E82C3301 mm/dd/yy Day Month dd, yyyy Month dd, yyyy hh:mm 09/04/08 Thursday September 04, 2008 Thursday September 04 2008 10:28 Format Example
$guid$ $newGuid$ $0:d$ $0:D$ $0:f$ $0:F$ $0:g$ $0:G$ $0:M$ $0:R$ $0:s$ $0:t$ $0:T$ $0:u$ $0:U$ $0:Y$ $dt:month$ $dt:dayofweek$
Month dd, yyyy hh:mm:ss AM/PM Thursday September 04 2008 10:28:31 AM mm/dd/yy hh:mm mm/dd/yy hh:mm:ss Month dd Dd Month yyyy hh:mm:ss zone yyyy-mm-dd hh:mm:ss hh:mm AM/PM hh:mm:ss AM/PM yyyy-mm-dd hh:mm:ss day, month dd, yyyy hh:mm:ss AM/PM Month yyyy mm Day 09/04/08 10:36 09/04/08 10:39:22 September 04 04 September 2008 10:46:56 BST 2008-09-04 10:47:43 02:45 PM 02:45:34 PM 2008-09-04 10:51:45 Thursday September 04, 2008 10:53:21 AM September 2008 09 Thursday
Table 48: REIE Adapter Property Tokens
Page 239
Appendix B Tokens
Token $dt:timeofday$ $dt:ticks$ $dt:dayofyear$
Description 24-hour time Seconds Number of the current day in the year hh:mm:ss
Format 17:35:46
Example
CurrTime.Ticks DayNumber DayNumber.FractionofDay 345 2454742.9149884
$0:yyyy$$dt:dayofyear$ Julian date: continuous count of days and fractions of a day that have elapsed since an initial epoch $0:yyyy$ Year
yyyy
2009
Table 48: REIE Adapter Property Tokens (Continued)
Page 240
Appendix C: Element Definitions

The main elements of REIEDataTrans are defined in the table below.
Element Adapters Definition DataTrans REIE uses its adapters to interface with other applications. Data is then routed between the connected applications using a combination of rules, processes and events. Adapters may be of two types: Application adapters are a combination of technology adapters and business rules or processes Technology adapters provide access to a technology enterprise. Examples
of technology adapters include HTTP, FTP, SMTP, ZIP and Tibco Rendezvous
Care must be taken not to confuse the two. In very simple terms, a technology adapter may be seen as the lowest level component of an application adapter. Adapter Services Host (ASH) ASH executes the receiver/interceptor and sender technology adapters as configured by the REIEDataTrans Manager. Multiple instances of the ASH may be installed on a single server. An ASH will only load the adapter configuration settings of those areas (and associated events) that are assigned to that ASH. Application adapter An application adapter is one process or a collection of processes that performs a specific task. For example, transfers data from the Data Scope Select system to the RRDS system. An area is a sub-division of an environment. Within an environment you must specify at least one area. Each area must be assigned to at least one Adapter Service Host (ASH). Areas may be used to spread the processing load across multiple services. Using areas allows you to assign multiple services to a single area if the events within that area require substantial processing capabilities. In the same way, you can assign multiple areas to a single service if those events are not process-hungry. Business Transaction Host (BTH) BTH is the service that executes business transactions. Business transactions are registered through the REIEDataTrans Manager and served up through the MSL to the BTH for both synchronous and/or asynchronous execution. A calendar defines the schedule against which Business Transaction events are executed. REIEDataTrans uses three separate databases: dtSchedule: the main database in which configurations, events and adapters are saved dtLog: the database in which all the logging messages are saved dtJournal: the database that is reserved for journals of all actions within REIE DataTrans
Area
Calendar Database
Table 49: Definition of Main Elements of REIE DataTrans
Page 241
Chapter C Adapter Configuration Properties
Element Dependency
Definition A dependency is a correlation between the current event and the completion of other events or processes. Two types of dependency can be defined for an event or a process: Dependencies On fail dependencies
Dependencies refer to the events and processes that are required to have succeeded in order for a particular event or process to be executed. On fail dependencies refer to the events and processes that are required to have failed in order for a particular event or process to be executed. Destination A destination is a component of a message type. A route must have one and only one destination. A new route is therefore always created with a default destination that points to a null sender. A document is a graphical view of one or more events. One or more documents may be assigned to a process to make the process clearer and to make the process flow easier to visualize. The environment is the overall context that all the areas, events, processes and so on relate to. When you log on to REIEDataTrans for the first time, the first thing you must do is create and configure the environment. An event in REIEDataTrans is an activity that monitors an action within the system. There are three types of activity: Scheduled activity Real-time activity On-demand activity
Document
Environment
Event
There are three types of event. Business Transaction events monitor scheduled and on-demand activity. Adapter events and Routing events monitor real-time activity. It is possible to define a dependency on the success or failure of an event. Globally Unique Identifier (GUID) Group A string of numbers, letters and hyphens that uniquely identifies a message or a file. Certain permissions may be grouped together to make them easier to manage. Users can then be assigned to a particular group of permissions. This is the way in which user permissions are managed. A type of technology adapter. Interceptor adapters carry out actions on information while the information is in transit on its way to its destination. A job is created each time an event is run. A job is a log of the instance of the event. A log is created of all activities. MSL is the control centre for all the services. A single MSL represents an environment. The MSL: Match Handles the registering and de registering of services Manages the configuration of all services Controls all communication between REIEDataTrans and the databases and services including communication relating to security
Interceptor Job Log Management Services Layer (MSL)
An Xpath query that allows a message to be interrogated against a regular expression (RegEx).
Table 49: Definition of Main Elements of REIE DataTrans (Continued)
Page 242
Element Match set
Definition A match set is made up of matches. Match sets can be relatively explicit with regards to the criteria that needs to be matched in each message. Messages on match sets can share namespaces. You can define more than one match set for a message type. If any of the match sets defined for a message type are evaluated as true (OR condition), a message is matched to a message type. If all the match sets defined for a message type are evaluated as true (AND condition), the match set is evaluated as true. Message types define how a message is to be handled and routed. A message type is made up of: Match sets Routes Destinations Actions Namespaces
Message type
Message types can share routes. Namespace A mechanism that allows REIEDataTrans to interpret non-standard XML if the user chooses to use it. You can define a number of namespaces for the environment. A default namespace is defined for each environment. This namespace cannot be deleted or changed. Process Receiver Route Routing A logical group of events. It is possible to define a dependency on the success or failure of a process. A type of technology adapter. Receiver adapters pick up information. The route that a message may take. A route cannot exist without a destination. Routes can share destinations and actions. A route can be defined on multiple message types. The most efficient way of moving a message from one location to another. Routing is used to deliver a message to one or more destinations after performing certain actions (for example, transformations) on the message. When a message is routed it is first crossreferenced against a number of user-defined match sets to determine the specific route the message should take. Responsible for the execution of time driven events. As with the Adapter Services Host, you can install multiple instances of the Scheduler Service on the same server and configure them for fail-over. A type of technology adapter. Sender adapters move messages towards a destination. A set of related components provided in support of one or more business processes. Performs basic send and receive operations: for example, receive a message of any type or sends an Enhanced Message Service message. Multiple technology adapters may be assigned to an event. Technology adapters may be of three types: Receivers Senders Interceptors
Scheduler Service
Sender Service Technology Adapter
Page 243
Element Transaction
Definition A framework that carries out a scheduled or an on-demand activity. Scheduled activities are carried out on certain dates and times determined by calendar rules. A Business Transaction event runs the transaction and determines how and when the transaction will run. For more information on writing transactions, refer to Chapter 4, Managing Business Transactions.
Page 244
Appendix D: Adapter Configuration Examples

This appendix describes some adapter configuration examples. The descriptions begin on the following page.
Page 245
Receiver Adapter Configuration Examples
Page 246
Context: Receive from Topic Example tcp://localhost:7222 X Admin 123eer Topic topicA 1000 text or map <![CDATA[xxxxx]]> CDATA XML text or map String 1000 X Integer text, map Defaults to text if no value is provided Only required for map X Queue1 X X Queue X Topic, Queue Dependent on emsType 344ddf X X Admin X tcp://localhost:7222 X Required Example Required Data Type Enumerations Notes Context: Receive from Queue Context: Content Example C:\temp C:\archive *.xml,*.txt $0:u$.xml,$guid$.txt content 2000 False 1000 True fileinfo Integer Boolean True, False *.xml,*.txt $0:u$.xml,$guid$.txt content, fileinfo Enumerations X C:\archive X C:\temp Required Example Context: fileInfo Required X X This is the location of the archival file Data Type Enumerations Notes
EMS Receiver Configuration Example
Property Name
hostName
username
Password
emsType
Chapter D Adapter Configuration Properties
topicOrQueueName
pollinginterval
messageType
mapMessageTemplate <![CDATA[xxxxx]]>
Table 50: EMS Receiver Configuration Example
File Receiver Configuration Example
Property Name
folderPath
moveTo
Filter
fileNameMask
Payload
pollingInterval
loadBalanced
Table 51: File Receiver Configuration Example
Property Name Example DataSource = <SQLServer Name>; initialcatalog = <DB Name>; Integrated Security = true; DataSource = <SQLServer Name>; initialcatalog = <DB Name>; Integrated Security = true; Only required is loadBalanced is True Required Example Required
Context: Content Data Type Enumerations Notes
Context: fileInfo
DSN

Context: Content Example C:\temp C:\archive X *.xml $0:u$.xml content 2000 False X True X X 1000 X Integer Boolean String True, False Only required is loadBalanced is True X fileinfo X X $guid$.txt X content, fileinfo Enumerations X *.txt X C:\archive X X C:\temp X Required Example Required Data Type Enumerations Context: fileInfo Notes Context: Default values Example topicA 11 1 X Required 11 1 Context: Example values Example topicB Required X Integer Integer 11,12 1,2,3 Data Type Enumerations Notes
Table 51: File Receiver Configuration Example
FTP Receiver Configuration Example
Property Name
folderPath
moveTo
Filter
fileNameMask
Payload
pollingInterval
loadBalanced
DSN
Table 52: FTP Receiver Configuration Example
Rendezvous Receiver Configuration Example
Property Name
subject
transport
interactionr
Page 247
Table 53: Rendevous Receiver Configuration Example
Page 248
Context: Default values Context: Example values Data Type Enumerations Notes Example lan0;;224.1.1.6 UDP purple_host:6555 0 2000 2000 Integer -1 Double Required Example Required
Property Name
net.network
net.service
net.daemon
net.license.ticket
timeout
pollingInternal
Table 53: Rendevous Receiver Configuration Example
Sender Adapter Configuration Examples
EMS Sender Configuration Example

Context: Receive from Topic Example tcp://localhost:7222 X Admin 123eer Topic topicA text text String text, map X Queue1 X X Queue X Topic, Queue Dependent on emsType If map is chosen, then the message must be sent in a specific XML format 344ddf X X Admin X tcp://localhost:7222 X Required Example Required Data Type Enumerations Notes Context: Receive from Queue
Property Name
hostName
username

Context: Content Example C:\temp $0:u$.xml content //Fullpath/text() X fileinfo $guid$.txt X C:\temp Required Example Context: fileInfo Required X X X X Data Type String String String String Boolean True, False Defaults to $0:u$$guid$ content, fileinfo Enumerations Enumerations Notes XMLNS:m35=http://m35.net/ns X
Password
emsType
topicOrQueueName
messageType
Table 54: EMS Sender Configuration Example
File Sender Configuration Example
Property Name
filePath
fileNameMask
Payload
messageNamespace
fileNameXpath
Table 55: File Sender Configuration Example
Page 249
Page 250
Context: Content Example C:\temp $0:u$.xml content String //Fullpath/text() X Boolean True, False X fileinfo X String $guid$.txt X String content, fileinfo Enumerations X C:\temp X String Defaults to $0:u$$guid$ Required Example Required Data Type Enumerations Notes Context: fileInfo Context: Default values Context: Example values Data Type Example topicB 11 1 lan0;;224.1.1.6 UDP purple_host:6555 Integer Integer X 11,12 1,2,3 Required Example topicA 11 1 X Required Enumerations Notes
FTP Sender Configuration Example
Property Name
filePath
fileNameMask
Payload
messageNamespace
fileNameXpath
Table 56: FTP Sender Configuration Example
Rendezvous Sender Configuration Example
Property Name
subject
transport
interactionr
net.network
net.service
net.daemon
net.license.ticket
Table 57: Rendevous Sender Configuration Example
Interceptor Adapter Configuration Example

Validation Interceptor Configuration Example
Property Name Required Example myLibrary.Validators.dll, myLibrary.Validators.CustomValidator1; myLibrary.MoreValidators.dll, myLibrary.MoreValidators.CustomValidator5 //FileInfo/FullPath xmlns:acme=http://www.acme.com X X X FileInfo C:\MyXmlSchema.xsd; C;\MyCustomSchema.xml C:\Temp\Files
customValidationTypes X fileNameXPath messageNamespace payload schemaFilePaths workingFolder X
Table 58: Validation Interceptor Example
Page 251
Page 252
Index
A
About this manual 1 Access items administrator 198 allocating to a user 196, 203 data entity access items 196 group access items 196 rules relating to 199 Access rights allocating to a user 199 custom rules 199 Acknowledging jobs 171 Adapter events 3437 adding 34 Adapter List screen 35 Adapter Services Host (ASH) 241 default application configuration set 23 restarting 21 Adapters 241 application 241 technology 5357 Add/Edit Event screen Adapter events 34 Business Transaction events 28 Routing events 40 Administrator users 195 Aggregated Processes creating 135 Application adapters 241 Application configuration sets default 23 Fail Over 23 Application Configuration Sets screen 23 Application configuration, changing 23 Applications about 78 Area variables 96, 97 Areas 15, 241 assigning services to 15, 17 creating 16 Areas Management screen 16 Assign Documents to Process screen 139 Assign Events to Process screen 132, 136, 139
B
Business Transaction Designer 4243 Business Transaction events 2533 adding 28 Business Transaction Host (BTH) 241 restarting 21
C
Calendars 4548, 241 creating 50 deleting 52 editing rules 51 hierarchy, using 47 rules 45 Closing REIE 5 Configuration Management screen 16, 17, 19, 21, 22 Configuration, reloading 202
D
Data Element definition 65 Data entity access items 196 Databases 241 Datasets definition 73, 74 registering 75 unregistering 76 Definitions of elements 241 Dependencies, specifying for an event 30 Dependency 242 Deployment transactions 19 examples 19 Destinations 242 Direct transaction calls 33 Document Management screen 146 Documents 145160, 242 creating 148157 editing 147 exporting 159 importing 159 processes, assigning to 133, 138 saving 147 shapes, adding text 154 shapes, associating with an event 154, 155
Page 253
Index shapes, changing properties view 157 shapes, colouring 156 shapes, connecting 152 shapes, deleting 153 shapes, moving 150 shapes, properties 153 shapes, resizing 151 shapes, rotating 156 shapes, selecting 149 Documents screen 133, 137 creating 207 deleting 210 editing 208 GUID 239, 242
H
Home ribbon bar 6
I
Import Environment Configuration Wizard 186189 Importing configuration entities 187, 193 configuration from XML 186 import rules 190 resolving conflicts 188, 191 Interceptor adapters configuration example 59 using existing configuration 36
E
Edit Journal screen 172 Edit User Permissions screen 203 Enabling events 29 Environment ribbon bar 6, 8 making visible 6 Environment Settings menu 16, 19, 21, 22, 23, 172, 177 Environment variables 96, 97 Environments 242 Event List screen 28 Event Log Logger 176 Events 2527, 242 Adapter events 3437 Business Transaction events 2533 enabling 29 event identifier 37 event identifiers 33 exporting details to Excel 27 processes, assigning to 132, 136, 139 Routing events 3840, 79 shapes in documents, associating with 154, 155 statuses 31 types in processes, setting 132, 137 Exporting configuration to XML 192
J
Jobs 162, 242 acknowledging 171 event status, updating 170 resending 166?? searching by acknowledgement 166 searching by area 166 searching by date range 165 searching by event 166 searching by event name 165 searching by event status 166 searching by GUID 166 searching by process 166 viewing journal information 172 viewing log messages 170 Journal information, viewing 172 Journaling 172 Journals screen 172
F
Filter fields 12 Filter pane, View Process screen 141??
L
Local variables 96 Log messages exporting to Excel 182 searching by date 182 searching by GUID 181 searching by Message 182 searching by XML Data 181 viewing from Event Viewer 182 viewing from View Log screen 179
G
Getting started 3 Global variables 96 Group access items 196 Groups 49, 195, 199, 205, 242 assigning users 209
Page 254
Index
Logger Viewer screen 177 Loggers deactivating 178 Event Log Logger 176 MS SQL Database Logger 176 Loggers screen 177 Logging level, setting 177 Logs 242 system log 21, 22
M
Match sets 79 creating 8284 deleting 87 editing 86 removing from message types 86 Menus Environment Settings 16, 19, 21, 22, 23, 172, 177 Routing 88 Message analysis 65 Message Type screen 81 Message types 79 associating Routing events 84 creating 8085 deleting 87 editing 86 Message Types screen 38, 79 MS SQL Database Logger 176 setting timeout value 178 Multiple screens, working with 10
changing details 138 creating 130 deleting 140 documents 145160 documents, assigning 133, 138 End events 132, 137 event types, setting 132, 137 events, assigning 132, 136, 139 force end 140 instances, searching by date range 143 instances, searching by instance id 143 instances, searching by process name 143 Normal events 132, 137 refreshing process grid 144 running 139 Start events 132, 137 termination status 142 track instances 141 Property mapping (Sender adapters) 61
Q
Quick Action ribbon bar 11
R
Receiver adapters 34 configuration example 58 Refreshing screens 12 REIE closing 5 getting started 3 release, displaying 13 signing out 5 system menu 4, 5 version, displaying 13 Reloading configuration 202 Replay Wizard 167?? Restarting services 21 Result codes Adapter events 37 Business Transaction events 32 Routing events 37 Ribbon bars Environment 6, 8 hiding buttons 9 Home 6 Quick Action 11 redisplaying buttons 9
N
Namespaces 79, 88, 243 creating 83, 89 deleting 90 editing 90 Namespaces screen 88, 91
O
On Fail Dependency 31 On Fail Dependency screen 32 On Success screen 36 Ordering elements on screens 12
P
Process Management screen 130, 134, 138 Processes 129144, 243
Page 255
Index Router Sender adapters 26 Routes 39, 243 Routing 243 Routing events 3840, 79 adding 38 message types, associating with 84 message types, removing from 86 Routing menu 88 Validation 37 Variables 97 View Calendars 49 View Groups 199, 206 View Job Detail 170 View Jobs 163166 View Log 22, 179182 View Process 141144, 199 View Process Detail 131, 135 View Users 200, 201 Search fields 12 Searching for items 12 Selecting from lists 12 Sender adapters 34 configuration example 58 property mapping 61 using existing configuration 34 Sender screen 35 Services 243 assigning to an area 17 restarting 21 Signing out of REIE 5 SQL Database Journal 57 configuring 172 Status of an event 31 System menu 4, 5
S
Scheduler Service 243 Fail Over application configuration set 23 Screens Adapter List 35 Add/Edit Event (Adapter events) 34 Add/Edit Event (Business Transaction Events) 28 Add/Edit Event (Routing events) 40 Application Configuration Sets 23 Areas Management 16 Assign Documents to Process 133, 137, 139 Assign Events to Process 132, 136, 139 bringing to front 10 closing from Close button 11 closing from title bar 11 Configuration Management 16, 17, 19, 21, 22 Document Management 146 Edit Journal 172 Edit User Permissions 203 Event List 28 filter fields 12 Journals 172 Logger Viewer 177 Loggers 177 Message Type 81 Message Types 38, 79 multiple 10 Namespaces 88, 91 On Fail Dependency 32 On Success 36 ordering elements 12 Process Management 130, 134, 138 refreshing 12 search fields 12 Sender 35 tiled tab groups, creating 11 Transaction Management 29
T
Technology adapters 5357, 243 adding properties 60 configuration properties 211237, 239??, 245?? configuring 57 Interceptors 5357, 242 Receivers 5357, 243 removing properties 61 Senders 5357, 243 Tokens ??240 Transaction Management screen 29 Transactions 29, 4143, 244 calling 41 calling directly 33 designing 42 scheduling 30 standard 43
U
User accounts creating 201 deleting 204
Page 256
Chapter 1 Adapter Configuration Properties editing 202 User permissions 199 Users, assigning to a group 209
V
Validation errors, correcting 37 Validation screen 37 Variables area 96, 97 defining 9599 environment 96, 97 global 96 in adapter configurations 99 in application configuration sets 101 in journal configuration 100 in transactions 100 local 96 searching for 99 Variables screen 97 View Calendars screen 49 View Groups screen 199, 206 View Job Detail screen 170 View Jobs screen 163166 View Log screen 22, 179182 View Process Detail screen 131, 135 View Process Instance screen 141?? View Process screen ??144, 199 View Users screen 200, 201
Page 257
Chapter 1 Adapter Configuration Properties
Page 258

Testing

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Testing

Hochgeladen von

Copyright:

Verfügbare Formate

Reuters Enterprise Platform

REUTERS ENTERPRISE PLATFORM (REP)

Reuters Enterprise Integration Engine (REIE) Reference Manual

REP120REEIE.090 Date of Issue: 12 August 2009

REP 1.2.0 - REIE Reference Manual REP120REEIE.090

REIE Ribbon Bars and Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 2: Creating and Configuring the Environment and Areas . . . . . . . . . . . . . . . . .15

Creating the Environment and Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Restarting and Stopping Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

REP 1.2.0 - REIE Reference Manual REP120REEIE.090

Restarting a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Stopping a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Changing the Application Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Chapter 3: Managing Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

Chapter 4: Managing Business Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

Designing Business Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Chapter 5: Managing Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

REP 1.2.0 - REIE Reference Manual REP120REEIE.090

Chapter 6: Managing Technology Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

Types of Technology Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Configuring Technology Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Adding and Removing Adapter Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 7: Using Message Analysis and Schema Management . . . . . . . . . . . . . . . . . . .65

Using Schema Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Chapter 8: Managing Datasets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73

REP 1.2.0 - REIE Reference Manual REP120REEIE.090

Chapter 9: Managing Applications, Message Types and Subscriptions . . . . . . . . . . . . .77

About Message Types and Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Chapter 10: Managing Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95

REP 1.2.0 - REIE Reference Manual REP120REEIE.090

Using Variables in Application Configuration Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Chapter 11: Using Data Analytics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103

Data Analytics Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Data Part Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

About the Query Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Chapter 12: Embedded Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123

Using Embedded Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Chapter 13: Managing Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129

REP 1.2.0 - REIE Reference Manual REP120REEIE.090

Using the Process Management Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Tracking Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Searching for a Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Refreshing the Process Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Chapter 14: Managing Process Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145

The Document Management Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Creating a New Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

REP 1.2.0 - REIE Reference Manual REP120REEIE.090

Other Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Chapter 15: Managing Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161

The View Jobs Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Searching for Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Carrying out an Advanced Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Resending a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Viewing Job Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Chapter 16: Managing Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175

Using the Loggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

REP 1.2.0 - REIE Reference Manual REP120REEIE.090

Viewing Log Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Searching the Log Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Chapter 17: Importing and Exporting Configuration Data . . . . . . . . . . . . . . . . . . . . . . .185

Importing Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

Chapter 18: System Administration Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .195

About Access Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

Rules Relating to Access Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Creating and Managing User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

REP 1.2.0 - REIE Reference Manual REP120REEIE.090