Using Two-Way Email: Version 7 Release 7

Using Two-Way Email
Version 7 Release 7
DN4501032.0510
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 DataMigrator and Magnify are trademark of Information Builders, Inc. Adobe, the Adobe logo, Acrobat, Adobe Reader, Flash, Flex, and PostScript are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. 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 publishers 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 2010, 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.
WebFOCUS
Contents
Preface................................................................................................................5
Documentation Conventions..............................................................................................6 Related Publications..........................................................................................................7 Customer Support.............................................................................................................7 Information You Should Have.............................................................................................8 User Feedback..................................................................................................................9 Information Builders Consulting and Training.......................................................................9
1. Using Two-Way Email.....................................................................................11

Two-Way Email User Steps...............................................................................................12 Subscribing for the First Time...........................................................................................12 Replying to the Confirmation Message..............................................................................15 Receiving Your Templates for the First Time......................................................................16 Requesting a Report........................................................................................................17 Examples of Requesting a Report and Accepting the Default Value of a Parameter.......18 Updating Your Subscription Information............................................................................20 Responding to an Alert....................................................................................................25
2. Two-Way Email Administration.......................................................................29

Accessing the Administrator Console................................................................................30 Adding or Deleting a Subscriber........................................................................................31 Maintaining an E-mail Address.........................................................................................33 Refreshing User Templates..............................................................................................34 Using the Job Log............................................................................................................35 Viewing the Status of an Executed Job......................................................................35 Purging the Job Log.................................................................................................37 Using the Event Log........................................................................................................38 Monitoring E-mail Traffic...........................................................................................40 Purging the Event Log..............................................................................................42 Checking the Status of a Job or Canceling a Job................................................................43
Using Two-Way Email
Contents
3. Developing a Two-Way Email Template..........................................................45

How Two-Way Email Works...............................................................................................46 Subscription and Confirmation Processing.................................................................47 Report Request Processing......................................................................................48 Secured Message Delivery.......................................................................................49 Security in the Subscription and Confirmation Procedure............................................49 Security in the Report Request Procedure..................................................................49 Error Account..........................................................................................................49 Report Display Considerations..................................................................................50 Alert Response........................................................................................................51 Creating a Template........................................................................................................51 Maintaining a Template...................................................................................................64 Sending a Template to Users...........................................................................................67 Attaching a Two-Way Email Template to an Alert................................................................68
Reader Comments.............................................................................................73
WebFOCUS
WebFOCUS
Preface
This documentation describes how Two-Way Email enables mobile business professionals to receive WebFOCUS reports through e-mail, using a handheld device, laptop, or desktop. It is intended for end users, administrators, and developers. Note: The WebFOCUS toolset generates the rich FOCUS fourth generation language. While this language is very extensive, the WebFOCUS toolset only supports a subset of the language and only specific syntax constructs. While the user can manually modify the content of these WebFOCUS procedures/files, there is no guarantee that the user will be able to open the modified procedure in the tool.
How This Manual Is Organized

This manual includes the following chapters: Chapter/Appendix 1 Using Two-Way Email Contents Explains the steps that a user performs to enable the Two-Way Email capability. Also describes what a template looks like, and how to use one to request a report. Addresses the alert response for those sites that have licensed and installed both ReportCaster and Two-Way Email. Describes how to use the Two-Way Email Administrator console to monitor the execution of report requests, cancel requests, and perform other administrative tasks. Describes Two-Way Email processing steps to help Administrators and Developers understand the tasks and oversee the Two-Way Email capability. It also includes instructions on how to create and maintain templates.
Two-Way Email Administration
Developing a Two-Way Email Template
Using Two-Way Email
Documentation Conventions
Documentation Conventions
The following table lists and describes the conventions that apply in this manual. Convention
THIS TYPEFACE
Description Denotes syntax that you must enter exactly as shown.
or
this typeface this typeface
Represents a placeholder (or variable) in syntax for a value that you or the system must supply. Indicates a default setting. Represents a placeholder (or variable), a cross-reference, or an important term. It may also indicate a button, menu item, or dialog box option you can click or select. 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. Indicates a group of optional parameters. None are required, but you may select one of them. Type only the parameter in the brackets, not the brackets. 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.
underscore
this typeface
this typeface Key + Key

{ [ } ]
...
. . .
WebFOCUS
Preface
Related Publications
To view a current listing of our publications and to place an order, visit our Technical Documentation Library, http://documentation.informationbuilders.com. You can also contact the Publications Order Department at (800) 969-4636.
Customer Support
Do you have any questions about this product? Join the Focal Point community. Focal Point is our online developer center and more than a message board. It is an interactive network of more than 3,000 developers from almost every profession and industry, collaborating on solutions and sharing tips and techniques, http://forums.informationbuilders.com/eve/forums. You can also access support services electronically, 24 hours a day, with InfoResponse Online. InfoResponse Online is accessible through our World Wide Web site, http://www.informationbuilders.com. It connects you 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 of www.informationbuilders.com also provides usage techniques, diagnostic tips, and answers to frequently asked questions. Call Information Builders Customer Support Service (CSS) at (800) 736-6130 or (212) 7366130. 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. Please be ready to provide your six-digit site code number (xxxx.xx) when you call. To learn about the full range of available support services, ask your Information Builders representative about InfoResponse Online, or call (800) 969-INFO.
Using Two-Way Email
Information You Should Have
Information You Should Have

To help our consultants answer your questions effectively, be prepared to provide the following information when you call: Your six-digit site code (xxxx.xx). Your WebFOCUS configuration: The front-end you are using, including vendor and release. The communications protocol (for example, TCP/IP or HLLAPI), including vendor and release. The software release. Your server version and release. You can find this information using the Version option in the Web Console. The stored procedure (preferably with line numbers) or SQL statements being used in server access. The Master File and Access File. The exact nature of the problem: Are the results or the format incorrect? Are the text or calculations missing or misplaced? The error message and return code, if applicable. Is this related to any other problem? Has the procedure or query ever worked in its present form? Has it been changed recently? How often does the problem occur? What release of the operating system are you using? Has it, your security system, communications protocol, or front-end software changed? Is this problem reproducible? If so, how? Have you tried to reproduce your problem in the simplest form possible? For example, if you are having problems joining two data sources, have you tried executing a query containing just the code to access the data source? Do you have a trace file? How is the problem affecting your business? Is it halting development or production? Do you just have questions about functionality or documentation?
WebFOCUS
Preface
User Feedback
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 use the Documentation Feedback form on our Web site, http://documentation.informationbuilders.com/feedback.asp. Thank you, in advance, for your comments.
Information Builders Consulting and Training

Interested in training? Information Builders Education Department offers a wide variety of training courses for this and other Information Builders products. For information on course descriptions, locations, and dates, or to register for classes, visit our World Wide Web site (http://www.informationbuilders.com) or call (800) 969-INFO to speak to an Education Representative.
Using Two-Way Email
Information Builders Consulting and Training
10
WebFOCUS
WebFOCUS
Using Two-Way Email
Two-Way Email enables mobile business professionals to request and receive WebFOCUS reports through e-mail, using a handheld device, laptop, or desktop. From any location, at any time, users have access to their company's enterprise data. To request a report, a user simply replies to and sends an e-mail that contains a Two-Way Email template. A template is the means by which a request is made and parameter values are supplied if required. A Managed Reporting Administrator or Developer creates and maintains templates for a user. This topic explains the steps a user performs to enable the Two-Way Email capability. It also describes how a template looks, and how to use one to request a report. Finally, it addresses alert response for those sites that have licensed and installed both ReportCaster and Two-Way Email.
Topics:
Two-Way Email User Steps Subscribing for the First Time Replying to the Confirmation Message Receiving Your Templates for the First Time Requesting a Report Updating Your Subscription Information Responding to an Alert
Using Two-Way Email
11
Two-Way Email User Steps
Two-Way Email User Steps

As a user, perform the following steps to enable Two-Way Email: 1. Subscribe to Two-Way Email by accessing and supplying information on an HTML subscription page. For more information, see Subscribing for the First Time on page 12. You can also ask your Managed Reporting Administrator to subscribe you from the TwoWay Email Administrator console. 2. Reply to the confirmation message sent by Two-Way Email. This message acknowledges your subscription request and validates your Reply-To e-mail address. For more information, see Replying to the Confirmation Message on page 15. 3. Receive and store your Two-Way Email templates in your inbox, or in a folder on your e-mail program. The Managed Reporting Administrator or Developer creates these templates for your use. Each template is associated with a Managed Reporting Standard Report of interest to you. For more information, see Receiving Your Templates for the First Time on page 16. 4. Request a report simply by selecting, replying to, and sending a template. For more information, see Requesting a Report on page 17. 5. Update your subscription information if it changes. For more information, see Updating Your Subscription Information on page 20.
Subscribing for the First Time

How to: Subscribe for the First Time Two-Way Email provides a subscription page accessed from a Web browser. You can display the subscription page on your desktop, laptop, or any handheld device that supports the Web. Use the subscription page to independently subscribe to Two-Way Email for the first time. On the subscription page, you must supply a valid Managed Reporting user ID and password. You must also supply a WebFOCUS Reporting Server user ID and password, unless they are stored for you on the server. If you do not know the required security information, ask your Managed Reporting Administrator for it. After you subscribe, you receive a confirmation message through e-mail. After you reply to it, Two-Way Email sends you all the templates you are authorized to use.
12
WebFOCUS
1. Using Two-Way Email
Procedure: How to Subscribe for the First Time

1. Your site has a Web address for the Two-Way Email subscription page. Ask your Managed Reporting Administrator for the address if you do not know it. From your browser, access the subscription page by entering the Web address. For example,
http://hostname[:port]/rc_context_root/twoway/mobile/twoway.htm
where:
hostname[:port]
Is the host name and optional port number (specified only if you are not using the default port number) of the Application Server where the ReportCaster Web application is deployed.
rc_context_root
Is the site-customized context root for the ReportCaster Web application deployed on your Application Server. The default value is rcaster. 2. Type your Managed Reporting user ID and password as assigned by the Managed Reporting Administrator. 3. Click Subscribing to Two-Way Email for the first time, as shown in the following image.
4. Click Continue.
Using Two-Way Email
13
Subscribing for the First Time A dialog box similar to the following image opens.
5. If applicable at your site, select Default to use the WebFOCUS Reporting Server user ID and password stored for you on that server. Otherwise, enter your security credentials for the WebFOCUS Reporting Server. 6. Type your e-mail address. Two-Way Email will use this address to send you Two-Way Email templates and WebFOCUS reports when you request them. The syntax is:
name@domain
where:
name
Is your e-mail user name.

domain
Is the domain name. Note: You must include the character @. 7. Click Add me to add your new subscription.
14
WebFOCUS
1. Using Two-Way Email A message informs you that Two-Way Email added your address to the database as shown in the following image.
8. You have the opportunity to add another e-mail address to your subscription information, or to view the information already supplied. To do so, click Continue. 9. Close the Two-Way Email window when you are done.
Replying to the Confirmation Message

How to: Reply to the Confirmation Message After receiving your subscription request and validating your security credentials, Two-Way Email sends you a confirmation message through e-mail, acknowledging your request and confirming that it has your correct e-mail address.
Using Two-Way Email
15
Receiving Your Templates for the First Time
Procedure: How to Reply to the Confirmation Message

1. Check your mailbox for a message from Two-Way Email. Open the confirmation message when it arrives. A window similar to the following opens.
2. As prompted, reply to the e-mail. Type your Managed Reporting user ID on the first line of the reply. If your device or program has an option to include the body of the e-mail (for example, Reply with Text or Include Original Text), select it. This option ensures that the content of the template is included in the reply. Two-Way Email requires the content to process the reply correctly. 3. Click Send to send your reply to Two-Way Email.
Receiving Your Templates for the First Time

After you subscribe for the first time and reply to the confirmation message, Two-Way Email sends you all the templates you are authorized to use for your reporting needs. Check your mailbox for their delivery. When they arrive, store them in your inbox, or in a folder on your e-mail program.
16
WebFOCUS
Requesting a Report
In this section: Examples of Requesting a Report and Accepting the Default Value of a Parameter How to: Request a Report After you receive and store your templates, you can request a WebFOCUS report. A template is the means by which you request a report and supply parameter values if required. A Two-Way Email template contains information about the associated report. It may also prompt you for one or more parameter values that define the scope of the report. If a template prompts you for a value, you must supply one; otherwise, the report will not run. A report template may request an update to a data source rather than a report. The following is a sample template requesting a report:
Enter a product category on line 1 of your reply. Valid product categories are Coffee, Food, Gifts. ---------<TWOWAY> YXBwL3RvdGFscmV0LnR4dCwjdGVsbG1ldGVzdHNuLHByb2dyYW1tL3By b2dyYW1tLmh0bSwwLjE4OTQ5NTI3NDE0NjIxMDky </TWOWAY>
The tags <TWOWAY> and </TWOWAY> delimit an encrypted eXtensible Markup Language (XML) stream describing the report, including its associated domain. Two-Way Email needs this information to retrieve the report code from the Managed Reporting Repository and route it to the WebFOCUS Reporting Server for execution. The prompt at the top of the sample template instructs you to supply a parameter value on line 1 of your reply. In this case, you must enter the name of a product category that exists in the data source, such as Coffee, Food, or Gifts. If you enter Coffee, the report will contain only data that applies to that category.
Procedure: How to Request a Report

1. Double-click the e-mail containing the template for the desired report. The subject of the e-mail typically identifies or describes the report.
Using Two-Way Email
17
Requesting a Report 2. Click Reply. If your device or program has an option to include the body of the e-mail (for example, Reply with Text or Include Original Text), select it. This option ensures that the content of the template is included in the reply. Two-Way Email requires the content to process the reply correctly. 3. If the report requires a parameter value, type it on the first line of the reply. Type multiple values on successive lines, each on a line by itself. To accept the default value of a parameter, type a period (.) on the applicable line in your reply. This action ensures that Two-Way Email will read the value properly. The e-mail may indicate valid values from which you can choose. If it does not, and you are not sure how to respond, ask your Managed Reporting Administrator or Developer. 4. Click Send. Two-Way Email will return the requested report to you.
Examples of Requesting a Report and Accepting the Default Value of a Parameter

The following are examples of requesting a report and accepting the default value of a parameter.
Example:
Requesting a Report With a Parameter

Suppose you want a report that shows the number of units sold, and the total dollar amount of sales, for a particular product category. The report is associated with a Two-Way Email template called Sales Report for User-supplied Category : TW. It requires a parameter value for the product category of interest. A Managed Reporting Administrator or Developer can create the Standard Report and template for you, as described in Developing a Two-Way Email Template on page 45. 1. Double-click the e-mail called Sales Report for User-supplied Category : TW. 2. The template prompts you for the product category and shows the possible values:
Enter a product category on line 1 of your reply. Valid product categories are Coffee, Food, Gifts.
18
WebFOCUS
1. Using Two-Way Email 3. Click Reply. If your device or program has an option to include the body of the e-mail (for example, Reply with Text or Include Original Text), select it. This option ensures that the content of the template is included in the reply. Two-Way Email requires the content to process the reply correctly. 4. Type Food on line 1 as the parameter value. 5. Click Send. Two-Way Email sends the report to you.
PAGE Category -------Food 1 Unit Sales ---------1384845 Dollar Sales -----------17229333
Example:
Accepting the Default Value of a Parameter

Suppose you want a report that shows the number of units budgeted, and the number of units sold, for a particular product category and store code. The report is associated with a Two-Way Email template called Budgeted Units by Category and Store Code : TW. For the product category, you can supply a value or accept the default. For the store code, you must accept the value provided by the Administrator. A Managed Reporting Administrator or Developer can create the Standard Report and template for you, as described in Developing a Two-Way Email Template on page 45. 1. Double-click the e-mail called Budgeted Units by Category and Store Code : TW. 2. The template prompts you as follows:
Enter a product category on line 1 of your reply. Valid product categories are Coffee, Food, Gifts. You can accept the default, which is Gifts. To accept the default, enter a period (.) on line 1 of your reply.
It also informs you that the only allowed store code value is R1019. 3. Click Reply. If your device or program has an option to include the body of the e-mail (for example, Reply with Text or Include Original Text), select it. This option ensures that the content of the template is included in the reply. Two-Way Email requires the content to correctly process the reply. 4. You want to accept the default, Gifts. As instructed, enter a period on line 1 of your reply.
Using Two-Way Email
19
Updating Your Subscription Information 5. Click Send. Two-Way Email sends the report to you.
PAGE Category -------Gifts 1 Store ID -------R1019 Budget Units -----------79552 Unit Sales ---------78869
Updating Your Subscription Information

How to: Access the Subscription Update Page Add a New E-mail Address Delete an Existing E-mail Address Refresh Your Templates Update Your Security Credentials Use the subscription update page to perform the following: Add a new e-mail address to the Two-Way Email database. The address will be associated with your subscription information. Delete an existing e-mail address from the Two-Way Email database. Refresh your Two-Way Email templates (that is, have them resent to you) if you accidentally delete one, or if the Managed Reporting Administrator or Developer creates or modifies a template for you. Update your WebFOCUS Reporting Server security credentials if they change.
20
WebFOCUS
Procedure: How to Access the Subscription Update Page

1. From your browser, access the subscription page by entering the Web address that applies to your site. For example,
http://hostname[:port]/rc_context_root/twoway/mobile/twoway.htm
where:
hostname[:port]
Is the host name and optional port number (specified only if you are not using the default port number) of the Application Server where the ReportCaster Web application is deployed.
rc_context_root
Is the site-customized context root for the ReportCaster Web application deployed on your Application Server. The default value is rcaster. 2. Type your Managed Reporting user ID and password as assigned by the Managed Reporting Administrator. 3. Click Updating a current Two-Way Email subscription, as shown in the following image.
4. Click Continue.
Using Two-Way Email
21
Updating Your Subscription Information As shown in the following image, the next dialog box allows you to perform update tasks, as described in the procedures that follow.
Procedure: How to Add a New E-mail Address

1. In the Email address field, type the new address. 2. Click Add.
22
WebFOCUS
1. Using Two-Way Email As shown in the following image, Two-Way Email confirms that the email address was added.
3. Click Continue to return to the subscription update page to perform other tasks or review what you have done. 4. Close the Two-Way Email window when you are finished. Two-Way Email sends a confirmation message to the new e-mail address. After you reply to the message, the address is activated, and Two-Way Email sends the templates you are authorized to use.
Using Two-Way Email
23
Updating Your Subscription Information
Procedure: How to Delete an Existing E-mail Address

1. In the list of current addresses, select the one you want to remove, as shown in the following image.
2. Click Delete. You are asked if you are sure you want to delete the address as shown in the following image.
3. Click OK to remove the address from the database. Click Cancel to discontinue the procedure and return to the previous window. 4. If you attempt to delete the only e-mail address associated with your subscription, the entire subscription (user account) will be cancelled. You are asked if you are sure you want to proceed with that action.
24
WebFOCUS
1. Using Two-Way Email Click OK to delete your subscription, or click Cancel to discontinue the procedure. If you click OK, Two-Way Email informs you that you are not in its user database as shown in the following image.
Procedure: How to Refresh Your Templates

1. From the list of current addresses, select the address to which you want to send the templates. 2. Click Refresh. A message informs you that fresh copies of your templates will be sent to the address specified.
Procedure: How to Update Your Security Credentials

1. Type your new WebFOCUS Reporting Server user ID and password in the appropriate fields. 2. Click Update. A message informs you that your user ID and password have been updated.
Responding to an Alert
Two-Way Email alert response is available only at sites that have licensed and installed both ReportCaster and Two-Way Email. For more information on ReportCaster Alerts, see the WebFOCUS Managed Reporting Developers Manual .
Using Two-Way Email
25
Responding to an Alert A Managed Reporting Administrator or Developer can attach a Two-Way Email template to a ReportCaster Alert. As a user, you are alerted when certain predefined data conditions are met. You can use the attached Two-Way Email template to respond to the alert to request a report for more detail.
Example:
A Managed Reporting Administrator or Developer can create the sample alert and template for you, as described in Developing a Two-Way Email Template on page 45. You are alerted when the total dollar sales for coffee for store code R1019 exceed $1,000,000. The alert takes the form of a report showing the exact amount of dollar sales. Attached to the report is a template, prompting you for another store code of interest, for comparison purposes. You will respond to the alert by supplying a store code value and sending the template. Your response generates a second report, showing the dollar sales for coffee for the supplied store code. You can then compare the two reports. 1. Periodically check your inbox for an alert from Two-Way Email, named Coffee Sales Alert. When it is delivered, open it and view the report. A template will be attached. Notice that the template prompts you for a store code.
PAGE Category -------Coffee 1 Store ID -------R1019 Dollar Sales -----------1393610
Enter a store code on line 1 of your reply. Valid store codes are R1088, R1109, R1250. ---------[TWOWAY] YXBwL3RvdGFscmV0LnR4dCwjdGVsbG1ldGVzdHNuLHByb2dyYW1tL3By b2dyYW1tLmh0bSwwLjE4OTQ5NTI3NDE0NjIxMDky [/TWOWAY]
2. Click Reply. If your device or program has an option to include the body of the e-mail (for example, Reply with Text or Include Original Text), select it. This option ensures that the content of the template is included in the reply. Two-Way Email requires the content to correctly process the reply. 3. Type the store code you are interested in.
26
WebFOCUS
1. Using Two-Way Email 4. Click Send. Two-Way Email sends the comparison report to you. For example, if you requested information on store code R1088, you receive the following report.
PAGE Category -------Coffee 1 Store ID -------R1088 Dollar Sales -----------1375040
Using Two-Way Email
27
28
WebFOCUS
WebFOCUS
Two-Way Email Administration
As a Managed Reporting Administrator and ReportCaster Administrator, you can use the Two-Way Email Administrator console to manage subscriber information, monitor the execution of report requests, cancel requests, and perform other administrative tasks. For information on developing Two-Way Email templates, see Developing a TwoWay Email Template on page 45.
Topics:
Accessing the Administrator Console Adding or Deleting a Subscriber Maintaining an E-mail Address Refreshing User Templates Using the Job Log Using the Event Log Checking the Status of a Job or Canceling a Job
Using Two-Way Email
29
Accessing the Administrator Console
Accessing the Administrator Console

How to: Access the Console and View Current Subscribers The Two-Way Email Administrator console enables the Managed Reporting Administrator to perform the following: View Managed Reporting users currently subscribed to Two-Way Email and their e-mail addresses. Add a new subscriber or delete an existing one. Maintain a user e-mail address. Resend all templates to a user. This feature is called refreshing the templates. View the status of an executed job using the Job Log. You can also purge the Job Log. Monitor e-mail traffic using the Event Log. You can also purge the Event Log. Check the status of an executing job or a queued job (one that is waiting to be sent to the WebFOCUS Reporting Server for execution). You can also cancel a queued job.
Procedure: How to Access the Console and View Current Subscribers

In the Managed Reporting browser blue toolbar, click Two-Way Email. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar.
30
WebFOCUS
2. Two-Way Email Administration The Two-Way Email Administrator console opens in a scrollable window as shown in the following image.
The console displays the following: All Managed Reporting users currently subscribed to Two-Way Email, listed on the left under Two-Way Email subscribers. All e-mail addresses for a selected user, listed on the right under Addresses for subscriber. You can only select one user at a time from the Two-Way Email subscribers list. However, you can select more than one address from the Addresses for subscriber list when you are deleting multiple addresses or selecting addresses for a refresh task.
Adding or Deleting a Subscriber

How to: Add a New Subscriber Delete an Existing Subscriber Use the Administrator console to add a new subscriber to the Two-Way Email database or delete an existing subscriber from the database. When a Managed Reporting Administrator adds a new subscriber using the Two-Way Email Administrator console, the subscriber receives a confirmation message from Two-Way Email, acknowledging the subscription request. The user must reply to the message. The subscription is activated once the confirmation process is complete.
Using Two-Way Email
31
Adding or Deleting a Subscriber
Procedure: How to Add a New Subscriber

1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access the Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar. 2. Click Add user. The Add Two-Way Email Subscriber dialog box opens as shown in the following image.
3. Type the Managed Reporting user ID and password. 4. Type the WebFOCUS (Reporting Server) user ID and password. To use default values specified in the Two-Way tab in the ReportCaster Server Configuration Tool, select the Use default credentials check box. 5. Type the user e-mail address. Click Add and the new user appears under Two-Way Email subscribers. If the user already has a Two-Way Email account, you receive a message informing you that the subscription procedure failed for that reason. If you make typing errors, click Reset to clear the fields.
32
WebFOCUS
2. Two-Way Email Administration
Procedure: How to Delete an Existing Subscriber

1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access the Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar. 2. Select the name of the subscriber you want to delete from the list on the left, under Two-Way Email subscribers. 3. Click Delete user. A window opens, with the name of the selected subscriber. 4. Click Delete to remove the subscriber from the Two-Way Email database.
Maintaining an E-mail Address

How to: Add a New E-mail Address Delete an Existing E-mail Address For any Two-Way Email user, you can: Add a new e-mail address to the Two-Way Email database. Delete an existing e-mail address from the Two-Way Email database. You can delete multiple addresses at one time. When you add a new e-mail address, the user receives a confirmation message at the new address from Two-Way Email and must reply to it. The new address is activated after the confirmation process is complete.
Procedure: How to Add a New E-mail Address

1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access the Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar. 2. Using the console, select the user from the list on the left, under Two-Way Email subscribers. 3. Click Add Email. 4. In the dialog box that appears, type the new e-mail address in the field and click Add.
Using Two-Way Email
33
Refreshing User Templates
Procedure: How to Delete an Existing E-mail Address

1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access the Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar. 2. Using the console, select the user from the list on the left, under Two-Way Email subscribers. 3. Select the address, or addresses, you want to remove from the list on the right, under Addresses for subscriber. 4. Click Delete Email. 5. In the dialog box that appears, click Delete. If you delete the only e-mail address associated with a user, the user subscription account for Two-Way Email is cancelled. You have an opportunity to proceed or cancel the action.
Refreshing User Templates

How to: Refresh User Templates You can resend user templates to a single e-mail address or to multiple addresses for that user.
Procedure: How to Refresh User Templates

1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access the Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar. 2. Using the console, select the user from the list on the left, under Two-Way Email subscribers. 3. Select the address, or addresses, to send the templates to using the list on the right, under Addresses for subscriber. 4. Click Refresh Templates. 5. Click OK to resend the templates that the subscriber is authorized to use.
34
WebFOCUS
Using the Job Log

In this section: Viewing the Status of an Executed Job Purging the Job Log Use the Job Log to view information about a job (Standard Report procedure) sent to the WebFOCUS Reporting Server for execution. The Job Log is an HTML page that opens in a browser window.
Viewing the Status of an Executed Job

How to: View the Status of an Executed Job The Job Log displays information about the activities that occurred during the execution and distribution of a report. The Job Log enables you to confirm that a report was executed and distributed successfully. If a job does not execute as expected, the Job Log displays explanatory information. The following image is a sample entry from a Job Log.
It includes the following: Two-Way Email Job Description. The name of the template associated with the job. Server User. The WebFOCUS Reporting Server user ID. Managed Reporting User. The Managed Reporting user ID. Process. A unique, system-generated key that identifies a specific execution of the template.
Using Two-Way Email
35
Using the Job Log Job Name. The name of the Managed Reporting Standard Report procedure, preceded by app and the forward slash delimiter (/). Start Time. The date and time the job started running. End Time. The date and time the job finished running. Messages. Details on the activities that took place during job execution and distribution.
Procedure: How to View the Status of an Executed Job

1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access the Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar. 2. Click the Job Log button on the left to display the Job Log Report interface as shown in the following image.
36
WebFOCUS
2. Two-Way Email Administration 3. Apply selection criteria to define the information that will be retrieved: Use the drop-down lists for Start Date and Start Time to specify the beginning of the time frame. Information on all jobs run from that date and time up to the current date and time will be retrieved. Type the name of a specific Two-Way Email template in the Job Description field. Information for only the jobs associated with that template during the specified time frame will be retrieved. Select the option Yes for Last Executed. Information for only the most recently executed job associated with the template (Job Description) during the specified time frame will be retrieved. 4. Click the Click to View button to display the Job Log report.
Purging the Job Log

How to: Purge the Job Log Because the Job Log accumulates information and can become difficult to navigate, it is recommended that you periodically purge the Job Log to remove older information and conserve space. You can control automatic purging of the Job Log at predefined intervals of time. Edit the LOG_PURGE_PERIOD parameter in the schedule section of the Distribution Server bkrsched.cfg file. For example, to automatically purge Job Log reports every two days, type:
LOG_PURGE_PERIOD 2
The parameter applies to the Two-Way Email Job Log and the ReportCaster Job Log. For more information, see the ReportCaster Development and Administration manual.
Procedure: How to Purge the Job Log

1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access the Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar.
Using Two-Way Email
37
Using the Event Log 2. Click the Job Log button on the left to display the Job Log Report interface as shown in the following image.
3. Using the drop-down lists for Ending Date, specify a date through which the Job Log will be purged. 4. Click the Click to Purge button. Respond to the confirmation message in the dialog box that appears. Two-Way Email will delete all reports from the beginning of the Job Log through the specified ending date.
Using the Event Log

In this section: Monitoring E-mail Traffic Purging the Event Log Use the Event Log to monitor the status of a Two-Way Email request as it is received, assessed for security, sent to the WebFOCUS Reporting Server for execution, and distributed as a report. The Event Log is an HTML page that opens in a browser window.
38
WebFOCUS
2. Two-Way Email Administration You can customize the content of the Event Log. Edit the EVENTLOG parameter in the TwoWay Email tab window of the Distribution Server Environment Setting window as shown in the following image.
The descriptions for each setting are outlined in the following table. Setting ON OFF ERROR Description Displays all events. Turns off the Event Log. Nothing is displayed. Displays only errors.
Using Two-Way Email
39
Using the Event Log
Monitoring E-mail Traffic

How to: Monitor E-mail Traffic The following image shows sample entries from an Event Log that displays only errors.
Each entry includes the following: Time. The date and time the event occurred. Server User. The WebFOCUS Reporting Server user ID. Managed Reporting User. The Managed Reporting user ID. Email Address. The e-mail address of the user. Message. A description of the error that occurred.
Procedure: How to Monitor E-mail Traffic

1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access the Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar.
40
WebFOCUS
2. Two-Way Email Administration 2. Click the Event Log button on the left to display the Event Log Report interface as shown in the following image.
3. Apply selection criteria to define the information that will be retrieved: Use the drop-down lists for Start Date to specify the beginning of the desired time frame. Information about all events that occurred from that date up to the current date will be retrieved. Type the Managed Reporting user ID in the MRE User field. Information for only the events associated with that user ID during the specified time frame will be retrieved. Type a WebFOCUS Reporting Server user ID in the WebFOCUS Server User field. Information for only the events associated with the supplied Managed Reporting user ID and WebFOCUS Reporting Server user ID during the specified time frame will be retrieved. Type an e-mail address in the Email Address field. Information for only the events associated with the supplied IDs and address during the specified time frame will be retrieved. 4. Click the Click to View button to display the Event Log report.
Using Two-Way Email
41
Using the Event Log
Purging the Event Log

How to: Purge the Event Log Because the Event Log accumulates information and can become difficult to navigate, it is recommended that you periodically purge the Event Log to remove older information and conserve space.
Procedure: How to Purge the Event Log

1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access the Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar. 2. Click the Event Log button on the left to display the Event Log Report interface, as shown in the following image.
3. Using the drop-down lists for Ending Date, specify a date through which the Event Log will be purged. 4. Click the Click to Purge button. Respond to the confirmation message in the dialog box that appears. Two-Way Email will delete all reports from the beginning of the Event Log through the specified ending date.
42
WebFOCUS
Checking the Status of a Job or Canceling a Job

How to: Check the Status of a Job Cancel a Queued Job You can check the status of an executing job or one that is waiting to be sent to the WebFOCUS Reporting Server for execution (a queued job). You can also cancel a queued job.
Procedure: How to Check the Status of a Job

1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access the Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar. 2. Click the Job Status button on the left to display a scrollable window as shown in the following image.
Jobs currently running on the WebFOCUS Reporting Server are displayed at the top of the window under Running Jobs. Jobs waiting to be sent to the WebFOCUS Reporting Server for execution are displayed near the bottom of the window under Queued Jobs.
Using Two-Way Email
43
Checking the Status of a Job or Canceling a Job The following information identifies a job: Job Number. The unique, system-generated key for a specific execution of a report. Started On (under Running Jobs). The date and time the job started running on the WebFOCUS Reporting Server. Submitted (under Queued Jobs). The date and time the job was submitted to the WebFOCUS Reporting Server for execution. Two-Way Fex. The name of the procedure for the Managed Reporting Standard Report. Originator. The e-mail address from which the request originated. 3. The Refresh this window every n seconds check box is selected by default to retrieve the latest information after the specified interval of time. You can accept the default interval of 10, as shown in the following image, or supply a new interval in seconds. Click Refresh to immediately retrieve the latest information.
Procedure: How to Cancel a Queued Job

1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access the Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email Administrator button in the toolbar. 2. Click the Job Status button on the left. 3. Select one or more jobs from the list under Queued Jobs and click Delete to cancel execution.
44
WebFOCUS
WebFOCUS
Developing a Two-Way Email Template
As a Managed Reporting Administrator or Developer, you use Managed Reporting to create and maintain TwoWay Email templates, the means by which a user requests a report. This topic describes several features of Two-Way Email, such as its processing steps, that will help Administrators and Developers understand the tasks and oversee the Two-Way Email capability. It also includes instructions on performing specific tasks. For information on using the Two-Way Email Administrator console, see TwoWay Email Administration on page 29.
Topics:
How Two-Way Email Works Creating a Template Maintaining a Template Sending a Template to Users Attaching a Two-Way Email Template to an Alert
Using Two-Way Email
45
How Two-Way Email Works

In this section: Subscription and Confirmation Processing Report Request Processing Secured Message Delivery Security in the Subscription and Confirmation Procedure Security in the Report Request Procedure Error Account Report Display Considerations Alert Response With Two-Way Email, mobile business professionals have access to the enterprise data of their company, from any location, at any time. The following basic activities enable the Two-Way Email capability. The Managed Reporting Administrator or Developer performs some activities, and the user performs others: The Managed Reporting Administrator or Developer creates Two-Way Email templates from Standard Reports in Managed Reporting. The Managed Reporting Administrator and ReportCaster Administrator subscribes a first-time user to Two-Way Email using the Two-Way Email Administrator console, or a user subscribes independently from an HTML subscription page supplied with Two-Way Email. Two-Way Email sends the user a confirmation message through e-mail acknowledging the subscription request. The user receives and replies to this message. Two-Way Email sends the user the templates allowed for use. The user stores them in the inbox or in a folder on the e-mail client. The user simply replies to and sends a template to receive the associated report. Details on the processing behind these activities follow.
46
WebFOCUS
3. Developing a Two-Way Email Template
Subscription and Confirmation Processing

The following steps take place when a new user subscribes to Two-Way Email using an HTML subscription page. A Managed Reporting Administrator and ReportCaster Administrator can also subscribe a new user from the Two-Way Email Administrator console. The following images depict the steps being explained.
From a browser, a user accesses the HTML subscription page and supplies the Managed Reporting user ID and password, WebFOCUS Reporting Server user ID and password, and e-mail address.
Two-Way Email checks the user ID, password, and domain authorization, links the security credentials to the applicable templates, and creates a new user record in the Two-Way Email user database.
Two-Way Email sends a confirmation message to the user through e-mail.
The user receives and replies to the confirmation message through e-mail, using a handheld device, laptop, or desktop computer.
Two-Way Email receives the confirmation reply and verifies the Reply-To address in the user record in the Two-Way Email database.
Two-Way Email retrieves the applicable templates from the Managed Reporting Repository and sends them to the validated, registered user as e-mail messagess.
Using Two-Way Email
47
Report Request Processing

The following steps take place when a user requests a report.
In the handheld device, laptop, or desktop computer from the e-mail client, the user selects, replies to, and sends a template. The e-mail is routed to an e-mail server.
The Two-Way Email Listener monitors its inbox on the email server and detects the request. It validates the address of the sender as a subscriber address and queues the request.
The Two-Way Email Dispatcher takes the request off the queue and starts a Worker thread.
The Worker checks the security credentials from Managed Reporting, retrieves the Standard Report procedure, merges it with parameter values, and sends it to the WebFOCUS Reporting Server for processing.
The Worker starts an agent on the WebFOCUS Reporting Server. The server runs the procedure with any parameter values. The Reporting Server sends output back to the Distribution Server.
The Distribution Server sends the e-mail message.
48
WebFOCUS
Secured Message Delivery

Two-Way Email provides the same level of secured message delivery as provided by Simple Mail Transfer Protocol (SMTP). Managed Reporting enables central management of user access to data. As a Managed Reporting Administrator, you use standard Managed Reporting security features to establish the credentials and access privileges of a user. You need to: Assign a Managed Reporting user ID and password to each Two-Way Email user. Grant authorized users access to certain domains.
Security in the Subscription and Confirmation Procedure

See Subscription and Confirmation Processing on page 47, for an illustration of this procedure. For a first-time subscriber, Two-Way Email checks the Managed Reporting user ID and password and the domain authorization. It creates a new subscriber record in the Two-Way Email database and sends a confirmation message to the e-mail address supplied. This message enables validation of the correct Reply-To address for the subscriber, since TwoWay Email actually uses the address to acknowledge the subscription request. Once Two-Way Email receives the reply of the subscriber to the message, it stores the correct address in the Two-Way Email database. The credentials of the subscriber are also linked to the allowed Two-Way Email templates. That information is encrypted to provide additional security.
Security in the Report Request Procedure

See Report Request Processing on page 48, for an illustration of this procedure. When a subscriber sends a request for a report, Two-Way Email makes sure that the ReplyTo e-mail address of the sender is the same as the e-mail address of the subscriber. This security feature prevents unauthorized users from gaining access to reports. Two-Way Email also verifies the content of the request to make sure it is a Two-Way Email request. If it is not, Two-Way Email sends the request to an error account.
Error Account
When a user requests a report, Two-Way Email examines the content of the request. NonTwo-Way Email requests are sent to an error account. The e-mail address for this account is specified during WebFOCUS installation. Make sure that someone periodically checks and cleans up the error account.
Using Two-Way Email
49
Report Display Considerations

A report displayed on a handheld device is text based and does not support formatting options such as font size or color. As a Managed Reporting Administrator or Developer, you are responsible for designing reports that are compatible with the display device. Reports may require tailoring for small screen presentation. Possible display options include the following. Narrow, tabular display, as shown in the following image.
Use the WebFOCUS PRINT and SUM commands to create tabular display. For example:
SET STYLE=OFF, PAGE-NUM=OFF TABLE FILE GGSALES SUM UNITS DOLLARS BY CATEGORY END
Free-form display, as shown in the following image.
Use the WebFOCUS HEADING command to create free-form display. For example:
SET STYLE=OFF, PAGE-NUM=OFF TABLE FILE GGSALES HEADING "<3>UNITS SOLD FOR COFFEE" "<5>AND BUDGETED UNITS" "CATEGORY: <CATEGORY>" "<4>UNITS SOLD: <UNITS>" "<4>BUDGETED UNITS: <BUDUNITS>" FOOTING "<8>Confidential" BY CATEGORY WHERE CATEGORY EQ 'Coffee' END
50
WebFOCUS
3. Developing a Two-Way Email Template Stacked display, as shown in the following image.
Use the WebFOCUS OVER command to create stacked display. For example:
SET STYLE=OFF, PAGE-NUM=OFF TABLE FILE GGSALES SUM UNITS OVER BUDUNITS OVER COMPUTE DIFF_UNITS = BUDUNITS - UNITS; OVER DOLLARS OVER BUDDOLLARS OVER COMPUTE DIFF_DOLLARS = BUDDOLLARS - DOLLARS; END
See the Creating Reports for WebFOCUS Language manual, for details on report display and syntax.
Alert Response
Two-Way Email alert response is available only at sites that have licensed and installed both ReportCaster and Two-Way Email. For more information, see the WebFOCUS Managed Reporting Developers Manual. A Managed Reporting Administrator or Developer can attach a Two-Way Email template to a ReportCaster Alert. The user is alerted when certain pre-defined data conditions are met, and can use the attached template to respond to the alert to request a report for more detail. Note: Two-Way Email does not support Compound Reports.
Creating a Template
How to: Create a Template Without Parameters Create a Template With Parameters As a Managed Reporting Administrator or Developer, you create a Two-Way Email template, or multiple templates, from an existing Standard Report.
Using Two-Way Email
51
Creating a Template A template may or may not contain parameters requiring values from the user. You do not need to prompt the user for all of the parameters in a Standard Report. You can set any parameter to a value appropriate for the user. Two-Way Email templates are stored with the Standard Report from which you create the template. In Developer Studio you can view created templates by right-clicking the Standard Report and selecting Show Two-Way Email Templates. In the browser, the template is located under the associated Standard Report. Note: Two-Way Email does not support Compound Reports.
Procedure: How to Create a Template Without Parameters

1. Right-click the Standard Report from which you want to create a Two-Way Email template. On the pop-up menu in: The browser, select New Two-Way Email Template. The New Two-Way Email Template dialog box opens. Skip to Step 3. Developer Studio, select Show Two-Way Email Templates. 2. From the Two-Way Email Templates tab, click New to open the New Two-Way Email Template dialog box. In the browser, another way to open the dialog box is to select the Standard Report, and click the icon on the toolbar labeled New Two-Way Email Template. In the Explorer in Developer Studio, you can select the Standard Report and then from the File menu, select New Two-Way Email Template. 3. On the New Two-Way Email Template dialog box, type the subject of the template in the Subject Line field. This value appears as the subject of the e-mail message sent to the user. Two-Way Email uses the name of the Standard Report as the default subject, followed by a Two-Way Email identifier (for example, TW). 4. Type a description of the template, or an informative message for the user, in the Ending Message field. This description or message appears in the body of the Two-Way Email template. 5. Click Email Preview to display the template as the user will see it. You can use Research In Motion Limited (RIM) or Palm handheld emulation to preview the template. Toggle between the two emulators by holding down the Shift key and clicking Email Preview. 6. Close the preview window when you are done.
52
WebFOCUS
3. Developing a Two-Way Email Template 7. Click OK on the Two-Way Email window. The Save New 'Two-Way Email' window opens. 8. Type the name of the template. and click OK. Two-Way Email displays the subject of the template as the default name.
Example:
Creating a Template Without Parameters

Suppose you want to create a Two-Way Email template from a Standard Report named Line Price. The Standard Report is:
TABLE FILE CENTORD SUM LINEPRICE BY PRODCAT END
1. Right-click the Standard Report named Line Price. On the pop-up menu in: The browser, select New Two-Way Email Template. The New Two-Way Email Template dialog box opens. Skip to Step 3. Developer Studio, select Show Two-Way Email Templates.
Using Two-Way Email
53
Creating a Template 2. From the Two-Way Email Templates tab, click New to open the New Two-Way Email Template dialog box, as shown in the following image.
3. In the Subject Line field, accept the default subject of the template. This value appears as the subject of the e-mail message sent to the user.
54
WebFOCUS
3. Developing a Two-Way Email Template 4. In the Ending Message field, type the following as the description of the template:
This report contains line price figures by product category for the Century Corporation.
This description appears in the body of the template, as shown in the following image.
5. Click Email Preview to display the template as the user will see it. You can use RIM or Palm handheld emulation to preview the template. Toggle between the two emulators by holding down the Shift key and clicking Email Preview. 6. Close the preview window when you are done.
Using Two-Way Email
55
Creating a Template 7. Click OK on the Two-Way Email window. The New Two-Way Email Template dialog box opens, as shown in the following image, containing Line Price : TW 1 as its default name.
8. Accept the default template name by clicking OK. 9. Click OK again to exit the Line Price Properties dialog box.
Procedure: How to Create a Template With Parameters

1. Right-click the Standard Report from which you want to create a Two-Way Email template. On the pop-up menu in: The browser, select New Two-Way Email Template. The New Two-Way Email Template dialog box opens. Skip to Step 3. Developer Studio, select Show Two-Way Email Templates. 2. From the Two-Way Email Templates tab, click New to open the New Two-Way Email Template dialog box. 3. On the New Two-Way Email Template dialog box, type the subject of the template in the Subject Line field. This value appears as the subject of the e-mail message sent to the user. Two-Way Email uses the name of the Standard Report as the default subject, followed by a Two-Way Email identifier (for example, TW). 4. Type a description of the template, or an informative message for the user, in the Ending Message field. For example, you may want to indicate valid values for a required parameter. This description or message appears in the body of the Two-Way Email template.
56
WebFOCUS
3. Developing a Two-Way Email Template 5. For each parameter, specify a property, as outlined in the following table. Property Require User Input Allow Default Description User must supply a value for the parameter. User can supply a value or use the default value. Type the default value in the field labeled Value. To accept a default value when requesting a report, the user must type a period on the line corresponding to the parameter. A period is required to ensure that Two-Way Email reads the line. Use Value Disable Administrator supplies the value that cannot be changed by the user. Type the required value in the field labeled Value. Does not prompt for a parameter value on the Two-Way Email template. Specify this property only when the parameter is already set on the WebFOCUS Reporting Server in a profile or stored procedure.
If you include multiple parameters in the template, click the Up and Down buttons to scroll through them. These buttons are only enabled when more than one parameter is specified. 6. If you click Require User Input or Allow Default, you can supply a prompt that the user will see in the template. For each parameter, type the applicable prompt in the Prompt field. If multiple parameter values are required, indicate the line number that each value should be supplied on. If a parameter has the property, Allow Default, instruct the user to type a period (.) on the appropriate line to accept the default value. 7. Click Email Preview to display the template as the user will see it. You can use RIM or Palm handheld emulation to preview the template. Toggle between the two emulators by holding down the Shift key and clicking Email Preview. 8. Close the preview window when you are done and click OK on the Two-Way Email window. The New Two-Way Email Template dialog box opens. Two-Way Email displays the subject of the template as the default name.
Using Two-Way Email
57
Creating a Template 9. Accept the default name, or type another name for the template, and click OK.
Example:
Creating a Template With a Parameter

Creating a Two-Way Email template using a Standard Report named Inventory Report for User-supplied Category provides inventory information for a product category specified by the user. The Standard Report is:
TABLE FILE CENTORD SUM QUANTITY BY PRODCAT WHERE PRODCAT EQ '&PRODCAT' END
1. Right-click the Standard Report named Inventory Report for User-supplied Category. On the pop-up menu in: The browser, select New Two-Way Email Template. The New Two-Way Email Template dialog box opens. Skip to Step 3. Developer Studio, select Show Two-Way Email Templates.
58
WebFOCUS
3. Developing a Two-Way Email Template 2. From the Two-Way Email Templates tab, click New to open the New Two-Way Email Template dialog box, as shown in the following image.
3. Use the default subject name of the template as displayed in the Subject Line field. This value appears as the subject of the e-mail message sent to the user. 4. Type the following informative message for the user in the Ending Message field:
Valid product categories are CD Players, Camcorders, Cameras, DVD, Digital Tape Recorders, PDA Devices, VCRs.
5. Confirm that the Require User Input radio button is selected.
Using Two-Way Email
59
Creating a Template 6. Type over the word PRODCAT to specify the following for the prompt that will display in the template:
Enter a product category on line 1 of your reply.
7. Click Email Preview to display the template as the user will see it. You can use RIM or Palm handheld emulation to preview the template. Toggle between the two emulators by holding down the Shift key and clicking Email Preview. 8. Close the preview window when you are done and click OK on the Two-Way Email window. The New Two-Way Email Template dialog box opens, as shown in the following image, containing Inventory Report for User-supplied Category as its default name.
9. Accept the default name of the template by clicking OK.
Example:
Creating a Template With Multiple Parameters

Suppose you want to create a Two-Way Email template using a Standard Report named Inventory and Line Price by Category and Store Code. It contains two parameters. For one parameter, PRODCAT, the user can supply a value or accept the default value provided by the Administrator. For the second parameter, STORE_CODE, the user must accept the value provided by the Administrator. The Standard Report is:
TABLE FILE CENTORD SUM QUANTITY LINEPRICE BY PRODCAT BY STORE_CODE WHERE STORE_CODE EQ '&STORE_CODE' WHERE PRODCAT EQ '&PRODCAT' END
1. Right-click the Standard Report named Inventory and Line Price by Category and Store Code. From the pop-up menu in: The browser, select New Two-Way Email Template. The New Two-Way Email Template dialog box opens. Skip to Step 3. Developer Studio, select Show Two-Way Email Templates.
60
WebFOCUS
3. Developing a Two-Way Email Template 2. Click New. The New Two-Way Email Template dialog box opens, as shown in the following image.
3. Use the default subject name of the template as displayed in the Subject Line field. This value appears as the subject of the e-mail message sent to the user. 4. The parameter PRODCAT is already highlighted, so you will define its properties first. Select Allow Default. 5. In the Value field, type the default value, DVD.
Using Two-Way Email
61
Creating a Template 6. In the Prompt field, specify the following for the prompt that will display in the template. You can type over the word PRODCAT.
Enter a product category on line 1 of your reply. Valid product categories are CD Players, Camcorders, Cameras, DVD, Digital Tape Recorders, PDA Devices, VCRs. You can accept the default, which is DVD. To accept the default, enter a period (.) on line 1 of your reply.
7. Click the second parameter, STORE_CODE, to highlight it. You will now define its properties. Type the following informative message for the user in the Ending Message field:
You must accept the store code value that is supplied for you. The store code value is 1003CA.
8. Select Use Value.
62
WebFOCUS
3. Developing a Two-Way Email Template 9. In the Value field, type the only valid value, 1003CA, as shown in the following image.
10. If a parameter has the property Use Value, you do not specify a prompt for it. Click Email Preview to display the template as the user will see it. You can use RIM or Palm handheld emulation to preview the template. Toggle between the two emulators by holding down the Shift key and clicking Email Preview. 11. Close the preview window when you are done and click OK on the Two-Way Email window. The New Two-Way Email Template dialog box opens. 12. Accept the default name of the template by clicking OK.
Using Two-Way Email
63
Maintaining a Template
Maintaining a Template
How to: Edit a Template Rename a Template Delete a Template As a Managed Reporting Administrator or Developer, you edit, rename, or delete an existing Two-Way Email template from Managed Reporting. If you edit a Standard Report associated with a Two-Way Email template and then open the template, a message describes the change. For example, if you remove a variable named CATEGORY from a Standard Report, you see the following when you open the template:
Variable 'CATEGORY' Has Been Deleted
Click OK to remove the message.
Procedure: How to Edit a Template

1. In Developer Studio, right-click the Standard Report that contains the Two-Way Email template associated with the template you want to edit. On the pop-up menu, select Show Two-Way Email Templates. In the browser, right-click the Two-Way Email Template and select Open. Skip to Step 3. 2. Select the template from the Attached Templates list and click Open.
64
WebFOCUS
3. Developing a Two-Way Email Template The following image shows the Inventory Report for User-supplied Category Properties dialog box open to the Two-Way Email Templates tab which contains a selected template.
Using Two-Way Email
65
Maintaining a Template The following image shows that the selected template has a single parameter, PRODCAT, that requires a user input and lists valid product categories in the Ending Message text box.
3. Make all necessary changes and click Email Preview to make sure the template appears as desired. You can use RIM or Palm handheld emulation to preview the template. Toggle between the two emulators by holding down the Shift key and clicking Email Preview. 4. Close the preview window when you are done. 5. Click OK on the Two-Way Email window to save the changes.
66
WebFOCUS
Procedure: How to Rename a Template

1. From Developer Studio, right-click the Standard Report that contains the Two-Way Email template name you want to change, and select Show Two-Way Email Templates. From the browser, right-click the Two-Way Email template and select Properties. Edit the name as desired and click OK. 2. Select the template from the Attached Templates list and click Open. 3. In the Subject Line, edit the name. 4. Click OK.
Procedure: How to Delete a Template

1. From Developer Studio, right-click the Standard Report that contains the Two-Way Email template you want to delete, and select Show Two-Way Email Templates. From the browser, right-click the Two-Way Email template and select Delete. Skip to Step 3. 2. Select the template from the Attached Templates list and click Delete. 3. Click Yes at the delete template prompt.
Sending a Template to Users

How to: Send a Template to Users As a Managed Reporting Administrator or Developer, you will periodically create new templates or modify existing ones. You can send a copy of a new or modified template to authorized users.
Procedure: How to Send a Template to Users

1. From Developer Studio, right-click the Standard Report that contains the new or modified template you want to send, and select Show Two-Way Email Templates. From the browser, right-click the Two-Way Email template and select Resend Template. 2. Select the template from the Attached Templates list and click Resend Template. Two-Way Email automatically sends a copy of the template to all users with authorized access to the associated domain.
Using Two-Way Email
67
Attaching a Two-Way Email Template to an Alert

This feature is available only at sites that have licensed and installed both ReportCaster and Two-Way Email. Two-Way Email is only available with ReportCaster. A Managed Reporting Administrator or Developer can attach a Two-Way Email template to a ReportCaster Alert. The user is alerted when certain predefined data conditions are met, and can use the attached template to respond to the alert to request a report for more detail, to redistribute a report or parts of it to other interested people, or to take other timely action. For the procedure on attaching a Two-Way Email template to a ReportCaster Alert using the Alert Wizard, see the WebFOCUS Managed Reporting Developers Manual. The following example illustrates the basic steps required to attach a template to an alert. It assumes that you are familiar with the Alert Wizard and the creation of Two-Way Email templates. Alert response enables many event-critical activities other than the simple one illustrated here, including drill-down reporting or data source maintenance.
Example:

In this example, the user is alerted when the total coffee sales for store code R1019 exceed $1,000,000. You create this alert test in Step 3. The alert to the user takes the form of a report showing the exact amount of coffee sales for store code R1019. You create this alert event (report) in Step 4. Attached to the report is a template that prompts the user for another store code. You create this template in Step 2. The user types the store code of interest for comparison purposes, and receives a second report showing the coffee sales for the supplied store code. You create the second report in Step 1.
68
WebFOCUS
3. Developing a Two-Way Email Template 1. Create a Standard Report named Coffee Sales for Competitive Store. This is the comparison report the user receives after replying to and sending the template attached to the alert. This report displays the coffee sales for a store code supplied by the user, who wants to compare that figure to the coffee sales for store code R1019.
TABLE FILE GGSALES SUM DOLLARS BY CATEGORY BY STCD WHERE CATEGORY EQ 'Coffee' WHERE STCD EQ '&STCD' END
2. Create a template for the preceding Standard Report. Use the instructions in How to Create a Template With Parameters on page 56. The template prompts the user for a store code. Perform the following when creating the template: a. Accept the default subject name in the Subject Line field. b. Select Require User Input. c. In the Ending Message field, type:
Valid store codes are R1088, R1109, R1250.
d. In the Prompt field, type:

Enter a store code on line 1 of your reply.
3. Using the Alert Wizard, create an alert test as follows. An alert test defines the data condition that is monitored, such as in the following example when the total coffee sales for store code R1019 exceed $1,000,000.
TABLE FILE GGSALES SUM DOLLARS BY CATEGORY BY STCD WHERE CATEGORY EQ 'Coffee' WHERE STCD EQ 'R1019' WHERE TOTAL DOLLARS GT 1000000 ON TABLE HOLD END
Using Two-Way Email
69
Attaching a Two-Way Email Template to an Alert 4. Using the Alert Wizard, create an alert event as follows. An alert event is the report that is distributed if the alert test is true.
TABLE FILE GGSALES SUM DOLLARS BY CATEGORY BY STCD WHERE CATEGORY EQ 'Coffee' WHERE STCD EQ 'R1019' WHERE TOTAL DOLLARS GT 1000000 END
5. Using the Alert Wizard, select Attach a Two-Way Email to this Alert. 6. Select the template named Coffee Sales for Competitive Store: TW, as shown in the following image, displaying the Alert Wizard, Two-Way window.
7. Using the Alert Wizard, name the new alert report Coffee Sales Alert. Schedule the alert for testing once a day. For the Subject on the Distribution tab in the ReportCaster schedule, type Coffee Sales Alert.
70
WebFOCUS
WebFOCUS
Index
A
Add Two-Way Email Subscriber dialog box 31, 32 alert events 25 alert response 25, 26
R
report parameters 19 report requests 18 ReportCaster 25 reports 17, 18, 45, 48, 50 designing 50 displaying 50 processing 48 requesting 17, 18, 48
D
default parameters 19
E
error accounts 49 Event Log for Two-Way Email 38 purging 38
S
subscribers 30
T
templates 16, 25, 51, 52, 53, 56, 58, 60, 64, 67, 68 attaching to an alert 51, 68 creating 51, 52, 53, 56, 58, 60 deleting 64, 67 editing 64 refreshing 25 renaming 64, 67 sending 67 Two-Way Email 11, 12, 13, 15, 16, 17, 18, 20, 21, 22, 24, 25, 30, 31, 35, 36, 38, 45, 46, 47, 48, 49, 50, 64 adding addresses 22 adding subscribers 31 deleting addresses 24 deleting subscribers 31 designing reports 50 displaying reports 50 enabling 46
J
Job Log for Two-Way Email 35, 37 purging 37
M
multiple parameters 60
N
New Two-Way Email Template dialog box 52, 53, 56
P
parameters 19
Using Two-Way Email
71
Index Two-Way Email (continued) error accounts 49 Event Log 38 Job Log 35 replying to confirmation messages 15, 16 requesting reports 17, 18, 48 security 15, 49 specifying report parameters 18 subscriber credentials 49 subscribing 12, 13, 47 templates 64 updating security credentials 25 updating subscription information 20, 21 verifying 47 viewing current subscribers 30 viewing job status 35, 36 Two-Way Email Administrator console 30, 31, 32, 33, 34, 35, 38, 40, 41, 42, 43, 44 accessing 30 adding addresses 33 adding subscribers 31, 32 Two-Way Email Administrator console (continued) canceling reports 43, 44 deleting addresses 33, 34 deleting subscribers 31, 33 monitoring e-mail traffic 40, 41 purging the Event Log 42 purging the Job Log 38 refreshing templates 34 using the Event Log 38 using the Job Log 35 viewing current subscribers 30 viewing job status 43 Two-Way Email templates 16, 25, 51, 52, 53, 56, 58, 60, 64, 67, 68 attaching to an alert 51, 68 creating 51, 52, 53, 56, 58, 60 editing 64 refreshing 25 renaming 67 sending 67
72
WebFOCUS
WebFOCUS
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 (212) 967-0460 books_info@ibi.com http://www.informationbuilders.com/bookstore/derf.html
Fax: E-mail: Web form: Name: Company: Address: Telephone: Email: Comments:
Date:
Information Builders, Two Penn Plaza, New York, NY 10121-2898 Using Two-Way Email Version 7 Release 7
(212) 736-4433 DN4501032.0510
Using Two-Way Email Creating Reports With Version 7 Release 7 WebFOCUS Language
Version 7 Release 6
Information Builders Two Penn Plaza New York, NY 10121-2898
Printed on recycled paper in the U.S.A.

Using Two-Way Email: Version 7 Release 7

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Using Two-Way Email: Version 7 Release 7

Uploaded by

Copyright:

Available Formats

Using Two-Way Email

1. Using Two-Way Email.....................................................................................11

2. Two-Way Email Administration.......................................................................29