Download iWay Enable Getting Started Guide

iWay iWay Enable Getting Started iWay Enable Version 1.0 (Compatible With iWay Service Manager Version 5.6)

DN3501938.0609

EDA, EDA/SQL, FIDEL, FOCCALC, FOCUS, FOCUS Fusion, FOCUS Vision, Hospital-Trac, Information Builders, the Information Builders logo, Parlay, PC/FOCUS, SmartMart, SmartMode, SNAPpack, TableTalk, WALDO, Web390, WebFOCUS and WorldMART are registered trademarks, and iWay and iWay Software are trademarks 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.

iWay

Contents Preface................................................................................................................5 Documentation Conventions..............................................................................................6 Related Publications..........................................................................................................7 Customer Support.............................................................................................................7 Help Us to Serve You Better...............................................................................................7 User Feedback................................................................................................................10 iWay Software Training and Professional Services..............................................................10

1. About Your Getting Started Manual..............................................................11 Where Do I Go First?.......................................................................................................12 Capturing Real-Time encoding="ISO-8859-1" ?> status false 1 XPATH(/SALES/TRANSACTION) 2009-05-06T21:18:09.794Z 0 5 success

Notice that the element tag indicates success and the element tag has a value of 5. This value indicates that five iterations were performed. The process flow you configured earlier in iWay Designer (sales.process) uses an Iterator object (Loop Transactions) and a File object (Tap encoding="ISO-8859-1" ?> 1 US 5 50

For example, sale_0002.xml has the following contents: 2 EU 5 100

If you have received the same results that are described in this section, your new channel (sales.channel) has been tested successfully and is fully operational.

iWay Enable Getting Started

79

Channel Procedures

80

iWay Software

iWay

5

Configuring Taps

This section describes how to configure the taps that were generated by the process flow that you created earlier using iWay Designer.


Topics: Tap Configuration Procedure

81

Tap Configuration Procedure

Tap Configuration Procedure How to: Configure Taps Two iWay Enable taps were generated by the process flow you created earlier using iWay Designer: sales.process.tap1 sales.process.tap2 You must now configure these taps using the iWay Enable facilities in the iWay Service Manager Administration Console. By default, the taps are not activated and do not contain any expressions. Each tap can expose any number of events based on the conditional expressions and business logic being used. The use of the _expose() function allows the tap to create business events which will store the time stamped data for each occurrence. Note: The following procedure describes how to configure the sales.process.tap1 tap. The configuration of the sales.process.tap2 tap is described in a later section, which will demonstrate the importance of updating taps in real-time without having to create new objects or recompile existing components.

Procedure: How to Configure Taps To configure iWay Enable taps: 1. Click Tools in the top pane of the iWay Service Manager Administration Console.

The iWay Service Manager Tools pane opens.

2. In the left pane, select Views under the Real-time section.

82

iWay Software

5. Configuring Taps The Views pane opens, as shown in the following image.

The Views pane is used to define and organize iWay Enable data and metadata. For example, key business objectives can be monitored by tapping and analyzing events. 3. Select the sales.process.tap1 tap in the Name column.

4. Right-click the sales.process.tap1 tap and select Edit IFL (iWay Functional Language) from the context menu.


83

Tap Configuration Procedure The Edit IFL Expression dialog box opens.

5. Enter the following expression in the top section of the Edit IFL Expression dialog box: _if(_contains(_ucase(XPATH(TRANSACTION/Region)),EU), _expose(sales.eu.sale,XPATH(/TRANSACTION/SalePrice),db,int),_if(_contains (_ucase(XPATH(TRANSACTION/Region)),US),_expose(sales.us.sale,XPATH (/TRANSACTION/SalePrice),db,int)))

84

iWay Software

5. Configuring Taps This expression indicates that we are checking if the Region value within the sales transaction is EU, and if so, we will expose the SalePrice value to the sales.eu.sale event. Otherwise, if the transaction is for the US region, we will expose the SalePrice value to the sales.us.sale event. This will keep track of the SalePrice per Region, allowing us to compare the real-time total sales for the two regions. 6. Click save. You are returned to the Views pane, where the new expression is now added to the Expression column for the sales.process.tap1 tap.

Note: You may need to refresh your Web browser after the expression is saved. 7. Select the check box next to the sales.process.tap1 tap to activate this tap.

You are now able to tap into incoming data through the process flow (sales.process) that was configured earlier and generate business events. The events will be associated with real-time feeds, ready to be incorporated into dashboards, composite applications, and other components.


85

Tap Configuration Procedure

86

iWay Software

iWay

6

Generating Events

This section describes how to generate two business events for the sample application.


Topics: Event Generation Procedure

87

Event Generation Procedure

Event Generation Procedure How to: Generate Events This procedure describes how to run the channel (sales.channel) by copying the sample input batch transaction (SalesTransactions.xml) into the incoming folder. This will execute the process flow (sales.process), and as the sales.process.tap1 tap is hit for every transaction, the conditional expression that was provided for the tap is evaluated and two business events are generated.

Procedure: How to Generate Events To generate events: 1. On your file system, copy the SalesTransactions.xml file that was created earlier into the following input directory: C:\Sales_Demo\sales_data\in

2. Click Tools in the top pane of the iWay Service Manager Administration Console.



88

iWay Software

6. Generating Events The Views pane opens, as shown in the following image.

4. Click the Events tab. The contents of the Events tab are displayed, as shown in the following image.


89

Event Generation Procedure 5. Scroll down the list until you find the following events: sales.eu.sale sales.us.sale Initially, the sales.eu.sale and sales.us.sale events do not have any associated feeds. Feeds represent the next phase in the iWay Enable configuration process where possible calculations are performed on events and the information is exposed to available applications. Now that real-time data is being captured as the transactions pass through the process flow (sales.process), this data can be used to create feeds, which can serve data being updated during real-time to a Web application. A feed can be created either through the register sets or as shown in this example, it can be generated automatically using a gauge and chart configuration facility. Under the Resources section, there is an option to select and configure various gauges and charts, which are packaged with iWay Enable and can be configured visually.

90

iWay Software

iWay

7

Creating a Graphical Chart

This section describes how to create a graphical chart for the sample application.


Topics: Graphical Chart Creation Procedure

91

Graphical Chart Creation Procedure

Graphical Chart Creation Procedure How to: Create a Graphical Chart An extensive collection of gauges and charts is packaged with iWay Enable that can be configured to render business data through feeds. Each gauge or chart contains various configuration options, depending on its type. After a gauge or chart is configured, it can be saved, which will generate a portlet that can be executed.

Procedure: How to Create a Graphical Chart To create a graphical chart: 1. Click Tools in the top pane of the iWay Service Manager Administration Console.


2. In the left pane, select Resources under the Real-time section.

92

iWay Software

7. Creating a Graphical Chart The Resources pane opens and displays the Gauges tab by default, as shown in the following image.

The Resources pane is used to define the visualization aspects of an iWay Enable application. A collection of gauges and charts, which can be configured and hosted as portlets, are ready to be incorporated into dashboards and composite applications. In this iWay Enable application, sales data for the EU and US regions will be monitored. 3. Click the Charts tab. The Charts tab opens and displays the available charts that can be configured, as shown in the following image.


93

Graphical Chart Creation Procedure 4. Click the Real Time Line chart.

The Real Time Line Chart configuration pane opens, as shown in the following image. A visual representation of the selected chart (for example, Real Time Line) is displayed on the left. There are five configuration tabs (Sources, Data, Labels, Visuals, and Extras) located on the right. By default, the Sources tab is selected.

94

iWay Software

7. Creating a Graphical Chart 5. In the Interval field, enter a value of 2, which indicates that the chart will update every two seconds.

6. Click Update. 7. Click the Data tab.

The Data tab is used to specify what events will be used to feed the data. Since more than one event will be monitored using the Real Time Line chart, you must manually type in the events instead of selecting a single event from the Events drop down list. 8. Provide the configuration properties, as defined in the following table. Parameter

Value

Events

sales.eu.sale|sales.us.sale

Aggregation

SUM

History

600000 (Default)


95

Graphical Chart Creation Procedure

Parameter

Value

Data Range

10 (Default)

9. Click Update. 10. Click the Labels tab.

11. Provide labels that will be used to identify the data in the Real Time Line chart, as defined in the following table.

96

Parameter

Value

Title

Total Sales

Subtitle

Europe vs. US

iWay Software

7. Creating a Graphical Chart

Parameter

Value

X Axis Name

Time Line

Y Axis Name

Sales

Notice that as you type values in the various label fields, the chart on the left updates to reflect the new data you entered.

12. Click Update. Optionally, you can continue to modify additional visual elements for the Real Time Line chart (for example, Theme, Background, or Style) by selecting the Visuals tab. The Extras tab can also be used to adjust the visual representation of the Real Time Line chart. For example, you can choose to show/hide the border, legend, current value, and the individual data points. Once the Real Time Line chart is configured and meets your requirements, there are several additional options available, which include generating a JASON object, XML, or saving the configured chart to create a portlet. 13. Click Save.


97

Graphical Chart Creation Procedure The Save as Portlet dialog box opens.

14. In the Name field, type TotalSalesGraph. 15. From the Type drop-down list, select Windowed, which indicates that a pop-up window will be used to display this portlet. 16. Click OK. You are returned to the main Resources pane where the Portlets tab is now selected.

The new Real Time Line chart (TotalSalesGraph) is now added to the table.

17. Right-click TotalSalesGraph and select View from the context menu. As a shortcut, you can also double-click the chart name.

98

iWay Software

7. Creating a Graphical Chart The TotalSalesGraph window opens and displays the Real Time Line chart you configured.

The Real Time Line chart contains two horizontal lines, which represent the earlier runs of data (EU and US sales). This data will be updated using the two second interval that was configured. You can also click the name of the chart in the title bar to view the chart in full-screen mode. 18. On your file system, copy the SalesTransactions.xml file that was created earlier into the following input directory: C:\Sales_Demo\sales_data\in


99

Graphical Chart Creation Procedure The Real Time Line chart will update in a few seconds to reflect new data.

Note that the use of gauges and charts is not required to generate feeds, since feeds can also be generated by creating a register set with the appropriate feed syntax.

100

iWay Software

iWay

8

Updating Taps

This section describes how to update taps for the sample application.

Topics: Tap Update Procedure


101

Tap Update Procedure

Tap Update Procedure How to: Update Taps A key part of any business process is the ability to modify or enable data capture at any point in time. A process flow can contain independent taps that are not configured initially with a specific expression. This allows you to modify or activate any tap using the iWay Service Manager Administration Console without having to go back to iWay Designer to modify the original process flow. As a result, you can have multiple deactivated taps in a process flow that serve as placeholders for future use. If the data capture requirement changes or there is a need to monitor more data, these taps can be activated accordingly.

Procedure: How to Update Taps To update taps: 1. Click Tools in the top pane of the iWay Service Manager Administration Console.



102

iWay Software

8. Updating Taps The Views pane opens, as shown in the following image.

3. Select the sales.process.tap2 tap in the Name column.

Note: The sales.process.tap2 tap was created earlier, but not configured. 4. Right-click the sales.process.tap2 tap and select Edit IFL (iWay Functional Language) from the context menu.


103

Tap Update Procedure The Edit IFL Expression dialog box opens.

5. Enter the following expression in the top section of the Edit IFL Expression dialog box: _if(_contains(XPATH(TRANSACTION/ProductID),1),_expose (sales.quantity.product1,XPATH(/TRANSACTION/Quantity),db,int),_if (_contains(XPATH(TRANSACTION/ProductID),2),_expose(sales.quantity.product2, XPATH(/TRANSACTION/Quantity),db,int),_if(_contains(XPATH(TRANSACTION/ ProductID),3),_expose(sales.quantity.product3,XPATH(/TRANSACTION/ Quantity),db,int))))

104

iWay Software

8. Updating Taps This expression allows you to capture the quantity sold for each product. Using iFL (iWay Functional Language) notation, the expression checks if the ProductID is 1. If this condition is met, the expression exposes the Quantity sold to the sales.quantity.product1 event. If the ProductID is 2, then the expression exposes its Quantity to the sales.quantity.product2 event. Finally, if the ProductID is 3, then the expression exposes the sales.quantity.product3 event. 6. Click save. You are returned to the Views pane, where the new expression is now added to the Expression column for the sales.process.tap2 tap.

Note: You may need to refresh your Web browser after the expression is saved. 7. Select the check box next to the sales.process.tap2 tap to activate this tap.

You are now able to tap into additional data through the process flow (sales.process) that was configured earlier and generate business events. As the process flow is processing the batched sales transactions, it is triggering the sales.process.tap2 tap, which runs the corresponding expression. As a result, three events are now generated for three product types, which are being processed. 8. On your file system, copy the SalesTransactions.xml file that was created earlier into the following input directory: C:\Sales_Demo\sales_data\in

9. Click Tools in the top pane of the iWay Service Manager Administration Console.


105

Tap Update Procedure The iWay Service Manager Tools pane opens.

10. In the left pane, select Views under the Real-time section. The Views pane opens, as shown in the following image.

11. Click the Events tab.

106

iWay Software

8. Updating Taps The contents of the Events tab are displayed, as shown in the following image.

12. Scroll down the list until you find the following events: sales.quantity.product1 sales.quantity.product2 sales.quantity.product3 Note: The new events do not have any associated feeds. However, the previously created events that are already used in the Real Time Line chart do have a default enable feed associated with them as well as the enable.sales.total.graph feed, which was created automatically by the chart. 13. Click Tools in the top pane of the iWay Service Manager Administration Console.


107

Tap Update Procedure The iWay Service Manager Tools pane opens.

14. In the left pane, select Resources under the Real-time section. The Resources pane opens and displays the Gauges tab by default, as shown in the following image.

15. Click the Charts tab.

108

iWay Software

8. Updating Taps The Charts tab opens and displays the available charts that can be configured, as shown in the following image.

16. Click the Real Time Column chart.


109

Tap Update Procedure The Real Time Column Chart configuration pane opens, as shown in the following image. A visual representation of the selected chart (for example, Real Time Column) is displayed on the left. There are five configuration tabs (Sources, Data, Labels, Visuals, and Extras) located on the right. By default, the Sources tab is selected.

17. In the Interval field, enter a value of 2, which indicates that the chart will update every two seconds.

18. Click Update.

110

iWay Software

8. Updating Taps 19. Click the Data tab.

The Data tab is used to specify what events will be used to feed the data. Since more than one event will be monitored using the Real Time Line chart, you must manually type in the events instead of selecting a single event from the Events drop down list. 20. Provide the configuration properties, as defined in the following table. Parameter

Value

Events

sales.quantity.product1|sales.quantity.product2|sales.quantity.product3

Aggregation

SUM

History

600000 (Default)

Data Range

5


111

Tap Update Procedure 21. Click Update. 22. Click the Labels tab.

23. Provide labels that will be used to identify the data in the Real Time Line chart, as defined in the following table.

112

Parameter

Value

Title

Product Sales

Subtitle

Comparative Sales

X Axis Name

Time Line

Y Axis Name

Total Sales

iWay Software

8. Updating Taps Notice that as you type values in the various label fields, the chart on the left updates to reflect the new data you entered.

24. Click Update and then Save. The Save as Portlet dialog box opens.

25. In the Name field, type ProductSalesGraph. 26. From the Type drop-down list, select Windowed, which indicates that a pop-up window will be used to display this portlet. 27. Click OK.


113

Tap Update Procedure You are returned to the main Resources pane where the Portlets tab is now selected.

The new Real Time Column chart (ProductSalesGraph) is now added to the table.

28. Right-click ProductSalesGraph and select View from the context menu. As a shortcut, you can also double-click the chart name.

114

iWay Software

8. Updating Taps The ProductSalesGraph window opens and displays the Real Time Column chart you configured.

The Real Time Column chart contains multiple vertical columns, which represent the earlier runs of data (total product sales). This data will be updated using the two second interval that was configured. You can also click the name of the chart in the title bar to view the chart in full-screen mode. 29. On your file system, copy the SalesTransactions.xml file that was created earlier into the following input directory: C:\Sales_Demo\sales_data\in


115

Tap Update Procedure The Real Time Column chart will update in a few seconds to reflect new data.

116

iWay Software

iWay

9

Enabling and Viewing Feeds

This section describes how to enable and view feeds for the sample application.


Topics: Enabling and Viewing Feeds Procedure

117

Enabling and Viewing Feeds Procedure

Enabling and Viewing Feeds Procedure How to: Enable and View Feeds When configured, feeds can perform any required calculations on the event data and present it to the external or internal application with real-time updates. Feeds can be configured by using iWay Special Registers (SREGs) or by creating a fully configured gauge or chart and a corresponding portlet. Any configuration process will allow the feed data to be accessible by Web applications. Any data that is displayed on a gauge or chart is represented by a feed. In the iWay Enable sample application, two graphs are created and two feeds are automatically generated as a result.

Procedure: How to Enable and View Feeds To enable and view feeds: 1. Click Tools in the top pane of the iWay Service Manager Administration Console.



118

iWay Software

9. Enabling and Viewing Feeds The Views pane opens, as shown in the following image.

3. Click the Feeds tab. The Feeds tab opens, as shown in the following image.

You can view the available feeds, including the two feeds that were automatically generated during the configuration of the iWay Enable sample application (enable.sales.product.graph and enable.sales.total.graph). The naming convention used by automatically generated feeds is enable.PortletName

where: PortletName

Is the name of the portlet.


119

Enabling and Viewing Feeds Procedure In the Usage column, the expression used by a feed can also be viewed. For example, you can see that the enable.sales.total.graph feed, which is used by the TotalSalesGraph portlet, is an update of the summation for the sales.eu.sale and sales.us.sale events within a one-minute interval. 4. Right-click an available feed (for example, enable.sales.total.graph) and select View feed from the context menu. The enable.sales.total.graph window opens and displays the current data in real time, which is represented by the feed information.

The URL representation for this feed can be used by any external application to access real-time data being captured by this process. The following is a sample URL for the enable.sales.total.graph feed, which was created by the TotalSalesGraph portlet: http://localhost:9999/ism/enable-dat?regs=enable.sales.total.graph

The above feed represents the label parameter, which contains values for the x-axis timeline and the value parameter, which represents the corresponding data for the two monitored events. This string can be parsed by a Web application and updated with each URL request as a result. As feeds are represented as registers within the system, they can also be views under the Registers section of the iSM Console.

120

iWay Software

9. Enabling and Viewing Feeds 5. Click Registry in the top pane of the iWay Service Manager Administration Console.

The iWay Service Manager Registry pane opens.

6. In the left pane, select Registers under the Variables section. The Registers pane opens, as shown in the following image.

The table that is provided lists any existing register sets and a short description for each. 7. Click the enable register set link.


121

Enabling and Viewing Feeds Procedure The Registers / enable pane opens.

All the feeds that were automatically generated are stored within the enable register set. The f[] annotation for the generated feeds indicates that this register is used as a feed. For example: f[enable.sales.product.graph] f[enable.sales.total.graph]

122

iWay Software

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:

Documentation Services - Customer Support Information Builders, Inc. Two Penn Plaza New York, NY 10121-2898

Fax:

(212) 967-0460

E-mail:

[email protected]

Web form:

http://www.informationbuilders.com/bookstore/derf.html

Name: Company: Address: Telephone:

Date:

Email: Comments:

Information Builders, Two Penn Plaza, New York, NY 10121-2898 iWay Enable Getting Started iWay Enable Version 1.0 (Compatible With iWay Service Manager Version 5.6)

(212) 736-4433 DN3501938.0609

Reader Comments

Information Builders, Two Penn Plaza, New York, NY 10121-2898 iWay Enable Getting Started iWay Enable Version 1.0 (Compatible With iWay Service Manager Version 5.6)

(212) 736-4433 DN3501938.0609