This section summarizes the API and API-related changes made between Panagon eProcess Release 4.2.2 and Release 5.0.
Topics covered in this section include:
Notes
One new public class, VWAttributeInfo, has been added to the eProcess API to support the use of attributes and also to support ActiveX/Open Client coexistence (future use).
Class | Method Included | Class or Method Description |
---|---|---|
VWAttributeInfo |
------- |
This class enables users to associate properties they define with VWOperationDefinition, VWQueueDefinition, VWRosterDefinition, VWStepDefinition, VWSystemAdministration, VWSystemConfiguration, and VWWorkflowDefinition objects. An additional future use of this class will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available (see Miscellaneous Development/API-Related Changes below). |
void deleteField ( String fieldName) |
Deletes the field entry that is specified by input field name. | |
String[] getAttributeNames ( ) |
Gets the array of attribute names for this VWAttributeInfo object. | |
int getFieldType ( String fieldName ) |
Returns the field type of the field value that corresponds to the input field name. | |
Object getFieldValue ( String fieldName ) |
Gets the object value for the input field name. | |
boolean isFieldArray ( String fieldName ) |
Indicates whether the field is an array. | |
void setFieldValue ( String fieldName, Object fieldValue ) |
Creates, deletes, or updates a VWAttributeInfo field value. The field names are labels for fieldValues. |
The following table summarizes the new methods added for this release.
Class | Members Added | Description | Reason for Change |
---|---|---|---|
VWActionType |
ACTION_TYPE_DB_EXECUTE |
Action type for a DB_exec instruction. |
Future support for a Database System Instruction feature. |
VWActionType |
ACTION_TYPE_LOG = 38 |
Action type for a logging instruction. |
Support for design-time customization of logging events. |
VWCompoundStepDefinition |
VWInstructionDefinition createLogInstruction ( String theEventType, String theEventText ) |
Creates a new instruction that will be added to the end of the list of instructions currently in this compound step. Given the input event, the input message will be logged. |
Support for design-time customization of logging events. |
VWOperationDefinition, VWQueueDefinition, VWRosterDefinition, VWStepDefinition, VWSystemAdministration, VWSystemConfiguration, and VWWorkflowDefinition |
VWAttributeInfo getAttributeinfo ( ) |
Returns theVWAttributeInfo object for this class.
|
Attribute support for these objects. See New Classes. |
VWOperationDefinition, VWQueueDefinition, VWRosterDefinition, VWStepDefinition, VWSystemAdministration, VWSystemConfiguration, and VWWorkflowDefinition | void setAttributeInfo ( VWAttributeInfo ) |
Sets the VWAttributeInfo object for this class.
|
Attribute support for these objects. See New Classes. |
VWQueue |
QUERY_GET_NO_ QUERY_GET_NO_TRANSLATED |
New static values to provide more effective query filtering. |
Enhance queries to filter flexibly on system fields. |
VWRoster |
QUERY_GET_NO_ QUERY_GET_NO_TRANSLATED |
New static values to provide more effective query filtering. |
Enhance queries to filter flexibly on system fields. |
VWSession |
ATTRIBUTES_SYSTEM
= 1 |
New static values to flag whether to fetch system-wide or isolated region-specific attribute information for the current logged-on session. |
Used to specify either system-wide or isolated region-specific attribute information. |
VWSession |
DATABASE_ORACLE=
1 |
New static values to define the database environment as database configuration types. |
Future support for a Database System Instruction feature. |
VWSession |
WEBAPP_NONE
= 0 |
New static values (as shown) to define the web application IDs. Note: Values 4-99 are reserved for FileNET use. Values 101-nnn are available for customer use. |
Used to specify the web application. An additional future use will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available. |
VWSession |
VWAttributeInfo fetchAttributes( int nFlag ) |
Fetches from the workflow server system-wide or region-specific attribute information for the current logged-on session. |
Useful for a customization that creates system-wide or region-specific attribute information via VWSystemAdministration or VWSystemConfiguration objects, respectively. |
VWSession |
int getDatabaseType() |
Returns the database configuration type of the current database. |
Future support for a Database System Instruction feature. |
VWSession |
int getDefaultWebApplication
( ) |
Returns the application environment type. |
Gets the default web application ID for a logged-on session. The web application id enables the workflow system to use web application-specific program implementations. |
VWSession |
String getServerName ( ) |
Returns the name of the server for this session. |
Enables an API user to get the server name at runtime. |
VWSession |
void setDefaultWebApplication
( int theWebApplicationId ) |
Stores the application environment type as one among: NONE, WORKPLACE, WORKFLO, OPEN_CLIENT, or CUSTOM. |
Sets the default web application ID for a logged-on session. The web application id enables the workflow system to use web application-specific program implementations. |
VWStepProcessorInfo |
Hashtable getLocations ( ) |
Gets an array of step processor URL locations, which are typically URLs of ASP or JSP pages. |
Future use of this method will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available. |
VWStepProcessorInfoDefinition |
VWStepProcessorInfoDefinition ( int, String, int, Hashtable, int, int, String ) |
Constructor to specify the URL locations of stepProcessors. |
Future use of this method will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available. |
VWStepProcessorInfoDefinition |
String getLocation (int ) |
Gets the URL location associated with this step processor info object,
for one Web Application. |
Future use of this method will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available. |
VWStepProcessorInfoDefinition |
Hashtable getLocations ( ) |
Gets the URL location associated with this step processor info object. |
Future use of this method will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available. |
VWStepProcessorInfoDefinition |
void setLocations ( Hashtable theLocations ) |
Sets the URL location associated with this step processor info object. |
Future use of this method will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available. |
VWSystemAdministration |
Commit ( ) |
Saves the session timeout interval, system flags, statistics consolidation interval, and attribute information to the workflow server database. |
Future use of this method will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available. |
VWSystemAdministration |
getSessionTimeOut( ) |
Gets the number of minutes before a client / server session timeout. |
Support for customization of the Session timeout period, rather than relying on the system default of 20 minutes. |
VWSystemAdministration |
void setSessionTimeOut( int ) |
Sets the number of minutes before a client / server session timeout. |
Support for customization of the Session timeout period, rather than enforcing a system default of 20 minutes. |
VWSystemAdministration |
SYSTEM_WIDE_FLAG_ |
Indicates that returns will be consistent with the documented behavior of the return system instruction. |
Future support for Analysis and Reporting features. |
VWSystemAdministration |
SYSTEM_WIDE_FLAG_ |
Indicates that the Analysis Engine should be disabled on the server. |
Future support for Analysis and Reporting features. |
VWWorkflowDefinition |
LVALUE = 0 |
Provides a standard static value for locating the pre-assignment values of an assignment array, in common with step definitions and event definitions. |
Used to support pre-assignment and post-assignment two-dimensional arrays. |
VWWorkflowDefinition |
RVALUE = 1 |
Provides a standard static value for locating the post-assignment values of an assignment array, in common with step definitions and event definitions. |
Used to support pre-assignment and post-assignment two-dimensional arrays. |
The IVWParameterConstants interface's fields for session and web application-related operations were modified for this release as shown in the following table.
Interface/Bean | Fields Deprecated | Fields Added, Deleted, or Replaced | Reason for Change |
---|---|---|---|
IVWParameterConstants |
|
The fields shown below were added, deleted, or replaced existing fields. The field string constant values shown specify the web application IDs. |
Provide web application IDs. An additional future use will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available (see Miscellaneous Development/API-Related Changes below). |
IVWParameterConstants | PRODUCT |
WEBAPP Value: webApp |
Same as above. |
IVWParameterConstants | BRIGHTSPIRE_PRODUCT |
WEBAPP_WORKPLACE Value: WORKPLACE |
Same as above. |
IVWParameterConstants | PANAGON_PRODUCT |
WEBAPP_WEB_WORKFLO Value: WEB_WORKFLO |
Same as above. |
IVWParameterConstants | OPEN_CLIENT_PRODUCT |
WEBAPP_OPEN_CLIENT Value: OPEN_CLIENT |
Same as above. |
IVWParameterConstants |
VIEWER Value: VIEWER |
New field added. Enables the applet to determine which document viewer to display (ActiveX or Java). | |
IVWParameterConstants | CUSTOM_PRODUCT | Deleted (not replaced). | FileNET eProcess does not currently support a sample custom product. |
The following table summarizes API class members that have been deprecated as of eProcess Release 5.0.
Note For information about any specific deprecation, refer to the "Deprecated Methods" section of the eProcess API JavaDoc documentation; for information on eProcess API JavaDoc documentation, see eProcess API Class Relationships.
Class | Member deprecated | Replacement | Reason for Change |
---|---|---|---|
VWQueue |
QUERY_GET_SYSTEM_ |
Not Replaced. This value is the default. |
To provide for inclusion or exclusion of system fields or translated system fields for query filtering. |
VWRoster |
QUERY_GET_SYSTEM_ |
Not Replaced. This value is the default. |
To provide for inclusion or exclusion of system fields or translated system fields for query filtering. |
VWSession |
PRODUCT_BPS |
Replaced by WEBAPP_WORKPLACE; use with setDefaultWebApplication(int). |
Future use of the replacement member will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available. |
VWSession |
PRODUCT_CUSTOM |
Replaced by WEBAPP_CUSTOM; use with setDefaultWebApplication(int). |
Future use of the replacement member will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available. |
VWSession |
PRODUCT_OPEN_CLIENT |
Replaced by WEBAPP_OPEN_CLIENT; use with setDefaultWebApplication(int). |
Future use of the replacement member will be to support ActiveX/Open Client coexistence when eProcess 5.0 integration with Open Client becomes available. |
VWSession |
PRODUCT_PW |
Replaced by WEBAPP_WEB_WORKFLO; use with setDefaultWebApplication(int). |
Helps manage more flexible environment specifications in multiple web application system configurations. |
VWSession |
setAuditState() |
Replaced by inserting an edited copy of an fnlogging.properties file in the <JRE>\lib directory. See this method in the eProcess API Javadoc for details. |
Support for the Sun 1.4 JRE. |
VWSession |
setProductId(int) |
Replaced by setDefaultWebApplication( int ). |
More flexible support for multiple Web Application system configurations. |
VWStepProcessorInfo |
getLocation() |
Replaced by getLocation( int ). |
To allow specification of one among multiple web application locations for a single step processor. |
VWStepProcessorInfoDefinition |
VWStepProcessorInfoDefinition |
Replaced by VWStepProcessorInfoDefinition |
To allow specification of multiple web application locations for a single step processor. |
VWStepProcessorInfoDefinition |
getLocation() |
Replaced by getLocation( int ). |
To allow specification of one among multiple web application locations for a single step processor. |
VWStepProcessorInfoDefinition |
setLocation(String) |
Replaced by setLocations ( Hashtable ). |
To allow specification of one among multiple web application locations for a single step processor. |
VWSystemAdministration |
setSystemWideFlags(int theFlags) |
Replaced by setSystemFlags ( int theFlags ). This replacement does not save system flags to the workflow server. |
More flexible flag setting replacement. |
The following are changes made for the eProcess 5.0 Release that were not directly made to any APIs, but which can affect how the APIs are used:
VWEventDefinition String[][] getAssignments() void setAssignments(String[][] theAssignments) VWCompoundStepDefinition VWInstructionDefinition createCreateInstruction(String theWorkClassName, String[][] theFieldAssignList) VWInstructionDEfinition createAssignInstruction(String[][] assignPairs)
Note Versions used may be updated. For the latest information on which versions of software (including JDKs) are supported for Panagon eProcess Web Services, Web WorkFlo and WorkFlo Services, see the eProcess Compatibility/Dependency/Server Matrix document, located at http://www.css.filenet.com web site (go to Product Info > Panagon > eProcess > Compatibility and Dependency).
You will then specify the web application when you run your application. For instance, to run the sample Java Step Processor, VWSampleStepApplication, you would specify as a parameter: webApp=WEB_WORKFLO (previously, you would have specified: product=PANAGON). For example:
javaw -classpath .;C:\Developer Files\samples\vwpanel\sample.jar;C:\<your directory>\pw.jar;%CLASSPATH% samples.vwpanel.samplestep.VWSampleStepApplication /hostName=<host name> /routerNames=vwrouter /routerPorts=1099 /idmPort=1099 /webApp=WEB_WORKFLO /queueName=InBox /wobNumber=B8D270F79636E1489BA9EC2DD9F7E950
For details, see the Run the Sample Step Processor Application step in the Building and Deploying the Sample Java Processors procedure.
The eProcess 5.0 release however, will support ActiveX and Open Client co-existence on the same web server, isolated region, and router at such time as Panagon Open Client is released for use with eProcess 5.0. For information on developing eProcess applications for ASP.NET-based Open Client, see the "Developing for eProcess Open Client" section of the Open Client Developer's Guide.
The following documentation changes have been made since the last release: