TIBCO BusinessEvents WebStudio User,Aos Guideusers to create or manage business rules in a web...

Two-Second Adv

TIBCO BusinessEvents®

Extreme WebStudio

User’s Guide Software Release 1.3.5

September2014

antage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDEDOR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITEDADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLEDSOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FORANY OTHER PURPOSE.USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF ALICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSEAGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USERLICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THESOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARELICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATEDIN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMSAND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND ANAGREEMENT TO BE BOUND BY THE SAME.This document contains confidential information that is subject to U.S. and international copyright laws andtreaties. No part of this document may be reproduced in any form without the written authorization of TIBCOSoftware Inc.TIBCO, The Power of Now, TIBCO ActiveMatrix, TIBCO ActiveMatrix BusinessWorks, TIBCO Administrator,TIBCO ActiveSpaces, TIBCO Designer, TIBCO Enterprise Message Service, TIBCO Hawk, TIBCO RuntimeAgent, TIBCO Rendezvous, are either registered trademarks or trademarks of TIBCO Software Inc. in the UnitedStates and/or other countries.EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of SunMicrosystems, Inc. in the U.S. and other countries.All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALLOPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAMETIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFICOPERATING SYSTEM PLATFORM.THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BEINCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKEIMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED INTHIS DOCUMENT AT ANY TIME.THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDINGBUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.This product is covered by U.S. Patent No. 7,472,101. U.S. Patent No. 8,219,852, and U.S Patent No. 8,407,723.Copyright © 2004-2014 TIBCO Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information

| iii

Contents

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xTIBCO BusinessEvents Extreme Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xOther TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviHow to Join DevZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviHow to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi

Chapter 1 Introduction to WebStudio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Introduction to TIBCO BusinessEvents Extreme WebStudio. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2Technical User Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2Business User Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Introduction to Rules Management Server (RMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

WebStudio and RMS User Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Chapter 2 Configuring RMS and RMS Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

RMS Project Directory Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10Adding a Project to RMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Configuring RMS Server Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12Configuring RMS Server Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12Enabling Remote Connection to RMS from WebStudio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

RMS Server Configuration Property Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Configuring User Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23Authentication In Various Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23

Authentication Property Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25CDD Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

Configuring Access Control for a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28Configuring Access Control—Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28Working with Access Control Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31Required Location of Access Control Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31Specifying and Grouping Project Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

TIBCO BusinessEvents Extreme WebStudio User’s Guide

iv | Contents

Defining Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Resource Types and Corresponding Action Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Chapter 3 Working With Projects in WebStudio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Starting and Logging in to RMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Status Check for RMS Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Checking Out a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Updating (Synchronizing) a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Committing Artifacts for Approval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Chapter 4 Working with Decision Tables in WebStudio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Working With Decision Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Create/Remove a Decision Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Edit a Decision Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Export a Decision Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Import a Decision Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Understanding Columns and Rows (Rules) in a Decision Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Conditions and Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Regular and Custom Conditions and Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Working With Rows and Columns in WebStudio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Add Condition and Action Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Working with Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Add a Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Setting Rule (Row) Priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Filter Rows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Remove Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Create Duplicate Rows (Rules) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Supported Operators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Using Operators in Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Analyze a Decision Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Validate a Decision Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Chapter 5 Business Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Business Rules Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Working with Business Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Adding Business Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Export a Business Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Deleting Business Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Business Rule Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72


Contents | v

Chapter 6 Working with the Approval Workflow in RMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

Working with the Approval Workflow—Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78Approval Status Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78

Checking a Worklist and Taking Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80

Chapter 7 Deployable Files Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83

Generating Deployable Files (EAR and Class Files) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84Generating the Project EAR or All Project Class Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85Generating One Decision Table’s Class File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86Generating One Business Rule’s Rule Template Instance File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89


vi | Contents


Tables | vii

Tables

Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Table 2 Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv

Table 3 RMS Server Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Table 4 Authentication Configuration Properties in the CDD File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Table 5 Resource Types and Their Allowable Action Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Table 6 Supported Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60


viii | Tables


| ix

Preface

TIBCO BusinessEvents Extreme WebStudio is an online tool that allows businessusers to create or manage business rules in a web browser. It allows the businessuser to define a business rule based on the rule template and rule template viewdefined by the developer in TIBCO BusinessEvents Extreme Studio. Similar toTIBCO BusinessEvents Extreme Decision Manager, a decision table in TIBCOBusinessEvents Extreme WebStudio is defined using a virtual rule function. Ruletemplates, rule template views, and virtual function are created in TIBCOBusinessEvents Extreme Studio.

TIBCO BusinessEvents Extreme WebStudio User’s Guide explains how to createbusiness rules, view/edit decision tables, and configure TIBCO BusinessEventsWebStudio.

TIBCO BusinessEvents ExtremeThe Power to Predict®

Topics

• Related Documentation, page x

• Typographical Conventions, page xiii

• Connecting with TIBCO Resources, page xvi

TIBCO BusinessEvents WebStudio User’s Guide

x | Related Documentation

Related Documentation

This section lists documentation resources you may find useful.

TIBCO BusinessEvents Extreme DocumentationThe following diagram shows the main documents in the TIBCO BusinessEventsExtreme documentation set,

The documentation set for TIBCO BusinessEvents Extreme is as follows.

• TIBCO BusinessEvents Extreme Installation: Read this manual for instructionson site preparation and installation.


Preface | xi

• TIBCO BusinessEvents Extreme Getting Started: After the product is installed,use this manual to learn the basics of TIBCO BusinessEvents: project designand deployment. This guide explains the main ideas so you gainunderstanding as well as practical knowledge.

• TIBCO BusinessEvents Extreme Architect’s Guide: Read this guide for overviewand detailed technical information to guide your work.

• TIBCO BusinessEvents Extreme Application Architect’s Guide: Read this guide foroverview and detailed technical information to guide your work indeveloping an application.

• TIBCO BusinessEvents Extreme Application Developer’s Guide: Use this guidewhen you implement a project design in TIBCO BusinessEvents ExtremeStudio. It covers topics such as project-level tasks, resource-level tasks, anddebugging,

• TIBCO BusinessEvents Extreme Java Developer’s Guide: Use this guide toprogram TIBCO BusinessEvents in Java.

• TIBCO BusinessEvents Extreme Administration: This book explains how toconfigure, deploy, monitor, and manage a TIBCO BusinessEvents applicationand the data it generates using the TIBCO BusinessEvents ExtremeAdministrator utility and other utilities provided with the product.

• TIBCO BusinessEvents Extreme Sizing Guide: Read this guide for information onhow to size systems for deploying TIBCO BusinessEvents applications.

• TIBCO BusinessEvents Extreme Tuning Guide: Read this guide for informationabout tuning your TIBCO BusinessEvents installation.

• TIBCO BusinessEvents Extreme Decision Manager User’s Guide. Read this guidefor information about using the TIBCO BusinessEventss Decision Managerproduct.

• TIBCO BusinessEvents Extreme WebStudio User’s Guide. Read this book to learnhow to use the TIBCO business Events Extreme WebStudio utility.

• TIBCO BusinessEvents Extreme Release Notes: Read the release notes for a list ofnew and changed features. This document also contains lists of known issuesand closed issues for this release.

• Online References:

— TIBCO BusinessEvents Extreme Java API Reference: This online referenceprovides the Javadoc-based documentation for the TIBCO BusinessEventsAPI.


xii | Related Documentation

Other TIBCO Product DocumentationYou may find it useful to refer to the documentation for the following TIBCOproducts:

• TIBCO ActiveSpaces®

• TIBCO ActiveSpaces® Transactions

• TIBCO Hawk®

• TIBCO Rendezvous®


Preface | xiii

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

ENV_NAME

TIBCO_HOME

BEX_HOME

TIBCO products are installed into an installation environment. A productinstalled into an installation environment does not access components in otherinstallation environments. Incompatible products and multiple instances of thesame product must be installed into different installation environments.

An installation environment consists of the following properties:

• Name Identifies the installation environment. This name is referenced indocumentation as ENV_NAME. On Microsoft Windows, the name isappended to the name of Windows services created by the installer and is acomponent of the path to the product shortcut in the Windows Start > AllPrograms menu.

• Path The folder into which the product is installed. This folder is referencedin documentation as TIBCO_HOME.

TIBCO BusinessEvents Extreme installs into a directory within a TIBCO_HOME.This directory is referenced in documentation as BEX_HOME. The default valueof BEX_HOME depends on the operating system. For example on Windowssystems, the default value is C:\tibco\be-x\1.1.0.

code font Code font identifies commands, code examples, filenames, pathnames, andoutput displayed in a command window. For example:

Use MyCommand to start the foo process.

bold code

font

Bold code font is used in the following ways:

• In procedures, to indicate what a user types. For example: Type admin.

• In large code samples, to indicate the parts of the sample that are ofparticular interest.

• In command syntax, to indicate the default parameter for a command. Forexample, if no parameter is specified, MyCommand is enabled:MyCommand [enable | disable]


xiv | Typographical Conventions

italic font Italic font is used in the following ways:

• To indicate a document title. For example: See TIBCOActiveMatrixBusinessWorks Concepts.

• To introduce new terms For example: A portal page may contain severalportlets. Portlets are mini-applications that run in a portal.

• To indicate a variable in a command or code syntax that you must replace.For example: MyCommand PathName

Keycombinations

Key name separated by a plus sign indicate keys pressed simultaneously. Forexample: Ctrl+C.

Key names separated by a comma and space indicate keys pressed one after theother. For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, forexample, an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to applythe information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example,data loss or corruption if certain steps are taken or not taken.

Table 1 General Typographical Conventions (Cont’d)

Convention Use

Table 2 Syntax Typographical Conventions

Convention Use

[ ] An optional item in a command or code syntax.

For example:

MyCommand [optional_parameter] required_parameter

| A logical OR that separates multiple items of which only one may be chosen.

For example, you can select only one of the following parameters:

MyCommand param1 | param2 | param3


Preface | xv

{ } A logical group of items in a command. Other syntax notations may appearwithin each logical group.

For example, the following command requires two parameters, which can beeither the pair param1 and param2, or the pair param3 and param4.

MyCommand {param1 param2} | {param3 param4}

In the next example, the command requires two parameters. The first parametercan be either param1 or param2 and the second can be either param3 or param4:

MyCommand {param1 | param2} {param3 | param4}

In the next example, the command can accept either two or three parameters.The first parameter must be param1. You can optionally include param2 as thesecond parameter. And the last parameter is either param3 or param4.

MyCommand param1 [param2] {param3 | param4}

Table 2 Syntax Typographical Conventions

Convention Use


xvi | Connecting with TIBCO Resources

Connecting with TIBCO Resources

This section provides links to helpful TIBCO resources.

How to Join DevZoneTIBCO DevZone is a developer-oriented community established for customersbuilding applications with BusinessEvents Extreme and ActiveSpacesTransactions. To register, go to https://devzone.tibco.com, click the Contact Uslink, and send an email to [email protected].

How to Access TIBCO DocumentationYou can access TIBCO documentation here:

http://docs.tibco.com

How to Contact TIBCO SupportFor comments or problems with this manual or the software it addresses, contactTIBCO Support as follows:

• For an overview of TIBCO Support, and information about getting startedwith TIBCO Support, visit this site:

http://www.tibco.com/services/support

• If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a username, you can request one.


http://docs.tibco.com

http://www.tibco.com/services/support

https://support.tibco.com

| 1

Chapter 1 Introduction to WebStudio

This chapter introduces the TIBCO BusinessEvents® Extreme WebStudioapplication and its server component, Rules Management Server (RMS).

Topics

• Introduction to TIBCO BusinessEvents Extreme WebStudio, page 2

• Introduction to Rules Management Server (RMS), page 6

• WebStudio and RMS User Workflow, page 7


2 | Chapter 1 Introduction to WebStudio

Introduction to TIBCO BusinessEvents Extreme WebStudio

TIBCO BusinessEvents Extreme WebStudio is a TIBCO BusinessEvents Extremeonline component consisting of a client, WebStudio, and a server—the RulesManagement Server (RMS).

WebStudio Component

TIBCO BusinessEvents Extreme WebStudio is an online component which allowsbusiness users to create/manage business rules in a web browser. In TIBCOBusinessEvents Extreme WebStudio the user defines an executable rule (businessrule) based on the rule template and the rule template view defined by thedeveloper in TIBCO BusinessEvents Extreme Studio. Similar to TIBCOBusinessEvents Extreme Decision Manager, a decision table in TIBCOBusinessEvents Extreme WebStudio is defined using virtual rule functions. Ruletemplates, rule template views, and virtual function are created in TIBCOBusinessEvents Extreme Studio by developers and stored in RMS repositories.

Rules Management Server (RMS) Component

Rules Management Server (RMS) is a server-based component that manages thelifecycle of WebStudio artifacts and WebStudio user access.

Using a menu of options in TIBCO BusinessEvents Extreme WebStudio, RMSallows business users to check out projects and check them in, subject to anapproval process that RMS also provides. You can customize the workflowprocess. For a more detailed overview see WebStudio and RMS User Workflow onpage 7.

Before you use RMS, you need some configuration, as explained in Introductionto Rules Management Server (RMS) on page 6.

Technical User TasksAs a technical user you configure RMS and the TIBCO BusinessEvents ExtremeWebStudio components, and set up project resources required for business usersto create decision tables or business rules. You also deploy decision tables orbusiness rules when they are ready for use, either in an enterprise archive (EAR)

The decision tables are available only if TIBCO BusinessEvents Extreme DecisionManager is installed. When you install TIBCO BusinessEvents Extreme, you aregiven the option of installing TIBCO BusinessEvents Extreme Decision Manager.


Introduction to TIBCO BusinessEvents Extreme WebStudio | 3

file, or as class files. You can deploy class files for use at startup, or hot deployed.You can also unload them from a running engine.You also define access controlsettings and can act as an approver to ensure that decision tables and businessrules created by business users are appropriate for use.

Virtual Rule Functions and Decision Tables

At designtime, technical users add virtual rule functions (VRFs) to a TIBCOBusinessEvents Extreme project. A VRF has no body, similar to a Java interface. Itsimplementation is provided using decision tables authored in TIBCOBusinessEvents Extreme WebStudio. VRFs are used in the TIBCO BusinessEventsExtreme project like any other rule function; they can be called from rules or otherrule functions. Here is a simple example:

/*** @description*/virtual void rulefunction Virtual_RF.Applicant_VirtualRuleFunction {

attribute {validity = ACTION;

}scope {

Concepts.Applicantapplicant;Events.ApplicationReceivedapplicationreceived;

}body {

}}

In TIBCO BusinessEvents Extreme WebStudio, business users add decision tableresources to VRFs. The decision table provides the body to the VRF, also known asthe VRF implementation.

One VRF can have more than one decision table. If a VRF has more than onedecision table, functions in TIBCO BusinessEvents Extreme determine how thetables are used.

Rule Template and Business Rule

At designtime users add a rule template to a TIBCO BusinessEvents Extremeproject. A rule template is a specialized rule that contains a pre-conditions sectionwhich defines the pre-conditions which must be met in addition to the conditionsdefined by the business user in a business rule.



The Action Context section of a rule template defines all possible actions that canbe taken by a business rule (after all conditions are met). Only the action contextstatements that the WebStudio user selects and defines as commands in thebusiness rules are actually taken (depending on the rule evaluation at runtime).For a business rule execution to succeed, a business rule definition must includeall Actions and the order should be maintained. Completing the definition of anaction is a WebStudio user task. If bindings are used (and a view) then inWebStudio, the business rule writer has to enter only the binding values tocomplete the definition. Action context statements are of three types: create,modify, and call, plus arbitrary actions.

Business User Task

Rule Building with Business Rules

As a business user, you check out projects from RMS, build business rules, andsubmit them for approval.

Business rules provide a rule builder or a user-friendly HTML form to build rules.In a builder you specify the conditions in the “when” section and the actions inthe “then” section. You can use artifacts and supported operators for buildingconditions and actions. In the user-friendly HTML form, you fill up the values forthe conditions and actions.

Rule Building with Decision Tables

As a business user, you check out projects from RMS, build decision tables, andsubmit them for approval.

Decision tables provide a graphical way to build complex business rules. Youcreate table columns by dragging and dropping predefined properties onto thedecision table framework. The properties belong to ontology resources defined inthe TIBCO BusinessEvents Extreme project. However, you can only use theproperties specified in the VRF. Columns can be created in other ways too. Youthen define threshold values (conditions) and actions in the cells of the table. Eachrow can be thought of as one rule in a table made up of many rules. Theindividual rules are often straightforward, as in the following examples.

Decision tables are also available in TIBCO BusinessEvents Extreme WebStudio inedit mode, if you have installed TIBCO BusinessEvents Extreme DecisionManager. When you install TIBCO BusinessEvents Extreme, you have the optionto install TIBCO BusinessEvents Extreme Decision Manager.


Introduction to TIBCO BusinessEvents Extreme WebStudio | 5

Three RuleConditions

Person.age < Max(20, Parent.age)Person.creditscore >= Math.function(...)Person.gender == "female"

Three RuleActions

Application.status = "ACCEPTED"Application.credit = 4000sendNotification()

However, one decision table can consist of hundreds, even thousands of ruleseach of which is executed only when its specific conditions are satisfied.

Exception Tables

Each decision table can optionally have another table known as an exceptiontable. The purpose of the exception table is purely organizational: it enables youto separate the business logic of the main decision table (added by business users)from any non-business logic (generally added by technical users). For example, inthe exception table, you could capture situations where fields are blank or containinvalid values, and define actions that send notifications or set return values. Therows of a decision table along with the rows of its exception table are consideredin an RTC. If you prefer, you can put non-business logic in the main table insteadof using an exception table.

Table Analyzer

The Table Analyzer feature analyzes decision tables and reports problems, such asuncovered ranges for conditions, uncovered domain entries, different set ofactions for identical conditions. Table Analyzer creates a sparse matrix datastructure representing an optimized form of decision tables in memory.



Introduction to Rules Management Server (RMS)

RMS is a lightweight rules management server component for managing therepository of TIBCO BusinessEvents Extreme projects. RMS provides an easy,secure, and scripted deployment lifecycle. RMS is supported on all platforms thatsupport TIBCO BusinessEvents Extreme. Users can access RMS remotely. RMSdoes not have to be installed on users’ machines.

Under certain circumstances, the use of RMS is optional. (see TIBCOBusinessEvents Extreme Decision Manager User’s Guide).

You may require some basic configuration before you use RMS. You also set up anRMS project for each TIBCO BusinessEvents Extreme project that includesdecision tables or business rules. See Chapter 2, Configuring RMS and RMSProjects, on page 9.

RMS enables business users to check out projects. The necessary project resourcesare loaded into the cache. If you have the TIBCO BusinessEvents ExtremeDecision Manager feature installed, then the artifacts are also copied into theclient’s machine. When users are finished working with the projects, they submitthe business rules and/or decision tables to RMS for approval. (See WebStudioand RMS User Workflow on page 7 for a more detailed overview.)

RMS enables technical users to do the following:

• Configure authentication and access control as needed.

• Approve or reject commit requests from Decision Manager and TIBCOBusinessEvents Extreme WebStudio users, check on the status of all suchrequests, keep track of all project versions, and view audit trails of statuschanges during workflow execution.

— Chapter 6, Working with the Approval Workflow in RMS, on page 77.

• Generate project Enterprise Archive (EAR) files or individual decision tableclasses or rule template instance file for business rule and for deployment andthen deploy them.

— Chapter 7, Deployable Files Generation, on page 83.

RMS is implemented using TIBCO BusinessEvents Extreme. KnowledgeableTIBCO BusinessEvents Extreme users can customize it.

The default location for RMS projects is theTIBCO_HOME/be/5.1/examples/standard/WebStudio directory. Note thatdocumentation is provided for the product as it is shipped. If you customize RMSsome documentation may not apply.


WebStudio and RMS User Workflow | 7

WebStudio and RMS User Workflow

This section describes how rules authored in TIBCO BusinessEvents ExtremeWebStudio are made available to a TIBCO BusinessEvents Extreme application.

Step 1: TIBCO BusinessEvents Extreme Designtime

A TIBCO BusinessEvents Extreme user creates a TIBCO BusinessEvents Extremeproject, adding the ontology, and writing rules that make use of virtual rulefunctions (VRFs) and Rule Templates. At designtime, VRFs have a signature butno body.

RMS ProjectSetup

The TIBCO BusinessEvents Extreme project for RMS is stored at the locationdefined by a property in the RMS server configuration. The RMS project requiresan access control file.

The RMS server must be running so that the login and workflow actions areavailable in the TIBCO BusinessEvents Extreme WebStudio component.

Step 2: TIBCO BusinessEvents Extreme WebStudio

A business user starts the TIBCO BusinessEvents Extreme WebStudio component,logs on to RMS, and checks out the project. The business user creates one or moredecision tables or business rules and saves the modified project locally, thencommits them for approval.

Step 3: Approval

An RMS user working in TIBCO BusinessEvents Extreme WebStudio receives therequest and reviews the checked-in artifacts and then approves or rejects them.The approved artifacts are available for subsequent checkouts or updates.

Step 4: Generating Deployable Files

An RMS user generates deployable files for resources that are ready fordeployment. You can generate EAR files or class files.

If the business user is creating/modifying the decision table for the first time,then the user generates EAR files before creating/modifying decision tables.



Step 5: Deployment

EAR files are deployed in the usual way, as explained in TIBCO BusinessEventsExtreme Administration. Class files for decision tables and rule template instancefiles for business rules are deployed by placing them in a configured locationrecognized by the TIBCO BusinessEvents Extreme engines at startup. They canalso be hot-deployed.


| 9

Chapter 2 Configuring RMS and RMS Projects

This chapter explains the directory structure of the Rules Management Server(RMS), and also explains how to set up user authentication and access control forRMS projects. The chapter also explains the configuration tasks for RMS, for RMSprojects, and for TIBCO BusinessEvents Extreme WebStudio.

Topics

• RMS Project Directory Structure, page 10

• Configuring RMS Server Properties, page 12

• RMS Server Configuration Property Reference, page 15

• Configuring User Authentication, page 23

• Authentication Property Reference, page 25

• Configuring Access Control for a Project, page 28


10 | Chapter 2 Configuring RMS and RMS Projects

RMS Project Directory Structure

All RMS projects exist in a repository under a root location directory and their ACLfiles exist under an RMS config location.

The root location and RMS config location are configurable using thews.scs.rootURL and ws.projects.acl.location properties in the RMS.cddfile.

The rms.cdd file is located in the TIBCO_HOME/be/5.1/rms/bin directory.

Root Location

After initial installation, the default location for RMS projects isTIBCO_HOME/be/5.1/examples/standard/WebStudio. The ws.scs.rootURLproperty in the RMS.cdd file specifies:

<property name="ws.scs.rootURL" type="string"value="c:/TIBCO_HOME/be/5.1/examples/standard/WebStudio"/>

TIBCO_HOME/be/5.1/examples/standard/WebStudio

If you want to use another location, create the location and then change thews.scs.rootURL property to point to that location.

ACL File

The ws.projects.acl.location property in the rms.cdd file specifies thelocation of security authorization files for all RMS projects.

The RMS config location is TIBCO_HOME/be/5.1/rms/config/security asshipped:

<property name="ws.projects.acl.location" type="string"value="c:TIBCO_HOME/be/5.1/rms/config/security"/>

To be able to work with a project in WebStudio, you must provide an ACL file (.acfile) for the project, in the TIBCO_HOME/be/5.1/rms/config/security directory.For example, for a project called MyRMSProject, the ACL file would beMyRMSProject.ac.

For more information on access control files, see Configuring Access Control for aProject, page 28.


RMS Project Directory Structure | 11

Adding a Project to RMSYou can create a project in TIBCO BusinessEvents Extreme Studio and follow thefollowing steps to add the TIBCO BusinessEvents Extreme project to RMS:

1. Under the RMS project root location directory, create a directory with a nameappropriate for the project.

The root location is configurable. See Configuring RMS Server Properties onpage 12.

2. Copy the TIBCO BusinessEvents Extreme Studio project contents that will beused in the Decision Manager feature or in TIBCO BusinessEvents ExtremeWebStudio to the project directory.

3. If the project contains custom functions, create the lib directory under theproject directory and then place the custom function jars under it.

4. Go to the TIBCO_HOME/be/5.1/rms/config/security directory and locatean existing ACL file.

5. Make a copy of the ACL file and rename it to indicate the project name for theproject you want to manage using TIBCO BusinessEvents ExtremeWebStudio.

The RMS config location is configurable. See Configuring RMS ServerProperties on page 12.



Configuring RMS Server Properties

RMS works out of the box on a local machine. Configuration is required to enableaccess by remote TIBCO BusinessEvents Extreme WebStudio and the DecisionManager clients.

You may need to make other changes to the server configuration. For example, ifyou change the server location or the location of the RMS project repository, youmust update the RMS server properties accordingly.

Configuring RMS Server PropertiesTo configure the RMS server properties, edit the RMS.cdd file.

You cannot edit a CDD file in TIBCO BusinessEvents Extreme Studio outside of itsproject context. To edit the CDD in TIBCO BusinessEvents Extreme Studio, importthe BRMS project into your workspace. After that, copy the RMS.cdd file to itsinstalled locations, as described in the following sections.

To Configure RMS Server Properties

See RMS Server Configuration Property Reference on page 15 for informationabout each property.

For information about properties that relate to the RMS project directorystructure, see RMS Project Directory Structure, page 10 .

Whenever you change the RMS.cdd file you must restart the RMS server so that ituses the updated values.

• As with any procedure that changes files, first back up any files that could beaffected. The RMS.cdd file is located in two places, in the product as shipped:— TIBCO_HOME/be/5.1/rms/project/BRMS/Deployment/RMS.cdd

— TIBCO_HOME/be/5.1/rms/bin/RMS.cdd

• After you update the RMS.cdd file in your workspace, overwrite the existingfiles with the updated ones, in the above locations (or the ones currently inuse, if different).

• Ensure that the CDD files in the BRMS project and the RMS startup directoryare kept in sync.


Configuring RMS Server Properties | 13

1. In TIBCO BusinessEvents Extreme Studio, choose File > Import > ExistingTIBCO BusinessEvents Project.

2. Ensure the Copy the projects into workspace check box is selected.

3. Select the following project:

TIBCO_HOME/be/5.1/rms/project/BRMS

4. In Studio Explorer, double-click RMS.cdd to open it in the CDD editor.

5. In the CDD editor Cluster tab, click Properties. In the Configuration panel onthe right, expand groups to see the individual properties. Complete the valuesas explained in RMS Server Configuration Property Reference on page 15.

— Enabling Remote Connection to RMS from WebStudio, page 14

— RMS Server Configuration Property Reference, page 15

6. To edit the source directly, click the Source tab.

This opens the rms.cdd file for editing.

7. Review the settings for the ws.scs.rootURL property and modify them ifnecessary. This property specifies the URL used to start the WebStudiointerface.

For details on this setting see Root Location on page 10.

8. Review the settings for the ws.projects.acl.location property and makesure that they are correct.

For details on this setting see ACL File on page 10.

9. Review the settings for the other properties in the “WS” property group andmake sure they are correct.

10. When you have finished editing, save the RMS.cdd file.

11. In the file system, copy the RMS.cdd file from your workspace to the BRMSproject and to the RMS server startup location:

TIBCO_HOME/be/5.1/rms/project/BRMS/Deployment/RMS.cdd

TIBCO_HOME/be/5.1/rms/bin/RMS.cdd

12. Make sure that you have an ACL file for the project in theTIBCO_HOME/be/5.1/rms/config/security directory.

See Adding a Project to RMS on page 11 for details on providing an ACL file(.ac file).

13. Restart the RMS server.

You will now be able to start TIBCO BusinessEvents Extreme WebStudio and useit to edit the project settings.



Enabling Remote Connection to RMS from WebStudioAs shipped, the tibco.clientVar.Webstudio/hostname property is set tolocalhost. This setting enables the product to be used on a single machine. Forproduction settings do the following to ensure that TIBCO BusinessEventsExtreme WebStudio users can connect to RMS from remote machines.

To Define the Location of the RMS Server Host for WebStudio

If you have not already done so, specify the RMS server hostname and port asfollows:

1. Import the BRMS project into your workspace and open the RMS.cdd file forediting. See To Configure RMS Server Properties on page 12 for details.

2. In the Deployment folder, double click rms.cdd to open the rms.cdd file forediting.

3. Locate the following lines:

<property name="tibco.clientVar.Webstudio/hostName" type="string"value="localhost"/>

<property name="tibco.clientVar.Webstudio/port" type="integer"value="8090"/>that reads <property-group comment="" name="WS">.

4. Edit the lines that specify the TIBCO BusinessEvents Extreme WebStudiohostname and port using the following properties:

tibco.clientVar.Webstudio/"hostname"tibco.clientVar.Webstudio/"port"

where hostname is the hostname of the RMS server host and port is the portnumber that is running the host (the default is port 8090)

5. Save the RMS.cdd file.

6. In the file system, copy the RMS.cdd file from your workspace to the BRMSproject and to the RMS server startup location:

TIBCO_HOME/be/5.1/rms/project/BRMS/Deployment/RMS.cdd

TIBCO_HOME/be/5.1/rms/bin/RMS.cdd

7. Restart the RMS server.


RMS Server Configuration Property Reference | 15

RMS Server Configuration Property Reference

See Configuring RMS Server Properties on page 12 for the related procedure.

Properties not documented in this table are either for internal use or are for othertypes of configuration explained elsewhere in the documentation.

Table 3 RMS Server Configuration Properties

Property Notes

WS-RMS-Common Property Group

ws.scs.rootURL

Specifies the location of the directory which contains the repository of RMSprojects. This is the root location for RMS project directories.

Default value (as shipped) isTIBCO_HOME/be/5.1/examples/standard/WebStudio

See RMS Project Directory Structure on page 10 for information on this setting.

rms.checkin.revisionId.initValue

Initial value of the revision number to use for project check in.

Default is 10000

ws.artifact.deploy.location

Name of the directory for storing EAR files generated for deployment. Separatedirectory for each project is created, where EAR files for the project are stored.

See also be.codegen.rootDirectory below.

Default is TIBCO_HOME/be/<version>/rms/shared

be.codegen.rootDirectory

Name of the directory for storing class files generated by the GenerateDeployable menu option. The directory location is relative to thews.artifact.deploy.location directory.

If this property is not present, files are stored in the deployment directory.

If this property is present but has no value, a directory is created with thedefault name Codegen.



RMS Property Group

rms.project.workspace

Not used in this release

Default is workspace

rms.project.decisiondata


Default is decisiondata

rms.project.deployment


Default is deployment

rms.workflowstages.config.file


Default is TIBCO_HOME/be/5.1/rms/config/RoleWorkflowStages.xml

rms.lockworkflowstages.config.file


Default is TIBCO_HOME/be/5.1/rms/config/LockWorkflowStages.xml

rms.roleArtifactTypes.config.file


Default isTIBCO_HOME/be/5.1/rms/config/RoleApplicableArtifactTypesConfig.x

ml

rms.external.entities.autodetect

Used internally. Do not change the value.

Table 3 RMS Server Configuration Properties (Cont’d)

Property Notes



Authentication and Authorization (ACL) Properties

be.auth.type

Specifies the authentication mechanism used, file or ldap. Additionalconfiguration is required.

be.auth.file.location

Location of the authentication file used for file-based authentication.

The default location isTIBCO_HOME/be/5.1/rms/config/security/users.pwd

java.security.auth.login.config

Location of the JAAS login configuration file. You can substitute a differentimplementation of the JAAS login module than the one provided.

The default location is:

TIBCO_HOME/be/5.1/rms/config/security/jaas-config.config.

ws.projects.acl.location

Location of the directory used for all ACL (authorization) files. Files must benamed using the format RMSProjectName.ac.

The default location is TIBCO_HOME/be/5.1/rms/config/security


Property Notes



RMS-GVs Property Group

This group of properties override the values of global variables provided in the TIBCOBusinessEvents Extreme Studio BRMS project. They are made available as global variables so thatthey can be overridden at runtime, as needed.

You can override the default global variable values in the RMS.cdd file (as shown below) forcommand-line startup.

For defining and using global variables in TIBCO BusinessEvents Extreme Studio projects, seeTIBCO BusinessEvents Extreme Developer’s Guide.

tibco.clientVar.RMS/hostname

Specifies the host name or IP address of the machine where RMS is hosted.Remote clients can connect to the server at this location.

Default is localhost.

tibco.clientVar.RMS/port

Specifies the port number of the machine where RMS hosted. This port is usedfor listening to client requests. See notes for tibco.clientVar.RMS/hostname.

Default is 5000.

tibco.clientVar.RMS/Approval/adminRole

The value specified here has Administrator role permissions. When youchange the default value, the Administrator role still has Administratorpermissions.

Default is Administrator.

WS Property Group

tibco.clientVar.Webstudio/warDir

Path to the Web archive for the client side representation of the TIBCOBusinessEvents Extreme WebStudio.

Default is rms/bin/WebStudio.war.


Property Notes



tibco.clientVar.Webstudio/hostName

Specifies the host name or IP address of the machine where RMS server ishosted for WebStudio.

Default is localhost.

tibco.clientVar.Webstudio/port

Specifies the port number of the machine where RMS server is hosted forWebStudio. This port is used for listening to client requests. See notes fortibco.clientVar.RMS/hostname.

Default is 8090.

tibco.clientVar.Webstudio/Connection/timeout

Timeout interval for the HTTP channel. This value is in milliseconds.

Default is 60000.

tibco.clientVar.Webstudio/sessionTimeOut

Time interval for which an inactive user session will be valid. This value is inminutes.

Default is 30.

ws.validateDT.temp.dir

Directory which is used as an interim storage of Decision Table contents duringthe validation process.

Default is rms/temp-dir.

Global Variable Properties for One-Way SSL Between RMS Server and Decision ManagerClients

See RMS Server Configuration Property Reference on page 15 for the procedure.

tibco.clientVar.RMS/security/securePort

The port to be used for secure HTTP communication. Default is 443.


Property Notes



tibco.clientVar.RMS/security/sslCertificateStore

Absolute path of the JKS keystore which contains the RMS server'spublic/private keys. If the certificate used is CA signed, include the CA'scertificate.

tibco.clientVar.RMS/security/sslCertificateStorePassword

The password for the keystore.

Properties for One-Way SSL Between LDAP Server, RMS Server, and Decision ManagerClients

Note

• For one-way SSL between LDAP server and RMS server, you must also change the value ofbe.auth.ldap.port.

• For one-way SSL between RMS server and Decision Manager clients, you must also set thevalue of be.auth.ldap.port.

See RMS Server Configuration Property Reference on page 15 for the procedure.

be.auth.ldap.usessl

If set to true, enables SSL between the RMS server and the LDAP server

If set to false or not set, the LDAP authentication uses a non-secure channel.

javax.net.ssl.trustStore

The absolute path of the keystore containing the LDAP server certificate chain.

javax.net.ssl.trustStorePassword

The password for the keystore.

javax.net.ssl.trustStoreType

The keystore type for keystores other than JKS type, for example, PKCS12.


Property Notes



Email Notification Property Group

Email notification properties are used to send email notification when an artifact (business rule /decision table) undergoes a status change in approval workflow, such as, on artifact commit and onartifact reviews (Approve, Reject, BuildAndDeploy).

In addition to these properties, you may have to define any SMTP protocol specific properties(mail.smtps.auth, mail.smtps.ssl.enable), depending on the mail server configuration. Theseproperties should be defined with a prefix ws.notify.prop, for example,ws.notify.prop.mail.smtps.auth, ws.notify.prop.mail.smtps.ssl.enable.

ws.notify.enabled

If set to true, send email notification.

If set to false, do not send email notification.

Default is false.

ws.notify.mail.domain

Specifies the domain on the email. This is used with the RMS username toconstruct the email address to which the notification is to be sent. For example,if RMS username is “admin” and the property is set to “tibco.com”, the emailaddress for the notification is [email protected].

ws.notify.prop.MAIL_PROTOCOL

Specifies the email protocol to be used to send the email. SMTP and SMTPS arevalid values.

Default is SMTPS.

ws.notify.prop.MAIL_SERVER_HOST

Specifies the host name of the email server.

ws.notify.prop.MAIL_SERVER_PORT

Specifies the port at which the mail server is listening.

ws.notify.prop.SENDER_EMAIL

Specifies the email address to be used for sending the notification email.


Property Notes



ws.notify.prop.SENDER_USERNAME

Specifies the sender’s username for authentication to email server.

ws.notify.prop.SENDER_PASSWORD

Specifies the sender’s email password for authentication to email server.


Property Notes


Configuring User Authentication | 23

Configuring User Authentication

You can choose between the following options for user authentication.

File Based Authentication This method authenticates a user against user datastored in a file based repository. This method is not recommended for productionpurposes. In file-based authentication, you define a list of user names, passwords,and roles in a the file called (by default) users.pwd file. This file is commonlyreferred to as the password file.

LDAP Authentication This method authenticates users against a directory serverusing LDAP as a protocol. TIBCO BusinessEvents Extreme applications canleverage this information to authenticate users. The role information is configuredthrough an LDAP attribute like the nsroledn attribute in Oracle Directory Server.The LDAP attribute differs in different directory server products. The details ofconfiguring LDAP authentication are beyond the scope of this documentation.Consult your LDAP product documentation.

Authentication In Various Components.

TIBCO BusinessEvents Extreme Decision Manager RMS Component

File-based authentication is enabled by default for the TIBCO BusinessEventsExtreme Decision Manager RMS component and LDAP authentication issupported.

This component also uses authorization. Authorization details are provided in thefollowing section of this chapter: Configuring Access Control for a Project,page 28.

To Enable Authentication and Select File or LDAP Authentication Type

1. In TIBCO BusinessEvents Extreme Studio, import and open the relevantproject and open the CDD file, or TIBCO BusinessEvents Extreme DecisionManager, as follows:

BE_HOME/rms/project/BRMS > RMS.cdd > Cluster properties > RMS propertygroup

2. In the CDD file add the following property if it is not present and specify thevalue as desired:be.auth.type=[file|ldap]



3. Do one of the following:

— To configure LDAP authentication, add and configure the LDAP propertiesshown in Table 4, Authentication Configuration Properties in the CDD File,on page 25. Familiarity with LDAP is required. Details are not provided inthis guide.

— To configure file-based authentication, see To Configure File-BasedAuthentication on page 24.

To Configure File-Based Authentication

This procedure continues the instructions in To Enable Authentication and SelectFile or LDAP Authentication Type on page 23.

1. In the CDD file, add (or configure) the property be.auth.file.location andset the value to the location of your password file.

2. Locate and open the password file. Its location is specified in the CDD file. Seestep 1 for default location details.

3. Add each user on a separate line using this format:

Username:password:role,role,role;

Do not use spaces. For example here are some entries that might be used inTIBCO BusinessEvents Extreme Decision Manager:

Mark:A31405D272B94E5D12E9A52A665D3BFE:BUSINESS_USER,APPROVER;James:21232f297a57a5a743894a0e4a801fc3:RULE_ADMINISTRATOR;

For Active Directory Configuration

For authentication, Active Directory requires the domain name, for example,[email protected], and not distinguished name (which is used with Oracle DirectoryServer). If you are using Active Directory for authentication, ensure that theuserPrincipalName attribute is set on AD server.


Authentication Property Reference | 25

Authentication Property Reference

CDD PropertiesAdd these to the appropriate CDD file. See To Enable Authentication and SelectFile or LDAP Authentication Type on page 23 for more details

Table 4 Authentication Configuration Properties in the CDD File

Property Notes

Common Authentication Properties

java.security.auth.login.config

Provides the absolute location for the login module configuration used by JAAS.Only advanced users should change this value (additional configuration is alsoneeded).

The locations of the provided files are as follows:

TIBCO BusinessEvents Extreme Decision Manager:BE_HOME/rms/config/security/jaas-config.config

be.auth.type

Specifies the authentication mechanism. Allowable values are as follows:

file: File-based authentication. Uses a password file.

ldap: LDAP-based authentication Uses a pre-existing LDAP setup in use in yourenvironment. Add and configure the properties shown in the LDAPAuthentication Properties section of this table to work with your LDAP setup.

Default is file

be.auth.file.location

Specifies the absolute filepath to and name of the password file. This file is used forfile-based authentication. Each project can have a different file. The locations of theprovided files are as follows:

TIBCO BusinessEvents Extreme Decision Manager:BE_HOME/rms/config/security/users.pwd



LDAP Authentication Properties

be.auth.ldap.host

Specifies the domain name of the host for LDAP authentication.

be.auth.ldap.portbe.mm.auth.ldap.port

Specifies the port for LDAP authentication.

be.auth.ldap.adminDN

Specifies the base distinguished name (DN) for admin login. For example,cn=Directory Administrators, dc=na, dc=tibco, dc=com.

be.auth.ldap.adminPassword

Specifies the password for the LDAP administrator DN.

be.auth.ldap.baseDN

Specifies the base tree in LDAP under which users can be searched. For example,dc=na, dc=tibco, dc=com.

be.auth.ldap.roleAttr

Specifies the name of the attribute used by the LDAP server for role information ofa user.

Default value is nsroledn (for Oracle Directory Server).

be.auth.ldap.uidattr

Specifies the name of the attribute used by the LDAP server for usernameinformation. Allowable values are as follows:

uid for Oracle Directory Server

cn for ActiveDirectory.

Default value is uid.

Table 4 Authentication Configuration Properties in the CDD File (Cont’d)

Property Notes


Authentication Property Reference | 27

be.auth.ldap.useRoleDN

Set this property to true to use the fully qualified name of the attribute used by theLDAP server for role information of a user.

Set this property to false to use only the name of the attribute, which is shown inthe notes for the be.auth.ldap.uidAttr property.

Default value is true.

be.auth.ldap.objectClass

Specifies the ObjectClass attribute value for DS.

Many object classes can exist, for example, inetOrgPerson on Oracle DirectoryServer, and user on Active Directory.

If search should span all object classes, keep this value empty or specify an asterisk("*").

be.auth.ldap.dnAttr

Specifies the name of the attribute that contains the fully qualified name.

Default value distinguishedName.

be.auth.ldap.ssl

Specifies a secure connection to the LDAP host is to be established.

Default value false. Set the property to true to enable a secure connection.

Table 4 Authentication Configuration Properties in the CDD File (Cont’d)

Property Notes



Configuring Access Control for a Project

Access control is a core product feature. Access control is used by RMS projectsand is available in the TIBCO BusinessEvents Extreme Decision Manager add-onand TIBCO BusinessEvents Extreme WebStudio.

This section describes how the access control (user authorization) system works,the types of resource specifications that are permitted, and how to grantpermissions to different users.

Configuring Access Control—OverviewFor each RMS project, you set up an access control file. In the access control file,you group the project resources as desired, giving each group (or individualresource) an ID. Then you use these IDs to assign permissions to each user role.

Establishing the User Roles

Access is defined using roles. If file-based authentication is used, roles are definedand assigned to users in the password file (by default called users.pwd). IfLDAP-based authentication is used, roles are defined and assigned to users in theLDAP directory.

Guidelines for Configuring Access Control

A project’s access control file is an XML file named as follows: RMSProjectName.ac.The ACL file is stored in the directory specified by the RMS.cdd propertyws.projects.acl.location.

In the access control file resources element, you create resource elements todefine groups of resources to suit your needs. You give each resource element anID. In the entries element, you add one entry element for each user role todefine the access permissions for that role, using the resource IDs and action

elements. This brief summary is provided so you can understand the followingguidelines. For full details. See Structure of the Access Control File on page 30.

You must use only the roles defined in the password file or LDAP directory(depending on authentication type used) when configuring the access control file.

User role and username should not be same. Each username and role nameshould be unique.


Configuring Access Control for a Project | 29

You can use two general approaches to setting permissions. The general aim is tosimplify the setup, minimizing the number of permissions you have to set in theaccess control file.

Allow everythingand specifyexceptions

One approach is to grant wide permissions using large resource groupings, andthen selectively deny permissions within those groupings.

For example, suppose you define two resources as follows:

<resource name="/Concepts/*" id="AllP" type="PROPERTY"/><resource name="/Concepts/Person/CustID" id="CID"type="PROPERTY"/>

The first resource element defines a resource group consisting of all conceptproperties in the /Concepts project folder. The second element specifies oneproperty in one concept. (The setup details are explained later in the chapter.)

Then you define permissions using those resources. For example, for a role namedCallCenter you might set up permissions as follows:

<entry><role name="CallCenter"/><permissions><permission resourceref="#AllP">

<action type="read">ALLOW</action></permission><permission resourceref="#CID">

<action type="read">DENY</action></permission>

</permissions></entry>

With these settings, you give users with the CallCenter role the read permissionfor all properties in the /Concepts directory except the custID property.

Deny everythingand specifyexceptions

Another approach is to deny all permissions (which is the default setting for allpermissions) and then give permissions to specific resources or groups ofresources as needed.

Mixing theseapproaches

You can mix these two approaches in one access control file. For example, you cangive broad permissions to one project folder, and then specify exceptions withinthat folder. For another folder you might give permissions selectively.

An example of an access control file (CreditCardApplication.ac) giving allpermissions available for the credit card application example, is located in thefollowing directory:

BE_HOME\rms\config\security



Structure of the Access Control File

The access control file for a project is an XML file with the following elements:

<resources><resource id="id" type="ResourceType"/><resource id="id" name="ProjectPath" type="ResourceType"/>. . .

</resources><entries>

<entry><role name="RoleName"/><permissions>

<permission resourceref="#id"><action type="ActionType">[ALLOW|DENY]</action>

</permission>. . .

</permissions></entry>. . .

</entries></acl>

• The entries element contains one entry for each role. For each role, youdefine one set of permissions. Each permission has of the followingattributes

• The resourceref attribute references a resource ID defined in the resourceselement. It identifies a resource or set of resources.

• The name attribute specifies the project path to the resource or resources. (Thename attribute is not used when you specify permissions for an entire resourcetype.)

• The resource type attribute specifies what types of resources in the specifiedname attribute project path are included in the permission.

• The action type attribute specifies an action type, for example, create. Thisattribute determines the kind of action a user has permission to do, for thespecified resource or resources.

See Table 5, Resource Types and Their Allowable Action Types, on page 34.



Permissions—ALLOW and DENY

The value of the action element is one of the key words ALLOW or DENY. Itdetermines whether the specified permission is given denied.

Working with Access Control FilesAccess control settings are created using XML files with the extension .ac. Youcan create or modify an RMSProjectName.ac file using any XML editor. This sectionexplains the elements used to define access control, ways you can add or editaccess control files, and where to place the files so they can be used by the RMS,Decision Manager components, and TIBCO BusinessEvents Extreme WebStudio.

Examples shipped with the product contain access control files you can use asmodels.

Required Location of Access Control FilesThe access control file for an RMS project must be placed in the location specifiedby the RMS server CDD property ws.projects.acl.location. An RMS project’sACL file must be named using the format RMSProjectName.ac.

Specifying and Grouping Project ResourcesIn the resources element, you group the project resources in whatever waysupports the permissions you want to set. You give each grouping or individualresource an ID that is used when defining the permissions.

Using Resource Type as a Filter

How you specify the resource group is partly determined by the resource typeattribute. The resource type can act as a filter. For example, suppose in the nameattribute you specify a directory that includes events and concepts. If you set thetype attribute to "CONCEPT" then the ID associated with this grouping is used toset permissions only on the concepts in that folder (and its subdirectories).

You could create a second grouping whose type specifies "EVENT" so that you canset permissions on events in that folder branch separately.

DENY is the default value. You only need to set the DENY value explicitly when youhave given ALLOW permissions at a higher level, and want to make individualexceptions within that broad scope.

The values ALLOW and DENY are case sensitive. Use all capitals.



Specifying an Individual Resource

To specify an individual resource, provide the project path to the resource in thename attribute. The project path is the folder path to the ontology entity, as seen inthe Explorer panel. The example below shows how to specify an ID that isassociated with the FirstName property of the Person concept:

<resource name="/Concepts/Person/FirstName" id="FN"type="PROPERTY"/>

Grouping Resources Using Wildcards

You can associate groups of resources with an ID using the wildcard character inthe project path. The asterisk (*) is used as the wildcard character. For example:<resource name="/someFolder/* "id="AllP" type="PROPERTY"/>

Grouping Resources by Resource Type

The broadest resource grouping is provided by setting permissions at the level ofresource type. This method groups all resources of that type in the project. To set aresource type resource group, you associate an ID with a resource type, and youdo not use the name attribute:<resource id="ID" type="ResourceType"/>

For example: <resource id="C" type="CONCEPT"/>

See Table 5, Resource Types and Their Allowable Action Types, on page 34 for alist of resource types, and the action types that are valid for each resource type.

Defining PermissionsAs explained in Specifying and Grouping Project Resources on page 31, youdefine a list of resource IDs according to the way you want to group resources andactions. All items included under one resource ID must be of the same resourcetype (or type of activity, such as checking out a project).

For each user role you add a set of permissions.

<role name="Administrator"/>

<permissions>

<permission resourceref="#PRJ">

<action type="checkout">ALLOW</action>

</permission>

. . . . . . . . . . . . . . . . . . . . . . . . . .

</permissions>



Each resourceref points to a resource ID. You create permissions using theactions available for the resource type specified for that ID, such as create, read,and modify. See Table 5, Resource Types and Their Allowable Action Types, onpage 34 for the resource types and their available action types.

By default, all permissions are denied. If a certain permission is not explicitlygiven to a role, then the role does not have the permission. This approach ensuresunauthorized users do not accidentally gain access to restricted resources.

Permissions are not hierarchical. That is, a create permission does not imply amodify permission or a read permission. All privileges are mutually exclusive.So, for example, if you want users to be able to modify some resources of a certainresource type, be sure to also give users the ability to view that resource type.

Note that for use in TIBCO BusinessEvents Extreme Decision Manager, mostTIBCO BusinessEvents Extreme project resources have only a read action type.

Resource Types and Corresponding Action TypesSee Defining Permissions on page 32 to understand how to define permissions fora user role using the action types available for each resource type.

If a resource ID specifies a set of resources, the permission applies to that set ofresources only. If it specifies a resource type, then the permission applies to allresources of that resource type.



Table 5 Resource Types and Their Allowable Action Types

Resource TypeAllowableActionTypes

(If action is ALLOW) Enables Users to. . .

PROJECT checkout Check out TIBCO BusinessEvents Extreme projectresources.

Note Users can check out only those resources they areallowed to read.

update Update TIBCO BusinessEvents Extreme projectresources that were checked out earlier.

Users can update only those resources they are allowedto read.

gen_deploy Use the Generate Deployable RMS menu option forbuilding EAR files or class files.

commit Commit the modified/deleted TIBCO BusinessEventsExtreme project resources.

approval Review the worklist items in a project. (WebStudioonly)

CATALOGFUNCTION invoke Invoke catalog functions in decision tables(RULEFUNCTIONIMPL resource type) that the users areallowed to modify.

CHANNEL read View channels.

CONCEPT read View concepts.

DOMAIN read View domain models.

create Create domain models.

EVENT read View events.

PROPERTY read View resource properties.

If no resources are specified, then users can viewproperties of all resources that they are allowed to view(read).

RULE read View rules (rule source code).



RULEFUNCTION read View rule functions (rule function source code).

add_impl Add decision tables (RULEFUNCTIONIMPL resourcetype).

If specific rule functions are not listed, then users canadd decision tables to all rule functions they areallowed to view (read).

(Other permissions that apply to decision tables are seton the resources used in the decision table.)

del_impl Delete decision tables (RULEFUNCTIONIMPL resourcetype).

RULEFUNCTIONIMPL read View decision tables (RULEFUNCTIONIMPL resourcetype).

Add columns in the Condition area of the decisiontable.

Add rows and modify cells in existing rows andcolumns.

modify Add columns in the Action area of decision tables.

WSDL read View WSDL files.

XSD read View XSD files.

WebStudio Only Permissions

RULETEMPLATE read Checkout rule templates.

RULETEMPLATEINSTANCE read View business rules.

add_inst Create business rule for the rule template.

del_inst Delete business rule.

RULETEMPLATEVIEW read Checkout rule template views.

Table 5 Resource Types and Their Allowable Action Types (Cont’d)

Resource TypeAllowableActionTypes

(If action is ALLOW) Enables Users to. . .


| 37

Chapter 3 Working With Projects in WebStudio

This chapter explains how to work with projects, for example, creating projectsand committing their resources for approval.

Topics

• Starting and Logging in to RMS, page 38

• Checking Out a Project, page 40

• Updating (Synchronizing) a Project, page 41

• Committing Artifacts for Approval, page 42


38 | Chapter 3 Working With Projects in WebStudio

Starting and Logging in to RMS

To start RMS, do one of the following:

• Execute TIBCO_HOME/be/<version>/rms/bin/be-rms.exe (be-rms onLinux) with valid arguments. For example, on Windows you would open acommand window in TIBCO_HOME/be/<version>/rms/bin/ and execute:

be-rms.exe

• (Windows only) Select Start > All Programs > TIBCO > Tibco be-x> TIBCOBusinessEvents Extreme version > Start Rules Management Server.

The server is ready when you see a message in the command window such asthis:

Info [HTTP-Channel-Startup] - [driver.http] Channel server for HTTPChannel [Port:5000] successfully started

To Log in to RMS from WebStudio

1. Type the URL http://host:port/WebStudio/ in a web browser. The defaulthost is localhost and the default port is 8090. Host and port are configurableusing properties in the RMS.cdd. Make sure that the RMS is running beforelogging to TIBCO BusinessEvents Extreme WebStudio.

2. Type the username and password for TIBCO BusinessEvents ExtremeWebStudio.

3. Click Login to sign in to RMS.

The application displays the TIBCO BusinessEvents Extreme WebStudiodashboard.

To Log out of RMS

In TIBCO BusinessEvents Extreme WebStudio, click Sign out to log out. In thecase of session timeout, the user is automatically logged out.

The default username is admin and the default password is admin.

The system restricts multiple simultaneous login of the same username.


Starting and Logging in to RMS | 39

Status Check for RMS ConnectionOnce a TIBCO BusinessEvents Extreme Studio, a TIBCO BusinessEvents ExtremeDecision Manager, or a TIBCO BusinessEvents Extreme WebStudio client logs into RMS, a background activity on the dashboard page periodically polls the RMSserver to refresh the Worklist items. You can configure the interval (in seconds) ofthese status checks by setting the following property in studio.tra:

rms.heartbeat.delay

By default, the delay is of two seconds.

If the server goes down, the menu options for RMS are automatically disabled.However, if you are already performing an RMS operation and the server goesdown, the operation fails. The login option is enabled when the server comes upagain.



Checking Out a Project

If RMS is used in your environment, then you must log into RMS and check out aproject from RMS before you can work with the project resources in the TIBCOBusinessEvents Extreme WebStudio UI.

When generating an EAR file using the Generate Deployable option, the projectresources from the RMS repository and not from the workspace are used.

Depending on your role or roles, you may not have permission to check out allresources or to do all of the documented tasks.

For instructions on updating a project you already checked out, see Updating(Synchronizing) a Project on page 41.

To Check Out a Project in WebStudio

1. Open the checkout window using any of the following methods:

— In the Dashboard tab, click the link in the My Projects section if no projectsare checked out.

— In the My Workspace tab, click WebStudio, and from the pull-down menu,choose RMS > Checkout.

— In the RMS toolbar, click the checkout icon .

2. In the checkout window, select the project you want to checkout from theProject List drop-down.

In TIBCO BusinessEvents Extreme WebStudio the checked out project isdisplayed under Group Contents and the project files are loaded to yourworkspace. The Group Contents section displays the artifacts based on the groups(Projects/Business Rules/Decision Tables) selected in the Groups section. TheBusiness Rules and the Decision Tables group are selected by default after youcheck out a project.

TIBCO BusinessEvents Extreme WebStudio displays the project files in the GroupContents section either as a list or in a tree structure. In the Group Contentssection click the project view icon to select the Show items as tree or Show itemsas list option to toggle between the tree view ( )and the list view ( ). The listview is the default view.


Updating (Synchronizing) a Project | 41

Updating (Synchronizing) a Project

This section explains how to update the projects on your workspace with the mostrecent changes from the corresponding RMS projects.

It is recommended that you log into the RMS server, and update (synchronize)your local copy of a project before continuing to work on it. Other users may havechecked in changes, additions, and deletions that are now available for checkout.There may be other changes too.

You can select what updates to accept. Changes and additions to individualdecision tables and business rules are listed.

To Update a Project in WebStudio

1. In the Group Contents section, select the artifact you need to synchronize.

2. Open the synchronize window using any of the following methods:

— Click WebStudio, and from the pull-down menu, select RMS >Synchronize.

— In the Group Contents directory, right-click on the selected artifact and thenselect RMS > Synchronize.

— Click the synchronize icon in the RMS toolbar.

3. Select the checkboxes of the files you want to synchronize and click OK.Alternatively, select the header checkbox to synchronize all the listed projectfiles and click OK.

The selected artifacts are updated with the latest project files from RMS.

The synchronize command does not support multiple artifact selection using Shiftor Ctrl key. Alternatively, select a folder/project to select all artifacts under thatfolder/project, when project files are displayed in a tree structure.



Committing Artifacts for Approval

After you complete the additions, changes, or deletions to a project you checkedout of RMS, commit the artifacts for approval. You can make a commit request fora selection of artifacts, or all.

Copies of submitted artifacts are saved in cache, with the names of the users whosubmitted them, version numbers, and the status Commited. A task is created forthe Approver role to review the check-in requests. (see Chapter 6, Working withthe Approval Workflow in RMS, on page 77).

A Revision ID is assigned to each commit request. This ID is used in other dialogsto allow you to view the details on the request.

Viewing the Audit Trail

You can view the entire audit record of the previous status changes for a checkin.This is especially useful for the multi-stage approval process so that differentreviewers actually share views on why a particular checkin was approved orrejected.

To Commit Project Resources for Approval from WebStudio

1. In the Group Contents section, select the artifact you need to commit.

2. Open the commit window using any of the following methods:

— Click WebStudio, and from the pull-down menu, select RMS > Commit.

— Right-click on the selected artifact and select RMS > Commit.

— Click the commit icon in the RMS toolbar.

3. In the Commit window enter the revision description in the Comments textbox.

The Comments field is a mandatory field and system will not commit thechanges to the repository if it is empty.

This feature is available only if the TIBCO BusinessEvents Extreme DecisionManager feature is installed.

The commit command does not support multiple artifact selection using the Shiftor Ctrl key. Alternatively, select a folder/project to select all the artifacts underthat folder/project, when the project files are displayed in a tree structure.


Committing Artifacts for Approval | 43

4. Click the checkboxes for the files you want to commit to the RMS project andclick OK. Alternatively, click the header checkbox to select all the listed projectfiles.

5. Click Finish after the system displays the checkin successful message with therevision ID.


| 45

Chapter 4 Working with Decision Tables in WebStudio

This chapter explains how to work with decision tables, in TIBCO BusinessEventsExtreme WebStudio.

Topics

• Working With Decision Tables, page 46

• Understanding Columns and Rows (Rules) in a Decision Table, page 51

• Working With Rows and Columns in WebStudio, page 53

• Supported Operators, page 60

• Analyze a Decision Table, page 62

• Validate a Decision Table, page 64

Decision tables are available in TIBCO BusinessEvents Extreme WebStudio in editmode only if you have the TIBCO BusinessEvents Extreme Decision Managerfeature installed on your system.

If you are creating/modifying the decision table for the first time, then generatethe EAR files before creating/modifying decision tables. See Generating theProject EAR or All Project Class Files on page 85 on how to generate the EAR filesfor the project.


46 | Chapter 4 Working with Decision Tables in WebStudio

Working With Decision Tables

This section presents the process to perform various decision table operations inTIBCO BusinessEvents Extreme WebStudio.

Create/Remove a Decision TableA decision table can only be created using a virtual rule function (VRF) in theBusinessEvents Extreme Studio interface. For instructions on adding a VRF, seeTIBCO BusinessEventsExtreme Developer’s Guide.

Once you have created a decision table, you can add it to a project using theTIBCO BusinessEvents Extreme WebStudio interface. You can also can deletedecision tables after they have been created in BusinessEvents Extreme Studio. Ifthe table you want to delete has been checked into the RMS project, then youmust submit the deletion for approval. After approval, the deleted table isremoved from the RMS project.

To Add a Decision Table to a Project

1. Select the Projects group.

2. In the Group Contents section, right click the virtual rule function (VRF) youwant to use and click New Decision Table.

3. Enter the decision table name in the Decision Table pop-up window and clickOK.

The new empty decision table is displayed in the work area.

To Remove a Decision Table


— In Group Contents, right-click the decision table name and select Delete.

— In Group Contents, select the decision table name. Then click the deleteicon in the Edit toolbar.



Working With Decision Tables | 47

2. If the table has been committed to the RMS project, select one of the followingoptions as appropriate:

— Commit the project or the parent folder so that the RMS master copy of thetable is also deleted.

— Synchronize the project to replace the deleted copy with the RMS projectversion of the table.

Edit a Decision Table

Open a decision table

In the Group Contents section, double click the decision table you want to open.You can now edit, analyze, and export the open decision table.

Add Rows and Columns

See Working With Rows and Columns in WebStudio on page 53 for more detailson adding rows and columns to a decision table in TIBCO BusinessEventsExtreme WebStudio.

Set Decision Table Properties

To set properties of a new decision table, follow these steps:




1. In the decision table work area, click the properties icon .The Properties view is displayed at the bottom of the work area.

2. In the Effective Date field, you can optionally define the date and time onwhich the decision table becomes valid in the runtime application. Click thecalendar icon and use the Calendar dialog box to set the date and then edit thetime as needed.

3. Similarly in the Expiry Date field, you can optionally define the date and timeafter which the decision table is no longer valid in the runtime application.

4. Select the Take Actions of One Row at Most check box if you want thedecision table to stop after one row (rule) passes the condition tests. Only theactions of that one row are considered (until the next time the decision table’srule function is called).

5. In the Priority field, set a priority as desired. When a VRF has multipleimplementations (decision tables), the decision table’s Priority settingdetermines the order in which the decision tables executes.

6. Click the Save icon in the Edit toolbar to save the changes to the decisiontable.

The decision table is still open for you to edit and changes are not applied to RMSunless you commit the changes to RMS.

Export a Decision TableYou can export decision tables from TIBCO BusinessEvents Extreme WebStudio toMicrosoft Excel spreadsheets. See Figure 1.


Working With Decision Tables | 49

Figure 1 Sample Exported Microsoft Excel Sheet:

To Export the Decision Table

1. Open the decision table you want to export.

2. Execute the export command in either of the following ways:

— Click the export icon in the Tools toolbar. You see the Save As dialogbox for the exported file.

— Right click the decision table in the Group Contents section and selectExport.

3. Navigate to the directory in which you want to save the excel file and providea file name.

4. Click Save.

Import a Decision TableYou can import correctly formatted Microsoft Excel file to create a decision tablein TIBCO BusinessEvents Extreme WebStudio.

Only import from Excel files is supported You cannot import from CSV(comma-separated values) files or tab-delimited text files. You can open such filesin Excel and save as Excel format binary files.



To Import the Decision Table

1. Open the Import dialog box in either of the following ways:

— Select the virtual rule function and click the import icon in the Toolstoolbar.

— Right click the virtual rule function in the Group Contents section andselect Import.

2. Click Choose File in the Import dialog box.

3. Browse the excel file you want to import and click Open.

4. Enter the new decision table name and click OK.


Understanding Columns and Rows (Rules) in a Decision Table | 51

Understanding Columns and Rows (Rules) in a Decision Table

A decision table rule is a row in the decision table. It has one or more conditionsand one or more actions. Each condition cell is equivalent to one condition (oneline) in the TIBCO BusinessEvents Extreme rule editor condition area. Similarlyeach action cell is equivalent to one action (one line) in the TIBCO BusinessEventsExtreme rule editor action area (that is, one rule). Decision table rules are likebusiness rules. The rule that calls the virtual rule function that implements thedecision table participates in inferencing in the usual way. When the virtual rulefunction is called, the decision table rules are applied.

Conditions and ActionsThe columns of a decision table are made up of condition columns on the left, andaction columns on the right. Each column represents one condition or one action.

A condition is a test that must evaluate to true before the action is executed. If adecision table rule uses multiple conditions, all the conditions for a row mustevaluate to true for the action to execute.

In each row (rule) you define the specific conditions and actions. For example, if acondition column is Age (using a concept property of that name), then each rowcan define a different age range. The action for each row would define whataction to take if a given concept instance contains an age property within thespecified range.

If you add a second condition column called Income, then before the action istaken, a concept instance would be tested to see if both the age and the income arewithin the ranges specified in the rule’s conditions.

Regular and Custom Conditions and ActionsA regular condition is the value of an entity specified in the VRF scope, or a simplecomparison with the value - is greater than, is less than, is greater than or equal to,is less than or equal to.

A custom condition can use the rule language, standard functions, and data in thescope of the function at runtime (for example, scorecards and global variables). Itcan contain complex formulas.

A regular action sets the value of an entity specified in the VRF scope.

Conditions that are blank, contain an asterisk, or are disabled are ignored, and aretreated as if they evaluate to true.



A custom action can use the rule language, standard functions, and data in thescope of the function at runtime to do whatever is desired. For example, the actioncould be to send an event out to a different system for follow-up.

Using non-literal values in a regular condition or regular action Suppose event Aand event B are in scope, and event A has property ZZ, and event B has propertyYY. Both properties belong to the same data type. Suppose you then dragproperty ZZ to a condition or action column. In the cell, you can then specify avalue as b.YY. The effect is different depending on the type of column:

• In a condition column, this means: compare the value of property ZZ with thevalue of property YY.

• In an action column this means: set the property ZZ to the value of YY.


Working With Rows and Columns in WebStudio | 53

Working With Rows and Columns in WebStudio

This section presents various operations you can perform as needed whileworking with rows and columns of a decision table in TIBCO BusinessEventsExtreme WebStudio.

Add Condition and Action ColumnsThe columns of a decision table are made up of condition columns on the left, andaction columns on the right. Each column represents one condition or one action.

A condition is a test that must evaluate to true before the action is executed. If adecision table rule uses multiple conditions, all conditions for a row mustevaluate to true in order for the action to execute.

Add condition and action columns from arguments under the VRF scope or usingthe rule language, standard functions, and data in the scope of the function atruntime (for example, scorecards and global variables).

To Add Condition and Action Columns from Arguments

1. Open the decision table you want to edit.

2. In the Group Contents section, right click the decision table and select ShowArguments.




A plus icon is displayed in front of the decision table for argument listexpansion.

3. Click the plus icon to expand the arguments list. If needed, click the plus iconsfor concepts and rules as well.

The decision table arguments are listed under the decision table.

4. Drag a property from the argument list to the decision table editor.

A Create Column pop-up window appears to create the condition or actioncolumn.



5. Click the Condition or Action radio button and click OK to create a Conditionor Action column. New Condition or Action column is added at the end of theCondition or Action column-sets respectively.

To Add Custom Condition and Action Columns

1. Open the decision table you want to edit.

2. Click Custom in the decision table editor menu and select either of thefollowing options:

— Select Add a custom Condition to insert a custom condition column at theend of condition column set.

— Select Add a custom Action to insert a custom action column at the end ofaction column set.

Working with ColumnsYou can perform actions on a column to resize, sort, associate to domain model, orremove from a decision table.

Resize a column

Perform any of the following actions to resize a column in the TIBCOBusinessEvents Extreme WebStudio:

• Drag the right boundary of a column to manually resize them.



• Open the column header menu using either of the following ways and clickAuto Fit to resize the column to fit to the content size:

— Right click on the column header you want to resize.

— Move the mouse pointer to the column header to view the down-pointingtriangle and click the triangle.

• Double click the right boundary of a column to make it auto fit to the contentsize.

• Open the column header menu using either of the above mentioned ways andclick Auto Fit All Columns to resize all columns to fit their content size.

Sort the decision table

Sort the decision tables in TIBCO BusinessEvents Extreme WebStudio in one ofthe following ways:

• Click once on the column header to sort the table in ascending order of thecolumn and click again on the column header to re-sort the table indescending order of the column.

• Open the column header menu using either of the following ways:

— Right click on the column header you want use for sorting.

— Move the mouse pointer to the column header to view the down-pointingtriangle and click the triangle.

• Click Sort Ascending or Sort Descending to sort the table in ascending ordescending order of the column.

Sort options are not available for columns with boolean entry values and forcustom condition and action columns.



Associate and Remove Domain Association

A domain model specifies the values that you may find useful for definingontology item properties. For example, instead of typing text for a certain conceptproperty, you can pick a value from a list, or enter a value within a predefinedrange.

To associate a domain model, right click on the column and on the menu, clickAssociate Domain. The setting toggles to ON. To clear the domain association,click Associate Domain again. The setting toggles to OFF.

Remove a Column

Right click the column header and click Remove to remove the column from thedecision table.

Add a RowEach row in a decision table represents a separate business rule. You can controlthe order in which sets of rows are executed using the row priority setting, seeSetting Rule (Row) Priorities on page 58.

Set Row Priority in TIBCO BusinessEvents Extreme WebStudio

To set the row priority, with ten as the lowest priority and one as the highest, dothe following:

1. Select the row whose priority you want to set.

2. Click the Properties icon to display the Properties view.

3. Select the Properties view, and select the Rule side-tab.

4. In the Priority field, select the appropriate value.

You cannot remove the last condition column because a minimum of onecondition column must exist if you have any action columns.



5. Click the Save icon in the Edit toolbar to save the changes to the decisiontable.

Setting Rule (Row) PrioritiesEach row is like a separate business rule. You can control the order in which setsof rows are executed using the row priority setting. Rows with higher prioritiesare executed before those with lower priorities, as follows:

1. First, all conditions are checked for all rows that have the highest priority.(The checking order within a set of rows with the same priority is notdeterminate.)

2. Then the rule actions for all of those rows whose conditions evaluate to trueare executed. (The execution order is not determinate. The runtime engineoptimizes rule execution.)

3. The process is repeated for all rows with the next highest priority, and so on.

To Set Row Priority

Ten is the lowest priority and one is the highest. Five is the default priority.

1. Select the row whose priority you want to set.

2. Select the Properties view and then select the Rule side-tab.

3. In the Priority field, select the appropriate value and click Apply.



Filter RowsFiltering rows helps you to focus on certain rows instead of entire table. Applyfilters on multiple columns for more refined results. In TIBCO BusinessEventsExtreme WebStudio decision table filter makes only textual comparison betweenthe row values and filter values.

Click Filter > Decision Table in the decision table editor menu to enable the filterfor the decision table. Enter the values in filter cells (above column header) tofilter the table.

To remove the filter click Filter > Remove in the decision table editor.

Remove RowsSelect the rows you need to remove and click Remove in the decision table editor.In the Remove Decision Table Record window, click OK to confirm the removal ofthe row. You can remove only one row at time.

Create Duplicate Rows (Rules)Select the Decision Table rows that you want to duplicate and click DuplicateRow in the Decision Table editor to duplicate the selected rows. New rows areadded, at the end of decision table, with the same conditions and actions ofselected rows, but with a different ID. You can then edit the rows as needed.



Supported Operators

Table 6 lists the operators supported by Decision Tables:

Table 6 Supported Operators

Operator Description

== Equals to

!= Does not equal to

> Greater than

>= Greater than or equals to

< Less than

<= Less than or equals to

|| Logical OR

&& Logical AND

+ Addition or String concatenation (depending on context)

! Logical NOT (only with boolean)

- Subtraction

* “Don’t Care” (that is, ignore), or multiplication (depending on context)

/ Division

= Assignment

. Scope resolution

() Operator precedence order or function call (depending on context)

[] Array declaration or array indexing (depending on context)

{} Block resolution or array Initialization (depending on context)

?: Ternary conditional

++ Increment (used only with custom actions)


Supported Operators | 61

Using Operators in Tables

Named or Scoped Conditions must Evaluate to Boolean

For logical operators, named conditions will have to use them explicitly from thesecond operand onwards.

For example, if the LHS of the condition is the column name, bankuser.Age, thefollowing are valid entries:

50 || ==60 , 40 && ==80, 20 || >=80

Custom Conditions must evaluate to Boolean

Same as above, except that you must specify the entire Boolean expression in thecell, including LHS.

Actions or Custom Actions

Named actions perform assignment of the cell expression to the column nameproperty.

Custom actions are treated as normal strings and can be anything that you wouldenter in the THEN section of rules (LHS included).

-- Decrement (used only with custom actions)

Table 6 Supported Operators (Cont’d)

Operator Description



Analyze a Decision Table

Table Analyzer will create a sparse matrix data structure representing anoptimized form of the decision table in memory. In the Table Analyzer you can setexample condition values and perform various validation checks on the currentlydisplayed decision table.

The table analyzer feature provides various tools that you can use to check thevalidity of your decision tables.

To analyze a decision in the TIBCO BusinessEvents Extreme WebStudio, do thefollowing:

1. Open the decision table you want to analyze.

2. Click the Decision Table Analyzer icon to view Table Analyzer.

3. In the Table Analyzer section, controls are created dynamically for settingvalues and ranges for each condition in the table. Enter or select the examplevalues for which you want to analyze the table.

For example, if the condition is a range, for instance “< 40” or “> 10 && <100”, then the corresponding control in the Table Analyzer section is a Sliderthat spans the range from the minimum value to the maximum value. You canthen select a range of values within the range.

4. Click the Analyze icon to analyze the decision table based on the selectedvalues.

• Table analyzer supports the Not Equal To (!=) operator.


Analyze a Decision Table | 63

A pop-up window displays the count of any issues. The Problems section atthe bottom displays more information on issues. Click the issue to highlightthe row.

You can click the Show Coverage icon in the table analyzer section to highlightall rows that meet the criteria.

For example, if you select Male for Gender; true for Eligible; and 50000-60000

for Income, clicking Show Coverage displays all rows that have Male, true, andan income between 50000 and 60000.



Validate a Decision Table

In TIBCO BusinessEvents Extreme WebStudio, you can validate decision tablesfor the changes using the validate command. Select the decision table and clickthe Validate icon to validate the table.

If there are any access control violations or syntax errors in the tables, they areshown in the Problems View tab at the bottom of the application. New errors insyntax are added to these existing errors. Double-click errors to see theproblematic view. Take any needed corrective actions and then validate the tableagain until all errors are resolved.

The Validate icon is activated when the decision table is opened in the editor. EARfile for the project should be present in the deploy location; otherwise, thevalidate command fails.


| 65

Chapter 5 Business Rules

The Business Rules artifact allows non-technical business users to build complexbusiness rules in TIBCO BusinessEvents Extreme WebStudio. Business Rules arecreated using the Rule templates developed in TIBCO BusinessEvents ExtremeStudio. See TIBCO BusinessEvents Extreme Developer’s Guide for details on how tocreate a rule template. This chapter explains business rules and how to createthem.

Topics

• Business Rules Overview, page 66

• Working with Business Rules, page 67

• Business Rule Operators, page 72


66 | Chapter 5 Business Rules

Business Rules Overview

Business rules are defined inside TIBCO BusinessEvents Extreme WebStudio, andare intended to be used by non-technical users. TIBCO BusinessEvents ExtremeWebStudio users complete the definition of the rule instance using one of thefollowing types of user interface:

• A form where users can provide values for bindings defined in TIBCOBusinessEvents Extreme Studio. The form interface is the visual presentationof the rule template defined by rule template views. See TIBCO BusinessEventsExtreme Developer’s Guide for more details on rule template views.

• A builder style of user interface where users can build conditions and actionsusing various operators. A builder based user interface is presented to theuser only if there is no view associated with the rule template.

Business Rule Builder

The builder for business rule in the TIBCO BusinessEvents Extreme WebStudioconsists of two sections:

When section - condition builder

When section lets the user define additional conditions that must be met, inaddition to the pre-condition defined in the Rule Template. The builderdetermines the scope of the rule template, and allows the user to defineindividual conditional clauses based on that scope. Each conditional clause hasone or more sub-clause, and a match operator determines whether the conditionalclause is true when all sub-clause are true, or any one sub-clause is true, or noneof the sub-clauses evaluate to true.

Then section - command builder

Then section defines additional actions to be taken based on the conditionsdefined. The builder lets the user define actions based on the statements definedin the Action Context section of the rule template.

Ensure that all the actions in the business rule are defined and the order shouldmatch that of the rule template. Otherwise, the business rule will be invalid.


Working with Business Rules | 67

Working with Business Rules

In TIBCO BusinessEvents Extreme WebStudio, you can create, modify, or deletebusiness rules. Any modification after commit goes through the RMS approvalprocess (see Chapter 6, Working with the Approval Workflow in RMS, onpage 77).

A business rule in a project is identified by the .ruletemplateinstance fileextension. The rule template instance file is generated when the BuildAndDeployoption is selected for the business rule in approvals. See Generating One BusinessRule’s Rule Template Instance File on page 87 for more details.

Adding Business RulesIn TIBCO BusinessEvents Extreme WebStudio, a business rule is created using arule template defined in TIBCO BusinessEvents Extreme Studio. If a rule templateview is associated for the rule template, the business rule has an easy-to-use formbased interface to specify conditions and actions; otherwise, conditions andactions are added using the builder. See TIBCO BusinessEvents Extreme Developer’sGuide for overview on rule template, and rule template view.

See Chapter 3, Working With Projects in WebStudio, on page 37 for more detailson starting and logging into RMS, and checking out project resources.

To add a business rule

1. In TIBCO BusinessEvents Extreme WebStudio, under the Group Contentssection, right click the rule template you want to use and select CreateBusiness Rule.

2. Type the business rule name in the dialogue box and click OK.

3. If the rule template view is defined for the rule template, then the HTML formis presented in the business rule editor. Then follow the steps as in To add abusiness rule using an HTML form on page 68 to create a business rule.

4. Otherwise, if the view is not associated with the rule template, a builderinterface opens up in the editor. Perform the steps in the following sections tocreate a business rule:

— To add a conditional clause using a builder on page 68

— To add an action using builder on page 69



To add a business rule using an HTML form

1. In WebStudio, enter the threshold values in the input fields of the HTMLform.

2. Click the Save icon to save updates to the business rule.

To add a conditional clause using a builder

1. In the business rule editor, under the When section, click the artifact-namelink and select the artifact you require.

2. Click the operator-name link to select another operator, or a child artifact ofthe previously selected artifact, as you require. See Condition BuilderOperators on page 72 for list of supported operators.

3. Enter the conditional value for the artifact in the empty box.

4. Click the Add icon to add another condition to the conditional clause, orclick the Remove icon to remove the existing condition from theconditional clause, if you want.

5. Click the Add Sub-clause icon to add a conditional sub-clause to theconditional clause, if you want.



6. Click the match-operator link to select the matching condition for which theconditional clause evaluates to true. The values are:

— Match Any Conditional clause is true if any of the condition evaluates totrue

— Match All Conditional clause is true only if all of the conditions evaluates totrue

— Match None Conditional clause is true only if none of the conditionsevaluates to true.


To add an action using builder

1. In the business rule editor, under the Then section, click the Actiondrop-down list to select the actions available for the rule template.

2. Click the artifact-name link and select the artifact you want modify.

3. Click the operator-name link and select the command for the artifact. SeeAction Builder Operators on page 74 for list of available on operators.

4. Type the value, you want to set for the artifact, in the empty box.

5. Click the Add icon to add another parameter for the action, or click theRemove icon to remove the parameter for action, if you want.




Export a Business RuleYou can export business rules fromTIBCO BusinessEvents Extreme WebStudio torule template instance file. Sample exported rule template instance file content:

<?xml version="1.0" encoding="UTF-8"?><RuleTemplateInstance id="738cd4ea-8569-4744-aa86-fb88a89bf0a3"implementsPath="/Rule_Templates/Applicant_PreScreen">

<actions/><binding id="minimumIncome" value="5000"/><binding id="minimumAge" value="25"/><binding id="creditType"/>

</RuleTemplateInstance>

To Export the Business Rule

1. Open the Export dialog box in either of the following ways:

— Select the business rule and in the Tools tool bar, click the Export icon .

— Right click the business rule in the Group Contents section and selectExport.

2. Navigate to the directory in which you want to save the rule template instancefile and provide a file name.

3. Click Save.

Deleting Business RulesIf the business rule you want to delete has been checked into the RMS project,then you must submit the deletion for approval. After approval, the deleted tableis removed from the RMS project, but it is not removed from the user’sworkspace.

To Delete a Business Rule


— In Group Contents, right-click the business rule name and select Delete.

— In Group Contents, select the business rule name. Then click the Deleteicon in the Edit toolbar.

If you are not sure whether a table you deleted was committed to the RMS projectin a prior action, click WebStudio, and form the pull-down menu, select Project >Commit. If the deleted table does not appear in the Changes Made panel, then itis a local table.



2. If the business rule has been committed to the RMS project, select one of thefollowing options as appropriate:

— Commit the project or the parent folder so that the RMS master copy of thebusiness rule is also deleted (see To Commit Project Resources for Approvalfrom WebStudio on page 42). OR

— Synchronize the project to replace the deleted copy with the RMS projectversion of the business rule (see To Update a Project in WebStudio onpage 41).


— In Studio Explorer, right-click the business rule name and select Delete.

— In Studio Explorer, select the business rule name. Then select File > Delete.

4. If the business rule has been committed to the RMS project, select one of thefollowing options as appropriate:

— Select Project > Commit so that the RMS master copy of the table is alsodeleted.

— Select Project > Synchronize to replace the local deleted copy with the RMSproject version of the table.

When an artifact deletion is approved, the artifact is permanently deleted fromthe RMS project. However, When Decision Manager or WebStudio users updatetheir projects, the deleted artifacts do not appear in the list of changes.

Users who have already checked out the project must manually delete their localcopy of the artifact.



Business Rule Operators

This section lists the operators supported in the business rules builder. RTIbuilder operators consists of the conditional clause operators and the actionbuilder operators. The operator list changes as per the parent entity type in thebuilder.

Condition Builder Operators

Parent Type Operator Value onWebStudio Client

Operator Value on RMSServer

Concept / Event

Matches Other Field == <field>

Differs From Field != <field>

Is Null == null

Is not Null != null

Data / Time / Datetime



Is Null == null

Is not Null != null

Integer / Float



Is Null == null

Is not Null != null

Greater Than >

Greater Than Field > <field>


Business Rule Operators | 73

Greater Than Equal To >=

Greater Than Equal To Field >= <field>

Less Than <

Less Than Field < <field>

Less Than Equal To <=

Less Than Equal To Field <= <field>

Equals ==

Not Equals !=

Text / String



Is Null == null

Is not Null != null

Equals ==

Not Equals !=

Boolean

Equals ==

Not Equals !=







Action Builder Operators



Concept / Event

Set To =

Set To Field = <field>

Set To Null = null

Data / Time / Datetime

Set To =


Set To Null = null

Integer / Float

Set To =


Increment By +=

Increment By Field += <field>

Decrement By -=

Decrement By Field -= <field>

Text / String

Set To =


Set To Null = null

Boolean

Set To True = true

Set To False = false


Business Rule Operators | 75





| 77

Chapter 6 Working with the Approval Workflow inRMS

This chapter explains the approval workflow of decision tables or business rules.

Topics

• Working with the Approval Workflow—Overview, page 78

• Checking a Worklist and Taking Action, page 80


78 | Chapter 6 Working with the Approval Workflow in RMS

Working with the Approval Workflow—Overview

When business users have finished working with artifacts (decision tables orbusiness rules), they submit them for approval. All business user actions, such ascommitting or deleting artifacts are committed to the RMS project only when auser whose role gives permission to do so approves the requests.

The approval permissions are set at the project level using the ACL file for theproject. Allow the approval action type for the user role in the ACL file to thegrant approval permission.

This section explains the provided workflow for approving and rejecting businessusers’ commit requests.

See Committing Artifacts for Approval on page 42 for business user procedures.

See Checking a Worklist and Taking Action on page 80 for approver procedures.

Who Can Approve or Reject Commit Requests

In TIBCO BusinessEvents Extreme WebStudio users with Administrator rolepermissions can approve or reject commit requests, or delegate approval. Theycan also delegate the task of approving or rejecting commit requests to anyspecified user role and not to a specific user. In this case, the approval or rejectionrequests will be sent to all the users in that role. See To Delegate a Workitem onpage 80.

Approval Status ValuesCOMMITED When a user commits one or more resources for approval, the statusof the request is set to Commited. The approver then sets the status asappropriate.

This manual documents the behavior of the product as shipped. The workflow,the roles used, and the permissions granted to the roles are all configurable.However, the general flow is likely to be similar to that described in this guide.

With this release, the approval can only be done in TIBCO BusinessEventsExtreme WebStudio.

Use of RMS—and therefore the approval process—is required when TIBCOBusinessEvents Extreme WebStudio is used.


Working with the Approval Workflow—Overview | 79

APPROVE The request was approved. If the submission request was to add orchange an artifact, that artifact is copied to the RMS project. If the submissionrequest was to delete an approved artifact, that artifact is deleted from the RMSproject.

REJECT The change was rejected. If the submission request was to add or changean artifact, that artifact is not copied to the RMS project. If the submission requestwas to delete an approved artifact, that artifact is not deleted. It is up to thebusiness user to make changes in their local project accordingly.

BUILDANDDEPLOY The artifact is built and ready to be deployed. The artifactafter approval is built and kept ready to be deployed at the location specified by aproperty in the RMS.cdd file. See RMS Server Configuration Property Referenceon page 15 for more details on property.



Checking a Worklist and Taking Action

Approval requests are handled in the Worklist window in TIBCO BusinessEventsExtreme WebStudio.

To Check Your Worklist and Take Action

1. Open the worklist window using any of the following methods:

— Click WebStudio, and from the pull-down menu, select RMS > ShowWorklist.

— Right-click any artifact and select RMS > Show Worklist.

— Click the Show Worklist icon in the RMS toolbar.

The worklist window displays all the requests submitted for approval.

2. To view the artifacts submitted for approval, click the triangle in front of theRevision ID. To examine the artifact before taking an action, double-click theartifact. The decision table or business rule displays in the editor.

3. To take action on an artifact, click the Commited status under the Statuscolumn, and select a value from the status drop-down menu:

— Approve

— Reject

A message field displays the error messages in the event of a problem.

4. Click anywhere outside the drop-down menu and click Ok.

To Delegate a Workitem

A user in the Administrator role can delegate a workitem to one or more roles.Users belonging to any of those roles see the workitem in their worklist.

Users in the role specified by the RMS global variable propertytibco.clientVar.RMS/Approval/adminRole have Administrator roleprivileges. See Configuring RMS Server Properties, page 12.


Checking a Worklist and Taking Action | 81


— Click WebStudio, and from the pull-down menu, select RMS > ShowWorklist.



The worklist window displays all the requests submitted for approval.

2. Select the checkbox for one or more Revision IDs you need to delegate.

3. Select one or more user roles from the DelegateTo drop down list and clickApply. You see all roles that you do not belong to, and that have permission toapprove or reject the artifact.

The workitem disappears from your worklist. It can be seen in the worklist ofthe users in the roles you selected in step 3.


| 83

Chapter 7 Deployable Files Generation

This chapter explains the configuration and the procedures for generating EARfiles, decision table classes, and business rule’s rule template instance file.

Topics

• Generating Deployable Files (EAR and Class Files), page 84


84 | Chapter 7 Deployable Files Generation

Generating Deployable Files (EAR and Class Files)

Deployable files are generated using the TIBCO BusinessEvents Extreme Studioproject files, located in the RMS project’s folder.

The deployable files are of two types: EAR files and class files.

EAR files are generated in Decision Manager and TIBCO BusinessEvents ExtremeWebStudio UI.

You can generate class files using Decision Manager and the TIBCOBusinessEvents Extreme WebStudio UI, or at the command line. You can generatean entire project’s class files, one decision table’s class file, or one business rule’srule template instance file. If you generate an entire project’s class files, a propertyin the CDD file enables you to exclude unwanted packages.

Location of Generated Files

Location of generated files can be configured using deploy location properties inthe RMS.cdd file. See RMS Server Configuration Property Reference on page 15 formore details on deploy location properties. Below are the locations of thegenerated files as per the preconfigured locations in the shipped product.

• EAR files are saved in the RMS project directory in the RMS’s shareddirectory. For example, the EAR file for the CreditCardApplication project(CreditCardApplication.ear) is stored atTIBCO_HOME/be/5.1/rms/shared/CreditCardApplication

• A project’s class files are saved in the Codegen subdirectory under the RMSproject directory in the RMS’s shared directory. For example, class files for theCreditCardApplication project (CreditCardApplication.ear) are stored atTIBCO_HOME/be/5.1/rms/shared/CreditCardApplication/Codegen

• Individual decision table’s class file and business rule’s rule template instanceare saved in the RMS project directory in the RMS’s shared directory.

You can generate one decision table’s class file and business rule’s rule templateinstance file, using TIBCO BusinessEvents Extreme WebStudio only.


Generating Deployable Files (EAR and Class Files) | 85

Generating the Project EAR or All Project Class FilesYou can generate deployable EAR files only if you have the permission to checkout all the required project resources (ACLs may limit what you can check out).

To Generate the Project EAR or All Project Class Files in WebStudio

1. Open the Generate Deployable window using any of the following methods:

— Click WebStudio, and from the pull-down menu, select RMS > DeployArtifacts.

— Right-click on any artifact and select RMS > Deploy Artifacts.

— Click the Generate Deployable icon in the RMS toolbar.

The Generate Deployable window is displayed.


— To generate class files, select the Generate Classes Only checkbox.

— To generate EAR files, do not select the Generate Classes Only checkbox.

3. From the drop-down list, select the project for which you want to generate thedeployable files.

4. (For EAR files only.) If you want to generate the debug information, select theGenerate Debug Info checkbox.

5. (For EAR files only.) If you want to include all service-level global variables,select the Include all service level global variables checkbox.

6. Click OK.

Files are saved to the preconfigured location (see Location of Generated Files onpage 84). Any existing files are overwritten.

If you have created/modified the decision table for the first time and did notgenerate the EAR files before creating/modifying decision tables, then youreceive an error while generating the deployables:

EAR for projects: <project_name> either not present or not in syncat deploy location.



Generating One Decision Table’s Class FileIn TIBCO BusinessEvents Extreme WebStudio, the BuildAndDeploy status menuoption in the Worklist window generates the class file for only the selecteddecision tables. You can generate a decision table’s class file only after it isapproved. See Checking a Worklist and Taking Action on page 80 on how toapprove a commit request.

To Generate One Decision Table Class File


— Click WebStudio, with the down pointing triangle in front of it, and selectRMS > Show Worklist.



The worklist window displays all the requests submitted for approval as wellas approved requests.

2. To view the approved decision tables, click the triangle in front of the RevisionID. To examine the decision table before taking an action, double-click thetable. The decision table displays in the editor.

3. To generate classes for the decision table, click the Approved status under theStatus column, and select BuildAndDeploy from the status drop-down menu.The project EAR must already be created.

A message field displays error messages in the event of a problem.

4. To start generating classes click anywhere outside the drop-down menu andclick Ok.

You can generate one decision table’s class file using TIBCO BusinessEventsExtreme WebStudio only.

If you have created/modified the decision table for the first time and did notgenerated the EAR files before creating/modifying decision tables, then youreceive error while generating the deployables:

EAR for projects: <project_name> either not present or not in syncat deploy location.


Generating Deployable Files (EAR and Class Files) | 87

Generating One Business Rule’s Rule Template Instance FileIn TIBCO BusinessEvents Extreme WebStudio, the BuildAndDeploy status menuoption in the Worklist window generates the rule template instance file for justselected business rules. You can generate a business rule’s rule template instancefile only after it is approved. See Checking a Worklist and Taking Action onpage 80 on how to approve a commited request.

To Generate One Rule Template Instance File


— Click WebStudio, with the down pointing triangle in front of it, and selectRMS > Show Worklist.



The worklist window displays all the requests submitted for approval as wellapproved requests.

2. To view the approved business rules, click the triangle in front of the RevisionID. To examine the business rule before taking an action, double-click the rule.The business rule displays in the editor.

3. To generate rule template instance file for the business rule, click theApproved status under the Status column, and select BuildAndDeploy fromthe status drop-down menu.

A message field displays error messages in the event of a problem.

4. To start generating rule template instance file, click anywhere outside thedrop-down menu and click Ok.


| 89

Index

A

Active Directory 24Adding a Project to RMS 11Adding Business Rules 67Approval Status Values 78Approving and Rejecting Commit Requests 78Authentication Property Reference 25

B

BE_HOME xiiibe.auth.file.location 25be.auth.ldap.adminDN 26be.auth.ldap.adminPassword 26be.auth.ldap.baseDN 26be.auth.ldap.dnAttr 27be.auth.ldap.host 26be.auth.ldap.objectClass 27be.auth.ldap.port 26be.auth.ldap.roleAttr 26, 26, 27, 27be.auth.ldap.ssl 27be.auth.type 23, 25be.mm.auth.ldap.port 26Business rule builder

command builder 66condition builder 66

C

Checking a Worklist and Taking Action 80Checking Out a Project 40Committing Artifacts for Approval 42Conditions and Actions 51Configuring Access Control—Overview 28

Configuring Basic RMS Server Properties 12Configuring for Deployment of Decision Table

Classes 84Configuring RMS Server Properties 12Configuring User Authentication 23Create/Remove a Decision Table 46Creating a Rule Management Server Project

Update a Project 41customer support xvi

D

Decision Manager and RMS Basic Workflow 7Defining Permissions 32Deleting Business Rules 70

E

Edit a Decision Table 47Email Notification Property Group 21Enabling Remote Connection to RMS 14ENV_HOME xiiiEstablishing the User Roles 28Exception Tables 5Export a Business Rule 70Export a Decision Table 48

G

Generating Deployable Files 84Guidelines for Configuring Access Control 28


90 | Index

I

Import a Decision Table 49Introduction to Decision Manager 2Introduction to Rules Management Server (RMS) 2, 10

J

java.security.auth.login.config 25

P

Permissions—ALLOW and DENY 31

R

Regular and Custom Conditions and Actions 51Required Location of Access Control Files 31Resource Types and Corresponding Action Types 33RMS Server Configuration Property Reference 15Rule Building with Decision Tables 4rule template 66

S

Set Decision Table Properties 47Specifying and Grouping Project Resources 31Specifying Permissions

Action Types 33Specifying Resources 31Starting and Logging in to RMS 38Status Check for RMS Connection 39Structure of the Access Control File 30support, contacting xvi

T

Table Analyzer 5technical support xviTIBCO BusinessEvents Virtual Rule Functions and

Decision Tables 3TIBCO_HOME xiii

U

Updating (Refreshing) a Project 41userPrincipalName 24

W

Workflow 7Working with Access Control Files 31Working With Decision Tables 46


TIBCO BusinessEvents WebStudio User,Aos Guideusers to create or manage business rules in a web...

Documents

Transcript of TIBCO BusinessEvents WebStudio User,Aos Guideusers to create or manage business rules in a web...