WebFOCUS Online Help > ReportCaster Development and Administration > Creating and Maintaining a Schedule > Specifying Distribution Options
In this section: |
The Distribution tab enables you to select how you want to distribute scheduled output. ReportCaster Administrators can specify which distribution methods will appear in the Distribution tab using the Schedule Method setting in the ReportCaster Server Configuration tool (for more information, see Specifying Schedule Method Settings). By default, you can distribute scheduled output using one of the following methods:
You can only schedule multiple tasks when using the Email and Printer distribution methods.
You can distribute scheduled output as e-mail attachment(s) or inline within the body of an e-mail message. Distributing scheduled output as an inline e-mail message is particularly useful when output is distributed to mobile devices, fax machines, or through e-mail systems that do not support attachments. For more information about distributing scheduled output to a fax machine, see Distributing Scheduled Output to a Fax Machine Using E-mail.
Note: The availability of the inline message option when you create a schedule depends on the Inline Report Distribution setting in the ReportCaster Server Configuration tool.
When distributing to PDA or Blackberry, check the capabilities of the device. If the device does not support attachments, use the inline option. The WP format is recommended.
Note: You can only distribute one Task as an inline e-mail message. If you are scheduling multiple Tasks using e-mail, the additional Tasks must be distributed as e-mail attachments.
From this screen, you can:
Create a new Distribution List by clicking the New icon.
View or edit a Distribution List by selecting the list and clicking the Edit icon. The contents of the list can only be changed by the ReportCaster Administrator or the owner of the Distribution List.
Delete a Distribution List by selecting the list and clicking the Delete icon. The Distribution List can only be deleted by the ReportCaster Administrator or the owner of the Distribution List.
Refresh an Address Book to display any new Distribution Lists that other users may have created.
Click OK to return to the Distribution tab. For more information about Distribution Lists, see Distribution List Overview.
Note: If the Email Delivery, Restrict Email Domains option is set to yes in the ReportCaster server configuration tool, then only those e-mail domains (the portion of the e-mail address following the at symbol) listed in Allowed Email Domains (also in the server configuration tool) are valid e-mail recipients.
Tip: You can specify multiple e-mail addresses with the Single Address option. In the To field, separate each e-mail address with a comma or a semicolon. The e-mail addresses will appear in the To: line of a single e-mail when the scheduled output is distributed. Each individual e-mail address can be a maximum of 130 characters as per SMTP specification. The total maximum length of this field is 800 characters.
Additionally, you can use group mail lists (defined on your mail server) with the Single Address option. Group mail lists enable you to distribute a report or notification to multiple recipients without having to maintain multiple e-mail addresses in the ReportCaster Repository. The format of the group mail list is dependent upon the mail server being used. For example, if you are using a Microsoft Exchange Server and your group mail list is defined as #group1, you would type group1@listdomain in the Single Address field. If the group mail list contains a space within its name, it must be enclosed within quotation marks. For more information, see your mail server administrator.
Tip: You can retrieve e-mail addresses defined in an LDAP data source. For more details, see How to Retrieve E-mail Addresses for a Schedule Using Address Search.
Specify the WebFOCUS Reporting Server Name, the Execution ID and password for the server, and the procedure name that creates the dynamic distribution list. For more information about dynamic distribution lists, see Creating a Dynamic Distribution List.
Tip: You can retrieve e-mail addresses defined in an LDAP data source. For more details, see How to Retrieve E-mail Addresses for a Schedule Using Address Search.
When creating a schedule, you can place multiple parameters and burst values from the scheduled procedure in an e-mail subject line. This allows the subject to be dynamically created in order to personalize e-mails to recipients. Parameters referenced in the subject line must be stored with the schedule information in the ReportCaster tables.
Parameters must be specified in the format '&parmname' (where parmname is the name of the parameter). Burst values must be specified using the syntax '%BURST'.
Note:
For an example of specifying parameters and burst values in an e-mail subject line, see Specifying Parameters and Burst Values in an E-mail Subject Line.
If you select the Zip File for Report option, then enter a name for the file in the Zip File Name field.
Note:
Note: For considerations you should be aware of when using a Microsoft Exchange Server or cc:Mail, see Considerations When Distributing Scheduled Output Using E-mail.
This schedule specifies burst values and multiple parameters in the e-mail subject line:
The above schedule might result in an e-mail similar to the following:
To search for e-mail addresses to add to a schedule:
Note: The Address Search icon only appears if the Email LDAP Enabled parameter is set to YES in the ReportCaster Server Configuration tool. For more information, see LDAP Settings.
The Address Search window opens.
For example, if you type S after the Last Name Starts with field, ReportCaster retrieves last names that start with the letter S:
Note: By default, ReportCaster retrieves a maximum of 300 e-mail addresses. You can change this default value for the duration of your session. However, if you log out and log back in, the Address Search window displays the default value of 300. ReportCaster allows the retrieval of a maximum of 500 e-mail addresses. If you suspect your search will return more than 500 records, you should refine your search criteria.
In this example, the e-mail addresses are added to the To field of your schedule:
By default, ReportCaster separates multiple e-mail addresses with a comma. The e-mail addresses will appear in the To: line of a single e-mail when the scheduled output is distributed.
Note: Repeat these steps if you want to change your search criteria or insert additional e-mail addresses into your schedule. If you insert additional e-mail addresses while the original e-mail addresses are selected, the new e-mail addresses will replace the old ones. If your cursor is positioned after the original e-mail addresses, the new e-mail addresses will be appended to the old ones, separated by a comma. However, be aware that the maximum number of characters is 800 when inserting addresses.
To send an inline e-mail message to a fax machine, you must register your e-mail address with a third-party e-mail distribution provider. The features offered by providers, (such as supported area codes and file formats), in addition to requirements on the structure of e-mail parameter values, may vary. It is important that you select a provider whose features are compatible with ReportCaster.
The following example shows how to distribute scheduled output directly to a fax machine. The e-mail address, john_doe@ibi.com, was registered with the e-mail distribution provider called emfax.com. During the processing of the request, ReportCaster generates the scheduled output and then distributes it using the e-mail address of emfax.com. The reply address specified in ReportCaster is the registered e-mail address that will be validated by emfax.com. If the e-mail address is valid, emfax.com will distribute the scheduled output to the fax number 12129999999. The validation of the registered e-mail address is performed by emfax.com, not by ReportCaster.
Note: The syntax used in this illustration is specific to this example. The required syntax for your provider may be different.
Note: You cannot distribute an e-mail attachment to a fax machine.
Note: You can also select a Distribution List, Distribution File, or a Dynamic Address. However, be sure to use the syntax required by your provider.
Note: If the Email Delivery, Restrict Email Domains option is set to yes in the ReportCaster server configuration tool, then only those e-mail domains (the portion of the e-mail address following the at symbol) listed in Allowed Email Domains (also in the server configuration tool) are valid e-mail recipients. The Distribution Server will not deliver output to an e-mail address whose domain is not on this list. Instead, the schedule will fail and an error message is written to the ReportCaster log.
ReportCaster transfers e-mail asynchronously to your e-mail system. The delivery time depends upon your e-mail system.
Exchange Mail Server Considerations:
Alternatively, you can contact Microsoft customer support for assistance. If you are using a mail server other than a Microsoft Exchange Server, refer to that vendor's documentation or contact their customer support for assistance.
CC:Mail Considerations:
When you distribute ReportCaster generated e-mail attachments greater than 20K in size to users of cc:Mail, cc:Mail renames the attachment textitm.txt, ignoring the file name and extension supplied by the user. This change affects DOC, HTML, and WP formats on UNIX and Windows platforms. However, despite the naming convention issue, the attachments contain the correct output and can be viewed if the attachment is saved to disk with the correct extension.
The following topics provide information about distributing scheduled output using File Transfer Protocol (FTP) or SSH File Transfer Protocol (SFTP). The benefit of using SFTP over FTP is that it encrypts the data and user credentials distributed over the network. Host key fingerprints are not used in this SFTP implementation.
Note:
The following procedure shows how to distribute scheduled output using FTP or SFTP. The SFTP distribution method does not support Prepared Reports.
The following image shows the New Schedule Distribution tab for FTP distribution. The selection are the same for SFTP distribution.
In this field, you can also designate a port for the (S)FTP server other than the default assignment using the syntax, hostname:port.
Note: When scheduling a Managed Reporting report from Domain Builder for (S)FTP distribution, the maximum number of characters that can be specified for the directory is 64, including the full path name.
From this screen, you can:
Create a new Distribution List by clicking the New icon.
View or edit a Distribution List by selecting the list and clicking the Edit icon. The contents of the list can be changed only by the ReportCaster Administrator or the owner of the Distribution List.
Delete a Distribution List by selecting the list and clicking the Delete icon. The Distribution List can be deleted only by the ReportCaster Administrator or the owner of the Distribution List.
Refresh an Address Book to display any new Distribution Lists that other users may have created.
Click OK to return to the Distribution tab. For more information about Distribution Lists, see Distribution List Overview.
Specify the WebFOCUS Reporting Server Name, the Execution ID and password for the server, and the procedure name that creates the dynamic distribution list. For more information about dynamic distribution lists, see Creating a Dynamic Distribution List.
The name of the index must be typed in the case specific to your operating system.
The following table lists the case you should use for a specific operating system:
Case |
Operating System |
---|---|
Upper |
z/OS |
Lower |
Windows UNIX |
Note: HTML, PDF, EXL2K, and (S)FTP are the only formats that generate an index page for burst report output. These index pages only contain the burst values specified in the Distribution List.
Select None if you do not want to Zip the output.
Select Add Reports to One Zip File to Zip the output in a single file. Type a name for the file in the Zip File Name field.
Select Create Separate Zip Files for Each Burst Value if the schedule task is burst and you want separate Zip files rather than a single file.
Note:
The following are known limitations when using (S)FTP distribution to a z/OS machine:
A file in any other format will be transferred in text mode as an ASCII file. Files in these formats are readable when transferred to UNIX and Windows file systems. Files in these formats that are transferred to a z/OS platform must be translated to EBCDIC before they can be read. The following is the command to translate the file:
iconv -fISO8859-1 -tIBM-1047 ascii.file > ebcdic.file
If you are distributing a report to a Palm™ Personal Digital Assistant (PDA), you must select the DOC format and a .txt extension for the report. The Palm Memo Pad application requires that all file names end with the .txt extension. For more information about how to transfer reports to a PDA using the HotSync process, see your PDA documentation.
When printing on Windows and UNIX, ReportCaster uses the lp (line printer) protocol, which runs on top of TCP/IP to communicate to printers. lp printing with the Novell Client is not supported. For printing on z/OS, ReportCaster uses the lpr (line printer remote) UNIX command, which has special options on the mainframe for sysout dest and class.
Note:
A DEST printserver
where:
Is the SYSOUT class to be assigned to a network printer.
Is the printer host name (for example, IBVM.P24E2).
From this screen, you can:
Create a new Distribution List by clicking the New icon.
View or edit a Distribution List by selecting the list and clicking the Edit icon. The contents of the list can be changed only by the ReportCaster Administrator or the owner of the Distribution List.
Delete a Distribution List by selecting the list and clicking the Delete icon. The Distribution List can be deleted only by the ReportCaster Administrator or the owner of the Distribution List.
Refresh an Address Book to display any new Distribution Lists that other users may have created.
Click OK to return to the Distribution tab. For more information about Distribution Lists, see Distribution List Overview.
queue@printserver
where:
Is the name of the printer queue.
Is the host name or IP address of the printer.
ReportCaster can differentiate between the printer queue and the printer host name/IP address due to the presence of the '@' separator. Information Builders recommends specifying both the printer queue and host name/IP address when distributing ReportCaster output to a printer. However, ReportCaster supports specifying only the host name or IP address of the printer. The maximum length of this field is 800 characters.
Specify the WebFOCUS Reporting Server Name, the Execution ID and password for the server, and the procedure name that creates the dynamic address list. For more information about dynamic address lists, see Creating a Dynamic Distribution List.
Note: If the printer you specify is unrecognized, the "Cannot connect to specified printer" message will be recorded in the log file when the ReportCaster Distribution Server tries to distribute the report.
As a ReportCaster Administrator, you can schedule My Reports and Standard Report for distribution to Managed Reporting.
Tip: Information Builders recommends distributing scheduled output to the Report Library rather than to Managed Reporting. The Report Library includes secure access to library content, the ability to save multiple versions of the same output, and the ability to set an expiration date or keep a specified number of versions.
When you select the Managed Reporting distribution method, the report output is distributed to Managed Reporting as a Standard Report or a My Report. The report is available to other users who have access to the Domain where the report resides.
ReportCaster performs the following tasks when you create a schedule to distribute output to the Managed Reporting Repository:
Note:
The following image shows the Distribution tab dialog box for Managed Reporting.
This is will be the name of the folder(s) that contain the output of the schedule when it runs.
When distributing scheduled output to Managed Reporting, consider the following:
<ADDTYPE> .csv application/vnd.ms-excel binary yes yes no yes no
To drill-down to a WebFOCUS Reporting Server procedure or a Managed Reporting procedure, the original procedure you are scheduling must include the following command:
SET FOCEXURL=http://hostname[:port]/wf_context_root/WFServlet;
where:
Is the host name and optional port number of the Web/Application Server on which the WebFOCUS Client is installed.
Is the site-customized context root for the WebFOCUS Web application deployed on your Application Server. ibi_apps is the default value.
The following FEX shows the coding for a Managed Reporting procedure using the FOCEXURL command.
-* FEX that is scheduled and distributed to the Report Library -* Set FOCEXURL value for navigation back to WF Client and MR context -* for execution of drill down request. Must be coded using -* concatenation of so that WF describe (auto prompting) is not invoked -* and also for character encoding within URL to be done correctly. -* Protocol, host and port to WF client. -* Do not use localhost for the host value! -SET &FOCEXURL='http://host:port'; -* -* Call to WF Client. /ibi_apps is the default URL context -* but can be customized -SET &FOCEXURL=&FOCEXURL | '/ibi_apps/WFServlet?IBIF_webapp=/ibi_apps' '&';
-* If report contains a drilldown the next set of lines are also needed. -* Set WF Reporting Server to run request on -SET &FOCEXURL=&FOCEXURL | 'IBIC_server=EDASERVE' | '&'; -* -* Set whether the message viewer feature is ON or OFF. -* When message viewer feature is ON the browser window displaying the -* report will have multiple frames. The top frame displays -* the report and the bottom frame displays any messages returned -* from the WF Server from the report execution. -* Most often utilized during report development or to debug a problem. -SET &FOCEXURL=&FOCEXURL | 'IBIWF_msgviewer=OFF' | '&'; -* -* IBIMR_drill tells WF client subsequent request is a drill down -* and the information after X, is the HREF of the MR domain -* that the drill down FEX is located in. -* In this example 'salesrpt' is the internal -* domain directory and salesrpt.htm is the HTML file -* containing the metadata information for the contents -* within the salesrpt domain. -SET &FOCEXURL=&FOCEXURL | 'IBIMR_drill=X,salesrpt/salesrpt.htm'| '&'; -* -* SET environmental variable FOCEXURL SET FOCEXURL='&FOCEXURL' -* TABLE FILE CAR SUM CAR.BODY.SALES BY CAR.ORIGIN.COUNTRY BY CAR.COMP.CAR BY CAR.CARREC.MODEL ON TABLE SET STYLE * TYPE=DATA, COLUMN=CAR.ORIGIN.COUNTRY, FOCEXEC=salesrpt/app/carmodel.fex, $ ENDSTYLE ON TABLE SET HTMLCSS ON ON TABLE NOTOTAL END
The following is an example of the drill down FEX that resides in Managed Reporting.
-* HTML Tool -* Created by Report Assistant -* FF Line do not change this line! Field Name -* FF Line do not change this line! Alias -* FF Line do not change this line! Format -* FF Line do not change this line! Segment -* FF Line do not change this line! displayTree=0 TABLE FILE CAR SUM CAR.SPECS.MPG CAR.SPECS.RPM CAR.BODY.SEATS BY CAR.COMP.CAR BY CAR.CARREC.MODEL BY CAR.BODY.BODYTYPE ON TABLE SET HTMLCSS ON ON TABLE NOTOTAL END -* End Report Assistant
When you create a schedule, you can specify to distribute scheduled output to the Report Library, a storage and retrieval facility. The Report Library can contain any information that is distributed by ReportCaster. When distributing to the Report Library, you can send an e-mail informing users of its availability and the link to the content in the library.
The Report Library includes secure access to library content, the ability to save multiple versions of the same output, and the ability to set an expiration date or keep a specified number of versions. The Report Library is only available to ReportCaster users who have been granted library privileges.
The Report Library stores items in categories that you create. These categories allow you to organize scheduled output in the Library for easy identification and tracking. When you choose the Report Library distribution method, you must designate the category that you want the scheduled output to be distributed to in the Category in Library option found in the New Task dialog box. This is a required field except when scheduling Managed Reporting tasks (Standard Reports and My Reports), where there is a default category name using the domain under which the report reside.
The Report Library consists of the Library Access List, Library Content, and Library Management interfaces. For information on accessing and using these interfaces, see Report Library.
Note: When a report is distributed to the Report Library, the Log Report will include the report ID and the report version number. This allows you to confirm which reports and report version were distributed to the Library.
Note: You can limit to whom the Email for Library option is available. For details, see Suppressing Library Distribution Options.
Select the Send email after save report to library check box and then click Email Options. The Email for Library window opens.
If you are on a Windows platform, do not specify localhost within the Library URL. In such a case, when a user receives the URL it will point to the user's own machine rather than the host name of the URL needed to access the content in the library.
Note: If the Library URL field is blank, then no report ID or burst values are sent with the e-mail notification. To directly control whether or not to send a report ID and burst values with an e‑mail notification, see the Send Report ID and Version with Notification Email configuration setting described in Report Library Settings.
Note: If the Email Delivery, Restrict Email Domains option is set to yes in the ReportCaster server configuration tool, then only those e-mail domains (the portion of the e-mail address following the at symbol) listed in Allowed Email Domains (also in the server configuration tool) are valid e-mail recipients.
Note: When a Managed Reporting report (Standard Report or My Report) is distributed to the Report Library, and Public distribution is specified, the library e-mail is sent only to the Managed Reporting users authorized to access the Domain from which the report originated. For Access List distribution, there is no filtering/validation done for the library e-mail, as it is the responsibility of the Access List owner to maintain the list so that it only includes authorized users. Users who receive a library e-mail who are not authorized to view the report as per Managed Reporting security cannot view the report in the library.
Click OK to return to the Distribution tab.
For more information about creating a Library Access List, see Managing Users and Groups Using the Library Access List Interface.
Note: You can limit the Access Options that appear on the Distribution tab. For details, see Suppressing Library Distribution Options.
version(s). The Report Library will store the output for the top number of versions specified. For example, if you specify 3 versions and the current version is 7, then versions 7, 6, and 5 are stored in the library. However, if you delete version 6, then only versions 7 and 5 are stored in the library. If you then distribute version 8 to the library, only version 8 and 7 are stored in the library since version 6 was deleted and version 5 is not among the top 3 versions.
day(s). The Report Library will store the output for the number of day(s) specified.
week(s). The Report Library will store the output for the number of week(s) specified.
month(s). The Report Library will store the output for the number of month(s) specified.
year(s). The Report Library will store the output for the number of year(s) specified.
Note: ReportCaster automatically purges expired output one hour after the Log Purge Time. The default Log Purge Time is 1:00 A.M., therefore, the default library purge time is 2:00 A.M. each day.
ReportCaster Administrators can set compression on by default using the Compression setting in the Library tab in the ReportCaster Server Configuration tool (for more information, see ReportCaster Server Configuration). However, you can override the default setting by selecting the Compression check box.
Note: If you distribute a compressed report to the library, consider that this may impact end user response time in viewing the report. A compressed report must first be decompressed before it is sent to the user. You should weigh the benefits of saving repository space against the impact on end user report retrieval time from the library.
When distributing a report to the Report Library, you can only drill-down to another report if it is a procedure on the WebFOCUS Reporting Server. There is currently no support for drill-down functionality to Managed Reporting procedures.
To drill-down to a WebFOCUS Reporting Server procedure, the original procedure you are scheduling must include the following command:
SET FOCEXURL=http://hostname[:port]/wf_context_root/WFServlet;
where:
Is the host name and optional port number of the Web/Application Server on which the WebFOCUS Client is installed.
Is the site-customized context root for the WebFOCUS Web application deployed on your Application Server. ibi_apps is the default value.
Enabling or disabling the burst option in a schedule being distributed to the library is not recommended because burst and non-burst reports display differently in the library. Rather than editing your schedule and changing this option, Information Builders recommends creating a new schedule as follows:
Note:
When limiting Report Library distribution to values in an Access List, note the following:
WebFOCUS |