ibi.broker.api.data.schedule
Class TaskWFServerProcedure

java.lang.Object
  ibi.broker.api.data.schedule.Task
      ibi.broker.api.data.schedule.TaskWFServerProcedure

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TaskStandardReport

public class TaskWFServerProcedure
extends Task

 The TaskWFServerProcedure class is one of six task types supported by 
 ReportCaster (MyReport, Standard Report, File, FTP 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 FOCUS executable (FOCEXEC) residing on a 
 WebFOCUS Reporting Server which is accessible to the distribution server. 
 
 The code below illustrates the use of the TaskWFServerProcedure class. It is taken
 from the samples packaged with the product.

 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 +  Copyright (c) 2004 Information Builders, Inc. All  Rights Reserved.     +
 +                                                                          +
 +  Information Builders offers sample API programs as a heuristic device.  +
 +  They are not intended, as is, for production use. Licensed users are    +
 +  welcome to alter and extend these samples and deploy them in other      +
 +  environments, or alternate configurations, as they see fit.             +
 +  Information Builders will support the documented functionality of       +
 +  its API classes and methods. However, Information Builders is not       +
 +  responsible for functionality or behavior of products built with        +
 +  its API unless the documented behavior of its discrete classes and      +
 +  methods is different than the actual results.                           +
 +                                                                          +
 +  Redistributions of IBI source code and documentation must be within     +
 +  the scope of the Information Builders Software License Agreement.       +
 +                                                                          +
 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++   

 public class S01_Add_Library 
{

        public S01_Add_Library(String[] arg) throws Exception
        {
                //   Example of arg
                //   scheduleDescription car execid execpass
                //   
                //Example of Report source
                //TABLE FILE CAR
                //PRINT CAR WHERE  
                //COUNTRY EQ 'ENGLAND'
                //END
                //

                String scheduleDescription = arg[0];
                String fexFileName = arg[1];
                String execId = arg[2];
                String execPassword = arg[3];

                // Create ScheduleManager
                ScheduleManager manager = Util.createCasterConnection().getScheduleManager();

                //create object schedule with default values from config file
                Schedule schedule = manager.createScheduleInstanceDefault();

                //set description
                schedule.setDescription(scheduleDescription);

                //set distribution to library
                Distribution distribution = new StorageLibrary();
                schedule.setDistribution(distribution);

                //create task
                TaskWFServerProcedure task = new TaskWFServerProcedure();
                task.setProcedureName(fexFileName);
                task.setExecId(execId);
                task.setExecPassword(execPassword);
                schedule.setTaskList(new Task[]{task});

                //subscribe schedule
                manager.addSchedule(schedule);
        }
        public static void main(String[] arg)
        {
                S01_Add_Library sampl = null;
                if(arg.length < 4) {
                         menu();
                         return;
                }
                try
                {
                        System.out.println("\n******* " + S01_Add_Library.class.getName() + " *****************");
                        sampl = new S01_Add_Library(arg);
                        System.out.println("\n" + sampl.getClass().getName() + " OK");
                }
                catch(Exception ce)
                {
                        ce.printStackTrace();
                        System.out.println(sampl.getClass().getName() + " FAIL");

                }

        }
        private static void menu()
        {
                System.out.println("Usage: java " + S01_Add_Library.class.getName() +  " <scheduleDescription> <fexFileName> <execId> <execPassword>");                 
  }
}

 

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ibi.broker.api.data.schedule.Task

Task.SystemTask

Field Summary

static java.lang.String	AHTML String identifier for send format AHTML.
static java.lang.String	ALPHA String identifier for send format ALPHA.
static java.lang.String	APDF
static java.lang.String	COM
static java.lang.String	COMMA String identifier for send format COMMA.
static java.lang.String	COMT String identifier for send format COMT.
static java.lang.String	DFIX_DELIMITER
static java.lang.String	DHTML String identifier for send format DHTML.
static java.lang.String	DOC String identifier for send format DOC.
static java.lang.String	EXCEL String identifier for send format EXCEL.
static java.lang.String	EXCEL_TEMPLATE String identifier for send format EXLEL TEMPLATE.
static java.lang.String	EXL07
static java.lang.String	EXL07_TEMPLATE
static java.lang.String	EXL2K String identifier for send format EXL2K.
static java.lang.String	EXL2K_FORMULA String identifier for send format EXL2K FORMULA.
static java.lang.String	EXL2K_PIVOT String identifier for send format EXL2K PIVOT.
static java.lang.String	EXL97 String identifier for send format EXL97.
static java.lang.String	FLEX
static java.lang.String	GIF String identifier for send format GIF.
static java.lang.String	HTML String identifier for send format HTML (Default).
static java.lang.String	HTML_ODP
static java.lang.String	JPEG
static java.lang.String	MHT
static java.lang.String	PDF String identifier for send format PDF.
static java.lang.String	PNG String identifier for send format PNG.
static java.lang.String	PPT String identifier for send format PPT.
static java.lang.String	PPT_TEMPLATE String identifier for send format PPT TEMPLATE.
static java.lang.String	PPTX String identifier for send format PPTX.
static java.lang.String	PS String identifier for send format PS.
static java.lang.String	SVG String identifier for send format SVG.
static java.lang.String	TAB
static java.lang.String	TABT String identifier for send format TABT.
static java.lang.String	VISDIS String identifier for send format VISDIS.
static java.lang.String	VISDISAE
static java.lang.String	WK1 String identifier for send format WK1.
static java.lang.String	WP String identifier for send format WP.
static java.lang.String	XML String identifier for send format XML.

Fields inherited from class ibi.broker.api.data.schedule.Task

description, enabled, FILE, FTP, id, MAINFRAME_JES_RETRIEVE, MY_REPORT, procedureName, reportName, SCHEDULE, STANDARD_REPORT, taskRetry, URL, WEBFOCUS_SERVER_PROCEDURE

Constructor Summary

TaskWFServerProcedure()

Method Summary

void	addParameter(Parameter parameter)
java.lang.String[]	getAllowFormatList()
java.lang.String	getExecId() Obtains the user name needed to establish a connection to the WebFOCUS Reporting Server.
java.lang.String	getExecPassword() Obtains the password needed to establish a connection to the WebFOCUS Reporting Server.
java.lang.String	getFirstPostProcessingProcedure() Obtains the name of the first of two possible post-processing procedures that can be associated with this WebFOCUS Server procedure task.
java.lang.String	getFirstPreProcessingProcedure() Obtains the name of the first of two possible pre-processing procedures that can be associated with this WebFOCUS Server procedure task.
Parameter[]	getParameterList() Obtains an array of Parameter objects, with each object representing a name value pair that is matched and then resolved upon the execution of this WebFOCUS Server procedure.
java.lang.String	getSecondPostProcessingProcedure() Obtains the name of the second of two possible post-processing procedures that can be associated with this WebFOCUS Server Procedure task.
java.lang.String	getSecondPreProcessingProcedure() Obtains the name of the second of two possible pre-processing procedures that can be associated with this WebFOCUS Server Procedure task.
java.lang.String	getSendFormat() Obtains the String constant representing the format of the report that will be generated by the WebFOCUS Reporting Server.
java.lang.String	getServerName() Obtains the name of the WebFOCUS Reporting Server housing the FOCUS procedure associated with this task.
boolean	isBurst() Obtains the value of a boolean flag that specifies whether or not report bursting is enabled.
void	setAllowFormatList(java.lang.String[] allowFormatList)
void	setBurst(boolean burst) Assigns the value of a boolean flag that specifies whether or not report bursting is enabled.
void	setExecId(java.lang.String execId) Assigns the user name needed to establish a connection to the WebFOCUS Reporting Server.
void	setExecPassword(java.lang.String execPassword) Assigns the password needed to establish a connection to the WebFOCUS Reporting Server.
void	setFirstPostProcessingProcedure(java.lang.String firstPostProcessingProcedure) Assigns the name of the first of two possible post-processing procedures that can be associated with this WebFOCUS Server Procedure task.
void	setFirstPreProcessingProcedure(java.lang.String firstPreProcessingProcedure) Assigns the name of the first of two possible pre-processing procedures that can be associated with this WebFOCUS Server procedure task.
void	setParameterList(Parameter[] parameterList) Obtains an array of Parameter objects, with each object representing a name value pair, that is matched and then resolved upon the execution of this WebFOCUS Server procedure.
void	setSecondPostProcessingProcedure(java.lang.String secondPostProcessingProcedure) Assigns the name of the second of two possible post-processing procedures that can be associated with this WebFOCUS Server Procedure task.
void	setSecondPreProcessingProcedure(java.lang.String secondPreProcessingProcedure) Assigns the name of the second of two possible pre-processing procedures that can be associated with this WebFOCUS Server Procedure task.
void	setSendFormat(java.lang.String sendFormat) Assigns the String constant representing the format of the report that will be generated by the WebFOCUS Reporting Server.
void	setServerName(java.lang.String serverName) Assigns the name of the WebFOCUS Reporting Server housing the FOCUS procedure associated with this task.

Methods inherited from class ibi.broker.api.data.schedule.Task

getDescription, getId, getProcedureName, getReportName, getTaskRetry, isEnabled, setDescription, setEnabled, setId, setProcedureName, setReportName, setTaskRetry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AHTML

public static final java.lang.String AHTML

String identifier for send format AHTML.

See Also:

Constant Field Values

HTML

public static final java.lang.String HTML

String identifier for send format HTML (Default).

See Also:

Constant Field Values

HTML_ODP

public static final java.lang.String HTML_ODP

See Also:

Constant Field Values

PDF

public static final java.lang.String PDF

String identifier for send format PDF.

See Also:

Constant Field Values

PS

public static final java.lang.String PS

String identifier for send format PS.

See Also:

Constant Field Values

DOC

public static final java.lang.String DOC

String identifier for send format DOC.

See Also:

Constant Field Values

WP

public static final java.lang.String WP

String identifier for send format WP.

See Also:

Constant Field Values

EXCEL

public static final java.lang.String EXCEL

String identifier for send format EXCEL.

See Also:

Constant Field Values

EXL2K

public static final java.lang.String EXL2K

String identifier for send format EXL2K.

See Also:

Constant Field Values

WK1

public static final java.lang.String WK1

String identifier for send format WK1.

See Also:

Constant Field Values

ALPHA

public static final java.lang.String ALPHA

String identifier for send format ALPHA.

See Also:

Constant Field Values

GIF

public static final java.lang.String GIF

String identifier for send format GIF.

See Also:

Constant Field Values

PNG

public static final java.lang.String PNG

String identifier for send format PNG.

See Also:

Constant Field Values

SVG

public static final java.lang.String SVG

String identifier for send format SVG.

See Also:

Constant Field Values

XML

public static final java.lang.String XML

String identifier for send format XML.

See Also:

Constant Field Values

TABT

public static final java.lang.String TABT

String identifier for send format TABT.

See Also:

Constant Field Values

TAB

public static final java.lang.String TAB

See Also:

Constant Field Values

COMMA

public static final java.lang.String COMMA

String identifier for send format COMMA.

See Also:

Constant Field Values

COMT

public static final java.lang.String COMT

String identifier for send format COMT.

See Also:

Constant Field Values

EXL2K_FORMULA

public static final java.lang.String EXL2K_FORMULA

String identifier for send format EXL2K FORMULA.

See Also:

Constant Field Values

EXL2K_PIVOT

public static final java.lang.String EXL2K_PIVOT

String identifier for send format EXL2K PIVOT.

See Also:

Constant Field Values

EXL97

public static final java.lang.String EXL97

String identifier for send format EXL97.

See Also:

Constant Field Values

EXCEL_TEMPLATE

public static final java.lang.String EXCEL_TEMPLATE

String identifier for send format EXLEL TEMPLATE.

See Also:

Constant Field Values

PPT

public static final java.lang.String PPT

String identifier for send format PPT.

See Also:

Constant Field Values

PPTX

public static final java.lang.String PPTX

String identifier for send format PPTX.

See Also:

Constant Field Values

PPT_TEMPLATE

public static final java.lang.String PPT_TEMPLATE

String identifier for send format PPT TEMPLATE.

See Also:

Constant Field Values

DHTML

public static final java.lang.String DHTML

String identifier for send format DHTML.

See Also:

Constant Field Values

VISDIS

public static final java.lang.String VISDIS

String identifier for send format VISDIS.

See Also:

Constant Field Values

VISDISAE

public static final java.lang.String VISDISAE

See Also:

Constant Field Values

COM

public static final java.lang.String COM

See Also:

Constant Field Values

JPEG

public static final java.lang.String JPEG

See Also:

Constant Field Values

MHT

public static final java.lang.String MHT

See Also:

Constant Field Values

FLEX

public static final java.lang.String FLEX

See Also:

Constant Field Values

APDF

public static final java.lang.String APDF

See Also:

Constant Field Values

EXL07

public static final java.lang.String EXL07

See Also:

Constant Field Values

EXL07_TEMPLATE

public static final java.lang.String EXL07_TEMPLATE

See Also:

Constant Field Values

DFIX_DELIMITER

public static final java.lang.String DFIX_DELIMITER

See Also:

Constant Field Values

Constructor Detail

TaskWFServerProcedure

public TaskWFServerProcedure()

Method Detail

isBurst

public boolean isBurst()

Obtains the value of a boolean flag that specifies whether or not report bursting is enabled. Report bursting allows you to a 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 email addresses in distribution lists, or user id's in library access lists.

Returns:

The value of the burst flag as a boolean.

See Also:

setBurst(boolean)

setBurst

public void setBurst(boolean burst)

Assigns the value of a boolean flag that specifies whether or not report bursting is enabled. Report bursting allows you to a 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 email addresses in distribution lists or user id's in library access lists.

Parameters:

burst - The boolean burst flag.

See Also:

isBurst()

getFirstPostProcessingProcedure

public java.lang.String getFirstPostProcessingProcedure()

Obtains 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 MyReport tasks only) are non-reporting FOCUS procedures that run synchronously after the execution of their associated task. They are often used to reset computing or data environments. The post-processing procedure is returned as a fully qualified path of a FOCUS procedure accessible to the reporting server.

Returns:

The fully qualified path of a reporting server accessible, post-processing FOCUS procedure as a String.

See Also:

setFirstPostProcessingProcedure(java.lang.String)

setFirstPostProcessingProcedure

public void setFirstPostProcessingProcedure(java.lang.String firstPostProcessingProcedure)

Assigns 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 FOCUS procedures that run synchronously after the execution of their associated task. They are often used to reset computing or data environments. The post-processing procedure is set as a fully qualified path of a FOCUS procedure accessible to the reporting server.

Parameters:

firstPostProcessingProcedure - The fully qualified path of a reporting server accessible, post-processing FOCUS procedure as a String.

See Also:

getFirstPostProcessingProcedure()

getFirstPreProcessingProcedure

public java.lang.String getFirstPreProcessingProcedure()

Obtains 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 FOCUS 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. The pre-processing procedure is returned as a fully qualified path of a FOCUS procedure accessible to the reporting server.

Returns:

The fully qualified path of a reporting server accessible, pre-processing FOCUS procedure as a String.

See Also:

setFirstPreProcessingProcedure(java.lang.String)

setFirstPreProcessingProcedure

public void setFirstPreProcessingProcedure(java.lang.String firstPreProcessingProcedure)

Assigns 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 FOCUS 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. The pre-processing procedure is returned as a fully qualified path of a FOCUS procedure accessible to the reporting server. return The fully qualified path of a reporting server accessible, pre-processing FOCUS procedure as a String.

See Also:

getFirstPreProcessingProcedure()

getParameterList

public Parameter[] getParameterList()

Obtains an array of Parameter objects, with each object representing a name value pair that is matched and then resolved upon the execution of this WebFOCUS Server procedure.

Returns:

An array of Parameter objects.

See Also:

setParameterList(ibi.broker.api.data.schedule.Parameter[])

setParameterList

public void setParameterList(Parameter[] parameterList)

Obtains an array of Parameter objects, with each object representing a name value pair, that is matched and then resolved upon the execution of this WebFOCUS Server procedure.

Parameters:

parameterList - An array of Parameter objects.

See Also:

getParameterList()

getExecPassword

public java.lang.String getExecPassword()

Obtains 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 FOCUS procedure that resides on the WebFOCUS Reporting Server during scheduling, as well as to run this procedure at the time the job is run.

Returns:

The password as a String.

See Also:

setExecPassword(String)

setExecPassword

public void setExecPassword(java.lang.String execPassword)

Assigns 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 FOCUS procedure that resides on the WebFOCUS Reporting Server during scheduling, as well as run this procedure at the time the job is run.

Parameters:

execPassword - The password String.

See Also:

getExecPassword()

getSecondPostProcessingProcedure

public java.lang.String getSecondPostProcessingProcedure()

Obtains 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 MyReport tasks only) are non-reporting FOCUS procedures that run synchronously after the execution of their associated task. They are often used to reset computing or data environments. The post-processing procedure is returned as a fully qualified path of a FOCUS procedure accessible to the reporting server.

Returns:

The second Post-processing Procedure name as a String.

See Also:

setSecondPostProcessingProcedure(java.lang.String)

setSecondPostProcessingProcedure

public void setSecondPostProcessingProcedure(java.lang.String secondPostProcessingProcedure)

Assigns 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 FOCUS procedures that run synchronously after the execution of their associated task. They are often used to reset computing or data environments. The post-processing procedure is set as a fully qualified path of a FOCUS procedure accessible to the reporting server.

Parameters:

secondPostProcessingProcedure - The fully qualified path of a reporting server accessible, post-processing FOCUS procedure as a String.

See Also:

getSecondPostProcessingProcedure()

getSecondPreProcessingProcedure

public java.lang.String getSecondPreProcessingProcedure()

Obtains 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 FOCUS 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. The pre-processing procedure is returned as a fully qualified path of a FOCUS procedure accessible to the reporting server.

Returns:

The fully qualified path of a reporting server accessible, pre-processing FOCUS procedure as a String.

See Also:

setSecondPreProcessingProcedure(java.lang.String)

setSecondPreProcessingProcedure

public void setSecondPreProcessingProcedure(java.lang.String secondPreProcessingProcedure)

Assigns 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 FOCUS 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. The pre-processing procedure is returned as a fully qualified path of a FOCUS procedure accessible to the reporting server.

Parameters:

secondPreProcessingProcedure - The fully qualified path of a reporting server accessible, pre-processing FOCUS procedure as a String.

See Also:

getSecondPreProcessingProcedure()

getSendFormat

public java.lang.String getSendFormat()

Obtains the String constant representing the format of the report that will be generated by the WebFOCUS Reporting Server. For example, PDF or HTML. Reports can formatted in any of the formats identified in the field name constants above if the FOCUS procedure is written to support the specified format.

Returns:

The format of this report as a String constant.

See Also:

setSendFormat(java.lang.String)

setSendFormat

public void setSendFormat(java.lang.String sendFormat)

Assigns the String constant representing the format of the report that will be generated by the WebFOCUS Reporting Server. For example, PDF or HTML. Reports can formatted in any of the formats identified in the field name constants if the FOCUS procedure is written to support the specified format.

Parameters:

sendFormat - The format of this report as a String constant.

See Also:

getSendFormat()

getServerName

public java.lang.String getServerName()

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

Returns:

The name of the Reporting Server as a String.

See Also:

setServerName(java.lang.String)

setServerName

public void setServerName(java.lang.String serverName)

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

Parameters:

serverName - The name of the Reporting Server.

See Also:

getServerName()

getExecId

public java.lang.String getExecId()

Obtains 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 FOCUS procedure that resides on the WebFOCUS Reporting Server during scheduling, as well as to run this procedure at the time the job is run.

Returns:

The execId as a String.

See Also:

setExecId(String)

setExecId

public void setExecId(java.lang.String execId)

Assigns 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 FOCUS procedure that resides on the WebFOCUS Reporting Server during scheduling, as well as to run this procedure at the time the job is run.

Parameters:

execId - The user name as a String.

See Also:

getExecId()

getAllowFormatList

public java.lang.String[] getAllowFormatList()

setAllowFormatList

public void setAllowFormatList(java.lang.String[] allowFormatList)

addParameter

public void addParameter(Parameter parameter)