Process Class Relationships

filenet.vw.api
Class VWSession

java.lang.Object
  |
  +--filenet.vw.api.VWSession
All Implemented Interfaces:
java.io.Serializable

public final class VWSession
extends java.lang.Object
implements java.io.Serializable

Use this class to establish a session and log onto a Process server. Once you have a session object, you can do the following:

If you are creating a session from a COM environment, use the constructor that has no arguments and call the logon method first. If you are developing in a COM environment, to logon, use the JiGlue COM Bridge (JiGlue.Util) to instantiate a VWSession() object; then invoke the VWSession.logon method with your logon(String, String, String) parameters. For example, the following VB code will logon a Process Engine Session:

See Also:
recoverUser( String, String[] ), VWRoster, VWQueue, Serialized Form

Field Summary
static int ATTRIBUTES_REGION
          Value of 2. Indicates region-specific attributes, for use with the fetchAttributes(int) method.
static int ATTRIBUTES_SYSTEM
          Value of 1. Indicates system-wide attributes, for use with the fetchAttributes(int) method.
static int DATABASE_ORACLE
          Value of 1. Indicates an Oracle Database.
static int DATABASE_SQL2000
          Value of 2. Indicates a SQL2000 Database.
static int PRODUCT_BPS
          Deprecated. Replaced by use of setDefaultWebApplication(int)
static int PRODUCT_CUSTOM
          Deprecated. Replaced by use of setDefaultWebApplication(int)
static int PRODUCT_OPEN_CLIENT
          Deprecated. Replaced by use of setDefaultWebApplication(int)
static int PRODUCT_PW
          Deprecated. Replaced by use of setDefaultWebApplication(int)
static int QUEUE_IGNORE_SECURITY
          Value of 16. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of queues to which the user has no access.
static int QUEUE_PROCESS
          Value of 1. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each process queue (a queue that holds objects for an external workflow to process).
static int QUEUE_SYSTEM
          Value of 4. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each system queue (a queue that the system configures).
static int QUEUE_USER_CENTRIC
          Value of 2. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each user queue (the individual queue of a workflow user, similar to a inbox for the user).
static int QUEUE_USER_CENTRIC_FOR_USER_ONLY
          Value of 32. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of the user-centric queue associated with the user information.
static int WEBAPP_CUSTOM
          Value of 100. Indicates the web application is for custom use.
static int WEBAPP_NONE
          Value of 0. Indicates the web application is not set.
static int WEBAPP_OPEN_CLIENT
          Value of 3. Indicates the web application is Open Client.
static int WEBAPP_WEB_WORKFLO
          Value of 2. Indicates the web application is eProcess Web Workflow.
static int WEBAPP_WORKPLACE
          Value of 1. Indicates the web application is Application Engine.
 
Constructor Summary
VWSession()
          Use this constructor in a COM environment.
VWSession(java.lang.String user, java.lang.String password, java.lang.String router_URL)
          Use this constructor to establish a session.
 
Method Summary
 boolean checkWorkflowIdentifier(java.lang.String workflowIdentifier)
          Determines whether or not a workflow is on the Process server, given an associated workflow version ID.
 int convertClassNameToId(java.lang.String aClassName, boolean aQueueClassType)
          Converts a roster or queue name to a class ID.
 java.lang.String convertIdToClassName(int aClassId, boolean aQueueClassType)
          Converts a class ID to a roster name or queue name.
 java.lang.String convertIdToUserName(int aUserId)
          Converts a user ID to a user name.
 int convertUserNameToId(java.lang.String aUserName)
          Converts a user name in three-part format (name:domain:organization)to a user ID.
 VWCreateLiveWOResult[] createLiveWorkObject(java.lang.String[] fieldNames, java.lang.Object[] fieldValues, java.lang.String workflowIdentifier, int numberToCreate)
          Creates (initializes, saves, and dispatches) work items from a transferred workflow definition, specified by its workflow identifier. Supports multiple work classes on one roster.
 VWNewWorkObject createNewWorkObject(java.lang.String workClassName)
          Deprecated. Replaced by createLiveWorkObject(String[], Object[], String, int)
 VWStepElement createWorkflow(java.lang.String workflowIdentifier)
          Uses the workflowIdentier String derived from a VWTranferResult object--see VWSession.transfer(,,,) or the workflow definition name (work class name) to launch a workflow from the currently transferred workflow definition.
 VWAttributeInfo fetchAttributes(int nFlag)
          Fetches system-wide or region-specific attribute information from the workflow server, for the current logged-on session.
 VWUserInfo fetchCurrentUserInfo()
          Gets information about the user logged on to this session.
 VWLog fetchEventLog(java.lang.String eventLogName)
          Retrieves an event log, given an associated event log name.
 java.lang.String[] fetchEventLogNames()
          Retrieves the name of every event log in the Process system.
 VWStepProcessorInfo fetchLaunchStepProcessor(java.lang.String workflowIdentifier)
          Retrieve a launch step processor, given an associated workflow definition ID.
 VWProcess fetchProcess(int workSpaceId, int workClassId, java.lang.String workflowNumber)
          Retrieves the workflow process containing this work object.
 java.lang.String[] fetchQueueNames(int fetchFlag)
          Retrieves the names of every work queue accessible through the session, within the queue type scope specified.
 java.lang.String[] fetchRosterNames(boolean ignoreSecurity)
          Retrieves the name of every roster in the system.
 VWStepProcessorInfo fetchStepProcessorInfo(java.lang.String processorIdentifier)
          Retrieves a step processor object defined for the current session and workflow definition, given the step processor ID.
 VWStepProcessorInfo[] fetchStepProcessors(int processorFlag)
          Retrieves a list of step processor objects defined for the current session and workflow definition.
 VWSystemAdministration fetchSystemAdministration()
          Gets system administration information for the Process system.
 VWSystemConfiguration fetchSystemConfiguration()
          Gets system configuration information for a system.
 VWSecurityList fetchUserGroups(int maxBufferSize)
          Gets group names for the Process system.
 VWUserInfo fetchUserInfo(java.lang.String theName)
          Gets general user information about a specified user.
 VWSecurityList fetchUsers(int maxBufferSize, boolean includeGroups)
          Fetches a collection of all user names defined on the Process system.
 java.lang.String[] fetchWorkClassNames(boolean ignoreSecurity)
          Retrieves the name of every work class in the system.
 VWWorkflowDefinition fetchWorkflowDefinition(int workSpaceId, java.lang.String workflowIdentifier)
          Fetches a workflow definition given the workspace id and the work class name or the version string.
 VWWorkflowSignature fetchWorkflowSignature(java.lang.String workflowIdentifier)
          Returns the workflow signature, given an associated work class name or workflow version.
static java.lang.String[] getActiveRouters(java.lang.String serverURL)
          This method lists the names of the routers configured on the web server.
 java.lang.String getCurrentVersion()
          Gets the current version of the Process API.
 int getDatabaseType()
          Gets the database configuration type for the workflow database.
static java.lang.String getDefaultRouter(java.lang.String serverURL)
          This method determines the name of the default router configured on the Web Server.
 int getDefaultWebApplication()
          Gets the default Web Application ID for a logged-on session; the default web application is applied to an initial transfer to a region.
 int getIsolatedRegion()
          Gets an integer that specifies the isolated region for the current session.
 VWQueue getQueue(java.lang.String queueName)
          Gets a queue object for the specified queue.
 java.lang.String[] getQueueNames(boolean includeSystem)
          Deprecated. Replaced by fetchQueueNames(int)
 VWRoster getRoster(java.lang.String rosterName)
          Gets a VWRoster object that represents the specified workflow roster.
 java.lang.String[] getRosterNames()
          Deprecated. Replaced by fetchQueueNames(int)
 java.lang.String getRouterURL()
          Gets the service name in string format, as follows: <:host name>:<port>/<router name>
 java.lang.String getServerName()
          Returns the name of the server for the current session.
 java.lang.String getToken()
          Gets a token from the user logon, which a shared logon may use.
 java.lang.String[] getUserNames()
          Deprecated. Replaced by fetchUsers(int, boolean)
 boolean isMemberOfGroup(java.lang.String groupName)
          Determines whether or not the logged on user is a member of a specific group.
 void logoff()
          Ends the session with the Process server and frees all resources.
 void logon(java.lang.String user, java.lang.String password, java.lang.String router_URL)
          Logs onto an existing session.
 void logonWithToken(java.lang.String theToken, java.lang.String router_URL)
          This method can establish a session, but it is no longer supported.
 boolean recoverUser(java.lang.String userName, java.lang.String[] queueNames)
          Recovers a user, given a list of queue names., like the list produced by fetchQueueNames(int).
 void setAuditState(java.lang.String fileName, java.lang.Integer[] options)
          Deprecated. Replaced by inserting a copy of the fnlogging.properties file in the <JRE>\lib directory. Edit this file to view or change logging properties. For detail information on the components of the fnlogging.properties file, see the Sun Javadoc documentation on the members of the java.util.logging class.
 void setDefaultWebApplication(int theWebApplicationId)
          Sets the default Web Application ID for a logged-on session; the default web application is applied to an initial transfer to a region.
 void setProductId(int theProductId)
          Deprecated. Replaced by setDefaultWebApplication(int)
 java.lang.String toString()
          Gets the router name and isolated region in string format, as entered by the user.
 VWTransferResult transfer(VWWorkflowDefinition theWorkflow, java.lang.String theWFDocKey, boolean theLinked, boolean theMakeNewWorkSpace)
          Transfers the workflow definition object, saving it on the workflow server. The work class name on the server will be the name from the VWWorkflowDefinition object, as returned by VWWorkflowDefinition.getName().
 void updateAPIUserCache()
          The API will cache user names for methods convertIdtoUserName,convertUserNametoId and getUserNames.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

QUEUE_PROCESS

public static final int QUEUE_PROCESS
Value of 1. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each process queue (a queue that holds objects for an external workflow to process).

QUEUE_USER_CENTRIC

public static final int QUEUE_USER_CENTRIC
Value of 2. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each user queue (the individual queue of a workflow user, similar to a inbox for the user).

QUEUE_SYSTEM

public static final int QUEUE_SYSTEM
Value of 4. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of each system queue (a queue that the system configures).

QUEUE_IGNORE_SECURITY

public static final int QUEUE_IGNORE_SECURITY
Value of 16. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of queues to which the user has no access.

QUEUE_USER_CENTRIC_FOR_USER_ONLY

public static final int QUEUE_USER_CENTRIC_FOR_USER_ONLY
Value of 32. Pass this value to the fetchFlag parameter of the fetchQueueNames() method to return the name of the user-centric queue associated with the user information. Use with QUEUE_USER_CENTRIC to filter out queues on multiple servers that do not apply to the current user logon to this VWSession object.

PRODUCT_PW

public static final int PRODUCT_PW
Deprecated. Replaced by use of setDefaultWebApplication(int)

Value of 1. Indicates the system is Panagon eProcess.

PRODUCT_BPS

public static final int PRODUCT_BPS
Deprecated. Replaced by use of setDefaultWebApplication(int)

Value of 2. Indicates the system is BrightSpire Process Engine.

PRODUCT_OPEN_CLIENT

public static final int PRODUCT_OPEN_CLIENT
Deprecated. Replaced by use of setDefaultWebApplication(int)

Value of 4. Reserved for future use.

PRODUCT_CUSTOM

public static final int PRODUCT_CUSTOM
Deprecated. Replaced by use of setDefaultWebApplication(int)

Value of 8. Reserved for custom use.

WEBAPP_NONE

public static final int WEBAPP_NONE
Value of 0. Indicates the web application is not set.

WEBAPP_WORKPLACE

public static final int WEBAPP_WORKPLACE
Value of 1. Indicates the web application is Application Engine.

WEBAPP_WEB_WORKFLO

public static final int WEBAPP_WEB_WORKFLO
Value of 2. Indicates the web application is eProcess Web Workflow.

WEBAPP_OPEN_CLIENT

public static final int WEBAPP_OPEN_CLIENT
Value of 3. Indicates the web application is Open Client.

WEBAPP_CUSTOM

public static final int WEBAPP_CUSTOM
Value of 100. Indicates the web application is for custom use.

DATABASE_ORACLE

public static final int DATABASE_ORACLE
Value of 1. Indicates an Oracle Database.

DATABASE_SQL2000

public static final int DATABASE_SQL2000
Value of 2. Indicates a SQL2000 Database.

ATTRIBUTES_SYSTEM

public static final int ATTRIBUTES_SYSTEM
Value of 1. Indicates system-wide attributes, for use with the fetchAttributes(int) method.

ATTRIBUTES_REGION

public static final int ATTRIBUTES_REGION
Value of 2. Indicates region-specific attributes, for use with the fetchAttributes(int) method.
Constructor Detail

VWSession

public VWSession()
Use this constructor in a COM environment. The only VWSession method that operates before logging on is the getCurrentVersion method. Logon immediately with the logon(String, String, String) method.

Example: set objJiGlue = CreateObject("JiGlue.Util") set session = objJiGlue.newInstance("filenet.vw.api.VWSession") session.logon "SysAdmin","SysAdmin","rmi://" & web_server_name & "/" & router_name

For Java environments, instantiate VWSession and logon in a single call, using VWSession(String, String, String); this is simpler and more efficient.


VWSession

public VWSession(java.lang.String user,
                 java.lang.String password,
                 java.lang.String router_URL)
          throws VWException
Use this constructor to establish a session. If the routerURL parameter contains a valid entry, the system connects the user to the specified router and logs the user on to the VW Server.

Example:

Parameters:
user - The Process user name
password - The user password
routerURL - The URL of the web server router, including the RMI protocol
Throws:
VWException - Causes include the specified logon already existing
Method Detail

logon

public void logon(java.lang.String user,
                  java.lang.String password,
                  java.lang.String router_URL)
           throws VWException
Logs onto an existing session. If the router_URL parameter contains a valid entry, the system connects the user to the specified router and logs the user on to the workflow server.

Example:

Parameters:
user - The Process user name
password - The password
routerURL - The URL of the web server router, including the RMI protocol.
Throws:
VWException - Causes include the specified logon already existing

logonWithToken

public void logonWithToken(java.lang.String theToken,
                           java.lang.String router_URL)
                    throws VWException
This method can establish a shared logon session. The VWSession constructors and logon(...) methods are preferable to this method, because all tokens time out and some tokens may not be valid.
Parameters:
theToken - The Process token.
routerURL - The URL of the web server router, including the RMI protocol.
Throws:
VWException - Causes include invalid arguments, like timed-out and invalid tokens.
See Also:
getToken()

getRoster

public VWRoster getRoster(java.lang.String rosterName)
                   throws VWException
Gets a VWRoster object that represents the specified workflow roster. A workflow roster is a collection of records that represent the work objects that an associated work class instantiates. A Remote Procedure Call (RPC) validates the workflow roster name.

Use the fetchRosterNames(boolean) method or the deprecated getRosterNames() method to get a list of workflow roster names.

In multi-server environments, if the roster is on a server that has not been accessed, the first method executed on the roster automatically logs the user on to the server. If the server has been accessed during the session, the system shares the logon information.

Parameters:
rosterName - The name of the workflow roster
Returns:
A VWRoster object that represents the workflow roster specified in the rosterName parameter
Throws:
VWException -  

getQueue

public VWQueue getQueue(java.lang.String queueName)
                 throws VWException
Gets a queue object for the specified queue. A Remote Procedure Call (RPC) validates the queue name.

Use the fetchQueueNames() method or the deprecated getQueueNames() method to get a list of queue names.

In multi-server environments, if the queue is on a server that has not been accessed, the first method call performed on the queue automatically logs the user on to the server. If the server has been accessed during the session, the system shares the logon information.

Parameters:
queueName - A queue name
Returns:
A VWQueue object that represents the queue specified in the queueName parameter
Throws:
VWException -  

logoff

public void logoff()
            throws VWException
Ends the session with the Process server and frees all resources.

When calling this method, keep the following guidelines in mind:

Throws:
VWException - Thrown if the method cannot end the session with the server and free all resources

getQueueNames

public java.lang.String[] getQueueNames(boolean includeSystem)
                                 throws VWException
Deprecated. Replaced by fetchQueueNames(int)

Retrieves the names of every work queue accessible through the session, optionally including system queues. You can use a returned work queue name to instantiate a VWQueue object, using the getQueue(String) method.
Parameters:
includeSystem - A boolean value: true includes the name of every system work queue in the returned String array; otherwise specify false.
Returns:
A list of queue names
Throws:
VWException - Causes include communication, server and connection problems.

fetchQueueNames

public java.lang.String[] fetchQueueNames(int fetchFlag)
                                   throws VWException
Retrieves the names of every work queue accessible through the session, within the queue type scope specified. You can use a returned work queue name to instantiate a VWQueue object, using the getQueue(String) method.
Parameters:
fetchFlag - An integer value that represents the queue type you wish to return. Set this value to the bitwise or of more than one of the queue process types to get the names of more than one type of queue process. Values for the QUEUE_PROCESS types are as follows:

  • 1 - QUEUE_PROCESS - indicates process type queues
  • 2 - QUEUE_USER_CENTRIC - indicates all user-centric queues
  • 4 - QUEUE_SYSTEM - indicates system queues
  • 16 - QUEUE_IGNORE_SECURITY - indicates queues to which this user has no access
  • 32 - QUEUE_USER_CENTRIC_FOR_USER_ONLY - indicates user-centric queues for this user only.

Example:

     // Fetch a list of queue names for Process queues and System Queues,
     // whether this user has access privilege to the queues or not:
    
     int myQueueFlags = (QUEUE_PROCESS | QUEUE_SYSTEM |
                         QUEUE_IGNORE_SECURITY);
     String[] QueueNames = null;
     QueueNames = MySession.fetchQueueNames(myQueueFlags);
     

Returns:
A list of queue names
Throws:
VWException - Causes include communication, server and connection problems.
See Also:
QUEUE_PROCESS

getRosterNames

public java.lang.String[] getRosterNames()
                                  throws VWException
Deprecated. Replaced by fetchQueueNames(int)

Retrieves the name of every roster in the system. A returned name will serve as input to instantiate a VWRoster object with getRoster(String) .
Returns:
A list of roster names.
Throws:
VWException - Causes include communication, server and connection problems.

fetchRosterNames

public java.lang.String[] fetchRosterNames(boolean ignoreSecurity)
                                    throws VWException
Retrieves the name of every roster in the system. You can use a returned name as input to a parameter of the getRoster method to query on the work objects of a specified roster.
Parameters:
ignoreSecurity - A boolean value: true enables returning the names of rosters which this user is not authorized to access; false causes this method to return only names of rosters which this user is authorized to access.
Returns:
A list of roster names.
Throws:
VWException - Causes include communication, server and connection problems.

fetchWorkClassNames

public java.lang.String[] fetchWorkClassNames(boolean ignoreSecurity)
                                       throws VWException
Retrieves the name of every work class in the system.
Parameters:
ignoreSecurity - A boolean value: true enables returning the names of work classes which this user is not authorized to access; false causes this method to return only names of work classes which this user is authorized to access.
Returns:
A list of work class names.
Throws:
VWException - Causes include communication, server and connection problems.

getCurrentVersion

public java.lang.String getCurrentVersion()
Gets the current version of the Process API.
Returns:
The current version level of the Process API, as a String object

getUserNames

public java.lang.String[] getUserNames()
                                throws VWException
Deprecated. Replaced by fetchUsers(int, boolean)

Retrieves a list of all user names defined on the system.
Returns:
A list of all user names defined on the system.
Throws:
VWException - Causes include when the user is not authorized to call this method, or when the number of names exceeds two million (2,000,000).

convertUserNameToId

public int convertUserNameToId(java.lang.String aUserName)
                        throws VWException
Converts a user name in three-part format (name:domain:organization)to a user ID. This method causes a call to the --eProcess server if there has been no previous server call to get user names. If the system does not find the user name, the method internally performs an additional RPC to retrieve an updated list of user names.
Parameters:
aUserName - The user name in a three-part format as follows:

    name:domain:organization

Returns:
The user ID
Throws:
VWException - Causes include:

  • The user lacks administrative authorization to call this method.
  • The system does not find the user name on a server-updated list.
See Also:
convertIdToUserName(int)

convertIdToUserName

public java.lang.String convertIdToUserName(int aUserId)
                                     throws VWException
Converts a user ID to a user name. This method causes a call to the --eProcess server if there has been no previous server call to get user names. If the system does not find the user name, the method internally performs an additional RPC to retrieve an updated list of user names.
Parameters:
aUserId - The user ID used to retrieve the user name
Returns:
The user name associated with the input user ID.
Throws:
VWException - Causes include:

  • The user lacks administrative authorization to call this method.
  • The system does not find the user name on a server-updated list.
See Also:
convertUserNameToId(java.lang.String)

updateAPIUserCache

public void updateAPIUserCache()
                        throws VWException
The API will cache user names for methods convertIdtoUserName,convertUserNametoId and getUserNames. These methods cache the names for performance reasons.
Throws:
VWException - Causes include:

  • The user lacks administrative authorization to call this method.
  • System or Network errors retrieving new list of names.
See Also:
convertUserNameToId(java.lang.String), convertIdToUserName(int), getUserNames()

convertClassNameToId

public int convertClassNameToId(java.lang.String aClassName,
                                boolean aQueueClassType)
                         throws VWException
Converts a roster or queue name to a class ID. If there has been no previous server call to get names, this method calls the server to get the information. If the system does not find the name, another RPC occurs to retrieve an updated list.
Parameters:
aClassName - The name of the workflow roster or queue to retrieve
aQueueClassType - A boolean value. Specify true to convert the name of a workflow queue; specify false to convert the name of a workflow roster.
Returns:
The workflow class ID for a queue or a roster
Throws:
VWException - Causes include user lack of administrative privilege to call this method.

convertIdToClassName

public java.lang.String convertIdToClassName(int aClassId,
                                             boolean aQueueClassType)
                                      throws VWException
Converts a class ID to a roster name or queue name. If there has been no previous server call to get IDs, this method calls to the server to get the information. If the system does not find the ID, another RPC occurs to retrieve an updated list.
Parameters:
aClassId - The Class ID of the name being retrieved
aQueueClassType - A boolean value. Specify true to convert the ID of a queue; specify false to convert the ID of a roster.
Returns:
The roster or queue name associated with the input class ID and queue class type.
Throws:
VWException - Causes include user lack of administrative privilege to call this method.

recoverUser

public boolean recoverUser(java.lang.String userName,
                           java.lang.String[] queueNames)
                    throws VWException
Recovers a user, given a list of queue names., like the list produced by fetchQueueNames(int). Recovery unlocks the user's work items if an event has caused them to be left locked. If the argument for the queueNames parameter is null, all queues are recovered. Administrative authority is required to perform queue recovery for work objects locked by another user.
Parameters:
userName - Null or the name of the user you wish to recover. A null value indicates the current user.
queueNames - A list of the names of the each queues to recover. Null is allowed and indicates that all queues are to be recovered, but a null member in a list causes an exception.
Returns:
A success/failure boolean value: true means success.
Throws:
VWException - Causes include system conditions that make a user or queue unavailable to the program, such as the following:

  • The user lacks administrative privilege to recover the user for any queue.
  • A region re-initialization makes a specified queue unavailable.
  • A server is not functioning.

fetchEventLog

public VWLog fetchEventLog(java.lang.String eventLogName)
                    throws VWException
Retrieves an event log, given an associated event log name.
Parameters:
eventLogName - An event log name. A list of valid event log names can be retrieved with fetchEventLogNames().
Returns:
A VWLog object representing the named event log
Throws:
VWException -  
Since:
VWWS3.10

fetchEventLogNames

public java.lang.String[] fetchEventLogNames()
                                      throws VWException
Retrieves the name of every event log in the Process system.
Returns:
A list of the event log names known to the Process system.
Throws:
VWException -  
Since:
VWWS3.10
See Also:
fetchEventLog( String )

setAuditState

public void setAuditState(java.lang.String fileName,
                          java.lang.Integer[] options)
                   throws java.lang.Exception
Deprecated. Replaced by inserting a copy of the fnlogging.properties file in the <JRE>\lib directory. Edit this file to view or change logging properties. For detail information on the components of the fnlogging.properties file, see the Sun Javadoc documentation on the members of the java.util.logging class.

This method does not create the specified output file and is non-functional in Panagon 4.2 and later versions of eProcess.

For earlier versions of eProcess, establishes an API audit trail as a log file.

Parameters:
fileName - The full path name of the file to which the audit will log the information; specify null to disable logging.
options - An integer value used to specify audit logging options, containing values as shown below:

  • 0: Turn logging off
  • 1: Turn logging on(logs all events)

Throws:
VWException -  
See Also:
Sun Javadoc for java.util.logging class

toString

public java.lang.String toString()
Gets the router name and isolated region in string format, as entered by the user. This is typically formatted as follows:
Overrides:
toString in class java.lang.Object
Returns:
The router name and isolated region.

getRouterURL

public java.lang.String getRouterURL()
Gets the service name in string format, as follows:
Returns:
The router name.

fetchSystemAdministration

public VWSystemAdministration fetchSystemAdministration()
                                                 throws VWException
Gets system administration information for the Process system.
Returns:
A VWSystemAdministration object that contains the administration information for the Process system.
Throws:
VWException - Thrown if the method cannot get system administration information for the Process system
Since:
VWWS3.10

fetchSystemConfiguration

public VWSystemConfiguration fetchSystemConfiguration()
                                               throws VWException
Gets system configuration information for a system. Configuration includes information about queues, rosters, and logs and values of instructions, operations, and logging output.
Returns:
A VWSystemConfiguration object that contains the configuration information for the isolated region
Throws:
VWException - Thrown if the method cannot get system configuration information for a system
Since:
VWWS3.10

fetchUserInfo

public VWUserInfo fetchUserInfo(java.lang.String theName)
                         throws VWException
Gets general user information about a specified user.
Parameters:
theName - The name of the user about whom you wish to retrieve information
Returns:
A VWUserInfo object containing information for the user specified in the Name parameter
Throws:
VWException - Thrown if the method cannot get general user information about a specified user
Since:
VWWS3.10

fetchUserGroups

public VWSecurityList fetchUserGroups(int maxBufferSize)
                               throws VWException
Gets group names for the Process system.
Parameters:
bufferSize - An integer value specifying the maximum number of elements to return in a fetch. Specify a value greater than 0 (zero).
Returns:
A VWSecurityList object that can be used to retrieve group names for the Process system
Throws:
VWException - Thrown if the method cannot get group names for the Process system
Since:
VWWS3.10

fetchUsers

public VWSecurityList fetchUsers(int maxBufferSize,
                                 boolean includeGroups)
                          throws VWException
Fetches a collection of all user names defined on the Process system.
Parameters:
bufferSize - Maximum number of elements to return in one fetch. You must specify a value greater than 0 (zero).
includeGroups - A boolean value: specify true to return a VWSecurityList collection of both the names users and groups; specify false to return only user names in the collection.
Returns:
A VWSecurityList object that holds a collection of all user names and (optionally) groups for the Process system.
Throws:
VWException - Causes include an illegal value for any input parameter, or problems with network components, the Process system, or the system communications.
Since:
VWWS3.10
See Also:
VWSecurityList

getDatabaseType

public int getDatabaseType()
                    throws VWException
Gets the database configuration type for the workflow database.
Returns:
An integer associated with the database configuration type.

fetchCurrentUserInfo

public VWUserInfo fetchCurrentUserInfo()
                                throws VWException
Gets information about the user logged on to this session.
Returns:
A VWUserInfo object containing information about the current user.
Since:
VWWS3.10

transfer

public VWTransferResult transfer(VWWorkflowDefinition theWorkflow,
                                 java.lang.String theWFDocKey,
                                 boolean theLinked,
                                 boolean theMakeNewWorkSpace)
                          throws VWException
Transfers the workflow definition object, saving it on the workflow server. The work class name on the server will be the name from the VWWorkflowDefinition object, as returned by VWWorkflowDefinition.getName().
Parameters:
theWorkflow - A workflow definition object.
theWFDocKey - The document identifier. Normally, this is a unique Content Services document identifier; however, the string may be null, or it may be an arbitrary string if the application does not require that the work class be mapped back to a document repository.

If this parameter value is non-null it will be stored in the transferred work class as a string field named F_SourceDoc, which the user can subsequently use to retrieve the document containing the VWWorkflow definition corresponding to the work class.

theLinked - A boolean control value: true indicates there is a link from a document in a library to the transferring workflow; false indicates there is no such link. Use this flag to ensure that the system does not remove a workspace that is needed for a document link when it cleans a library on the Process Server.
theMakeNewWorkSpace - A boolean control value: true transfers the workflow definition to a new workspace on the server; false transfers the workflow definition to the current workspace on the server.
Returns:
A VWTransferResult object that contains information about the status and the version of the transfer.
Throws:
VWException -  
Since:
VWWS3.10
See Also:
VWTransferResult, VWWorkflowDefinition

createWorkflow

public VWStepElement createWorkflow(java.lang.String workflowIdentifier)
                             throws VWException
Uses the workflowIdentier String derived from a VWTranferResult object--see VWSession.transfer(,,,) or the workflow definition name (work class name) to launch a workflow from the currently transferred workflow definition. The system assumes that the first step in the definition is a launch step.
Parameters:
workflowIdentifier - The workflow definition name (work class name or the Process version string) obtained from a VWSession.transfer object
Returns:
A VWStepElement object that represents the launch step for the workflow. This happens only after the system creates the corresponding work object on the server. This method returns an error unless the workflow token contains valid information.

To increase efficiency in the system, delete the completed work object as soon as you no longer need it.

Throws:
VWException - This method throws an exception for conditions that include the following:

  • The user enters a VWVersion token that contains a VWServiceName and isolated region other than those used by this VWSession for router connection.
  • The workflow definition name does not exist.
  • The VWTransferResult Object is no longer valid due to a region initialization.
  • There are network problems connecting to the server.

createNewWorkObject

public VWNewWorkObject createNewWorkObject(java.lang.String workClassName)
                                    throws VWException
Deprecated. Replaced by createLiveWorkObject(String[], Object[], String, int)

Creates a new workflow object from a client. Use the more flexible createLiveWorkObject instead--this method is included for legacy purposes, only. The primary limitation is that each work class must have a corresponding and identical Roster name.

Warning Only one work class can apply to a single workflow roster.

Parameters:
workClassName - The name of the work class the users transferred to the Process server.
Returns:
A VWNewWorkObject object that contains information from the source work item. You must save it for the new item to exist on the workflow system.
Throws:
VWException - Thrown if the method cannot create a new workflow object from a client
See Also:
createLiveWorkObject(java.lang.String[], java.lang.Object[], java.lang.String, int)

isMemberOfGroup

public boolean isMemberOfGroup(java.lang.String groupName)
                        throws VWException
Determines whether or not the logged on user is a member of a specific group.
Parameters:
groupName - The group name with which to check user membership
Returns:
A boolean value: true if the user is a member of the group specified in the groupName parameter or if the user belongs to the System Administration Group; false otherwise
Throws:
VWException - An example trigger: the user does not belong to the System Administration Group and the system does not find the group name specified in the groupName parameter.

getToken

public java.lang.String getToken()
                          throws VWException
Gets a token from the user logon, which a shared logon may use. A logon token can only be returned if this session is connected to a router located on a Process server.
Returns:
The token associated with the session log on used by the user.
Throws:
VWException - Thrown if the method cannot get a token of the user logon, which a shared logon may use. This may occur as a result of an IDM server error.

fetchStepProcessors

public VWStepProcessorInfo[] fetchStepProcessors(int processorFlag)
                                          throws VWException
Retrieves a list of step processor objects defined for the current session and workflow definition.
Parameters:
processorFlag - An integer that specifies the step processor types for which you want information, according to the following filter values:

  • 1: Default launch step (PROCESSOR_LAUNCH_DEFAULT)
  • 2: Default step (PROCESSOR_STEP_DEFAULT)
  • 3: Default, launch or step (PROCESSOR_DEFAULT)
  • 4: Launch step, default or not (PROCESSOR_LAUNCH)
  • 8: Step, default or not (PROCESSOR_STEP)

You can perform a bitwise or of these flags to combine their properties, or you can use them individually.

Example:

     // Fetch an array of VWStepProcessorInfo objects for all launch
     // processors and default-only, non-launch step processors.
     //
     VWStepProcessorInfo[] Processors = null;
     int iprocFlags = (PROCESSOR_LAUNCH | PROCESSOR_STEP_DEFAULT);
     Processors = mySession.fetchStepProcessors(iprocFlags);
     

Note See the VWStepProcessorInfo Field Summary for more information on the step processor types.
Returns:
An array of VWStepProcessorInfo objects.
Throws:
VWException -  
Since:
VWWS3.10
See Also:
VWStepProcessorInfo

fetchLaunchStepProcessor

public VWStepProcessorInfo fetchLaunchStepProcessor(java.lang.String workflowIdentifier)
                                             throws VWException
Retrieve a launch step processor, given an associated workflow definition ID. This is the Process version string obtained from a VWTransferResult object.
Parameters:
workflowIdentifier - Process version string obtained from a VWTransferResult object.
Returns:
A VWStepProcessorInfo object that contains information about the launch step processor information, given the Process version string obtained from a VWTransferResult object.
Throws:
VWException -  
Since:
VWWS3.10
See Also:
transfer(VWWorkflowDefinition, String, boolean, boolean), VWTransferResult

fetchStepProcessorInfo

public VWStepProcessorInfo fetchStepProcessorInfo(java.lang.String processorIdentifier)
                                           throws VWException
Retrieves a step processor object defined for the current session and workflow definition, given the step processor ID.
Parameters:
processIdentifier - The step processor ID, as a unique integer in string format
Returns:
The VWStepProcessorInfo object specified by the step processor ID
Throws:
VWException - Thrown if the method cannot retrieve the step processor object
Since:
VWWS3.10
See Also:
VWStepProcessorInfo

checkWorkflowIdentifier

public boolean checkWorkflowIdentifier(java.lang.String workflowIdentifier)
                                throws VWException
Determines whether or not a workflow is on the Process server, given an associated workflow version ID.
Returns:
A boolean value: true if a workflow with the ID specified in the workflowIdentifier parameter exists on the Process server; false otherwise
Throws:
VWException - Causes includes inputting a work class workflowIdentifier rather than a workflow version ID.
See Also:
VWTransferResult, transfer(VWWorkflowDefinition, String, boolean, boolean)

getIsolatedRegion

public int getIsolatedRegion()
                      throws VWException
Gets an integer that specifies the isolated region for the current session.
Returns:
An integer that specifies the isolated region for the current session.

setProductId

public void setProductId(int theProductId)
                  throws VWException
Deprecated. Replaced by setDefaultWebApplication(int)

Sets the product id for a logged-on session; needs to be set before an isolated region initialization or initial transfer to a region. The product id enables the Process Engine system to function according to product-specific configurations, for example, retrieving appropriate sample step processors for a given product. The current default for a given isolated region is PRODUCT_PW, for Panagon.
Parameters:
theProductId - An integer that specifies the product id for the session. For example, BrightSpire Process Engine requires this to be set to PRODUCT_BPS (integer value 2).
Throws:
VWException - This method can throw exceptions. Causes include an invalid product ID.

setDefaultWebApplication

public void setDefaultWebApplication(int theWebApplicationId)
                              throws VWException
Sets the default Web Application ID for a logged-on session; the default web application is applied to an initial transfer to a region.

The Web Application ID enables the workflow system to use web application-specific program implementations. For example, to access the appropriate locations for sample step processors, which can depend on the specific web application.
Note: The current default for a given isolated region is WEBAPP_NONE.

Parameters:
theWebApplicationId - An integer that specifies the Web Application ID} for the session. For example, a WorkPlace web application is set to WEBAPP_WORKPLACE (integer value 1). IDs in the range of 0 to 99 are reserved for FileNet use. IDs 100-999 are available to customers.
Throws:
VWException - Causes include an invalid product ID.
See Also:
getDefaultWebApplication()

getDefaultWebApplication

public int getDefaultWebApplication()
                             throws VWException
Gets the default Web Application ID for a logged-on session; the default web application is applied to an initial transfer to a region.

The Web Application ID enables the workflow system to use web application-specific program implementations. For example, to access the appropriate locations for sample step processors, which can depend on the specific web application.
Note: The current default for a given isolated region is WEBAPP_NONE.

Returns:
An integer that specifies the Web Application ID for the session. For example, a BrightSpire web application is set to WEBAPP_WORKPLACE (integer value 1). IDs 4-99 are reserved for FileNet use. IDs 100-999 are available to customers.
Throws:
VWException - Causes include an invalid product ID.
See Also:
setDefaultWebApplication(int)

getActiveRouters

public static java.lang.String[] getActiveRouters(java.lang.String serverURL)
                                           throws VWException
This method lists the names of the routers configured on the web server.
Parameters:
serverURL - the URL/UNC representation of the name of the web server. This method is not supported for the Panagon Process system.
Returns:
A list names of the routers configured on the web server.

getDefaultRouter

public static java.lang.String getDefaultRouter(java.lang.String serverURL)
                                         throws VWException
This method determines the name of the default router configured on the Web Server. This method is not supported for the Panagon Process system.
Returns:
String for the default router name.

fetchProcess

public VWProcess fetchProcess(int workSpaceId,
                              int workClassId,
                              java.lang.String workflowNumber)
                       throws VWException
Retrieves the workflow process containing this work object.
Parameters:
workSpaceId - An integer value that is the workSpaceId associated with the process
workClassId - An integer value that is the workClassId associated with the process
workflowNumber - A string representation of the workflowNumber associated with the process
Returns:
A VWProcess object that represents the workflow process containing this work object
Throws:
VWException - Thrown if the method cannot retrieve the workflow process containing this work object
Since:
VWWS4.20

createLiveWorkObject

public VWCreateLiveWOResult[] createLiveWorkObject(java.lang.String[] fieldNames,
                                                   java.lang.Object[] fieldValues,
                                                   java.lang.String workflowIdentifier,
                                                   int numberToCreate)
                                            throws VWException
Creates (initializes, saves, and dispatches) work items from a transferred workflow definition, specified by its workflow identifier. Supports multiple work classes on one roster.

The source workflow definition must exist on the current workflow server. This implies that the VWServiceName and isolated region for this identifier match those of the current VWSession object. This can be verified by using a workflow version ID (rather than a work class name) for the workflow identifier and validating checkWorkflowIdentifier(String) the workflow version ID before you call createLiveWorkObject().

Parameters:
fieldNames - An array of strings containing the names of the fields to update in the new work items, in the same order that the values for those fields are supplied in the fieldValues parameter
fieldValues - An array of objects whose values are supplied, in order, to the fields named in the fieldNames parameter
workflowIdentifier - The workflow definition name (work class name) as returned by the VWWorkflowDefinition.getName() method; or the workflow version ID (version property) as returned by the VWTransferResult.getVersion() method. A VWTransferResult object is returned by the VWSession.transfer(,,,) method.
numberToCreate - The number of work items to create
Returns:
Array of type VWCreateLiveWOResult objects: these objects contain the F_WobNum and RosterNames for the new work items, allowing convenient access to the new items.
Throws:
VWException - Causes include inputting a workflow identifier that is not associated with any workflow on the workflow server.
See Also:
VWTransferResult, transfer(VWWorkflowDefinition, String, boolean, boolean)

fetchWorkflowSignature

public VWWorkflowSignature fetchWorkflowSignature(java.lang.String workflowIdentifier)
                                           throws VWException
Returns the workflow signature, given an associated work class name or workflow version.
Parameters:
workflowIdentifier - The workflow definition name (work class name on the Process Server or the VWVersion string property stored by the Content Server)
Throws:
VWException - Causes include a null workflowIdentifier.
Since:
PWWS 4.2

fetchWorkflowDefinition

public VWWorkflowDefinition fetchWorkflowDefinition(int workSpaceId,
                                                    java.lang.String workflowIdentifier)
                                             throws VWException
Fetches a workflow definition given the workspace id and the work class name or the version string.
Parameters:
workSpaceId - The id of the workspace from which to fetch the workflow definition, or -1 for the current workspace.
workflowIdentifier - The workflow definition name (work class name or the Process version string obtained from a WTransferResult object). If the workflowIdentifier is a version string then the workSpaceId parameter is ignored, and the workspace id from the version string is used.
Returns:
A VWWorkflowDefinition object
Throws:
VWException - Thrown if this method cannot fetch a workflow definition string
See Also:
VWTransferResult, transfer(VWWorkflowDefinition, String, boolean, boolean)

getServerName

public java.lang.String getServerName()
                               throws VWException
Returns the name of the server for the current session.
Returns:
The server name
Throws:
VWException -  

fetchAttributes

public VWAttributeInfo fetchAttributes(int nFlag)
                                throws VWException
Fetches system-wide or region-specific attribute information from the workflow server, for the current logged-on session.

System-wide attributes would be initialized with VWSystemAdministration.setAttributeInfo(VWAttributeInfo), and persisted with VWSystemAdministration.commit(). The region-specific attributes, including VWQueueDefinition attributes, are initialized with VWSystemConfiguration.setAttributeInfo(VWAttributeInfo) and saved with VWSystemConfiguration.commit().

Parameters:
nFlag - specifies which category of attribute information will be returned: ATTRIBUTES_SYSTEM for system-wide attributes, or ATTRIBUTES_REGION for region-specific attributes.
Returns:
The requested type of attribute information, as it was last persisted on the workflow server.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.