What's New in 5.0

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

  1. The major feature change for the eProcess 5.0 Release, the addition of the Analysis and Reporting Engine, required little change to the eProcess API, except for the addition of flags for the VWSystemAdministration class to support future uses.
  2. eProcess integration with Open Client (in addition to the current ActiveX client) for use with the IDM .NET 3.2 Open Client will initially be provided for use with the eProcess 4.2.2 release. For information on using eProcess in an environment that includes both Open Client and ActiveX clients, see Miscellaneous Development/API-Related Changes below. For information on developing eProcess applications for IDM .NET-based Open Client, see the "Developing for eProcess Open Client" section of the Open Client Developer's Guide.

New API Classes

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.

Back to top


Modified API Classes

The following table summarizes the new methods added for this release.

Class Members Added Description Reason for Change
VWActionType

ACTION_TYPE_DB_EXECUTE
= 37

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_
SYSTEM_FIELDS = 1024

QUERY_GET_NO_TRANSLATED
_SYSTEM_FIELDS = 2048

New static values to provide more effective query filtering.

Enhance queries to filter flexibly on system fields.
VWRoster

QUERY_GET_NO_
SYSTEM_FIELDS = 1024

QUERY_GET_NO_TRANSLATED
_SYSTEM_FIELDS = 2048

New static values to provide more effective query filtering.

Enhance queries to filter flexibly on system fields.
VWSession

ATTRIBUTES_SYSTEM = 1
ATTRIBUTES_REGION = 2

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
DATABASE_SQL2000 = 2

New static values to define the database environment as database configuration types.

Future support for a Database System Instruction feature.
VWSession

WEBAPP_NONE = 0
WEBAPP_WORKPLACE = 1
WEBAPP_WEB_WORKFLO = 2
WEBAPP_OPEN_CLIENT = 3 WEBAPP_CUSTOM = 100

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.
The location may be a URL of the asp page.

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.
The location may be a URL of the asp page.

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_
CONSISTENT_RETURN
= 0x200

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_
NO_ANALYSIS_ENG
= 0x100

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.

Back to top


Modified Java UI Toolkit Beans and Interfaces

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.

Back to top


Deprecated Class Members: Methods and Static Values

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_
FIELDS = 256
QUERY_GET_TRANSLATED
_SYSTEM_FIELDS = 512

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_
FIELDS = 256
QUERY_GET_TRANSLATED
_SYSTEM_FIELDS = 512

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
( int theId, int theProcessorType, String theName, int theAppType, String theLocation, int theWidth, int theHeight, String theApp )

Replaced by VWStepProcessorInfoDefinition
( int theId, int theProcessorType, String theName, int theAppType, Hashtable theLocation, int theWidth, int theHeight, String theApp ).

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.

Back to top

 


Miscellaneous Development/API-Related Changes

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:

Back to top


Documentation Changes

The following documentation changes have been made since the last release:

Back to top