iway iway Business Activity Monitor User's Guide Version Service Manager (SM) DN

Transcription

1 iway iway Business Activity Monitor User's Guide Version Service Manager (SM) DN

2 Cactus, EDA, EDA/SQL, FIDEL, FOCUS, Information Builders, the Information Builders logo, iway, iway Software, Parlay, PC/FOCUS, RStat, TableTalk, Web390, and WebFOCUS are registered trademarks, and Magnify is a trademark of Information Builders, Inc. Due to the nature of this material, this document refers to numerous hardware and software products by their trademarks. In most, if not all cases, these designations are claimed as trademarks or registered trademarks by their respective companies. It is not this publisher s intent to use any of these names generically. The reader is therefore cautioned to investigate all claimed trademark rights before using any of these names other than to refer to the product described. Copyright 2009, by Information Builders, Inc. and iway Software. All rights reserved. Patent Pending. This manual, or parts thereof, may not be reproduced in any form without the written permission of Information Builders, Inc.

3 iway Contents Preface...5 Documentation Conventions...5 Related Publications...6 Customer Support...6 Help Us to Serve You Better...7 User Feedback...9 iway Software Training and Professional Services Introducing iway Business Activity Monitor...11 About iway Business Activity Monitor...12 iway Business Activity Monitor Components...12 iway Business Activity Monitor Architecture...13 New Features in the Release Installing and Configuring iway Business Activity Monitor...15 Installation Prerequisites...16 Installing iway Business Activity Monitor...16 Configuring iway Business Activity Monitor in Standalone Mode...19 Configuring iway Business Activity Monitor in Multinode (Client/Server) Mode...23 Configuring the iway Business Activity Monitor Web Application...29 Configuring the iway Business Activity Monitor Channel Configuring and Using iway Business Activity Monitor...37 Accessing the iway Business Activity Monitor Web Application...38 Activity Management...39 Channel Activity...40 EDI Activity...42 Partner Activity...44 Message Resubmission...46 Using the Search Function...48 Administration...49 iway Business Activity Monitor User's Guide 3

4 Contents User Management...49 Role Management...50 Correlation Management...51 Dashboard...53 Reader Comments iway Software

5 iway Preface This describes how to install and configure iway Business Activity Monitor (BAM). It is intended for users with an administrator's knowledge of the operating environment of iway Service Manager (ism) and an associated database system to be used in conjunction with BAM. How This Manual Is Organized This manual includes the following chapters: Chapter/Appendix Introducing iway Business Activity Monitor Installing and Configuring iway Business Activity Monitor Configuring and Using iway Business Activity Monitor Contents Provides an overview of iway Business Activity Monitor (BAM), including key features and components. Provides iway Business Activity Monitor (BAM) prerequisite information and describes how to install BAM. Describes how to configure and use iway Business Activity Monitor (BAM). Documentation Conventions The following table lists and describes the conventions that apply in this manual. Convention THIS TYPEFACE or this typeface Description Denotes syntax that you must enter exactly as shown. iway Business Activity Monitor User's Guide 5

6 Related Publications Convention this typeface underscore this typeface Key + Key { } Description Represents a placeholder (or variable), a cross-reference, or an important term. It may also indicate a button, menu item, or dialog box option that you can click or select. Indicates a default setting. Highlights a file name or command. Indicates keys that you must press simultaneously. Indicates two or three choices; type one of them, not the braces. Separates mutually exclusive choices in syntax. Type one of them, not the symbol. Indicates that you can enter a parameter multiple times. Type only the parameter, not the ellipsis points (...). Indicates that there are (or could be) intervening or additional commands. Related Publications To view a current listing of our publications and to place an order, visit our World Wide Web site, You can also contact the Publications Order Department at (800) Customer Support Do you have questions about iway Business Activity Monitor (BAM)? Call Information Builders Customer Support Services (CSS) at (800) or (212) Customer Support Consultants are available Monday through Friday between 8:00 A.M. and 8:00 P.M. EST to address all your questions. Information Builders consultants can also give you general guidance regarding product capabilities and documentation. Be prepared to provide your six-digit site code (xxxx.xx) when you call. 6 iway Software

7 Preface You can also access support services electronically, 24 hours a day, with InfoResponse Online. InfoResponse Online is accessible through our World Wide Web site, You can connect to the tracking system and knownproblem database at the Information Builders support center. Registered users can open, update, and view the status of cases in the tracking system and read descriptions of reported software issues. New users can register immediately for this service. The technical support section also provides usage techniques, diagnostic tips, and answers to frequently asked questions. To learn about the full range of available support services, ask your Information Builders representative about InfoResponse Online, or call (800) 969-INFO. Help Us to Serve You Better To help our consultants answer your questions effectively, be prepared to provide specifications and sample files and to answer questions about errors and problems. The following table lists the environment information our consultants require. Platform Operating System OS Version JVM Vendor JVM Version The following table lists the deployment information our consultants require. Adapter Deployment Container For example, JCA, Business Services Provider, iway Service Manager For example, WebSphere Version Enterprise Information System (EIS) - if any EIS Release Level EIS Service Pack iway Business Activity Monitor User's Guide 7

8 Help Us to Serve You Better EIS Platform The following table lists iway-related information needed by our consultants. iway Adapter iway Release Level iway Patch The following table lists the types of iway Explorer. Specify the version (and platform, if different than listed previously) in the columns provided. iway Explorer Type Swing Servlet Eclipse Embedded in iway Designer Version Platform The following table lists additional questions to help us serve you better. Request/Question Error/Problem Details or Information Did the problem arise through a service or event? Provide usage scenarios or summarize the application that produces the problem. When did the problem start? Can you reproduce this problem consistently? Describe the problem. 8 iway Software

9 Preface Request/Question Error/Problem Details or Information Describe the steps to reproduce the problem. Specify the error message(s). Any change in the application environment: software configuration, EIS/database configuration, application, and so forth? Under what circumstance does the problem not occur? Following is a list of error/problem files that might be applicable. Input documents (XML instance, XML schema, non-xml documents) Transformation files Error screen shots Error output files Trace files User Feedback Service Manager package to reproduce problem Custom functions and agents in use Diagnostic Zip Transaction log For information on tracing, see the iway Service Manager User's Guide. In an effort to produce effective documentation, the Documentation Services staff welcomes your opinions regarding this manual. Please use the Reader Comments form at the end of this manual to communicate suggestions for improving this publication or to alert us to corrections. You can also go to our Web site, and use the Documentation Feedback form. Thank you, in advance, for your comments. iway Business Activity Monitor User's Guide 9

10 iway Software Training and Professional Services iway Software Training and Professional Services Interested in training? Our Education Department offers a wide variety of training courses for iway Software and other Information Builders products. For information on course descriptions, locations, and dates, or to register for classes, visit our World Wide Web site, or call (800) 969-INFO to speak to an Education Representative. Interested in technical assistance for your implementation? Our Professional Services department provides expert design, systems architecture, implementation, and project management services for all your business integration projects. For information, visit our World Wide Web site, 10 iway Software

11 iway 1 Introducing iway Business Activity Monitor This section provides an overview of iway Business Activity Monitor (BAM), including key features and components. Topics: About iway Business Activity Monitor New Features in the Release iway Business Activity Monitor User's Guide 11

12 About iway Business Activity Monitor About iway Business Activity Monitor In this section: iway Business Activity Monitor Components iway Business Activity Monitor Architecture iway Business Activity Monitor (BAM) is an extension of iway Service Manager (ism) and a Web application that monitors information published and archived by ism. iway Business Activity Monitor Components This section provides an overview of the components that are used within the iway Business Activity Monitor (BAM) framework. iway Service Manager iway Business Activity Monitor (BAM) is an extension of iway Service Manager (ism) and a Web application that monitors information published and archived by iway Service Manager. iway Service Manager is a prerequisite of the iway Business Activity Monitor extension. iway Business Activity Monitor Extension iway Business Activity Monitor provides an iway Service Manager extension, which can be applied to a standard installation of iway Service Manager. The BAM extension includes an Activity Facility, which is also known as the BAM Activity Driver. BAM Activity Driver The BAM Activity Driver controls the generation of System and Business Metrics both as extended transaction records and publishing of business and system performance metrics aggregated in real-time. Additionally the BAM Activity Driver archives the performance metrics to a database on the frequency chosen by the administrator. SQL / JDBC Database Server The BAM Activity Driver uses a database for metric definitions, performance metric data archival, and so on. As such, a database is also a prerequisite of BAM. Currently, BAM supports: Oracle 8i, 9i, 10g, and 11g; MS SQL Server 2005 and higher; and MySQL version 5.0 and higher. iway Business Activity Monitor Web Application iway Business Activity Monitor provides an iway Service Manager Web application, which is used to configure BAM settings from a console environment. 12 iway Software

13 1. Introducing iway Business Activity Monitor iway Business Activity Monitor Architecture iway Business Activity Monitor (BAM) is an extension of iway Service Manager (ism). As a result, the architecture of BAM is based on ism. BAM uses standard ism components and augments the iway service design-time and runtime environment to easily access the BAM repository data. The BAM Web application allows users to configure metric definitions and performance metric data archival using an intuitive GUI, which persists the data to a BAM repository. New Features in the Release This section lists and describes new features that are available in the release of iway Business Activity Monitor (BAM). The BAM Web application is redesigned using AJAX (Asynchronous JavaScript and XML) and conforms to the Web 2.0 standard. WebFOCUS is no longer required to utilize BAM. Instead, BAM is fully integrated with iway Service Manager (ism) version and BAM supports: Oracle 8i, 9i, 10g, and 11g; MS SQL Server 2005 and higher; and MySQL version 5.0 and higher. BAM supports the H2 Database (H2DB), which can be configured as an in-memory database. BAM uses an ism data provider for connection pooling. Additional runtime functions are available to obtain data from the BAM repository. BAM SQL scripts are executed automatically based on the target database and no longer need to be executed separately. Many of the issues that were experienced in previous releases of BAM have been resolved in the and releases. iway Business Activity Monitor User's Guide 13

14 New Features in the Release 14 iway Software

15 iway Installing and Configuring iway Business 2 Activity Monitor This section provides iway Business Activity Monitor (BAM) prerequisite information and describes how to install BAM. Topics: Installation Prerequisites Installing iway Business Activity Monitor Configuring iway Business Activity Monitor in Standalone Mode Configuring iway Business Activity Monitor in Multinode (Client/Server) Mode Configuring the iway Business Activity Monitor Web Application Configuring the iway Business Activity Monitor Channel iway Business Activity Monitor User's Guide 15

16 Installation Prerequisites Installation Prerequisites The following components must be installed and configured before installing iway Business Activity Monitor (BAM): Web Browser Microsoft Internet Explorer Version 7 or 8 Firefox Version 3 and higher Note: Support for JavaScript is required and cookies must be enabled. iway Service Manager Version and higher iway Service Manager Administrator privileges One of the following supported database systems: Oracle 8i, 9i, 10g, and 11g MS SQL Server 2005 and higher MySQL version 5.0 and higher Installing iway Business Activity Monitor How to: Install iway Business Activity Monitor This section describes how to install iway Business Activity Monitor (BAM). Procedure: How to Install iway Business Activity Monitor To install iway Business Activity Monitor (BAM): 1. Install iway Service Manager Version or higher and ensure that the Business Activity Monitor option is selected during the installation sequence. 16 iway Software

17 2. Installing and Configuring iway Business Activity Monitor For example, installing BAM on a Windows platform provides an option to select Business Activity Monitor, as shown in the following image. Once the installation is completed, the iwcpbam.jar file is available in the following directory: iway_home\etc\manager\console\iwcpbam.jar where: iway_home Is the directory where iway Service Manager is installed. 2. Open the iway Service Manager Administration Console. 3. Perform the following tasks: a. Go to the target database (for example, MySQL) and create an empty database called bam. Note: This is the database that is used for storing BAM data. All tables and schema will be created in this database. iway Business Activity Monitor User's Guide 17

18 Installing iway Business Activity Monitor b. Using the iway Service Manager Administration Console, create a JDBC Data Provider for the bam database (for example, BAMDBProvider). For more information on configuring Data Providers, see the iway Service Manager User s Guide. Notes: A suitable driver must be added to the iway_home\lib directory to create a Data Provider. When connecting to MySQL, do not use org.gjt.mm.mysql.driver. This MySQL driver is not a production version and is not compatible with current MySQL servers. 18 iway Software

19 2. Installing and Configuring iway Business Activity Monitor c. Once the Data Provider is created, click Tools, and select Business Activity Monitor in the left pane. The Business Activity Monitor pane opens, as shown in the following image. Important: Before continuing and depending on your requirements, you must decide whether to configure BAM in standalone mode or client/server mode. BAM can be configured in client/server mode or standalone mode on one machine. However, keep in mind that moving between configuration modes (for example, client/server mode to standalone mode) will delete the existing client configuration. As a result, you must use caution before proceeding. Whichever configuration mode is chosen, it is recommended to review all the configuration sections in this chapter for a better understanding of the BAM architecture. Configuring iway Business Activity Monitor in Standalone Mode How to: Configure iway Business Activity Monitor in Standalone Mode This section describes how to configure iway Business Activity Monitor in standalone mode. iway Business Activity Monitor User's Guide 19

20 Configuring iway Business Activity Monitor in Standalone Mode Procedure: How to Configure iway Business Activity Monitor in Standalone Mode To configure iway Business Activity Monitor in standalone mode. 1. In the iway Service Manager Administration Console, click Tools, and select Business Activity Monitor in the left pane. 2. Click Configure BAM in Standalone mode. 20 iway Software

21 2. Installing and Configuring iway Business Activity Monitor The Specify Properties for SingleNode Configuration pane opens, as shown in the following image. By default, the Standard Properties tab is selected. Note: BAM configuration panes are divided into tabs based on the frequency of usage and priority of the fields that must be provided. Even though some fields are required, they may not all be listed in the Standard Properties tab. They can also be included in the Extended Properties tab. However, all required fields contain default values which should be sufficient in most cases. 3. Configure the parameters in the Standard Properties tab. The following table lists and describes the parameters in the Standard Properties tab. Parameter BAM is Active Generate Real Time Metrics Description Starts or stops iway Business Active Monitor. If BAM is inactive, no metrics are collected. As a result, it is recommended to keep BAM active at all times. Used to capture data for real-time dashboards. As a best practice, it is recommended to keep this option selected. iway Business Activity Monitor User's Guide 21

22 Configuring iway Business Activity Monitor in Standalone Mode Parameter Collect Metrics Real-time collection period (sec) * Create Metrics Flat File Description Collects metrics and generates alerts when selected. If this option is not selected, data is still collected but metrics are not created and no alerts are triggered. Deselecting this option will cause the background thread to stop running, which can save CPU resources. BAM can create alerts based on the constraints and rules that are defined. These alerts in the form of flat files are generated based on the defined time period. BAM can also creates metrics as XML to be used for other use cases and for legacy charts. Select this option if legacy chart support is required or raw XML data is needed. This is a deprecated option and may not be included in future releases. 4. Click the Extended Properties tab. Note: The values that are found in the Extended Properties tab can be left as default in most cases. 5. Click the User Define Properties tab. The User Define Properties tab allows administrator to define the metrics (SREGS), which need to be captured by BAM. 22 iway Software

23 2. Installing and Configuring iway Business Activity Monitor 6. Click Add Metrics to define a new metric. A new line to define a metric (SREG) is provided, as shown in the following image. 7. Select a function from the Choose Function drop-down list to provide aggregation for the metric. The empty field next to the Choose Function drop-down list allows you to specify options for the metric. The Display Value as field allows you to specify a name for the metric. For example, an SREG called nacameravalue with a display value set to North America Camera Order will display the metric as North America Camera Order in the user s dashboard. Note: If specific metrics are not defined, BAM will not capture data for these metrics (SREGS). 8. Once all the parameter values are specified in the Standard Properties tab, Extended Properties tab, and User Define Properties tab, click Save Changes. Configuring iway Business Activity Monitor in Multinode (Client/Server) Mode How to: Configure iway Business Activity Monitor in Multinode (Client) Mode Configure iway Business Activity Monitor in Multinode (Server) Mode Multinode mode provides a mechanism for creating a single instance to monitor all instances of iway Service Manager (ism). In this mode, an ism instance acting as a server should be identified. It is recommended that a dedicated ism instance should be acting as a BAM server as this will have a minimal impact on the performance of the core application. iway Business Activity Monitor User's Guide 23

24 Configuring iway Business Activity Monitor in Multinode (Client/Server) Mode Procedure: How to Configure iway Business Activity Monitor in Multinode (Client) Mode To configure iway Business Activity Monitor in multinode (client) mode. 1. In the iway Service Manager Administration Console, click Tools, and select Business Activity Monitor in the left pane. 2. Click Configure BAM in MultiNode mode Client. The Specify Properties for MultiNode Configuration pane opens, as shown in the following image. 24 iway Software

25 2. Installing and Configuring iway Business Activity Monitor Note: BAM configuration panes are divided into tabs based on the frequency of usage and priority of the fields that must be provided. Even though some fields are required, they may not all be listed in the Standard Properties tab. They can also be included in the Extended Properties tab. However, all required fields contain default values which should be sufficient in most cases. 3. Configure the parameters in the Standard Properties tab. The following table lists and describes the parameters in the Standard Properties tab. Parameter Config Name * Server IP / Server Host Name * Sending Transport Port * Sending Transport * Description A unique name for this multinode (client) configuration. You can combine a machine name and an ism configuration name (for example, MyServer-base). The name of the destination host server to which data needs to be sent. The server port which listens for incoming data. The default port number is The protocol type that is used to send data. The default protocol type is TCP. 4. Click the Extended Properties tab. Note: The values that are found in the Extended Properties tab can be left as default in most cases. 5. Once all the parameter values are specified in the Standard Properties tab and Extended Properties tab, click Save Changes. iway Business Activity Monitor User's Guide 25

26 Configuring iway Business Activity Monitor in Multinode (Client/Server) Mode Procedure: How to Configure iway Business Activity Monitor in Multinode (Server) Mode To configure iway Business Activity Monitor in multinode (server) mode. 1. In the iway Service Manager Administration Console, click Tools, and select Business Activity Monitor in the left pane. 2. Click Configure BAM in MultiNode mode Server. The Specify Properties for MultiNode Configuration pane opens. 3. Configure the parameters in the Standard Properties tab. The following table lists and describes the parameters in the Standard Properties tab. 26 iway Software

27 2. Installing and Configuring iway Business Activity Monitor Note: BAM configuration panes are divided into tabs based on the frequency of usage and priority of the fields that must be provided. Even though some fields are required, they may not all be listed in the Standard Properties tab. They can also be included in the Extended Properties tab. However, all required fields contain default values which should be sufficient in most cases. Parameter BAM is Active Generate Real Time Metrics Collect Metrics Real-time collection period (sec) * Create Metrics Flat File Receiving Transport Port * Receiving Transport * Description Starts or stops iway Business Active Monitor. If BAM is inactive, no metrics are collected. As a result, it is recommended to keep BAM active at all times. Used to capture data for real-time dashboards. As a best practice, it is recommended to keep this option selected. Collects metrics and generates alerts when selected. If this option is not selected, data is still collected but metrics are not created and no alerts are triggered. Deselecting this option will cause the background thread to stop running, which can save CPU resources. BAM can create alerts based on the constraints and rules that are defined. These alerts in the form of flat files are generated based on the defined time period. BAM can also creates metrics as XML to be used for other use cases and for legacy charts. Select this option if legacy chart support is required or raw XML data is needed. This is a deprecated option and may not be included in future releases. The server port which listens for incoming data. The default port number is The protocol type that is used to send data. The default protocol type is TCP. 4. Click the Extended Properties tab. iway Business Activity Monitor User's Guide 27

28 Configuring iway Business Activity Monitor in Multinode (Client/Server) Mode Note: The values that are found in the Extended Properties tab can be left as default in most cases. 5. Click the User Define Properties tab. The User Define Properties tab allows administrator to define the metrics (SREGS), which need to be captured by BAM. 6. Click Add Metrics to define a new metric. A new line to define a metric (SREG) is provided, as shown in the following image. 7. Select a function from the Choose Function drop-down list to provide aggregation for the metric. The empty field next to the Choose Function drop-down list allows you to specify options for the metric. The Display Value as field allows you to specify a name for the metric. For example, an SREG called nacameravalue with a display value set to North America Camera Order will display the metric as North America Camera Order in the user s dashboard. Note: If specific metrics are not defined, BAM will not capture data for these metrics (SREGS). 8. Once all the parameter values are specified in the Standard Properties tab, Extended Properties tab, and User Define Properties tab, click Save Changes. 28 iway Software

29 2. Installing and Configuring iway Business Activity Monitor Configuring the iway Business Activity Monitor Web Application How to: Configure the iway Business Activity Monitor Web Application iway Business Activity Monitor (BAM) includes an intuitive GUI for monitoring, creating dashboards, and generating alerts/metrics. This section describes how to configure the iway Business Activity Monitor Web application. Procedure: How to Configure the iway Business Activity Monitor Web Application To configure the iway Business Activity Monitor Web application. 1. In the iway Service Manager Administration Console, click Tools, and select Archive Manager in the left pane. The Archive Manager pane opens, as shown in the following image. iway Business Activity Monitor User's Guide 29

30 Configuring the iway Business Activity Monitor Web Application 2. Select Import components from a repository archive and click Next. 3. Select BAMChannel and click Next. Once imported and deployed, the BAMChannel is added to the list of available channels in the iway Service Manager Administration Console, as shown in the following image. 4. Restart iway Service Manager. The required database tables are created in the target database. All BAM tables start with BAM_. 30 iway Software

31 2. Installing and Configuring iway Business Activity Monitor 5. Verify that the database is created in the target database by connecting to a database server using any client. 6. Verify that the BAMChannel is deployed and running. 7. Enter the following URL in your Web browser: The User Authentication logon page opens. 8. Enter admin as the user name (default) and iway as a password. 9. Click Login. Note: After installation, verify that the target database is running prior to starting iway Service Manager (ism). ism looks for the target database before initializing BAM. If the target database is unavailable or not running, then BAM will generate errors. Users that start ism as automatic service should be aware of issues, since ism may be starting before the target database has started. The recommended method is to start BAM manually after checking that the target database has started. iway Business Activity Monitor User's Guide 31

32 Configuring the iway Business Activity Monitor Channel The iway Business Activity Monitor Web application opens, as shown in the following image. Configuring the iway Business Activity Monitor Channel How to: Configure the iway Business Activity Monitor Channel iway Business Activity Monitor (BAM) is required to send s at various times. As a result, it leverages the iway Service Manager component. The component is included with the installation as an archive file and can be found in the archive folder as BAM Channel. Procedure: How to Configure the iway Business Activity Monitor Channel To configure the iway Business Activity Monitor Web channel. 1. In the iway Service Manager Administration Console, click Tools, and select Archive Manager in the left pane. 32 iway Software

33 2. Installing and Configuring iway Business Activity Monitor The Archive Manager pane opens, as shown in the following image. 2. Select Import components from a repository archive and click Next. 3. Select BAM channel and click Next. iway Business Activity Monitor User's Guide 33

34 Configuring the iway Business Activity Monitor Channel Once imported and deployed, the BAM channel is added to the list of available channels in the iway Service Manager Administration Console, as shown in the following image. 34 iway Software

35 2. Installing and Configuring iway Business Activity Monitor 4. Change the SMTP server settings by navigating to Registry, Registers, and opening the BAM register set. 5. Modify the BAM register set to reflect your settings for sending . Note: The default value can be used for the Admin register. However, all remaining registers should reflect the values suitable for sending s in your environment. For more information about using the correct values for these registers, contact your network administrator. 6. Once you have finished modifying the settings for the BAM register set, rebuild and redeploy the iway Business Activity Monitor Web channel (BAM channel). iway Business Activity Monitor User's Guide 35

36 Configuring the iway Business Activity Monitor Channel 36 iway Software

37 iway Configuring and Using iway Business Activity 3 Monitor This section describes how to configure and use iway Business Activity Monitor (BAM). Topics: Accessing the iway Business Activity Monitor Web Application Activity Management Administration Correlation Management Dashboard iway Business Activity Monitor User's Guide 37

38 Accessing the iway Business Activity Monitor Web Application Accessing the iway Business Activity Monitor Web Application How to: Access the iway Business Activity Monitor Web Application iway Business Activity Monitor (BAM) includes a Web application for monitoring, creating dashboards, and generating alerts/metrics. Procedure: How to Access the iway Business Activity Monitor Web Application To access the iway Business Activity Monitor (BAM) Web application: 1. Enter the following URL in your Web browser: The User Authentication logon page opens. 2. Enter admin as the user name (default) and iway as a password. 3. Click Login. 38 iway Software

39 3. Configuring and Using iway Business Activity Monitor The iway Business Activity Monitor Web application opens, as shown in the following image. Activity Management The various BAM facilities can be accessed by clicking the corresponding tabs at the top of the pane. The following sections describe the BAM facilities in more detail. In this section: Channel Activity EDI Activity Partner Activity Message Resubmission Using the Search Function Activity Management allows you to monitor activities at the iway Service Manager channel level. In the iway Business Activity Monitor (BAM) Web application, three tabs are provided in the Activity Management facility for configuration purposes: Channel Activity EDI Activity iway Business Activity Monitor User's Guide 39

40 Activity Management Partner Activity The following sections provide more information on each available tab in the Activity Management facility. Channel Activity The Channel Activity tab is used to display activities that are occurring within a channel. It provides the channel name, when the activity happened, and when the activity ended, Status information (completed, failed, active) is also provided. Users also can view the specific message with which the transaction was executed and the transaction history of that particular transaction. 40 iway Software

41 3. Configuring and Using iway Business Activity Monitor The following table lists and describes all the columns that are available in the Channel Activity tab of the Activity Management facility. Column Name Configuration Name Channel Name Protocol Start Time End Time Status Description The name of the BAM configuration that was provided during the MultiNode mode configuration. For more information, see Installing and Configuring iway Business Activity Monitor on page 15. The name of the channel on which the message is being executed. Displays the channel protocol. For example, if the channel protocol is a File listener, then File is listed in the Protocol column. If an Internal listener is used, then Internal is listed in the Protocol column. The start time is shown in GMT at which BAM logged the start time of the message. The end time is shown in GMT at which BAM logged the end time of the message. The message status is shown as a flag. A green flag indicates that the message execution has executed successfully. A red flag indicates that the message execution has failed. A blue flag indicates that the message execution status cannot be determined. An orange flag indicates that the message execution has started. Message Tx History The hyperlink opens the message with which the transaction was started. Shows the transaction history and transaction path of the given transaction. iway Business Activity Monitor User's Guide 41

42 Activity Management EDI Activity The EDI Activity tab is used to display EDI activities. These activities are automatically identified based on the Ebix that is configured for the specific channel in the iway Service Manager Administration Console. For example, the following channel (EDI_Capture) has three Ebixes attached: In this case, the EDI activities will be captured automatically and displayed under the EDI Activity tab. The following table lists and describes all the columns that are available in the EDI Activity tab of the Activity Management facility. Column Name EDI Type EDI Version Description Displayes the type of EDI document that is received (for example, X12). Displayes the version of the EDI document that is received (for example, 4010). 42 iway Software

43 3. Configuring and Using iway Business Activity Monitor Column Name Ack Status Description The acknowledgement status is shown as a flag. A green flag indicates that the message is accepted. A red flag indicates that the message is rejected. A blue flag indicates that the message is partially accepted. At least one transaction set was rejected. An orange flag indicates that the message is accepted, but an error condition exists. EDI Transaction ID Configuration Name Channel Name Start Time End Time Message Size (Bytes) Status Displays the EDI transaction ID of the EDI document that is received (for example, 850). The name of the BAM configuration that was provided during the MultiNode mode configuration. For more information, see Installing and Configuring iway Business Activity Monitor on page 15. The name of the channel on which the message is being executed. The start time is shown in GMT at which BAM logged the start time of the message. The end time is shown in GMT at which BAM logged the end time of the message. The size of the EDI message that is received. The message status is shown as a flag. A green flag indicates that the message execution has executed successfully. A red flag indicates that the message execution has failed. A blue flag indicates that the message execution status cannot be determined. An orange flag indicates that the message execution has started. iway Business Activity Monitor User's Guide 43

44 Activity Management Column Name Message Tx History Description The hyperlink opens the message with which the transaction was started. Shows the transaction history and transaction path of the given transaction. Partner Activity The Partner Activity tab is used to display the activity that is occuring for partners. This is useful for business users to know how many transactions were executed for a particular partner. Activities are captured only if the bam_tpm_partnerid and bam_tpm_partnername Special Registers (SREGs) are set. If these SREGs are not set, then the Partner Activity tab will be empty. For example, the following SREGs are set in a process flow service object. 44 iway Software

45 3. Configuring and Using iway Business Activity Monitor The following image shows the contents of the Partner Activity tab displayed in the iway Business Activity Monitor (BAM) Web application. The following table lists and describes all the columns that are available in the Partner Activity tab of the Activity Management facility. Column Name Partner Name Partner ID Configuration Name Channel Name Start Time Description Name of the partner as specified in the bam_tpm_partnername Special Register (SREG). Name of the partner as specified in the bam_tpm_partnerid Special Register (SREG). The name of the BAM configuration that was provided during the MultiNode mode configuration. For more information, see Installing and Configuring iway Business Activity Monitor on page 15. The name of the channel on which the message is being executed. The start time is shown in GMT at which BAM logged the start time of the message. iway Business Activity Monitor User's Guide 45

46 Activity Management Column Name End Time Status Description The end time is shown in GMT at which BAM logged the end time of the message. The message status is shown as a flag. A green flag indicates that the message execution has executed successfully. A red flag indicates that the message execution has failed. A blue flag indicates that the message execution status cannot be determined. An orange flag indicates that the message execution has started. Message Tx History The hyperlink opens the message with which the transaction was started. Shows the transaction history and transaction path of the given transaction. Message Resubmission Message resubmission allows a message to be retrieved for a particular transaction. It returns the message to be retrieved for a transaction with which it was run. Click View in the Message column for a corresponding transaction. 46 iway Software

47 3. Configuring and Using iway Business Activity Monitor The following dialog box opens, which shows the message that the selected transaction used to execute. You can can provide a file name with which this document needs to be saved as and also change the document content as displayed. Click Resubmit Message once you are ready. The document will be made available under the following directory: iway_home\etc\bam\resubmit where: iway_home Is the directory where iway Service Manager is installed. The document is now available (for example, to run in a process flow). Additional logic to use the document must be designed accordingly, but in most cases the logic can involve moving the document from this directory to another. iway Business Activity Monitor User's Guide 47

48 Activity Management Using the Search Function Search functionality is provided in all Activity Management facility tabs to filter the desired results. Provide search criteria in the corresponding fields and click Search to display only the filtered records based on the search criteria. Click Reset to remove the selected search criteria and show all the records. The following table lists and describes all the search fields that are available. Field Name Choose Channel Protocol Entry Time Date From Hr Min Date To Hr Min Group Result Description Allows data filtering based on a specific channel name. Chanel data is displayed for which BAM has collected the data. Allows searching based on the protocol type that is used in the channel (for example, Internal, File). Time at which the message was first monitored on iway Service Manager. Date since the message was processed. Hour from which the message starts to be monitored. Minutes from which the message starts to be monitored. Date range up to which the message needs to be filtered. Hour up to which the message needs to be filtered. Minute up to which the message needs to be filtered. Group search result, which allows the message to be filtered. 48 iway Software

49 3. Configuring and Using iway Business Activity Monitor Administration In this section: User Management Role Management The Administration tab allows users with administrator privileges to create users who can access a iway Business Activity Monitor (BAM) application. User Management The User tab allows administrators to manage existing users or add new users. Added users are associated with specific roles that have been assigned to them. After logging into the iway Business Activity Monitor Web application, each user is granted with the privileges that their role allows. iway Business Activity Monitor User's Guide 49

50 Administration Role Management The Role tab allows administrators to manage existing roles or create new roles for users. Existing roles means providing access to the current modules that are listed in the BAM User Role dialog box, as shown in the following image. 50 iway Software

51 3. Configuring and Using iway Business Activity Monitor Once a role is configured for a user, this user will only have access to the specific modules that have been assigned after logging into the iway Business Activity Monitor Web application. Correlation Management Correlation Management allows users to correlate long running processes or processes made up of multiple sub processes. iway Business Activity Monitor User's Guide 51

52 Correlation Management This facility can also be used in conjunction with correlation agents, which can be used to create a process correlation that is displayed in the Correlation Management tab. The following table lists and describes all the columns that are available in the Correlation Management tab. Column Name Correlation ID State Description The correlation ID, which is unique across all available correlations. State of the correlation, which can be one of the following: Close - The correlation is closed and no further action will be taken. Open - The correlation is still open. Anticipation - The correlation state cannot be determined. Last Update Time Last Update Tx ID Expiration Time Tx Details The last time when the correlation was updated. The last transaction that updated this correlation. The time at which the correlation will expire. The transaction that was associated as part of the correlation. 52 iway Software

53 3. Configuring and Using iway Business Activity Monitor Dashboard The Dashboard tab allows users to receive real-time system information. The dashboard consists of tabs, which include widgets. The Add Widgets option is disabled by default and can only be enabled only when a user adds a tab. The dashboard consists of many tabs. Each tab can have a different layout depending on the number of widgets that need to be rendered. The Column Layout drop-down list provides the following options: 1 Column Layout (Fill entire tab with one Widget - Only one widget can be displayed, which is useful for rendering reports. 2 Column Layout - Two widgets can be displayed in two columns. 3 Column Layout - Three widgets can be displayed in three columns. iway Business Activity Monitor User's Guide 53

54 Dashboard Widgets can be added to any tab in the dashboard. Click the Add Widgets button in the Dashboard tab. The following types of widgets are available: URL Widget - Contains only the URL content. Chart Widget - Contains metrics as a chart. Pre Defined Widget - Contains pre-defined metrics charts. These are quick charts, which can be added to the tabs in the iway Business Activity Monitor Web application. Enable Widget - Contains portlets defined in iway Enable that can be rendered as tabs in the iway Business Activity Monitor Web application. 54 iway Software

55 iway Reader Comments In an ongoing effort to produce effective documentation, the Documentation Services staff at Information Builders welcomes any opinion you can offer regarding this manual. Please use this form to relay suggestions for improving this publication or to alert us to corrections. Identify specific pages where applicable. You can contact us through the following methods: Mail: Fax: Web form: Name: Company: Address: Telephone: Comments: Documentation Services - Customer Support Information Builders, Inc. Two Penn Plaza New York, NY (212) books_info@ibi.com Date: Information Builders, Two Penn Plaza, New York, NY (212) iway Business Activity Monitor User's Guide DN Version Service Manager (SM)

56 Reader Comments Information Builders, Two Penn Plaza, New York, NY (212) iway Business Activity Monitor User's Guide DN Version Service Manager (SM)