The Distributions tab in the Advanced Scheduling tool provides the options available for distributing the scheduled report procedure (FEX), as shown in the following image.
You can distribute a report using one of the following methods.
Note:
How to: |
Reference: |
When you distribute a report through email, you can include the report in the body of the email (known as an inline email message) or send it as an attachment. Only the DHTML, DOC, GIF, HTML, JPG, PNG, SVG, and WP formats can be distributed as an inline email message.
Distributing a report as an inline email message is particularly useful when the report is distributed to mobile devices, fax machines, or through email systems that do not support attachments.
Note: To send an inline email message to a fax machine, you must register your email address with a third-party email distribution provider. The features offered by providers, such as supported area codes, file formats, and requirements on the structure of email parameter values, may vary. It is important that you select a provider whose features are compatible with ReportCaster.
The following image shows the Distribution dialog box of the Advanced Scheduling tool, which can be accessed by selecting the Distribution tab, clicking on the New drop-down list, and selecting Email as the distribution method.
Note:
When you create a schedule that uses email distribution, you can type email addresses in the To field, as shown in the following image.
If you type multiple email addresses in the To field, you can use a semi-colon or comma symbol between each email address, to designate how the Distribution Server delivers information.
If you use the comma symbol to separate email addresses, all email addresses are visible to every email recipient.
The schedule will distribute a report named Sales_Metrics_YTD.htm to these email addresses. When you run the schedule, the log report states that one report named Sales_Metrics_YTD.htm has been distributed to both email addresses through a single email.
If you use the semi-colon symbol to separate email addresses, each recipient only sees their own email address.
The schedule will distribute a report named Sales_Metrics_YTD.htm to these email addresses. When you run the schedule, the log report states that two reports named Sales_Metrics_YTD.htm have been distributed to EmailA@ibi.com and EmailB@ibi.com through separate emails.
You can use the Cc and Bcc options for all types of email schedules. These options allow you to send copies of an email distribution to additional recipients, simplifying the creation of scheduled email distributions. For more information, see Using the Cc and Bcc Email Options.
How to: |
Email is the default value.
Or
Click To in order to open the Enter Email Addresses dialog box and enter email addresses for the recipients. You can use this feature if you must also add email addresses to the Cc or Bcc fields. When your updates are complete click OK.
You can specify multiple email addresses in an email address field. Separate each email address with a comma (,) or a semicolon (;). If you separate multiple addresses by comma, the email addresses will appear in the To line of a single email when the scheduled output is distributed. If you separate multiple addresses by semicolons, the single email address of the recipient will appear in the To line of each of the multiple emails sent when the scheduled output is distributed.
Each individual email address can contain a maximum of 130 characters, according to the SMTP specification. The total maximum length of this field is 800 characters. For more information, see Specifying Multiple E-mail Addresses
Note: You can also use group mail lists (defined on your mail server) with the Email Address(es) option. You can use group mail lists to distribute a report or notification to multiple recipients without having to maintain multiple email addresses in the Repository. The format of the group mail list depends on 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 enter group1@listdomain in the Email Address(es) field. If the group mail list contains a space within its name, enclose the space with double quotation marks ('' ''). For more information, see your mail server administrator.
A Dynamic Distribution List enables you to return in memory, either a list of burst values and destinations, or only a list of destinations from a data source (for example, a flat file, SQL database, FOCUS data source, or LDAP).
When Dynamic Distribution List is selected, the To field is enabled to facilitate the selection of the Procedure Name. Once a procedure is selected, you can pass a parameter on the command line of the fex, as shown in the following image.
For more information, see Creating a Dynamic Distribution List and Generating a Dynamic Distribution List From WebFOCUS Repository Procedures.
Both of these separators cause the distribution server to send the same copy to all parties in the Cc list or the Bcc list.
Or
Use this method if you wish to add a Bcc list. The Bcc List does not appear on the Distribution: Email tab until you enter values in it using the Enter Email Addresses dialog box.
Note:
ReportCaster does not require a value for this field, but your email system may require one.
Note: If a default Mail Reply Address was not provided in the ReportCaster Configuration tool, the default Reply Address used for this field is the email address of the user that is signed in to WebFOCUS. ReportCaster obtains the email address of the user from the WebFOCUS security system.
Note: You can also provide a custom default distribution message using the Email Distribution and Notification settings in the ReportCaster Configuration tool in the ReportCaster Console. This allows you to override the default message, Please see attachment(s), by enabling you to create a custom message specific to your organization. The message displays when creating a schedule using Email distribution. The new message will not affect existing schedules.
Note: When you use the file option, the information can be maintained in one common place. It can also be revised among multiple schedules. There is no size limit to the contents of the file, other than what the email client and server support.
You have the option of converting your distributed report into a password-protected compressed file. By default, the Add Report to Zip File check box is not selected and the Report will not be compressed. You can optionally password protect a zipped file by including a password in a Distribution File or Dynamic Distribution List. For more information, see Creating an External Distribution File or Creating a Dynamic Distribution List.
By default, the Add Report to Zip File check box is not selected and the Report will not be compressed.
Note: Support of Unicode characters in a Zip file name and content within a Zip file on Windows 7 and Windows 2008 Server R2 requires the following hotfix from Microsoft: http://support.microsoft.com/kb/2704299/en-us. Without this hotfix, file names are corrupted after you decompress a .zip file in Windows 7 or in Windows Server 2008 R2.
The Email distribution is listed in the table within the Distribution tab.
After you specify distribution options for Email in the Advanced Scheduling tool, you can customize settings for Mail Server Information.
The Options tab displays, as shown in the following image.
The default Mail Server displays in the Mail Server Name field.
If you select this check box, the Account Name check box and Password button is enabled, allowing you to set values for these fields.
How to: |
This section provides information about distributing scheduled output using File Transfer Protocol (FTP).
Note: You can use parameters (amper variables) when specifying values in the FTP settings of a schedule. These parameters can be system variables, such as &YYMD, or any amper variable for which a value is returned by the Reporting Server when the scheduled procedure is executed. To use the dot file extension separator after a variable terminate the variable with the '|' character (for example, &YYMD|.htm.) Similarly, to use the ampersand character itself, follow the ampersand with the '|' character (for example, Smith&|Jones). If a value for a parameter specified in a schedule is not returned by the Reporting Server when the procedure executes, the schedule will fail with a "No report to distribute" error. If the scheduled task is burst, you can also use the '%BURST' symbol to include the burst value. If the multiple reports are distributed in one archive file, the burst value will not be substituted in the Zip filename.
The Distribution dialog box appears, as shown in the following image.
FTP is the default value.
Note:
Note: When scheduling an FTP distribution, the maximum number of characters you can specify for the directory is 255, including the full path name.
Note:
Without this hotfix, file names are corrupted after you decompress a .zip file in Windows 7 or in Windows Server 2008 R2.
Note: Availability of this option is dependent on your ReportCaster configuration. For more information, see How to Configure FTP Settings. For WebFOCUS Server Procedures, if you are going to specify that the report is to be burst, type the name of the file in which you want the index page to be created.
Important: You must type the name of the index 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 |
---|---|
Uppercase |
z/OS |
Lowercase |
Windows UNIX |
Note: Index pages for burst report output contain only the burst values specified in the Distribution List.
The schedule to distribute appears in the Advanced Scheduling tool.
After you specify distribution options for FTP in the Advanced Scheduling tool, you can customize settings for FTP server information.
The current value for FTP Server Name and Account Name display, by default.
Note:
How to: |
The report formats that support printing are DOC, PDF (when you configure ReportCaster to allow print distribution for PDF format and the printer has the appropriate driver), PS, and WP. For more information, see ReportCaster Configuration.
Note: Problems may occur in printed output if the distributed reports contain UTF-8 characters.
Note: You can use parameters (amper variables) when specifying a value for the Printer Name field of a schedule. These parameters can be system variables, such as &YYMD, or any amper variable for which a value is returned by the Reporting Server when the scheduled procedure is executed. To use the dot file extension separator after a variable terminate the variable with the '|' character (for example, &YYMD|.htm). Similarly, to use the ampersand character itself, follow the ampersand with the '|' character (for example, Smith&|Jones). If a value for a parameter specified in a schedule is not returned by the Reporting Server when the procedure executes, the schedule will fail with a "No report to distribute" error. If the scheduled task is burst, you can also use the '%BURST' symbol to include the burst value.
The following distribution output types are available for Print in the Advanced Scheduling tool.
queue@printserver
where:
Is the name of the printer queue.
Is the host name or IP address of the printer.
Note: ReportCaster can differentiate between the printer queue and the printer host name or IP address due to the presence of an at sign (@) separator. Although ReportCaster supports specifying only the host name or IP address of the printer, we recommend that you specify both the printer queue and host name or IP address when distributing ReportCaster output to a printer. The maximum length of this field is 800 characters.
The schedule task appears in the Advanced Scheduling tool.
How to: |
When scheduling a report procedure (FEX) to distribute report output to the Report Library, specify the Distribution information. The best practice when distributing reports to the Library is to create and specify a different folder location for each Library report to avoid name conflicts when creating multiple schedules for the same report procedure (FEX). This includes the WebFOCUS Repository folder to which to distribute the report, as well as Access Options. These include Owner (Private), Share to Everyone, or Access List (Share Advanced). Expiration of Reports in Library and Report Compression can also be specified.
When scheduling a report procedure for distribution to the Report Library, you select the folder to which the report output will be distributed. Using the Advanced button, you can optionally specify a subfolder to which the output will be distributed. If the subfolder does not exist, it is created dynamically during distribution of the initial schedule execution. During subsequent executions of the schedule, reports are distributed to the existing Library item wherever it is located. You must specify a pattern to be used for the title of the subfolder when the subfolder is created. The pattern can contain text, parameters (amper variables) and, if the scheduled task is burst, the ‘%BURST’ symbol. If the ‘%BURST’ symbol is used, a new subfolder is created for each burst value. You can also select the option to compress a library report when it is stored in the Repository.
You also have the option to specify a Category value to help you further organize the listing of Library reports within the ReportCaster Explorer. In the ReportCaster Explorer, a Category column is available that can be selected to sort Library reports by the Category values.
How to: |
Note: You can use parameters (amper variables) when specifying values for the Library fields of a schedule. These parameters can be system variables, such as &YYMD, or any amper variable for which a value is returned by the Reporting Server when the scheduled procedure is executed. To use the dot file extension separator after a variable terminate the variable with the '|' character (for example, &YYMD|.htm). Similarly, to use the ampersand character itself, follow the ampersand with the '|' character (for example, Smith&|Jones). If a value for a parameter specified in a schedule is not returned by the Reporting Server when the procedure executes, the schedule will fail with a "No report to distribute" error. If the scheduled task is burst, you can also use the '%BURST' symbol to include the burst value.
The Distribution dialog box opens, as shown in the following image.
Report Library is the default value.
The folder location defaults to the same folder as the report procedure (FEX) being scheduled. Users can also select a different folder that they have authority to write to and create content in for the report to be distributed to that location.
Note: As a best practice, create and specify a different folder to which the Library reports will be distributed.
Use the following information to set these options:
If you select Shared with, click the Access List button to invoke the Open dialog box from which you can select an Access List that you are authorized to access.
After you specify distribution options for the Report Library in the Advanced Scheduling tool, you can customize settings for Mail Server Information.
The Options tab displays, as shown in the following image.
The present value for Distribution Name displays by default.
Once the Send email after report saved to library check box is selected, you can customize Mail Server Information and Email for Library settings.
If you Select the This server requires authentication check box, the Account Name and Password button are available to set values for these respective fields.
How to: |
When creating a schedule with Report Library distribution, you can select the Domains folder in the Resources tree as the top-level folder location to which the sub-folders containing library reports will be burst.
You can schedule a library report to be placed in a sub-folder without having to create the sub-folder first. When you schedule a library report to be burst to a top-level folder, the distribution server will automatically create new sub-folders containing the burst library reports.
A library report does not have to be distributed to a single folder. Depending on which sub-folder pattern is used, a user can distribute library reports into multiple sub-folders based on the burst values defined by the chosen variable.
Note: In order to burst library reports to top-level folders, you must be authorized to create new sub-folders in the Domains folder.
The Advanced Scheduling tool displays.
The Browse for Folder dialog box opens.
The Library Advanced Options dialog box opens.
For more information on ReportCaster Variables, see ReportCaster Internal Variables.
Note: Because the Burst Report process creates separate subfolders for each individual report that uses a different burst value, you will be unable to clear this check box after you create and save the Report Library distribution schedule. If you no longer need to burst your selected Report Library distribution content, you must create a new Report Library distribution schedule that does not select the Burst Report check box.
New sub-folders containing your burst library reports are now created in the top-level folder of the workspace.
Note: The sub-folder structure is contingent on the variable that is used.
How to: |
When distributing scheduled output to the repository in the Advanced Scheduling tool, specify the folder location.
The Distribution dialog box appears, as shown in the following image.
Repository is the default value.
The folder location defaults to the same folder as the report procedure (FEX) being scheduled. Users can also select a different folder that they have authority to write to and create content in for the report to be distributed successfully to that location.
The Repository File System Distribution function allows you send reports to a directory accessible by the distribution server. When you distribute to the Repository with the File System configured, you can choose a File System folder, as shown in the following image.
Note:
A user must be granted the Distribute to File System privilege to use this distribution method. In addition, an administrator must use the WebFOCUS Administration Console to configure file system directories for distribution. Users must be authorized to see these folders, which is done by granting users the list command on the File subsystem. For more information, see the TIBCO WebFOCUS® Security and Administration technical content.
Once authorized, a user can schedule content to be distributed to a configured folder.
How to: |
In ReportCaster, a single Advanced Schedule can contain multiple tasks and distribution methods. For example, you can create a multi-task schedule that has two or more email distributions. This allows the distribution of a multi-task schedule to be changed by switching which distribution will be enabled for use, rather than deleting the existing distribution and creating a new one.
Note:
Populate all required fields for the selected method. For specific guidance on using a particular method, see Using the Email Distribution Option in the Advanced Scheduling Tool, Using the FTP Distribution Option in the Advanced Scheduling Tool, Using a Printer Distribution Option in the Advanced Scheduling Tool, Using the Report Library Distribution Option in the Advanced Scheduling Tool, or Using the Managed Reporting Distribution Option in the Advanced Scheduling Tool.
Populate all required fields for the selected method. The multiple distribution methods that you have selected display, as shown in the following image.
You can select additional methods, or complete your schedule creation process.