8/2/2019 wf77twowayemail
1/74
Using Two-Way EmailVersion 7 Release 7
DN4501032.0510
8/2/2019 wf77twowayemail
2/74
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 andMagnify are trademark of Information Builders, Inc.
Adobe, the Adobe logo, Acrobat, Adobe Reader, Flash, Flex, and PostScript are either registered trademarks ortrademarks 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 theirtrademarks. In most, if not all cases, these designations are claimed as trademarks or registered trademarks by therespective companies. It is not this publishers intent to use any of these names generically. The reader is thereforcautioned 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 manuaor parts thereof, may not be reproduced in any form without the written permission of Information Builders, Inc.
8/2/2019 wf77twowayemail
3/74
WebFOCUS
Contents
Preface................................................................................................................5
Documentation Conventions..............................................................................................6
Related Publications..........................................................................................................
Customer Support.............................................................................................................
Information You Should Have.............................................................................................
User Feedback..................................................................................................................
Information Builders Consulting and Training.......................................................................
1. Using Two-Way Email.....................................................................................11Two-Way Email User Steps...............................................................................................1
Subscribing for the First Time...........................................................................................1
Replying to the Confirmation Message..............................................................................15
Receiving Your Templates for the First Time......................................................................1
Requesting a Report........................................................................................................1
Examples of Requesting a Report and Accepting the Default Value of a Parameter.......1
Updating Your Subscription Information............................................................................2
Responding to an Alert....................................................................................................25
2. Two-Way Email Administration.......................................................................29
Accessing the Administrator Console................................................................................3
Adding or Deleting a Subscriber........................................................................................3
Maintaining an E-mail Address.........................................................................................33
Refreshing User Templates..............................................................................................34
Using the Job Log............................................................................................................3
Viewing the Status of an Executed Job......................................................................3
Purging the Job Log.................................................................................................3
Using the Event Log........................................................................................................38
Monitoring E-mail Traffic...........................................................................................4
Purging the Event Log..............................................................................................42
Checking the Status of a Job or Canceling a Job................................................................4
Using Two-Way Email
8/2/2019 wf77twowayemail
4/74
3. Developing a Two-Way Email Template..........................................................45
How Two-Way Email Works...............................................................................................4
Subscription and Confirmation Processing.................................................................4
Report Request Processing......................................................................................48
Secured Message Delivery.......................................................................................49
Security in the Subscription and Confirmation Procedure............................................4
Security in the Report Request Procedure..................................................................4
Error Account..........................................................................................................49
Report Display Considerations..................................................................................5
Alert Response........................................................................................................5
Creating a Template........................................................................................................5
Maintaining a Template...................................................................................................64
Sending a Template to Users...........................................................................................6
Attaching a Two-Way Email Template to an Alert................................................................68
Reader Comments.............................................................................................73
4 WebFOCU
Contents
8/2/2019 wf77twowayemail
5/74
WebFOCUS
Preface
This documentation describes how Two-Way Email enables mobile business professionalsto 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 languagand only specific syntax constructs. While the user can manually modify the content of thes
WebFOCUS procedures/files, there is no guarantee that the user will be able to open themodified procedure in the tool.
How This Manual Is Organized
This manual includes the following chapters:
ContentsChapter/Appendix
Explains the steps that a user performs to enable
the Two-Way Email capability. Also describes what atemplate looks like, and how to use one to request
a report. Addresses the alert response for those sitesthat have licensed and installed both ReportCaster
and Two-Way Email.
Using Two-Way Email1
Describes how to use the Two-Way Email
Administrator console to monitor the execution ofreport requests, cancel requests, and perform other
administrative tasks.
Two-Way Email
Administration
2
Describes Two-Way Email processing steps to help
Administrators and Developers understand the tasks
and oversee the Two-Way Email capability. It alsoincludes instructions on how to create and maintaintemplates.
Developing a Two-Way Email
Template
3
Using Two-Way Email
8/2/2019 wf77twowayemail
6/74
Documentation Conventions
The following table lists and describes the conventions that apply in this manual.
DescriptionConvention
Denotes syntax that you must enter exactly as shown.THIS TYPEFACE
or
this typeface
Represents a placeholder (or variable) in syntax for a value thatyou or the system must supply.
this typeface
Indicates a default setting.underscore
Represents a placeholder (or variable), a cross-reference, or animportant term. It may also indicate a button, menu item, or
dialog box option you can click or select.
this typeface
Highlights a file name or command.this typeface
Indicates keys that you must press simultaneously.Key + Key
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 ofthem, not the symbol.
|
Indicates that you can enter a parameter multiple times. Typeonly the parameter, not the ellipsis points (...).
...
Indicates that there are (or could be) intervening or additional
commands.
.
.
.
6 WebFOCU
Documentation Conventions
8/2/2019 wf77twowayemail
7/74
Related Publications
To view a current listing of our publications and to place an order, visit our TechnicalDocumentation Library, http://documentation.informationbuilders.com. You can also contac
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
message board. It is an interactive network of more than 3,000 developers from almostevery 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 InfoResponseOnline. InfoResponse Online is accessible through our World Wide Web site,
http://www.informationbuilders.com. It connects you to the tracking system and known-problem 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 reportesoftware issues. New users can register immediately for this service. The technical suppor
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 caalso 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 Buildersrepresentative about InfoResponse Online, or call (800) 969-INFO.
Using Two-Way Email
Preface
http://documentation.informationbuilders.com/http://forums.informationbuilders.com/eve/forumshttp://www.informationbuilders.com/http://www.informationbuilders.com/http://forums.informationbuilders.com/eve/forumshttp://documentation.informationbuilders.com/8/2/2019 wf77twowayemail
8/74
Information You Should Have
To help our consultants answer your questions effectively, be prepared to provide the followininformation 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 optioin 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 ormisplaced?
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, 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? Dyou just have questions about functionality or documentation?
8 WebFOCU
Information You Should Have
8/2/2019 wf77twowayemail
9/74
User Feedback
In an effort to produce effective documentation, the Documentation Services staff welcomeyour 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, visour World Wide Web site (http://www.informationbuilders.com) or call (800) 969-INFO to
speak to an Education Representative.
Using Two-Way Email
Preface
http://documentation.informationbuilders.com/feedback.asphttp://documentation.informationbuilders.com/feedback.asp8/2/2019 wf77twowayemail
10/74
10 WebFOCU
Information Builders Consulting and Training
8/2/2019 wf77twowayemail
11/74
WebFOCUS
Using Two-Way Email1
Topics:Two-Way Email enables mobile business
professionals to request and receiveWebFOCUS reports through e-mail, using
a handheld device, laptop, or desktop.From any location, at any time, users
have access to their company'senterprise data.
Two-Way Email User Steps
Subscribing for the First Time
Replying to the Confirmation Message
Receiving Your Templates for the First
TimeTo request a report, a user simply repliesto and sends an e-mail that contains aTwo-Way Email template. A template is
the means by which a request is madeand parameter values are supplied if
required. A Managed ReportingAdministrator or Developer creates and
maintains templates for a user.
Requesting a Report
Updating Your Subscription
Information
Responding to an Alert
This topic explains the steps a user
performs to enable the Two-Way Emailcapability. It also describes how a
template looks, and how to use one torequest a report. Finally, it addresses
alert response for those sites that havelicensed and installed both ReportCaster
and Two-Way Email.
Using Two-Way Email 1
8/2/2019 wf77twowayemail
12/74
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 Two
Way Email Administrator console.
2. Reply to the confirmation message sent by Two-Way Email. This message acknowledgeyour 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 thesetemplates for your use. Each template is associated with a Managed Reporting Standar
Report of interest to you. For more information, see Receiving Your Templates for the FirsTime 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 displathe 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 arstored for you on the server. If you do not know the required security information, ask you
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 WebFOCU
Two-Way Email User Steps
8/2/2019 wf77twowayemail
13/74
How to Subscribe for the First TimeProcedure:
1. Your site has a Web address for the Two-Way Email subscription page. Ask your Manage
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 thedefault port number) of the Application Server where the ReportCaster Web applicatio
is deployed.
rc_context_root
Is the site-customized context root for the ReportCaster Web application deployedon your Application Server. The default value is rcaster.
2. Type your Managed Reporting user ID and password as assigned by the ManagedReporting 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 1
1. Using Two-Way Email
8/2/2019 wf77twowayemail
14/74
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 credentialsfor the WebFOCUS Reporting Server.
6. Type your e-mail address. Two-Way Email will use this address to send you Two-WayEmail 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. ClickAdd me to add your new subscription.
14 WebFOCU
Subscribing for the First Time
8/2/2019 wf77twowayemail
15/74
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-WayEmail 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 1
1. Using Two-Way Email
8/2/2019 wf77twowayemail
16/74
How to Reply to the Confirmation MessageProcedure:
1. Check your mailbox for a message from Two-Way Email. Open the confirmation messag
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 lin
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 procesthe 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 Ema
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 WebFOCU
Receiving Your Templates for the First Time
8/2/2019 wf77twowayemail
17/74
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 templat
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 alsoprompt you for one or more parameter values that define the scope of the report. If a templat
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.
----------
YXBwL3RvdGFscmV0LnR4dCwjdGVsbG1ldGVzdHNuLHByb2dyYW1tL3By
b2dyYW1tLmh0bSwwLjE4OTQ5NTI3NDE0NjIxMDky
The tags and delimit an encrypted eXtensible Markup Language(XML) stream describing the report, including its associated domain. Two-Way Email needthis information to retrieve the report code from the Managed Reporting Repository and rout
it to the WebFOCUS Reporting Server for execution.
The prompt at the top of the sample template instructs you to supply a parameter value oline 1 of your reply. In this case, you must enter the name of a product category that exist
in the data source, such as Coffee, Food, or Gifts. If you enter Coffee, the report will contaionly data that applies to that category.
How to Request a ReportProcedure:
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 1
1. Using Two-Way Email
8/2/2019 wf77twowayemail
18/74
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 proces
the reply correctly.
3. If the report requires a parameter value, type it on the first line of the reply. Type multiplvalues on successive lines, each on a line by itself.
To accept the default value of a parameter, type a period (.) on the applicable line inyour 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 yo
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 aparameter.
Requesting a Report With a ParameterExample:
Suppose you want a report that shows the number of units sold, and the total dollar amoun
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 valufor the product category of interest.
A Managed Reporting Administrator or Developer can create the Standard Report and templatfor 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 WebFOCU
Requesting a Report
8/2/2019 wf77twowayemail
19/74
8/2/2019 wf77twowayemail
20/74
5. Click Send.
Two-Way Email sends the report to you.
PAGE 1
Category Store ID Budget Units Unit Sales
-------- -------- ------------ ----------
Gifts R1019 79552 78869
Updating Your Subscription Information
How to:
Access the Subscription Update Page
Add a New E-mail Address
Delete an Existing E-mail AddressRefresh 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 associate
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 accidentalldelete 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 WebFOCU
Updating Your Subscription Information
8/2/2019 wf77twowayemail
21/74
How to Access the Subscription Update PageProcedure:
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 thedefault port number) of the Application Server where the ReportCaster Web applicatio
is deployed.
rc_context_root
Is the site-customized context root for the ReportCaster Web application deployedon your Application Server. The default value is rcaster.
2. Type your Managed Reporting user ID and password as assigned by the ManagedReporting Administrator.
3. Click Updating a current Two-Way Email subscription, as shown in the following image.
4. Click Continue.
Using Two-Way Email 2
1. Using Two-Way Email
8/2/2019 wf77twowayemail
22/74
As shown in the following image, the next dialog box allows you to perform update tasks
as described in the procedures that follow.
How to Add a New E-mail AddressProcedure:
1. In the Email address field, type the new address.
2. ClickAdd.
22 WebFOCU
Updating Your Subscription Information
8/2/2019 wf77twowayemail
23/74
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 repl
to the message, the address is activated, and Two-Way Email sends the templates yoare authorized to use.
Using Two-Way Email 2
1. Using Two-Way Email
8/2/2019 wf77twowayemail
24/74
How to Delete an Existing E-mail AddressProcedure:
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 followinimage.
3. Click OKto 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 youwant to proceed with that action.
24 WebFOCU
Updating Your Subscription Information
8/2/2019 wf77twowayemail
25/74
Click OKto delete your subscription, or click Cancel to discontinue the procedure. If yo
click OK, Two-Way Email informs you that you are not in its user database as shown inthe following image.
How to Refresh Your TemplatesProcedure:
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 addres
specified.
How to Update Your Security CredentialsProcedure:
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 botReportCaster and Two-Way Email. For more information on ReportCaster Alerts, see the
WebFOCUS Managed Reporting Developers Manual .
Using Two-Way Email 2
1. Using Two-Way Email
8/2/2019 wf77twowayemail
26/74
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 armet. You can use the attached Two-Way Email template to respond to the alert to request
a report for more detail.
Responding to an AlertExample:
A Managed Reporting Administrator or Developer can create the sample alert and templatfor 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 andsending 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 AlertWhen it is delivered, open it and view the report. A template will be attached. Notice tha
the template prompts you for a store code.
PAGE 1
Category Store ID Dollar Sales
-------- -------- ------------
Coffee R1019 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 correctlprocess the reply.
3. Type the store code you are interested in.
26 WebFOCU
Responding to an Alert
8/2/2019 wf77twowayemail
27/74
4. Click Send.
Two-Way Email sends the comparison report to you. For example, if you requestedinformation on store code R1088, you receive the following report.
PAGE 1
Category Store ID Dollar Sales
-------- -------- ------------
Coffee R1088 1375040
Using Two-Way Email 2
1. Using Two-Way Email
8/2/2019 wf77twowayemail
28/74
28 WebFOCU
Responding to an Alert
8/2/2019 wf77twowayemail
29/74
WebFOCUS
Two-Way Email Administration2
Topics:As a Managed Reporting Administrator
and ReportCaster Administrator, you canuse the Two-Way Email Administrator
console to manage subscriberinformation, monitor the execution of
report requests, cancel requests, andperform other administrative tasks.
Accessing the Administrator Console
Adding or Deleting a Subscriber
Maintaining an E-mail Address
Refreshing User Templates
For information on developing Two-WayEmail templates, see Developing a Two-
Way Email Template on page 45.Using the Job Log
Using the Event Log
Checking the Status of a Job orCanceling a Job
Using Two-Way Email 2
8/2/2019 wf77twowayemail
30/74
Accessing the Administrator Console
How to:
Access the Console and View Current Subscribers
The Two-Way Email Administrator console enables the Managed Reporting Administrator tperform 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 tothe WebFOCUS Reporting Server for execution). You can also cancel a queued job.
How to Access the Console and View Current SubscribersProcedure:
In the Managed Reporting browser blue toolbar, click Two-Way Email. In the Developer Studi
Explorer, click the Two-Way Email Administrator button in the toolbar.
30 WebFOCU
Accessing the Administrator Console
8/2/2019 wf77twowayemail
31/74
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 subscribe
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 ardeleting 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 Emai
Administrator console, the subscriber receives a confirmation message from Two-Way Emaiacknowledging the subscription request. The user must reply to the message. The subscriptio
is activated once the confirmation process is complete.
Using Two-Way Email 3
2. Two-Way Email Administration
8/2/2019 wf77twowayemail
32/74
How to Add a New SubscriberProcedure:
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-Wa
Email Administrator button in the toolbar.
2. ClickAdd 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 valuesspecified in the Two-Way tab in the ReportCaster Server Configuration Tool, select theUse default credentials check box.
5. Type the user e-mail address. ClickAdd and the new user appears under Two-Way Ema
subscribers.
If the user already has a Two-Way Email account, you receive a message informing yothat the subscription procedure failed for that reason.
If you make typing errors, click Reset to clear the fields.
32 WebFOCU
Adding or Deleting a Subscriber
8/2/2019 wf77twowayemail
33/74
How to Delete an Existing SubscriberProcedure:
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-Wa
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 newaddress from Two-Way Email and must reply to it. The new address is activated after the
confirmation process is complete.
How to Add a New E-mail AddressProcedure:
1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access theTwo-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Wa
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. ClickAdd Email.
4. In the dialog box that appears, type the new e-mail address in the field and click Add.
Using Two-Way Email 3
2. Two-Way Email Administration
8/2/2019 wf77twowayemail
34/74
How to Delete an Existing E-mail AddressProcedure:
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-Wa
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, undeAddresses 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 thauser.
How to Refresh User TemplatesProcedure:
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-Wa
Email Administrator button in the toolbar.
2. Using the console, select the user from the list on the left, under Two-Way Emailsubscribers.
3. Select the address, or addresses, to send the templates to using the list on the rightunder Addresses for subscriber.
4. Click Refresh Templates.
5. Click OKto resend the templates that the subscriber is authorized to use.
34 WebFOCU
Refreshing User Templates
8/2/2019 wf77twowayemail
35/74
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 theWebFOCUS 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 an
distribution of a report. The Job Log enables you to confirm that a report was executed andistributed 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 3
2. Two-Way Email Administration
8/2/2019 wf77twowayemail
36/74
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
How to View the Status of an Executed JobProcedure:
1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access theTwo-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Wa
Email Administrator button in the toolbar.
2. Click theJob Logbutton on the left to display the Job Log Report interface as shown i
the following image.
36 WebFOCU
Using the Job Log
8/2/2019 wf77twowayemail
37/74
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 thtime frame. Information on all jobs run from that date and time up to the current dat
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 tim
frame will be retrieved.
Select the option Yes for Last Executed. Information for only the most recentlyexecuted job associated with the template (Job Description) during the specified tim
frame will be retrieved.
4. Click the Click to Viewbutton 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 andconserve 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.cf
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.
How to Purge the Job LogProcedure:
1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access theTwo-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Wa
Email Administrator button in the toolbar.
Using Two-Way Email 3
2. Two-Way Email Administration
8/2/2019 wf77twowayemail
38/74
2. Click theJob Logbutton on the left to display the Job Log Report interface as shown i
the following image.
3. Using the drop-down lists for Ending Date, specify a date through which the Job Log wi
be purged.
4. Click the Click to Purge button. Respond to the confirmation message in the dialog bothat 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 distributeas a report. The Event Log is an HTML page that opens in a browser window.
38 WebFOCU
Using the Event Log
8/2/2019 wf77twowayemail
39/74
You can customize the content of the Event Log. Edit the EVENTLOG parameter in the Two
Way Email tab window of the Distribution Server Environment Setting window as shown inthe following image.
The descriptions for each setting are outlined in the following table.
DescriptionSetting
Displays all events.ON
Turns off the Event Log. Nothing is displayed.OFF
Displays only errors.ERROR
Using Two-Way Email 3
2. Two-Way Email Administration
8/2/2019 wf77twowayemail
40/74
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.
How to Monitor E-mail TrafficProcedure:
1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access theTwo-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Wa
Email Administrator button in the toolbar.
40 WebFOCU
Using the Event Log
8/2/2019 wf77twowayemail
41/74
2. Click the Event Logbutton on the left to display the Event Log Report interface as show
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 timeframe. 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 theevents 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 useID 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 eventsassociated with the supplied IDs and address during the specified time frame will
be retrieved.
4. Click the Click to Viewbutton to display the Event Log report.
Using Two-Way Email 4
2. Two-Way Email Administration
8/2/2019 wf77twowayemail
42/74
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 andconserve space.
How to Purge the Event LogProcedure:
1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access theTwo-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Wa
Email Administrator button in the toolbar.
2. Click the Event Logbutton on the left to display the Event Log Report interface, as showin 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 bothat appears. Two-Way Email will delete all reports from the beginning of the Event Lo
through the specified ending date.
42 WebFOCU
Using the Event Log
8/2/2019 wf77twowayemail
43/74
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 theWebFOCUS Reporting Server for execution (a queued job). You can also cancel a queued
job.
How to Check the Status of a JobProcedure:
1. Select Two-Way Email on the Managed Reporting browser blue toolbar to access theTwo-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Wa
Email Administrator button in the toolbar.
2. Click theJob 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 4
2. Two-Way Email Administration
8/2/2019 wf77twowayemail
44/74
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 th
WebFOCUS Reporting Server for execution.
Two-Way Fex. The name of the procedure for the Managed Reporting StandardReport.
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 defaultinterval of 10, as shown in the following image, or supply a new interval in seconds.
Click Refresh to immediately retrieve the latest information.
How to Cancel a Queued JobProcedure:
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-Wa
Email Administrator button in the toolbar.
2. Click theJob Status button on the left.
3. Select one or more jobs from the list under Queued Jobs and click Delete to cancel
execution.
44 WebFOCU
Checking the Status of a Job or Canceling a Job
8/2/2019 wf77twowayemail
45/74
WebFOCUS
Developing a Two-Way Email Template3
Topics:As a Managed Reporting Administrator
or Developer, you use ManagedReporting to create and maintain Two-
Way Email templates, the means bywhich a user requests a report.
How Two-Way Email Works
Creating a Template
This topic describes several features of
Two-Way Email, such as its processing
steps, that will help Administrators andDevelopers understand the tasks andoversee the Two-Way Email capability. It
also includes instructions on performingspecific tasks.
Maintaining a Template
Sending a Template to Users
Attaching a Two-Way Email Templateto an Alert
For information on using the Two-WayEmail Administrator console, see Two-
Way Email Administration on page 29.
Using Two-Way Email 4
8/2/2019 wf77twowayemail
46/74
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 templatesfrom 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-WayEmail.
Two-Way Email sends the user a confirmation message through e-mail acknowledgingthe 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 WebFOCU
How Two-Way Email Works
8/2/2019 wf77twowayemail
47/74
Subscription and Confirmation Processing
The following steps take place when a new user subscribes to Two-Way Email using an HTM
subscription page. A Managed Reporting Administrator and ReportCaster Administrator caalso subscribe a new user from the Two-Way Email Administrator console.
The following images depict the steps being explained.
Two-Way Email sends aconfirmation message to th
user through e-mail.
Two-Way Email checks the
user ID, password, anddomain authorization, links
the security credentials tothe applicable templates,
and creates a new userrecord in the Two-Way Email
user database.
From a browser, a useraccesses the HTMLsubscription page and
supplies the ManagedReporting user ID and
password, WebFOCUSReporting Server user ID
and password, and e-mailaddress.
Two-Way Email retrieves thapplicable templates from
the Managed Reporting
Repository and sends themto the validated, registereduser as e-mail messagess.
Two-Way Email receives the
confirmation reply and verifiesthe Reply-To address in the
user record in the Two-WayEmail database.
The user receives andreplies to the confirmation
message through e-mail,using a handheld device,
laptop, or desktop computer.
Using Two-Way Email 4
3. Developing a Two-Way Email Template
8/2/2019 wf77twowayemail
48/74
Report Request Processing
The following steps take place when a user requests a report.
The Two-Way EmailDispatcher takes the
request off the queue andstarts a Worker thread.
The Two-Way Email Listener
monitors its inbox on the e-mail server and detects the
request. It validates theaddress of the sender as a
subscriber address andqueues the request.
In the handheld device,laptop, or desktop
computer from the e-mailclient, the user selects,
replies to, and sends atemplate. The e-mail is
routed to an e-mail server.
The Distribution Serversends the e-mail message
The Worker starts an agenton the WebFOCUS
Reporting Server. Theserver runs the procedure
with any parameter values.The Reporting Server sends
output back to theDistribution Server.
The Worker checks thesecurity credentials from
Managed Reporting,retrieves the Standard
Report procedure, mergesit with parameter values,
and sends it to theWebFOCUS Reporting
Server for processing.
48 WebFOCU
How Two-Way Email Works
8/2/2019 wf77twowayemail
49/74
Secured Message Delivery
Two-Way Email provides the same level of secured message delivery as provided by Simpl
Mail Transfer Protocol (SMTP).
Managed Reporting enables central management of user access to data. As a ManagedReporting Administrator, you use standard Managed Reporting security features to establis
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 Processingon 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-WaEmail 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 Two-Way 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 correcaddress 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 Processingon 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 Emai
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. Non-
Two-Way Email requests are sent to an error account. The e-mail address for this accountis specified during WebFOCUS installation.
Make sure that someone periodically checks and cleans up the error account.
Using Two-Way Email 4
3. Developing a Two-Way Email Template
8/2/2019 wf77twowayemail
50/74
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 reportthat 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
"UNITS SOLD FOR COFFEE"
"AND BUDGETED UNITS"
"CATEGORY: "
"UNITS SOLD: "
"BUDGETED UNITS: "
FOOTING
"Confidential"
BY CATEGORY
WHERE CATEGORY EQ 'Coffee'
END
50 WebFOCU
How Two-Way Email Works
8/2/2019 wf77twowayemail
51/74
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 OVERCOMPUTE DIFF_DOLLARS = BUDDOLLARS - DOLLARS;
END
See the Creating Reports for WebFOCUS Language manual, for details on report display ansyntax.
Alert Response
Two-Way Email alert response is available only at sites that have licensed and installed botReportCaster 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 toa ReportCaster Alert. The user is alerted when certain pre-defined data conditions are metand 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 ParametersCreate 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 5
3. Developing a Two-Way Email Template
8/2/2019 wf77twowayemail
52/74
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 anyparameter 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 StandarReport and selecting Show Two-Way Email Templates. In the browser, the template is locateunder the associated Standard Report.
Note: Two-Way Email does not support Compound Reports.
How to Create a Template Without ParametersProcedure:
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 Templat
dialog box opens. Skip to Step 3.
Developer Studio, select Show Two-Way Email Templates.
2. From the Two-Way Email Templates tab, click Newto 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 Explorerin 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 thSubject Line field. This value appears as the subject of the e-mail message sent to thuser.
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 EndinMessage field.
This description or message appears in the body of the Two-Way Email template.
5. Click Email Previewto 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 andclicking Email Preview.
6. Close the preview window when you are done.
52 WebFOCU
Creating a Template
8/2/2019 wf77twowayemail
53/74
7. Click OKon 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.
Creating a Template Without ParametersExample:
Suppose you want to create a Two-Way Email template from a Standard Report named LinPrice.
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 Templat
dialog box opens. Skip to Step 3.
Developer Studio, select Show Two-Way Email Templates.
Using Two-Way Email 5
3. Developing a Two-Way Email Template
8/2/2019 wf77twowayemail
54/74
2. From the Two-Way Email Templates tab, click Newto 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 appearsas the subject of the e-mail message sent to the user.
54 WebFOCU
Creating a Template
8/2/2019 wf77twowayemail
55/74
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 Previewto display the template as the user will see it.
You can use RIM or Palm handheld emulation to preview the template. Toggle betweenthe 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 5
3. Developing a Two-Way Email Template
8/2/2019 wf77twowayemail
56/74
7. Click OKon 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 OKagain to exit the Line Price Properties dialog box.
How to Create a Template With ParametersProcedure:
1. Right-click the Standard Report from which you want to create a Two-Way Email templateOn the pop-up menu in:
The browser, select New Two-Way Email Template. The New Two-Way Email Templat
dialog box opens. Skip to Step 3.
Developer Studio, select Show Two-Way Email Templates.
2. From the Two-Way Email Templates tab, click Newto open the New Two-Way EmailTemplate dialog box.
3. On the New Two-Way Email Template dialog box, type the subject of the template in thSubject Line field. This value appears as the subject of the e-mail message sent to th
user.
Two-Way Email uses the name of the Standard Report as the default subject, followedby a Two-Way Email identifier (for example, TW).
4. Type a description of the template, or an informative message for the user, in the EndinMessage 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 WebFOCU
Creating a Template
8/2/2019 wf77twowayemail
57/74
5. For each parameter, specify a property, as outlined in the following table.
DescriptionProperty
User must supply a value for the parameter.Require User Input
User can supply a value or use the default value. Type thedefault 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.
Allow Default
Administrator supplies the value that cannot be changed by theuser. Type the required value in the field labeled Value.
Use Value
Does not prompt for a parameter value on the Two-Way Emailtemplate. Specify this property only when the parameter is
already set on the WebFOCUS Reporting Server in a profile orstored procedure.
Disable
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 ispecified.
6. If you click Require User Input orAllow Default, you can supply a prompt that the user
will see in the template. For each parameter, type the applicable prompt in the Prompfield.
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 (.) onthe appropriate line to accept the default value.
7. Click Email Previewto display the template as the user will see it.
You can use RIM or Palm handheld emulation to preview the template. Toggle betwee
the two emulators by holding down the Shift key and clicking Email Preview.
8. Close the preview window when you are done and click OKon 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 5
3. Developing a Two-Way Email Template
8/2/2019 wf77twowayemail
58/74
9. Accept the default name, or type another name for the template, and click OK.
Creating a Template With a ParameterExample:
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 bythe 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. Onthe pop-up menu in:
The browser, select New Two-Way Email Template. The New Two-Way Email Templat
dialog box opens. Skip to Step 3.
Developer Studio, select Show Two-Way Email Templates.
58 WebFOCU
Creating a Template
8/2/2019 wf77twowayemail
59/74
2. From the Two-Way Email Templates tab, click Newto 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. Thivalue 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, Digita
Tape Recorders, PDA Devices, VCRs.
5. Confirm that the Require User Input radio button is selected.
Using Two-Way Email 5
3. Developing a Two-Way Email Template
8/2/2019 wf77twowayemail
60/74
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 Previewto display the template as the user will see it.
You can use RIM or Palm handheld emulation to preview the template. Toggle betweenthe two emulators by holding down the Shift key and clicking Email Preview.
8. Close the preview window when you are done and click OKon 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.
Creating a Template With Multiple ParametersExample:
Suppose you want to create a Two-Way Email template using a Standard Report namedInventory 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 valuprovided 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 StoreCode. From the pop-up menu in:
The browser, select New Two-Way Email Template. The New Two-Way Email Templat
dialog box opens. Skip to Step 3.
Developer Studio, select Show Two-Way Email Templates.
60 WebFOCU
Creating a Template
8/2/2019 wf77twowayemail
61/74
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. Thi
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.
SelectAllow Default.
5. In the Value field, type the default value, DVD.
Using Two-Way Email 6
3. Developing a Two-Way Email Template
8/2/2019 wf77twowayemail
62/74
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, Digita
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 itsproperties.
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 WebFOCU
Creating a Template
8/2/2019 wf77twowayemail
63/74
8/2/2019 wf77twowayemail
64/74
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 existin
Two-Way Email template from Managed Reporting.
If you edit a Standard Report associated with a Two-Way Email template and then open thtemplate, 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 OKto remove the message.
How to Edit a TemplateProcedure:
1. In Developer Studio, right-click the Standard Report that contains the Two-Way Emailtemplate 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 WebFOCU
Maintaining a Template
8/2/2019 wf77twowayemail
65/74
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 6
3. Developing a Two-Way Email Template
8/2/2019 wf77twowayemail
66/74
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 texbox.
3. Make all necessary changes and click Email Previewto make sure the template appearas desired.
You can use RIM or Palm handheld emulation to preview the template. Toggle betweethe two emulators by holding down the Shift key and clicking Email Preview.
4. Close the preview window when you are done.
5. Click OKon the Two-Way Email window to save the changes.
66 WebFOCU
Maintaining a Template
8/2/2019 wf77twowayemail
67/74
How to Rename a TemplateProcedure:
1. From Developer Studio, right-click the Standard Report that contains the Two-Way Ema
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 th
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.
How to Delete a TemplateProcedure:
1. From Developer Studio, right-click the Standard Report that contains the Two-Way Ematemplate 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 Ste
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 templateor modify existing ones. You can send a copy of a new or modified template to authorized
users.
How to Send a Template to UsersProcedure:
1. From Developer Studio, right-click the Standard Report that contains the new or modifietemplate 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 6
3. Developing a Two-Way Email Template
8/2/2019 wf77twowayemail
68/74
Attaching a Two-Way Email Template to an Alert
This feature is available only at sites that have licensed and installed both ReportCasterand Two-Way Email. Two-Way Email is only available with ReportCaster.
A Managed Reporting Administrator or Developer can attach a Two-Way Email template toa ReportCaster Alert. The user is alerted when certain predefined data conditions are metand 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 timeaction.
For the procedure on attaching a Two-Way Email template to a ReportCaster Alert using thAlert 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 Emailtemplates. Alert response enables many event-critical activities other than the simple one
illustrated here, including drill-down reporting or data source maintenance.
Attaching a Two-Way Email Template to an AlertExample:
In this example, the user is alerted when the total coffee sales for store code R1019 excee$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 salesfor 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 creat
this template in Step 2.
The user types the store code of interest for comparison purposes, and receives a secondreport showing the coffee sales for the supplied store code. You create the second reportin Step 1.
68 WebFOCU
Attaching a Two-Way Email Template to an Alert
8/2/2019 wf77twowayemail
69/74
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 attacheto 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 toCreate a Template With Parameters on page 56. The template prompts the user for astore 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 datacondition that is monitored, such as in the following example when the total coffee sale
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 6
3. Developing a Two-Way Email Template
8/2/2019 wf77twowayemail
70/74
4. Using the Alert Wizard, create an alert event as follows. An alert event is the report tha
is distributed if the alert test is true.
TABLE FILE GGSALES
SUM DOLLARS
BY CATEGORYBY STCD
WHERE CATEGORY EQ 'Coffee'
WHERE STCD EQ 'R1019'
WHERE TOTAL DOLLARS GT 1000000
END
5. Using the Alert Wizard, selectAttach 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 ale
for testing once a day.
For the Subject on the Distribution tab in the ReportCaster schedule, type Coffee Sales
Alert.
70 WebFOCU
Attaching a Two-Way Email Template to an Alert
8/2/2019 wf77twowayemail
71/74
WebFOCUS
Index
A
Add Two-Way Email Subscriber dialog box 31, 32
alert events 25
alert response 25, 26
D
default parameters 19
E
error accounts 49
Event Log for Two-Way Email 38
purging 38
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
R
report parameters 19
report requests 18
ReportCaster 25
reports 17, 18, 45, 48, 50
designing 50displaying 50
processing 48requesting 17, 18, 48
S
subscribers 30
T
templates 16, 25, 51, 52, 53, 56, 58, 60, 64,67, 68
attaching to an alert 51, 68creating 51, 52, 53, 56, 58, 60
deleting 64, 67editing 64
refreshing 25renaming 64, 67
sending 67Two-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 22adding subscribers 31
deleting addresses 24deleting subscribers 31
designing reports 50displaying reports 50
enabling 46
Using Two-Way Email 7
8/2/2019 wf77twowayemail
72/74
Two-Way Email (continued)
error accounts 49Event Log 38
Job Log 35replying to confirmation messages 15, 16
requesting reports 17, 18, 48security 15, 49
specifying report parameters 18subscriber credentials 49
subscribing 12, 13, 47templates 64
updating security credentials 25updating subscription information 20, 21
verifying 47viewing current subscribers 30
viewing job status 35, 36Two-Way Email Administrator console 30, 31, 32,
33, 34, 35, 38, 40, 41, 42, 43, 44accessing 30
adding addresses 33adding subscribers 31, 32
Two-Way Email Administrator console (continued)
canceling reports 43, 44deleting addresses 33, 34
deleting subscribers 31, 33monitoring e-mail traffic 40, 41
purging the Event Log 42purging the Job Log 38
refreshing templates 34using the Event Log 38
using the Job Log 35viewing current subscribers 30
viewing job status 43Two-Way Email templates 16, 25, 51, 52, 53, 56,
58, 60, 64, 67, 68attaching to an alert 51, 68
creating 51, 52, 53, 56, 58, 60editing 64
refreshing 25renaming 67
sending 67
72 WebFOCU
Index
8/2/2019 wf77twowayemail
73/74
WebFOCUS
Reader Comments
In an ongoing effort to produce effective documentation, the Documentation Services staf
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 followinmethods:
Documentation Services - Customer SupportMail:Information Builders, Inc.
Two Penn PlazaNew York, NY 10121-2898
(212) 967-0460Fax:
http://www.informationbuilders.com/bookstore/derf.htmlWeb form:
Name:
Company:
Address:
Telephone: Date:
Email:
Comments:
Information Builders, Two Penn Plaza, New York, NY 10121-2898 (212) 736-4433
Using Two-Way Email DN4501032.051Version 7 Release 7
mailto:[email protected]://www.informationbuilders.com/bookstore/derf.htmlhttp://www.informationbuilders.com/bookstore/derf.htmlmailto:[email protected]8/2/2019 wf77twowayemail
74/74
Creating Reports WithWebFOCUS LanguageVersion 7 Release 6
Using Two-Way Email
Version 7 Release 7
Recommended