Structures

The structures used by ReportCaster Web Services are:

  • Authentication
  • User
  • Address Book
  • Schedule
  • Alert
  • Parameter Reflection
  • Destination
  • Notification
  • Destination Element
  • Option Value
  • E-mail Distribution
  • Parameter
  • FTP Distribution
  • Task
  • Print Distribution
  • File Task
  • SFTP Distribution
  • FTP Task
  • Dynamic Address
  • My Report Task
  • Library Storage
  • Standard Report
  • Library Email Notification
  • URL Task
  • MRE Storage
  • WebFOCUS Server Procedure Task
  • Access Element
  • Daily Scheduling
  • Library Access Book
  • Hourly Scheduling
  • Category
  • Minute Scheduling
  • Content
  • Monthly Scheduling
  • Version
  • Schedule Once
  • Job
  • Weekly Schedule
  • Log List
  • Yearly Schedule
  • Log Detail
  • Secondary Run Time and Task Retry
  • Group



x
Authenticate (Authentication Structure)

Authenticate is a structure used with ReportCaster Web Services and is the first parameter for every ReportCaster function (except logon). The logon function accepts a user name and password. Upon authentication, a security token is generated by the server and set into this structure. This token is similar to a cookie, enabling programmers to re-authenticate in structure applications without having to pass user names and passwords. It also allows the development of single sign techniques. In general, subsequent authentications, after the user name and passwords are accepted, should use the security token. This structure can also be used to authenticate on every ReportCaster function call. The user ID and password can be passed without setting the security token.

Name

Type

Description

Password

String

The password associated with this authentication information.

SecurityToken

String

The security token associated with this authentication information.

User

String

The user name associated with this authentication information.

The following is an example of the Authenticate structure.

Authenticate structure example image



x
AddrBook (Address Book Structure)

The AddrBook structure creates and configures ReportCaster Address Books. An Address Book contains information on the recipients of ReportCaster output, such as e-mail addresses in the case of e-mail distributions, printer addresses, in the case of print distributions, and directory paths in the case of FTP distributions. FTP, Print, and e-mail address books also contain burst options.

Instead of distributing an entire report, ReportCaster's burst feature allows you to break a report into sections to be distributed separately. Bursting enables relevant sections of a report to be sent to individual users. Each report section is saved as a separate file.

Name

Type

Description

Access

String

The Access function specifies the security level of an Address Book. Access must be either ''PUBLIC'' or ''PRIVATE''. A public Address Book can be viewed by all ReportCaster users, while a private Address Book can be viewed only by the owner and the ReportCaster Administrator.

BookName

String

Specifies the name of an Address Book.

DestinationList

DestinationElement

The DestinationList is a list of DestinationElements. Depending upon the distribution function, each element may contain an e-mail address, printer destination, or FTP path and the burst value associated with that destination. Collectively, these elements create an Address Book.

Method

String

Specifies the distribution function for an Address Book. The function specified must be either FTP, EMAIL, or PRINT.

Owner

String

Indicates the owner of an Address Book. The user ID specified will be associated with the Address Book as the owner, and will have privileges to view and modify the Address Book.

The following is an example of the AddrBook structure.

AddrBook structure example image



x
Alert (Alert Structure)

The Alert structure represents the information needed to set up an alert schedule in ReportCaster. Alerts can only be scheduled if a specially formatted alert executable has been created as a Standard Report in Managed Reporting. The alert executable in Managed Reporting will contain code determining the conditions of the alert. This code can be a query that tests for certain data conditions or checks for the existence of a file. If the conditions are met the alert will be activated. When ReportCaster schedules an alert, it will check the conditions of the alert based upon the frequency of the designated schedule. Only when the alert returns true does the schedule run. This alert structure includes functionality to determine whether the alert has been triggered and the ability to define how an alert should be reset after it is triggered.

Name

Type

Description

ResetInterval

Integer

The time interval (delay) between when an alert schedule is run upon being triggered and when it is reactivated. The actual time period is based on the reset type. For example, if the reset type is HOUR, a specified reset interval of three would represent a three hour delay.

ResetType

String

The reset type for an alert.

The valid values are:

  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • YEAR
  • CONTINUE. Reactivate the alert immediately.
  • AUTO. Reactivate the alert when the condition is no longer true.
  • TERMINATE. Deactivate the schedule.

Triggered

Boolean

If the alert has been set off, the flag value is True. If not, the value is False.

TwoWayEmailAttached

Boolean

If the Two-Way Email is attached, the flag value is True. If not, the value is False.

The following is an example of the Alert structure.

Alert structure example image



x
Destination (Destination Structure)

When ReportCaster distributes output, it determines the recipient(s) by accessing the destination definition. A destination definition possesses one or many recipients of the scheduled distribution.

Name

Type

Description

DistributionList

String

A list of one or many recipients stored within the ReportCaster Address Book. Type must be set to ''DISTRIBUTION_LIST''.

DistributionFile

String

A list of one or many recipients stored within a physical file accessible to the Distribution Server. Type must be set to ''DISTRIBUTION_FILE''.

SingleAddress

String

A single recipient and is entered by the person scheduling a job when the job is created. Type must be set to ''SINGLE_ADDRESS''.

DynamicAddress

dynamicAddress

A structure containing the definition of the Reporting Server procedure to run to obtain a list of one or more recipients. Type must be set to ''DYNAMIC_ADDRESS''.

Type

String

Valid values are:

  • DISTRIBUTION_FILE
  • DISTRIBUTION_LIST
  • DYNAMIC_ADDRESS
  • SINGLE_ADDRESS

The following is an example of the Destination structure.

Destination structure example image



x
DestinationElement (Destination Element Structure)

The DestinationElement structure specifies destination locations and burst values. A DestinationElement encapsulates a single line in an Address Book, containing the destination for ReportCaster output and the corresponding burst value, if any, associated with that destination. ReportCaster's burst feature allows you to break a report into sections to be distributed separately, based upon a primary sort field. Bursting enables relevant sections of a report to be sent to individual users. Each report section is saved as a separate file.

Name

Type

Description

BurstValue

String

The burst value associated with this DestinationElement.

Location

String

A destination location representing a single destination in an Address Book. The destination location can be an FTP file path, an e-mail address, a printer name or a printer location.

The following is an example of the DestinationElement structure.

DestinationElement structure example image



x
DistributionEmail (E-mail Distribution Structure)

E-mail distribution is one of five distribution types supported by ReportCaster. The DistributionEmail structure is used when the intended distribution method for the scheduled ReportCaster job is via e-mail.

Name

Type

Description

Destination

Destination

The destination structure that can contain one of the four types: Distribution List, Distribution File, Single Address, and Dynamic Address. These destination types contain one or more recipients of the scheduled distribution. In this case where distribution is via e-mail, the recipients are listed as e-mail addresses.

InlineMessage

String

The inline message associated with an e-mail report distribution. An inline message is the message contained in the body of the e-mail when the report is sent as an attachment. If the report is sent inline, this should not be set.

The size limit for an inline message is 255 characters.

InlineTaskIndex

Integer

The index of the task that is going to be inline (in the body of the e-mail). ReportCaster schedules can accept multiple tasks, with each task representing a report within the schedule. These tasks will run sequentially. The task index is the sequential index number (from 0 to N) assigned to the tasks within a scheduled distribution. This is particularly important for inline e-mail distribution because only one of the tasks can be an inline report (for example, a report whose contents are in the body of the e-mail). The other reports are sent as an attachment.

MailFrom

String

The e-mail address associated with the From header field of a scheduled e-mail distribution.

The size limit for MailFrom is 65 characters.

MailReplyAddress

String

The reply e-mail address from Reply Address header field of a scheduled e-mail distribution.

The size limit for mail reply address is 65 characters.

mailServerName

String

An SMTP mail server name associated with scheduled e-mail distribution. The size limit for mail server name is 65 characters.

MailSubject

String

An e-mail subject corresponding to the "Subject" header field associated with scheduled e-mail distribution.

The size limit for mail subject is 90 characters.

SendingReportAsAttachment

Boolean

True. Send report as an attachment.

False. Send report within the body of the e-mail.

ZipFileName

String

The name of the zip file associated with a scheduled e-mail distribution.

The zip result should be set to true.

The size limit for zip file name is 64 characters.

ZipResult

Boolean

True. Zip output.

False. Do not zip output.

The following is an example of the Distribution Email structure.

Distribution Email structure example image



x
DistributionFTP (FTP Distribution Structure)

The DistributionFTP structure is used to distribute a scheduled ReportCaster report via FTP.

Name

Type

Description

Destination

Destination

The destination structure that contains information indicating where the scheduled report will be distributed. In this case the target(s) will be via an FTP distribution and the ultimate destination(s) will be one or more paths on the target FTP server.

FtpLocation

String

The virtual directory for a report scheduled for distribution via FTP. A virtual directory is a directory name used in a path that corresponds to a physical directory on a server. The report will be sent to this target destination via FTP.

FtpPassword

String

The password to the target FTP server needed to authenticate at the time of report distribution. The FTP password is part of the credentials necessary for the user to access the FTP server.

FtpServerName

String

The name of the FTP server that is the target of the distribution.

FtpUserName

String

The user name needed to authenticate to the target FTP server at the time of report distribution. The FTP user name is part of the credentials necessary for the user to have access to the FTP server.

IndexFile

String

Specifies the index file associated with report(s) scheduled for distribution via FTP where bursting is activated. When bursting is activated, the index file specifies the name of the file where the corresponding index page will be created. If bursting is activated (Burst =TRUE), and no index file is specified, an error occurs.

Note that it makes sense to burst a report in cases where the distribution type is: DISTRIBUTION LIST, DISTRIBUTION FILE and DYNAMIC LIST. In the case where distribution type is SINGLE ADDRESS, there is no need to burst because the reports will be sent to a single address.

The following is an example of the DistributionFTP structure.

DistributionFTP structure example image



x
DistributionPrint (Print Distribution Structure)

Print distribution is one of five distribution types supported by ReportCaster. The DistributionPrint structure is used when the intended distribution method for the scheduled ReportCaster job is via a printer.

Name

Type

Description

Destination

Destination

The destination structure that contains information indicating the target(s) of distribution.

The following is an example of the DistributionPrint structure.

DistributionPrint structure image



x
DistributionSFTP (SFTP Distribution Structure)

The DistributionSFTP structure is used to distribute a scheduled ReportCaster report through FTP using Secure Shell (SSH) Transfer Protocol.

Name

Type

Description

Destination

Destination

The destination structure that contains information indicating where the scheduled report will be distributed. In this case, the target is through an FTP distribution and the ultimate destination(s) will be one or more paths on the targeted FTP server.

FtpLocation

String

The virtual directory for a report scheduled for distribution through FTP. A virtual directory is a directory name used in a path that corresponds to a physical directory on a server. The report will be sent to this target destination through FTP.

FtpPassword

String

The password to the target FTP server needed to authenticate at the time of report distribution. The FTP password is part of the credentials necessary for the user to access the FTP server.

FtpServerName

String

The name of the FTP server that is the target of the distribution.

FtpUserName

String

The user name needed to authenticate the target FTP server at the time of report distribution. The FTP user name is part of the credentials necessary for the user to have access to the FTP server.

IndexFile

String

Specifies the index file associated with the report(s) scheduled for distribution through FTP where bursting is activated.

When bursting is activated, the index file specifies the name of the file where the corresponding index page will be created.

If bursting is activated (BURST=TRUE) and no index file is specified, an error occurs.

Note that it makes sense to burst a report in cases where the distribution type is DISTRIBUTION LIST, DISTRIBUTION FILE, and DYNAMIC LIST. In the case where distribution type is SINGLE ADDRESS, there is no need to burst because the reports will be sent to a single address.

The following is an example of the DistributionSFTP structure.

DistributionSFTP structure example image



x
DynamicAddress (Dynamic Address Structure)

The DynamicAddress structure is used when a ReportCaster distribution list is created dynamically at runtime. The program creating a dynamic distribution list is a procedure residing on a Reporting Server.

Name

Type

Description

Password

String

The value of the password required for authentication to the Reporting Server containing the WebFOCUS procedure that creates the dynamic distribution list.

ProcedureName

String

The name of the WebFOCUS procedure that produces the dynamic distribution list. Accepts a maximum value of 64 characters.

ServerName

String

The name of the Reporting Server that contains the WebFOCUS procedure that creates the dynamic distribution list.

UserName

String

The user ID to the Reporting Server that contains the WebFOCUS procedure that creates the dynamic distribution list.

The following is an example of the DynamicAddress structure.

DynamicAddress structure example image



x
StorageLibrary (Library Storage Structure)

StorageLibrary is a structure representing one of five distribution types supported by ReportCaster. The StorageLibrary structure is used when the intended distribution method for the scheduled ReportCaster job is storage in the ReportCaster Library. The ReportCaster Library is a secure, database based, common access and archiving environment optionally available with the ReportCaster product.

Name

Type

Description

AccessList

String

The name of the access list associated with this report distribution to the library. The access list is a collection of user IDs and burst values that specify whether a user can view a library resident report, or a burst segment of that report. Accepts a maximum of 64 characters.

AccessType

String

The access type for this library distribution. The access type is one of three options for viewing a library report:

  • PUBLIC
  • OWNER
  • ACCESS_LIST

Category

String

The library category associated with this report. Each category is a root directory within the library used to organize the distribution of reports. Any task other than a Standard Report or MyReport that is delivered to the library must be assigned a category when a schedule is created. The scheduled report, and all subsequent versions of the report, are filed in subdirectories under the category assigned to it. If the category doesn't exist, a new category (for example, root directory) is created upon distribution. Accepts a maximum of 90 characters.

ExpirationData

Integer

The expiration data used to calculate the expiration of a library resident report. For a given expiration mode, the expiration data represents a corresponding integer that, when combined with the expiration mode, determines if a report should expire. For example, if the expiration mode is set to ''D'' and the expiration data is set to 3, the report will expire in 3 days. For ''V'', the expiration data represents the threshold number of versions that must exist prior to the report expiring from the library.

ExpirationMode

String

The expiration mode is a basis of calculating when a library report will expire. There are seven expiration modes:

  • D - Day
  • H - Hour
  • M - Month
  • V - Version
  • W - Week
  • Y - Year
  • N - Never

When associated with a corresponding expiration data integer, ReportCaster can determine when a library report will expire. For example, if the expiration mode is set to ''D'' and the expiration data is set to 3, the report will expire in three days. For ''V'', the expiration data represents the threshold number of versions that must exist prior to the report expiring from the library.

LibraryURL

String

The base URL contained in a library e-mail notification. When library notification is turned on via SendEmailAfterSaveReport, all users who have access to a library report are sent an e-mail that contains message content, usually a notification that the report is available, and a URL that opens the report in the browser. The base URL can be set to a value that is accessible inside or outside of the ReportCaster environment. Accepts a maximum of 128 characters.

MailFrom

String

The From e-mail address in this library e-mail notification (library e-mail notification must be turned on by way of SendEmailAfterSaveReport). The maximum size of the From e-mail address is 65 characters.

MailMessage

String

The e-mail message content contained in the e-mail message sent out as part of this notification e-mail. (Library e-mail notification must be turned on by way of SendEmailAfterSaveReport). The maximum size of the e-mail message is 255 characters.

MailReplyAddress

String

The Reply e-mail address sent in this Library e-mail notification. (Library e-mail notification must be turned on by way of SendEmailAfterSaveReport). The maximum size of the Reply e-mail address is 65 characters.

MailServerName

String

The mail server name used to send this library e-mail notification. (Library e-mail notification must be turned on by way of SendEmailAfterSaveReport). The maximum size of the mail server name is 65 characters.

MailSubject

String

The e-mail subject sent in this library e-mail notification. (Library e-mail notification must be turned on by way of SendEmailAfterSaveReport). The maximum size of the Subject e-mail header is 255 characters.

SaveBurstFromList

Boolean

Specifies whether or not to store only library reports with burst value(s) defined in a specified Access List.

SendEmailAfterSaveReport

Boolean

Specifies whether or not an e-mail notification is sent after a report is saved to the library. If the value is True, an e-mail notification is sent to users who have access to the report. If it is False, no e-mail notification is sent.

StorageLibraryEmail

StorageLibraryEmail

Structure that contains e-mail notification settings. Used as an alternative to setting e-mail notification directly in the StorageLibrary structure.

The following is an example of the StorageLibrary structure.

StorageLibrary structure example image



x
StorageLibraryEmail (Library Email Notification Structure)

The StorageLibraryEmail structure contains the settings for e-mail notification when a report gets saved to the Report Library.

Name

Type

Description

LibraryURL

String

The base URL contained in a library e-mail notification. When library notification is turned on through SendEmailAfterSaveReport, all users who have access to a library report are sent an e-mail that contains message content, usually a notification that the report is available, and a URL that opens the report in the browser. The base URL can be set to a value that is accessible inside or outside of the ReportCaster environment. Accepts a maximum of 128 characters.

MailFrom

String

The From e-mail address in this library e-mail notification (library e-mail notification must be turned on by way of SendEmailAfterSaveReport). The maximum size of the From e-mail address is 65 characters.

MailMessage

String

The e-mail message content contained in the e-mail message sent out as part of this notification e-mail. (Library e-mail notification must be turned on by way of SendEmailAfterSaveReport). The maximum size of the e-mail message is 255 characters.

MailReplyAddress

String

The Reply e-mail address sent in this Library e-mail notification. (Library e-mail notification must be turned on by way of SendEmailAfterSaveReport). The maximum size of the Reply e-mail address is 65 characters.

MailServerName

String

The mail server name used to send this library e-mail notification. (Library e-mail notification must be turned on by way of SendEmailAfterSaveReport). The maximum size of the mail server name is 65 characters.

MailSubject

String

The e-mail subject sent in this library e-mail notification. (Library e-mail notification must be turned on by way of SendEmailAfterSaveReport). The maximum size of the Subject e-mail header is 255 characters.

SendEmailAfterSaveReport

String

Specifies whether or not an e-mail notification is sent after a report is saved to the library. If the value is True, an e-mail notification is sent to users who have access to the report. If it is False, no e-mail notification is sent.

The following is an example of the StorageLibraryEmail structure.

StorageLibraryEmail structure example image



x
StorageMRE (MRE Storage Structure)

MRE Storage is one of five distribution types supported by ReportCaster. The StorageMRE is used when the intended distribution method for the scheduled ReportCaster job is to store the output in the Managed Reporting Environment.

Name

Type

Description

FolderName

String

The name of the folder to which you are sending a report for scheduled distribution to Managed Reporting. The folder name will be appended next to the run time of the report, and the name of the resulting report in the folder will also contain the folder name. The report will be placed in the domain of the report that it ran. If the report that was run is a Standard Report, it will place it in the Standard Reports folder. If the report is a My Report it will be placed in My Reports.

The following is an example of the StorageMRE structure.

StorageMRE structure example image



x
AccessElement (Access Element Structure)

The AccessElement structure is a sub-structure of the LibraryAccessBook structure. It is an array containing the users and/or groups that are allowed to view the output of specified schedules distributed to the Report Library.

Name

Type

Description

burstValue

String

The high-level sort value of the report to which the memberName has access.

memberName

String

The user ID or ReportCaster group name.

MemberType

String

The type of entry in memberName. The valid values are:

  • G- Group
  • U - User

The following is an example of the AccessElement structure.

AccessElement structure example image



x
LibraryAccessBook (Library Access Book Structure)

The LibraryAccessBook structure creates and configures ReportCaster Library Access Books. A Library Access Book contains the users and/or groups that are allowed to view the output of specified schedules distributed to the Report Library. The Library Access Book may be modified only by ReportCaster Administrators and the user who created it.

Name

Type

Description

AccessElementList

AccessElement

An array structure containing the ReportCaster user IDs and/or groups that have access to the specific ReportLibrary content.

Description

String

The description of the Library Access Book.

Name

String

The name of the Library Access Book.

Id

String

The identifier for this Library Access Book. This identifier is the name assigned by the Distribution Server when the Library Access Book is created and is meant to be unique. To ensure the integrity of the ReportCaster Repository, do not manipulate this ID unless you are certain that the reassigned value is unique.

Owner

String

The ReportCaster user ID that is defined as the owner of the Library Access Book.

The following is an example of the LibraryAccessBook structure.

The LibraryAccess Book



x
Category (Category Structure)

The category structure provides a means of categorizing, storing and manipulating Report Library reports. In addition to category, the other structures involved in the hierarchical organization of Report Library content are Content and Version whereby category exists at the top of the hierarchy as the root (for example, the parent), followed by content, and then finally nested below that the actual versions.

Name

Type

Description

ContentList

Content

A list of Report Library content information that is nested into this Category. As the Category is the parent of Content in the hierarchical scheme, the Content list provides access to the actual content for a given instance of Category. Each member of the Content list is the parent of version information representing a report that was run and then distributed to this category. The actual reports are contained within the version information.

Id

String

The identifier for this category. This identifier is the name assigned by the Distribution Server at the time of the distribution of the Report Library content and is meant to be unique. In order to ensure that the integrity of the Report Library database is maintained, do not manipulate this ID unless you are certain that your reassigned value is unique.

Mre

Boolean

A flag indicating whether or not the library report content under this category exists in Managed Reporting. If the flag returns True, the report content exists within a Managed Reporting distribution and this category belongs to the Managed Reporting domain. If the flag returns False, the report is not associated with a Managed Reporting distribution and thus this category does not belong to the Managed Reporting domain.

Name

String

The name of the category under which Report Library content and their related version information will be organized.

The following is an example of the Category structure.

Category structure example image



x
Content (Content Structure)

The content structure provides a means of organizing, manipulating and storing Report Library reports. In addition to the content structure, the other structures involved in the hierarchical organization of Report Library reports are Category and Version whereby Category exists at the top of the hierarchy (for example, the parent), followed by Content, and then finally nested below that the actual versions. The content information is the parent that encapsulates the report output of a scheduled library distribution. The reports themselves are accessed via a list of version information referenced by this content information.

Name

Type

Description

AccessList

String

The name of the Access List, which is a list of users that have access to this content in the Report Library.

The maximum size of an Access List is 64 characters.

AccessType

String

The access type for this library distribution.

The available choices are:

ACCESS_LIST

Access via Access List.

PUBLIC

Public access.

OWNER

Access by owner.

BurstValue

String

The burst value associated with this library report distribution. ReportCaster's burst feature allows you to break a report up into sections to be distributed separately based on the value of a primary sort field, also known as a burst value. In order to burst a report for distribution to the library or any other destination, burst in the task must be set to true. The maximum size of the burst value is 75 characters.

Description

String

A description for the scheduled distribution of Report Library content. The maximum size for the description is 90 characters.

ExpireInterval

Integer

The expiration interval to a report content distributed to the Report Library. The expiration interval is an integer that is coupled with the expiration mode. For example, if the expiration mode is set for ''D'', an expiration interval of 15 would mean that the report in the Report Library will expire in 15 days.

ExpireMode

String

The expiration mode for the Report Library content. The valid values are:

  • V - Version
  • H - Hour
  • N - Never
  • D - Day
  • W - Week
  • M - Month
  • Y - Year

Id

String

An identifier for Report Library content. The ID is created by the Distribution Server at the time of distributing content and is meant to uniquely identify content in the Report Library database. In order to ensure that the integrity of the Report Library database is maintained, do not manipulate this ID unless you are certain that your reassigned value is unique.

Owner

String

An owner to this scheduled distribution of content to the Report Library. The Distribution Server assumes the owner is identified with the user name of the individual logged into ReportCaster who scheduled the distribution of Report Library content. The maximum size is 48 characters.

ScheduleId

String

The ID for the schedule that created this report content.

VersionList

Version

A list of version information that contain the report output from the ReportCaster schedule that is associated with this content information. Each content structure represents a ReportCaster schedule that is distributed to the library. The actual reports produced by the schedule are contained in a list of version information, with each member of the version list representing the output of a single scheduled distribution.

The following is an example of the Content structure.

Content structure image



x
Version (Version Structure)

The version structure provides a means of organizing (by version) Report Library content, which exists as a result of scheduled distributions to the library. In addition to the version structure, other structures involved in the hierarchical organization of Report Library content are Category and Content whereby Category exists at the top of the hierarchy (for example, the parent), followed by Content, and then finally nested below that the actual versions.

Name

Type

Description

CreateDate

Date

The creation date for this version of Report Library content. The creation date is calendar information and is originally set at the time of report distribution.

ExpireDate

Date

The expiration date for this version of Report Library content. The expiration date is calendar information and is originally set at the time of report distribution.

Format

String

The format of this version of Report Library content.

Id

String

An identifier to a version of Report Library content. The ID is created by the Distribution Server at the time of distributing this version of content and is meant to uniquely identify content in the Report Library database. To ensure that the integrity of the Report Library database is maintained, do not manipulate this ID unless you are certain that your reassigned value is unique.

Size

Long

The size of this version of Report Library content. The size is set at the time of report distribution.

VersionNumber

Integer

An integer version number to the content in ReportCaster's Report Library database. A version indicates a new execution of an existing scheduled report. The version number is originally set at the time of report distribution.

The following is an example of the Version structure.

Version structure example image



x
Job (Job Structure)

A job is information which represents a schedule at the time it is actually set to run on the Distribution Server. Once resident on the Distribution Server queue, each schedule can have any number of associated jobs that correspond to the number of times a schedule is executed. Therefore, there is a one-to-many relationship between a schedule and a job.

Name

Type

Description

Id

String

The ID is a unique process identifier assigned to each job by the Distribution Server each time it runs a schedule. Therefore, it uniquely identifies each instance of a schedule run on the Distribution Server.

Schedule

Schedule

The schedule information to be run on the Distribution Server.

startTime

Date

The time that the schedule associated with this job is either put on the queue of the Distribution Server, or sent to the Reporting Server for execution. This time is not a duration, but is calendar information indicating the moment the job was sent to either the job queue or execution, dependant upon the current status of the job. This data is transitory and is not available after a job leaves a queue or completes execution.

The following is an example of the Job structure.

Job Structure image example



x
DsLog (Log List Structure)

When a scheduled report distribution job is run on the Distribution Server, the log of all activity relating to this process is encapsulated by way of the DsLog and DsLogElement structures. The DsLog structure holds the general information pertaining to the log record of a job that is run by the Distribution Server. For each job, there is a corresponding DsLog information. For DsLog information there can be corresponding DsLogElement information.

Name

Type

Description

EndTime

Date

The calendar time when the schedule job run ends.

ErrorType

String

The type of error that may have occurred during the scheduled report distribution job run. The acceptable values are:

0 - No errors.

1 - Fatal errors.

JobId

String

A unique identifier to the log or record of a ReportCaster job. This ID is the same as that used to uniquely identify the job itself.

LogElementList

DsLogElement

The list of Log information that is associated with a specific log.

Owner

String

The user name of the schedule owner.

ScheduleDescription

String

The text describing the schedule that is being run and logged on the Distribution Server. This is the same descriptive text is defined in the schedule description.

ScheduleId

String

The unique identifier to the schedule that is being run and logged on the Distribution Server.

StartTime

Date

The calendar time when the schedule job run begins.

The following is an example of the DsLog structure.

DsLog structure image example



x
DsLogElement (Log Detail Structure)

When a scheduled report distribution job is run on the Distribution Server, the record or log of all activity relating to this process is represented by way of the DsLog and DsLogElement structures, and stored in the ReportCaster Repository. The DsLogElement structure holds the specific information pertaining to each log record of a job that is run on the Distribution Server. For DsLog information, which contains general information about a log record, there can be corresponding DsLogElement information containing the specific detailed logged messages corresponding to each step of the job execution process. Therefore, the relationship between DsLog and DsLogElement is one-to-many.

Name

Type

Description

Error

Boolean

A flag specifying whether or not the message associated with this instance of DsLogElement is an error message. If the log message is an error message, the flag is True. If the log message is not an error message, the flag is false.

ExecId

String

The execution ID is the user ID used by the Distribution Server to authenticate with the Reporting Server. This ID is meaningful only when the task associated with this DsLogElement information needs to authenticate with the Reporting Server. The only task types for which this is true are: WebFOCUS Server procedures, Standard Reports, URLs, and MyReports. For all other task types and for all other steps in the job execution process this ID is NULL.

Message

String

The log text describing exactly what takes place in the job execution process during this instance of DsLogElement. Typical messages contain text such as "Start Task X" and "Connecting to Server Y".

MessageCode

String

The message code is used to group logging messages related to each step in the process of executing a job on the Distribution Server. There are only two groups, SCHEDULE MESSAGE CODE and TASK MESSAGE CODE, that correspond to messages specifically associated with a schedule and messages specifically associated with a task respectively. Currently, SCHEDULE MESSAGE CODE is set to "BTP1010" and TASK MESSAGE CODE is set to "BTP1020".

TaskDescription

String

The task associated with the DsLogElement. This is reserved for use by the Distribution Server.

The following is an example of the DsLogElement structure.

DsLogElement structure image example



x
Group (Group Structure)

The ReportCaster group structure allows the creation and manipulation of ReportCaster authentication and authorization groups.

This is used for ReportCaster only and is not associated with Managed Reporting.

Name

Type

Description

Description

String

The description of the ReportCaster group. This can be a maximum of 90 characters.

Id

String

Unique identifier for the group name.

Name

String

The name of the group. This can be accepts a maximum of 48 characters.

The following is an example of the Group structure.

Group structure image example



x
User (User Structure)

The User structure allows the creation and manipulation of ReportCaster Users for the purpose of authentication and authorization.

This is used for ReportCaster only and is not associated with Managed Reporting.

Name

Type

Description

Active

Boolean

User's status is either inactive or active. True indicates an active user.

Address

String

The user's e-mail address. This is particularly important for library users. The maximum length of is 90 characters.

Description

String

The description of the user. Accepts a maximum of 90 characters.

LibraryCapability

Boolean

The user's capability to use the ReportCaster library. True indicates that the user can use the library.

Name

String

The user's login name, also known as the ReportCaster ID. The size limit is 48 characters.

Password

String

The password associated with the user name. The size limit is 240 characters.

Role

String

The user's ReportCaster role. Valid values are:

ADMIN

Administrator.

USER

User.

ScheduleCapability

Boolean

The user's capability to schedule report distributions. True indicates that the user can schedule jobs.

The following is an example of the User structure.

User structure image example



x
Schedule Structure

The schedule structure encapsulates the process of scheduling reports for distribution by ReportCaster. Schedule information is represented by a unique identifier called a scheduleId and is comprised of various information, such as Destination, Distribution, TimeInfo and Task, representing components of the schedule.

Name

Type

Description

Active

Boolean

The flag indicating whether or not a scheduled distribution is active. If True, the schedule is active. If False, the schedule is inactive.

CompressedReport

Boolean

True - compresses the report before it is stored in the library.

False - does not compress the report before it is stored in the library.

DeleteJobAfterRun

Boolean

A flag indicating whether or not a schedule is deleted after running the job. If True, the job is deleted after all tasks are completed. If False, the job is not deleted.

Description

String

The text describing the job that is being scheduled. This text needs to be unique for each owner of a scheduled job. The maximum size of the description is 90 characters.

Distribution

DistributionEmail

DistributionFTP

DistributionPrint

DistributionSFTP

StorageLibrary

StorageMRE

Assigns the distribution information associated with this schedule.

Id

String

A unique identifier to this schedule. The developer/user should never manipulate this identifier. If it is set by the user during schedule creation, ReportCaster will override that setting.

Notification

Notification

Specifies the notification information associated with this schedule.

Owner

String

The owner of this schedule. The maximum size of the owner is 48 characters.

Priority

Integer

The priority level for the scheduled job. The value ranges from 1 (highest priority) to 5 (lowest priority).

TaskList

Task

TaskStandardReport

TaskWFServerProcedure

TaskMyReport

TaskFile

TaskFTP

TaskURL

A list of task information, with each task information containing one report that is to be distributed as part of this schedule. The order of the tasks in the list corresponds to the order the tasks will be synchronously run and then distributed by the Distribution Server.

TimeInfo

TimeInfoDay

TimeInfoHour

TimeInfoMinute

TimeInfoMonth

TimeInfoOnce

TimeInfoWeek

TimeInfoYear

The information associated with this schedule that contains the frequency and time parameters indicating when and how often this schedule should run.

TraceType

Integer

0 = Default Trace. Uses ReportCaster trace configuration setting.

1 = No Traces

2 = Trace Schedule

3 = Trace Schedule and Report

The following is an example of the Schedule structure.

Schedule structure image example



x
AmperParameter (Parameter Reflection Structure)

AmperParameter is used to specify, discover, and retrieve parameter names and values located within a WebFOCUS procedure. This structure is only used by the function getAmperParameterList.

The getAmperParameterList function returns a list of AmperParameter information, with each member of the list representing a single parameter from the task that was passed as input.

Name

Type

Description

DefaultValue

String

The default value that has been assigned to the parameter defined within the procedure. The maximum length of the defaultValue is 255 characters.

Format

String

The format of the parameter as defined in the procedure. For example, A10.

Maximum

String

The maximum value allowed for the parameter input as defined in the procedure.

Minimum

String

The minimum value allowed for the parameter input as defined in the procedure.

Multi

Boolean

True if MultiSelect OR is defined for the parameter within the procedure.

Operation

String

OR - if MultiSelect OR is defined for the parameter within the procedure.

OptionValueList

OptionValue

A list representing the list of valid options for a given parameter as defined within a procedure.

ParameterDescription

String

The prompt description for the parameter as defined in the procedure.

ParameterName

String

A name of the parameter associated with an instance of AmperParameter. The maximum length of the parameterName is 64 characters.

The following is an example of the AmperParameter structure.

AmperParameter structure image example



x
Notification (Notification Structure)

When scheduled reports are distributed, ReportCaster allows selected individuals to be notified with log information about the distribution. This notification feature can be altered on a per schedule basis and can be set to inactive, always notify, or notify only on error. Each schedule allows two types of notification to be sent simultaneously, brief and full. Where brief notification contains partial log information and full notification contains complete log information.

Name

Type

Description

AddressForBriefNotification

String

The e-mail address where a brief notification message will be sent after running a schedule in ReportCaster. The content of the brief notification e-mail is partial log information for a given schedule run. The maximum size of the brief notification e-mail address is 75 characters.

AddressForFullNotification

String

The e-mail address where a full notification message will be sent upon running a schedule in ReportCaster. The content of the full notification e-mail is the complete log information for a given schedule run. The maximum size of the full notification e-mail address is 75 characters.

From

String

The e-mail address linked to the From header to which notification will be sent upon running a schedule in ReportCaster. The maximum size of the From address is 75 characters.

Subject

String

The subject header in the e-mail to which notification will be sent upon running a schedule in ReportCaster. The maximum size of the e-mail Subject is 255 characters.

Type

String

The type of notification message to be sent upon the running of a ReportCaster schedule. The three possible types are: ALWAYS, INACTIVE, and ONERROR.

The following is an example of the Notification structure.

Notification structure image example



x
OptionValue Structure

The OptionValue structure is used in conjunction with the AmperParameter structure to enable the ReportCaster user to retrieve the list of valid values for parameters defined within a procedure.

Name

Type

Description

Description

String

The text used to describe what the option value is. For example, if the option value is "ENG", the description might read: "The country of England".

Name

String

The value for a particular option value. For example if the option value is ENG, the name might be "ENG" and the description might read, "The country of England".

The following is an example of the OptionValue structure.

OptionValue structure image example



x
Parameter Structure

The Parameter structure provides a means of obtaining and assigning parameter names and values relating to reporting tasks associated with a ReportCaster scheduled distribution. Any parameter associated with a ReportCaster schedule is resolved at the time of distribution. Parameters can be assigned to the following report task types:

In WebFOCUS Server Procedure, Standard Report, and MyReport tasks, the name portion of the parameter is associated with an amper variable within the procedure and resolved at runtime. In the case of URLs, the name value pairs will be appended to the URL upon submission after the question mark within the URL.

Name

Type

Description

AmperParameter

AmperParameter

Structure containing characteristics for each parameter. The getAmperParameterList function retrieves the parameters to an AmperParameter structure, which can then be merged as a sub-structure to the Parameter structure.

Name

String

The name of a parameter associated with a task scheduled for distribution within ReportCaster. The maximum length of the name field is 64 characters.

Value

String

The value of a parameter associated with a task scheduled for distribution within ReportCaster. The maximum length of the value field is 255 characters.

The following is an example of the Parameter structure.

Parameter structure image example



x
Task (Task Structure)

The Task structure is used to define ReportCaster task information. There are six task types that can be used within a task definition. Each task type would consist of its own structure that defines the information needed for the schedule. The task types are as follows:

Since a ReportCaster schedule can contain many tasks of different task types, the task structure is used to define the array of tasks. Each task subscript within the array is of a structure dependent on its task type (for example, TaskStandardReport). If a schedule is made up of tasks with all of them being of the same task type, the specific task type structure (for example, TaskStandardReport) can be used to define the array of tasks instead of the task structure.


Top of page

x
TaskFile (File Task Structure)

The TaskFile structure is one of five task types supported by ReportCaster (WebFOCUS Server procedure, MyReport, Standard Report, and URL are the others). Each task type corresponds to a means of running or accessing a report that can be distributed by ReportCaster. TaskFile allows ReportCaster to schedule the distribution of a file, represented by a fully qualified path to which the ReportCaster Distribution Server has read access.

Name

Type

Description

Description

String

The text used to describe the task. The maximum size for the description is 255 characters.

Id

String

The unique identifier ReportCaster generates for every saved task. The user is not allowed to manipulate this ID. If it is assigned a value different from the generated value, ReportCaster will override that with the generated ID.

ReportName

String

The name of the report associated with this task. It is used when sending output as an attachment. The maximum size for report name is 64 characters.

TaskRetry

TimeInterval

A structure defining the time interval for restarting a task if the task did not complete successfully.

FileName

String

The name of the file to be scheduled for distribution by ReportCaster. The name of the file must be preceded by a fully qualified path to which the ReportCaster Server has read access. The maximum size for the file name (including path string) is 255 characters.

The following is an example of the TaskFile structure.

TaskFile structure image example



x
TaskFTP (FTP Task Structure)

The TaskFTP structure is used to retrieve a file from any FTP server.

Name

Type

Description

Description

String

The text used to describe the task. The maximum size for the description is 255 characters.

Id

String

The unique identifier ReportCaster generates for every saved task. The user is not allowed to manipulate this ID. If it is assigned a value different from the generated value, ReportCaster will override that with the generated ID.

ReportName

String

The name of the report associated with this task. It is used when sending output as an attachment. The maximum size for report name is 64 characters.

TaskRetry

TimeInterval

A structure defining the time interval for restarting a task if the task did not complete successfully.

DeleteAfterRetrieval

Boolean

Indicates whether or not the file is deleted after retrieval.

true - the file is deleted after retrieval is complete.

false - the file is not deleted after retrieval is complete.

FileName

String

The name of the file to be retrieved from the FTP server. The name of the file must be preceded by a fully qualified path to which the ReportCaster Server has read access. The maximum size for the file name (including path string) is 255 characters.

Password

String

The password to the source FTP server needed to authenticate at the time of file retrieval. The FTP password is part of the credentials necessary for the user to access the FTP server.

ServerName

String

The name of the FTP server that is the source of the file retrieval.

UserName

String

The user name needed to authenticate to the source FTP server at the time of file retrieval. The FTP user name is part of the credentials necessary for the user to have access to the FTP server.

The following is an example of the TaskFTP structure.

TaskFTP structure image example



x
TaskMyReport (My Report Task Structure)

The TaskMyReport structure is one of five task types supported by ReportCaster (WebFOCUS Server procedure, Standard Report, file, and URL are the others). Each task type corresponds to a means of running or accessing a report that can be distributed by ReportCaster. TaskMyReport allows ReportCaster to schedule the distribution of a Managed Reporting MyReport.

Name

Type

Description

Description

String

The text used to describe the task. The maximum size for the description is 255 characters.

Id

String

The unique identifier ReportCaster generates for every saved task. The user is not allowed to manipulate this ID. If it is assigned a value different from the generated value, ReportCaster will override that with the generated ID.

ReportName

String

The name of the report associated with this task. It is used when sending output as an attachment. The maximum size for report name is 64 characters.

TaskRetry

TimeInterval

A structure defining the time interval for restarting a task if the task did not complete successfully.

Alert

Alert

An Alert structure.

AlertEnabled

Boolean

The value that determines whether or not an alert is enabled. If True, the alert is enabled. If False, it is disabled.

DomainHREF

String

The internal value for a domain assigned by Managed Reporting at the time the domain is created.

FolderHREF

String

The internal value for a Reporting folder assigned by Managed Reporting at the time the folder is created.

ProcedureDescription

String

The description of the ProcedureName. The value is not stored in the ReportCaster repository, but can be populated using WebFOCUS Web services.

Burst

Boolean

The value that specifies whether or not report bursting is enabled. Report bursting allows you to segment a report into sections based upon a primary sort field. The report segments are then distributed as separate reports by the Distribution Server. Access to these report segments is based upon burst values (specific values of the primary sort field) that are associated with e-mail addresses in distribution lists or user IDs in library access lists.

ExecId

String

The user name needed to establish a connection to the WebFOCUS Reporting Server. The user name is one of the credentials necessary for a user to access a WebFOCUS procedure that resides on the WebFOCUS Reporting Server during scheduling, as well as to run this procedure at the time the job is run.

ExecPassword

String

The password needed to establish a connection to the WebFOCUS Reporting Server. The password is one of the credentials necessary for a user to access a WebFOCUS procedure that resides on the WebFOCUS Reporting Server during scheduling, as well as run this procedure at the time the job is run.

FirstPostProcessingProcedure

String

The name of the first of two possible post-processing procedures that can be associated with this WebFOCUS Server procedure task. Post-processing procedures (available for WebFOCUS Server procedure, Standard Report, and My Report tasks only) are non-reporting WebFOCUS procedures that run synchronously after the execution of their associated task. They are often used to reset computing or data environments.

FirstPreProcessingProcedure

String

The name of the first of two possible pre-processing procedures that can be associated with this WebFOCUS Server procedure task. Pre-processing procedures (available for WebFOCUS Server procedure, Standard Report, and MyReport tasks only) are non-reporting WebFOCUS procedures that run synchronously prior the execution of their associated task. They are often used to set or test conditions before the running of reports.

ParameterList

Parameter

An array of Parameter information, with each structure representing a name value pair that is matched and then resolved upon the execution of this WebFOCUS Server procedure.

ProcedureName

String

The internal value for a WebFOCUS procedure assigned by Managed Reporting at the time the procedure is created (for example, app/ranking).

SecondPostProcessingProcedure

String

The name of the second of two possible post-processing procedures that can be associated with this WebFOCUS Server Procedure task. Post-processing procedures (available for WebFOCUS Server procedure, Standard Report, and My Report Tasks only) are non-reporting WebFOCUS procedures that run synchronously after the execution of their associated task. They are often used to reset computing or data environments.

SecondPreProcessingProcedure

String

The name of the second of two possible pre-processing procedures that can be associated with this WebFOCUS Server procedure task. Pre-processing procedures (available for WebFOCUS Server Procedure, Standard Report, and My Report Tasks only) are non-reporting WebFOCUS procedures that run synchronously prior the execution of their associated task. They are often used to set or test conditions before the running of reports.

SendFormat

String

The report format that will be generated by the WebFOCUS Reporting Server. For example, PDF or HTML.

ServerName

String

The name of the WebFOCUS Reporting Server housing the WebFOCUS procedure associated with this task.

The following is an example of the TaskMyReport structure.

TaskMyReport structure image example



x
TaskStandardReport (Standard Report Structure)

The TaskStandardReport structure is one of five task types supported by ReportCaster (WF Server Procedure, MyReport, File, and URL are the others). Each task type corresponds to a means of running or accessing a report that can be distributed by ReportCaster. TaskStandardReport allows ReportCaster to schedule the distribution of Managed Reporting Standard Reports. With TaskStandardReport, you can associate an alert with the report, which allows you to schedule actions that are contingent upon specific alert conditions being triggered.

Name

Type

Description

Description

String

The text used to describe the task. The maximum size for the description is 255 characters.

Id

String

The unique identifier ReportCaster generates for every saved task. The user is not allowed to manipulate this ID. If it is assigned a value different from the generated value, ReportCaster will override that with the generated ID.

ReportName

String

The name of the report associated with this task. It is used when sending output as an attachment. The maximum size for report name is 64 characters.

TaskRetry

TimeInterval

A structure defining the time interval for restarting a task if the task did not complete successfully.

Alert

Alert

An Alert structure.

AlertEnabled

Boolean

The value that determines whether or not an alert is enabled. If True, the alert is enabled. If False, it is disabled.

DomainHREF

String

The internal value for a domain assigned by Managed Reporting at the time the domain is created.

FolderHREF

String

The internal value for a Reporting folder assigned by Managed Reporting at the time the folder is created.

ProcedureDescription

String

The description of the ProcedureName. The value is not stored in the ReportCaster repository, but can be populated using WebFOCUS Web services.

Burst

Boolean

The value that specifies whether or not report bursting is enabled. Report bursting allows you to segment a report into sections based upon a primary sort field. The report segments are then distributed as separate reports by the Distribution Server. Access to these report segments is based upon burst values (specific values of the primary sort field) that are associated with e-mail addresses in distribution lists or user IDs in library access lists.

ExecId

String

The user name needed to establish a connection to the WebFOCUS Reporting Server. The user name is one of the credentials necessary for a user to access a WebFOCUS procedure that resides on the WebFOCUS Reporting Server during scheduling, as well as to run this procedure at the time the job is run.

ExecPassword

String

The password needed to establish a connection to the WebFOCUS Reporting Server. The password is one of the credentials necessary for a user to access a WebFOCUS procedure that resides on the WebFOCUS Reporting Server during scheduling, as well as run this procedure at the time the job is run.

FirstPostProcessingProcedure

String

The name of the first of two possible post-processing procedures that can be associated with this WebFOCUS Server procedure task. Post-processing procedures (available for WebFOCUS Server procedure, Standard Report, and My Report tasks only) are non-reporting WebFOCUS procedures that run synchronously after the execution of their associated task. They are often used to reset computing or data environments.

FirstPreProcessingProcedure

String

The name of the first of two possible pre-processing procedures that can be associated with this WebFOCUS Server procedure task. Pre-processing procedures (available for WebFOCUS Server procedure, Standard Report, and MyReport tasks only) are non-reporting WebFOCUS procedures that run synchronously prior the execution of their associated task. They are often used to set or test conditions before the running of reports.

ParameterList

Parameter

An array of parameter information, with each structure representing a name value pair that is matched and then resolved upon the execution of this WebFOCUS Server procedure.

ProcedureName

String

The internal value for a WebFOCUS procedure assigned by Managed Reporting at the time the procedure is created (for example, app/ranking.)

SecondPostProcessingProcedure

String

The name of the second of two possible post-processing procedures that can be associated with this WebFOCUS Server Procedure task. Post-processing procedures (available for WebFOCUS Server procedure, Standard Report, and My Report Tasks only) are non-reporting WebFOCUS procedures that run synchronously after the execution of their associated task. They are often used to reset computing or data environments.

SecondPreProcessingProcedure

String

The name of the second of two possible pre-processing procedures that can be associated with this WebFOCUS Server procedure task. Pre-processing procedures (available for WebFOCUS Server Procedure, Standard Report, and My Report Tasks only) are non-reporting WebFOCUS procedures that run synchronously prior the execution of their associated task. They are often used to set or test conditions before the running of reports.

SendFormat

String

The report format that will be generated by the WebFOCUS Reporting Server. For example, PDF or HTML.

ServerName

String

The name of the WebFOCUS Reporting Server housing the WebFOCUS procedure associated with this task.

The following is an example of the TaskStandardReport structure.

TaskStandardReport structure image example



x
TaskURL (URL Task Structure)

The TaskUrl structure is one of five task types supported by ReportCaster (WF Server Procedure, MyReport, Standard Report, and File are the others). Each task type corresponds to a means of running or accessing a report that can be distributed by ReportCaster. TaskURL allows ReportCaster to connect to a specified URL at execution time, retrieve the pages returned by that URL and distribute them. TaskURL can be used to call any type of URL, including programs that are executed by JSP and ASP pages as well as reports generated by other reporting products.

Name

Type

Description

Description

String

The text used to describe the task. The maximum size for the description is 255 characters.

Id

String

The unique identifier ReportCaster generates for every saved task. The user is not allowed to manipulate this ID. If it is assigned a value different from the generated value, ReportCaster will override that with the generated ID.

ReportName

String

The name of the report associated with this task. It is used when sending output as an attachment. The maximum size for report name is 64 characters.

TaskRetry

TimeInterval

A structure defining the time interval for restarting a task if the task did not complete successfully.

ParameterList

Parameter

An array of parameters. Each parameter structure in the array contains one name value pair. Upon execution of a schedule, the parameters are appended to the URL in normal fashion, after the question mark (?).

Password

String

The value of the password necessary for access to the URL's Web server. This password is submitted within the HTTP header.

UrlString

String

The URL of the Web page to be distributed.

UserName

String

The value of the user name necessary for access to the URL's Web server. This user name is submitted within the HTTP header.

The following is an example of the TaskURL structure.

TaskURL structure image example



x
TaskWFServerProcedure (WebFOCUS Server Procedure Task Structure)

The TaskWFServerProcedure structure is one of five task types supported by ReportCaster (MyReport, Standard Report, File and URL are the others). Each task type corresponds to a means of running or accessing a report that can be distributed by ReportCaster. TaskWFServerProcedure enables you to schedule the distribution of reports that reside specifically on a WebFOCUS Reporting Server. A WebFOCUS Server procedure is a WebFOCUS report (FOCEXEC) residing on a WebFOCUS Reporting Server that is accessible to the Distribution Server.

Name

Type

Description

Description

String

The text used to describe the task. The maximum size for the description is 255 characters.

Id

String

The unique identifier ReportCaster generates for every saved task. The user is not allowed to manipulate this ID. If it is assigned a value different from the generated value, ReportCaster will override that with the generated ID.

ReportName

String

The name of the report associated with this task. It is used when sending output as an attachment. The maximum size for report name is 64 characters.

TaskRetry

TimeInterval

A structure defining the time interval for restarting a task if the task did not complete successfully.

Burst

Boolean

The value that specifies whether or not report bursting is enabled. Report bursting allows you to segment a report into sections based upon a primary sort field. The report segments are then distributed as separate reports by the Distribution Server. Access to these report segments is based upon burst values (specific values of the primary sort field) that are associated with e-mail addresses in distribution lists or user IDs in library access lists.

ExecId

String

The user name needed to establish a connection to the WebFOCUS Reporting Server. The user name is one of the credentials necessary for a user to access a WebFOCUS procedure that resides on the WebFOCUS Reporting Server during scheduling, as well as to run this procedure at the time the job is run.

ExecPassword

String

The password needed to establish a connection to the WebFOCUS Reporting Server. The password is one of the credentials necessary for a user to access a WebFOCUS procedure that resides on the WebFOCUS Reporting Server during scheduling, as well as run this procedure at the time the job is run.

FirstPostProcessingProcedure

String

The name of the first of two possible post-processing procedures that can be associated with this WebFOCUS Server procedure task. Post-processing procedures (available for WebFOCUS Server procedure, Standard Report, and My Report tasks only) are non-reporting WebFOCUS procedures that run synchronously after the execution of their associated task. They are often used to reset computing or data environments.

FirstPreProcessingProcedure

String

The name of the first of two possible pre-processing procedures that can be associated with this WebFOCUS Server procedure task. Pre-processing procedures (available for WebFOCUS Server procedure, Standard Report, and MyReport tasks only) are non-reporting WebFOCUS procedures that run synchronously prior the execution of their associated task. They are often used to set or test conditions before the running of reports.

ParameterList

Parameter

An array of parameter information, with each structure representing a name value pair that is matched and then resolved upon the execution of this WebFOCUS Server procedure.

ProcedureName

String

The name of the WebFOCUS procedure (FOCEXEC) that resides on the Reporting Server that is associated with this task. This WebFOCUS procedure is the program responsible for generating the report that this task will create.

SecondPostProcessingProcedure

String

The name of the second of two possible post-processing procedures that can be associated with this WebFOCUS Server Procedure task. Post-processing procedures (available for WebFOCUS Server procedure, Standard Report, and My Report Tasks only) are non-reporting WebFOCUS procedures that run synchronously after the execution of their associated task. They are often used to reset computing or data environments.

SecondPreProcessingProcedure

String

The name of the second of two possible pre-processing procedures that can be associated with this WebFOCUS Server procedure task. Pre-processing procedures (available for WebFOCUS Server Procedure, Standard Report, and My Report Tasks only) are non-reporting WebFOCUS procedures that run synchronously prior the execution of their associated task. They are often used to set or test conditions before the running of reports.

SendFormat

String

The report format that will be generated by the WebFOCUS Reporting Server. For example, PDF or HTML.

ServerName

String

The name of the WebFOCUS Reporting Server housing the WebFOCUS procedure associated with this task.

The following is an example of the TaskWFServerProcedure structure.

TaskWFServerProcedure structure image example



x
TimeInfoDay (Daily Scheduling Structure)

The TimeInfoDay structure represents time information pertaining to scheduled reports that run in intervals of days.

Name

Type

Description

NextRunTime

Date

Calendar information indicating the next run time for a scheduled event. NextRunTime is generally used only as an internal function. It is not recommended for general usage and is not formally supported. Manually re-setting system designated fields might result in unpredictable behavior. However, the expected behavior if a user or programmer uses NextRunTime to designate a next run time that is different from the run time calculated internally is that the scheduled job will run at the new next run time. It then resumes normal calculation.

StartTime

Date

Calendar information indicating the start time for a scheduled event. The start time is designated as the first time a new schedule is set to run. Creating a new schedule and altering any jobs that are to run in the future will create an entirely new start time. The default start time is the current time. After the first time a schedule runs, subsequent run times can be obtained via NextRunTime.

EndTime

Date

Calendar information indicating the end time for a scheduled event. ReportCaster will not run a job for this schedule after this date.

Frequency

Integer

The frequency for a scheduled event in days. For example, if an e-mail report distribution is set to run every third day, the frequency would be 3.

SecondaryRunInterval

TimeInterval

A structure that defines a secondary run interval within the day the schedule runs. The interval is setup to run on a minute(s) basis for a specified number of minutes or until a specified time.

The following is an example of the TimeInfoDay structure.

TimeInfoDay structure image example



x
TimeInfoHour (Hourly Scheduling Structure)

The TimeInfoHour structure represents time information pertaining to scheduled reports that run in intervals of hours.

Name

Type

Description

EndTime

Date

Calendar information indicating the end time for a scheduled event. ReportCaster will not run a job for this schedule after this date.

Frequency

Integer

The frequency for a scheduled event, in hours. For example, if an e-mail report distribution is set to run every five hours, the frequency would be 5.

Friday

Boolean

Whether or not the ReportCaster job is scheduled for a Friday. If true, the job will run on a Friday.

Monday

Boolean

Whether or not the ReportCaster job is scheduled for a Monday. If true, the job will run on a Monday.

Saturday

Boolean

Whether or not the ReportCaster job is scheduled for a Saturday. If true, the job will run on a Saturday.

Sunday

Boolean

Whether or not the ReportCaster job is scheduled for a Sunday. If true, the job will run on a Sunday.

Thursday

Boolean

Whether or not the ReportCaster job is scheduled for a Thursday. If true, the job will run on a Thursday.

Tuesday

Boolean

Whether or not the ReportCaster job is scheduled for a Tuesday. If true, the job will run on a Tuesday.

Wednesday

Boolean

Whether or not the ReportCaster job is scheduled for a Wednesday. If true, the job will run on a Wednesday.

NextRunTime

Date

Calendar information indicating the next run time for a scheduled event. NextRunTime is generally used only as an internal function. It is not recommended for general usage and is not formally supported. Manually re-setting system designated fields might result in unpredictable behavior. However, the expected behavior if a user or programmer uses NextRunTime to designate a next run time that is different from the run time calculated internally is that the scheduled job will run at the new next run time. It then resumes normal calculation.

StartTime

Date

Calendar information indicating the start time for a scheduled event. The start time is designated as the first time a new schedule is set to run. Creating a new schedule and altering any jobs that are to run in the future will create an entirely new start time. The default start time is the current time. After the first time a schedule runs, subsequent run times can be obtained via NextRunTime.

The following is an example of the TimeInfoHour structure.

TimeInfoHour structure image example



x
TimeInfoMinute (Minute Scheduling Structure)

The TimeInfoMinute structure represents time information pertaining to scheduled reports that run in intervals of minutes.

Name

Type

Description

EndTime

Date

Calendar information indicating the end time for a scheduled event. ReportCaster will not run a job for this schedule after this date.

Frequency

Integer

The frequency for a scheduled event, in minutes. For example, if an e-mail report distribution is set to run every five minutes, the frequency would be 5.

Friday

Boolean

Whether or not the ReportCaster job is scheduled for a Friday. If true, the job will run on a Friday.

Monday

Boolean

Whether or not the ReportCaster job is scheduled for a Monday. If true, the job will run on a Monday.

Saturday

Boolean

Whether or not the ReportCaster job is scheduled for a Saturday. If true, the job will run on a Saturday.

Sunday

Boolean

Whether or not the ReportCaster job is scheduled for a Sunday. If true, the job will run on a Sunday.

Thursday

Boolean

Whether or not the ReportCaster job is scheduled for a Thursday. If true, the job will run on a Thursday.

Tuesday

Boolean

Whether or not the ReportCaster job is scheduled for a Tuesday. If true, the job will run on a Tuesday.

Wednesday

Boolean

Whether or not the ReportCaster job is scheduled for a Wednesday. If true, the job will run on a Wednesday.

NextRunTime

Date

Calendar information indicating the next run time for a scheduled event. NextRunTime is generally used only as an internal function. It is not recommended for general usage and is not formally supported. Manually re-setting system designated fields might result in unpredictable behavior. However, the expected behavior if a user or programmer uses NextRunTime to designate a next run time that is different from the run time calculated internally is that the scheduled job will run at the new next run time. It then resumes normal calculation.

StartTime

Date

Calendar information indicating the start time for a scheduled event. The start time is designated as the first time a new schedule is set to run. Creating a new schedule and altering any jobs that are to run in the future will create an entirely new start time. The default start time is the current time. After the first time a schedule runs, subsequent run times can be obtained via NextRunTime.

The following is an example of the TimeInfoMinute structure.

TimeInfoMinute structure image example



x
TimeInfoMonth (Monthly Scheduling Structure)

The TimeInfoMonth structure represents time information pertaining to scheduled reports that run in intervals of months.

Name

Type

Description

DayOfWeek

Integer

Day of the week for the report to run. DayOfWeekEnabled must be true.

Valid Values are:

  • 1- Sunday
  • 2 - Monday
  • 3 - Tuesday
  • 4 - Wednesday
  • 5 - Thursday
  • 6 - Friday
  • 7 - Saturday

DayOfWeekEnabled

Boolean

true - DayOfWeek and WeekOfMonth must be set.

false - DaysOfMonth and/or LastDayOfMonth must be set.

DaysOfMonth

Boolean

A 31 element array indicating which days of the month have been selected for a report to run. All array members are initialized to False. Those members of the array that are then set to true are the days of the month the schedule will run. DayOfWeekEnabled must be false.

EndTime

Date

Calendar information indicating the end time for a scheduled event. ReportCaster will not run a job for this schedule after this date.

Frequency

Integer

The frequency for a scheduled distribution. For example, if an e-mail report distribution is set to run every six months, the frequency is 6. ReportCaster uses standard Java data arithmetic to determine run dates when adding months to a start date.

LastDayOfMonth

Boolean

An indicator whether or not the last day of the month flag is set. When this flag is set, ReportCaster runs a schedule on the last day of the month regardless of what day it is. For example, a schedule set to run on February 28th will next run on March 31st if this flag is set. Otherwise, ReportCaster will run the job on the corresponding day of the next month. If this flag isn't set then it will run the report on March 28th. If the corresponding day of the next month doesn't exist, then ReportCaster will not run the report.

SecondaryRunInterval

TimeInterval

A structure that defines a secondary run interval within the day the schedule runs. The interval is setup to run on a minute(s) basis for a specified number of minutes or until a specified time.

WeekOfMonth

Integer

Week of the month for the report to run. DayOfWeekEnabled must be true.

Valid Values are:

  • 1 - first week
  • 2 - second week
  • 3 - third week
  • 4 - fourth week
  • 5 - last week

NextRunTime

Date

Calendar information indicating the next run time for a scheduled event. NextRunTime is generally used only as an internal function. It is not recommended for general usage and is not formally supported. Manually re-setting system designated fields might result in unpredictable behavior. However, the expected behavior if a user or programmer uses NextRunTime to designate a next run time that is different from the run time calculated internally is that the scheduled job will run at the new next run time. It then resumes normal calculation.

StartTime

Date

Calendar information indicating the start time for a scheduled event. The start time is designated as the first time a new schedule is set to run. Creating a new schedule and altering any jobs that are to run in the future will create an entirely new start time. The default start time is the current time. After the first time a schedule runs, subsequent run times can be obtained via NextRunTime.

The following is an example of the TimeInfoMonth structure.

TimeInfoMonth structure image example



x
TimeInfoOnce (Schedule Once Structure)

The TimeInfoOnce structure represents time information pertaining to scheduled jobs that are to run only once.

Name

Type

Description

NextRunTime

Date

Calendar information indicating the next run time for a scheduled event. NextRunTime is generally used only as an internal function. It is not recommended for general usage and is not formally supported. Manually re-setting system designated fields might result in unpredictable behavior. However, the expected behavior if a user or programmer uses NextRunTime to designate a next run time that is different from the run time calculated internally is that the scheduled job will run at the new next run time. It then resumes normal calculation.

StartTime

Date

Calendar information indicating the start time for a scheduled event. The start time is designated as the first time a new schedule is set to run. Creating a new schedule and altering any jobs that are to run in the future will create an entirely new start time. The default start time is the current time. After the first time a schedule runs, subsequent run times can be obtained via NextRunTime.

The following is an example of the TimeInfoOnce structure.

TimeInfoOnce structure image example



x
TimeInfoWeek (Weekly Schedule Structure)

The TimeInfoWeek structure represents time information pertaining to scheduled reports that run in intervals of weeks.

Name

Type

Description

EndTime

Date

Calendar information indicating the end time for a scheduled event. ReportCaster will not run a job for this schedule after this date.

Frequency

Integer

The frequency for a scheduled event, in weeks. For example, if an e-mail report distribution is set to run every five weeks, the frequency would be 5.

Friday

Boolean

Whether or not the ReportCaster job is scheduled for a Friday. If true, the job will run on a Friday.

Monday

Boolean

Whether or not the ReportCaster job is scheduled for a Monday. If true, the job will run on a Monday.

Saturday

Boolean

Whether or not the ReportCaster job is scheduled for a Saturday. If true, the job will run on a Saturday.

Sunday

Boolean

Whether or not the ReportCaster job is scheduled for a Sunday. If true, the job will run on a Sunday.

Thursday

Boolean

Whether or not the ReportCaster job is scheduled for a Thursday. If true, the job will run on a Thursday.

Tuesday

Boolean

Whether or not the ReportCaster job is scheduled for a Tuesday. If true, the job will run on a Tuesday.

Wednesday

Boolean

Whether or not the ReportCaster job is scheduled for a Wednesday. If true, the job will run on a Wednesday.

SecondaryRunInterval

TimeInterval

A structure that defines a secondary run interval within the day the schedule runs. The interval is setup to run on a minute(s) basis for a specified number of minutes or until a specified time.

NextRunTime

Date

Calendar information indicating the next run time for a scheduled event. NextRunTime is generally used only as an internal function. It is not recommended for general usage and is not formally supported. Manually re-setting system designated fields might result in unpredictable behavior. However, the expected behavior if a user or programmer uses NextRunTime to designate a next run time that is different from the run time calculated internally is that the scheduled job will run at the new next run time. It then resumes normal calculation.

StartTime

Date

Calendar information indicating the start time for a scheduled event. The start time is designated as the first time a new schedule is set to run. Creating a new schedule and altering any jobs that are to run in the future will create an entirely new start time. The default start time is the current time. After the first time a schedule runs, subsequent run times can be obtained via NextRunTime.

The following is an example of the TimeInfoWeek structure.

TimeInfoWeek structure image example



x
TimeInfoYear Structure (Yearly Schedule Structure)

The TimeInfoYear structure represents time information pertaining to scheduled reports that run in intervals of years.

Name

Type

Description

EndTime

Date

Calendar information indicating the end time for a scheduled event. ReportCaster will not run a job for this schedule after this date.

Frequency

Integer

Assigns the frequency for a scheduled event, in years. For example, if an e-mail report distribution is set to run every five years, the frequency would be 5.

SecondaryRunInterval

TimeInterval

A structure that defines a secondary run interval within the day the schedule runs. The interval is setup to run on a minute(s) basis for a specified number of minutes or until a specified time.

NextRunTime

Date

Calendar information indicating the next run time for a scheduled event. NextRunTime is generally used only as an internal function. It is not recommended for general usage and is not formally supported. Manually re-setting system designated fields might result in unpredictable behavior. However, the expected behavior if a user or programmer uses NextRunTime to designate a next run time that is different from the run time calculated internally is that the scheduled job will run at the new next run time. It then resumes normal calculation.

StartTime

Date

Calendar information indicating the start time for a scheduled event. The start time is designated as the first time a new schedule is set to run. Creating a new schedule and altering any jobs that are to run in the future will create an entirely new start time. The default start time is the current time. After the first time a schedule runs, subsequent run times can be obtained via NextRunTime.

The following is an example of the TimeInfoYear structure.

TimeInfoYear structure example image



x
TimeInterval (Secondary Run Time and Task Retry Structure)

The TimeInterval structure is used to define a secondary run interval within the day the schedule runs for Daily, Weekly, Monthly, and Yearly schedules. This structure is also used by all Tasks for defining the time interval for restarting a task if the task did not complete successfully. The interval is setup to run on a minute(s) basis for a specified number of minutes or until a specified time. The secondary run interval cannot exceed the NEXTRUNTIME for the primary run interval. For example, a daily schedule cannot have a secondary run interval greater than 1 day. If a secondary run interval is scheduled to run after the schedule's next primary run interval, the secondary run interval is stopped and an error message is displayed to the user and written to the log file.

Name

Type

Description

Duration

Integer

The duration, specified in minutes, during which the time interval will be applied. UseUntilTime must be false.

Enabled

Boolean

true - Time Interval settings are active.

false - Time Interval settings are inactive.

Interval

Integer

Applies the time interval every n minutes.

UntilTime

Date

The end time for which the time interval will be applied. UseUntilTime must be true.

UseUntilTime

Boolean

true - the Until Time value determines the end of the time interval.

false - the Duration value determines the end of the time interval.

The following is an example of the TimeInterval structure. It will run the schedule every 30 minutes for 5 hours (300 minutes) starting at 3:00PM.

TimeInterval structure example image


WebFOCUS