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 Engine. Once you have a session object, you can do the following:

If you are creating a session for FileNet Web Services or Open Client, use the constructor that has no arguments and call the logon method first. If you are developing for FileNet Web Services or Open Client, 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 to a Process Engine Session:

If you wish to use the Application Engine .asp files with this session, call the setProductId(int) method after logging on.

WARNING: If the same or a duplicate VWSession object is used more than one time concurrently, a Process Services error (SAS session is already open) will result.

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 DS_TYPE_LDAP
          Value of 1, representing a Lightweight Directory Access Protocol (LDAP) database security type.
static int DS_TYPE_SEC
          Value of 0, representing a FileNet database security type.
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 SEARCH_TYPE_CONTAINS
          Value of 4, indicating a pattern search would match when all of the characters in the pattern match, in order, to a corresponding series of characters in the name being compared, and that the name may contain additional alphanumeric characters before or after the matching series of characters.
static int SEARCH_TYPE_CUSTOM
          Value of 1, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding characters in the name being compared, and that the name does not contain any characters before or after the matching characters.
static int SEARCH_TYPE_NONE
          Value of 0, indicating a pattern search would match all user names and ignore the searchPattern string.
static int SEARCH_TYPE_PREFIX_MATCH
          Value of 2, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding beginning series of characters in the name being compared, and that the name may contain additional alphanumeric characters after the matching series of characters.
static int SEARCH_TYPE_SUFFIX_MATCH
          Value of 3, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding ending series of characters in the name being compared, and that the name may contain additional alphanumeric characters before the matching series of characters.
static int SORT_TYPE_ASCENDING
          Value of 1, indicating an ascending sort is to be performed.
static int SORT_TYPE_DESCENDING
          Value of 2, indicating a descending sort is to be performed.
static int SORT_TYPE_NONE
          Value of 0, indicating no sorting is to be performed.
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 FileNet Web Services.
static int WEBAPP_WORKPLACE
          Value of 1. Indicates the web application is Application Engine.
 
Constructor Summary
VWSession()
          Use this constructor with FileNet Web Services or Open Client.
VWSession(java.lang.String user, java.lang.String password, java.lang.String router_URL)
          Use this constructor to establish a session.
 
Method Summary
 boolean checkSystemWideFlagSetting(int flagOptions)
          Checks the system wide flag settings given the VWSystemAdministration System wide flag option.
 boolean checkWorkflowIdentifier(java.lang.String workflowIdentifier)
          Determines whether or not a workflow is on the Process Engine, 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 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)
          Launches a workflow defined by a transferred workflow definition, as specified by a workflow identifier version String derived from a VWTransferResult object or a workflow definition name (work class name).
 VWAttributeInfo fetchAttributes(int nFlag)
          Fetches system-wide or region-specific attribute information from the Process Engine 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 Engine system.
 boolean[] fetchIsGroup(java.lang.String[] names)
          Determines whether or not names passed in are groups.
 VWStepProcessorInfo fetchLaunchStepProcessor(java.lang.String workflowIdentifier)
          Retrieves 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 Engine.
 VWSystemConfiguration fetchSystemConfiguration()
          Gets system configuration information for a system.
 VWSecurityList fetchUserGroups(int maxBufferSize)
          Gets group names for the Process Engine.
 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 Engine.
 java.lang.String[] fetchWorkClassNames(boolean ignoreSecurity)
          Retrieves the name of every work class in the system.
 VWWorkflowDefinition fetchWorkflowDefinition(int workSpaceId, java.lang.String workflowIdentifier)
          Deprecated. Replaced by fetchWorkflowDefinition(int,String, boolean) which can handle a workflow definition that references a work class from a previous version of Process that was known as Panagon Visual WorkFlo. It also can represent a workflow definition that explicitly incorporates default terminate or malfunction maps.
 VWWorkflowDefinition fetchWorkflowDefinition(int workSpaceId, java.lang.String workflowIdentifier, boolean convert)
          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.
 VWSecurityList findGroups(java.lang.String searchPattern, int searchType, int sortType, int maxBufferSize)
          Fetches a collection of all group names defined within the default LDAP domain, matching them for inclusion in the result collection, according to this method's search pattern and search type arguments.
 VWSecurityList findUsers(java.lang.String searchPattern, int searchType, int sortType, int maxBufferSize)
          Fetches a collection of all user names defined within the default LDAP domain, matching them for inclusion in the result collection, according to this method's search pattern and search type arguments.
static java.lang.String[] getActiveRouters(java.lang.String serverURL)
          For the Application Engine only, this method lists the names of the routers configured on the Process Engine's server.
 java.lang.String getCurrentVersion()
          Gets the current version of the Process Engine API.
 int getDatabaseType()
          Gets the database configuration type for the workflow database.
static java.lang.String getDefaultRouter(java.lang.String serverURL)
          For the Application Engine only, this method determines the name of the default router configured on the Process Engine's server.
 java.lang.String getDefaultSecurityDomain()
          Returns the name of the default security domain.
 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. A workflow roster is a collection of records that represents the work objects that an associated work class instantiates.
 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>
 int getSecurityDatabaseType()
          Returns the type of security database.
 java.lang.String getServerName()
          Returns the name of the Process Engine's 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 isLoggedOn()
          Checks whether this session is currently logged on or not.
 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 Engine 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)
          For FileNet Web Services and Open Client only, this method can establish a shared logon session.
 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 Process Engine.The work class name saved on the Process Engine will be the name that is returned by the VWWorkflowDefinition.getName() method of of the input workflow definition.
 void updateAPIUserCache()
          Caches user names for methods convertIdtoUserName, convertUserNametoId and getUserNames, for performance enhancement.
 
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 a former version of FileNet Image Manager, Panagon eProcess.

PRODUCT_BPS

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

Value of 2. Indicates the system is Process Engine.

PRODUCT_OPEN_CLIENT

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

Value of 4. Indicates the system is Open Client.

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 FileNet Web Services.

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.

DS_TYPE_SEC

public static final int DS_TYPE_SEC
Value of 0, representing a FileNet database security type.

DS_TYPE_LDAP

public static final int DS_TYPE_LDAP
Value of 1, representing a Lightweight Directory Access Protocol (LDAP) database security type.

SEARCH_TYPE_NONE

public static final int SEARCH_TYPE_NONE
Value of 0, indicating a pattern search would match all user names and ignore the searchPattern string.

SEARCH_TYPE_CUSTOM

public static final int SEARCH_TYPE_CUSTOM
Value of 1, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding characters in the name being compared, and that the name does not contain any characters before or after the matching characters.

SEARCH_TYPE_PREFIX_MATCH

public static final int SEARCH_TYPE_PREFIX_MATCH
Value of 2, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding beginning series of characters in the name being compared, and that the name may contain additional alphanumeric characters after the matching series of characters.

SEARCH_TYPE_SUFFIX_MATCH

public static final int SEARCH_TYPE_SUFFIX_MATCH
Value of 3, indicating a pattern search would match when all of the characters in the pattern match, in order, to the corresponding ending series of characters in the name being compared, and that the name may contain additional alphanumeric characters before the matching series of characters.

SEARCH_TYPE_CONTAINS

public static final int SEARCH_TYPE_CONTAINS
Value of 4, indicating a pattern search would match when all of the characters in the pattern match, in order, to a corresponding series of characters in the name being compared, and that the name may contain additional alphanumeric characters before or after the matching series of characters.

SORT_TYPE_NONE

public static final int SORT_TYPE_NONE
Value of 0, indicating no sorting is to be performed.

SORT_TYPE_ASCENDING

public static final int SORT_TYPE_ASCENDING
Value of 1, indicating an ascending sort is to be performed.

SORT_TYPE_DESCENDING

public static final int SORT_TYPE_DESCENDING
Value of 2, indicating a descending sort is to be performed.
Constructor Detail

VWSession

public VWSession()
Use this constructor with FileNet Web Services or Open Client. 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 onto the Process Engine.

Example:

Parameters:
user - The Process Engine 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 onto the Process Engine.

Example:

Parameters:
user - The Process Engine 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 exists

logonWithToken

public void logonWithToken(java.lang.String theToken,
                           java.lang.String router_URL)
                    throws VWException
For FileNet Web Services and Open Client only, 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 represents the work objects that an associated work class instantiates. A Remote Procedure Call (RPC) validates the specified workflow roster name.

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

In multi-server environments, if the roster is on an additional server that has not been accessed, the first method executed on the roster automatically logs the user onto the additional server. If the additional server was previously accessed during the session, the logon information is shared.

Parameters:
rosterName - The name of the workflow roster
Returns:
A VWRoster object that represents the workflow roster that is specified by 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 specified queue name.

Use the fetchQueueNames(int) 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 onto the additional server. If the additional server was previouly accessed during the session, the logon information is shared.

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

isLoggedOn

public boolean isLoggedOn()
Checks whether this session is currently logged on or not.

Returns:
true if this session is currently logged on, or false if this session is not logged on.

logoff

public void logoff()
            throws VWException
Ends the session with the Process Engine 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 Process Engine 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 - true causes the execustion to include 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 communications, 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 communications, 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 communications, 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 - true cause execution to enable 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 communications, 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 - true cause execution to enable 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 - Type of causes include communications, server and connection problems.

getCurrentVersion

public java.lang.String getCurrentVersion()
Gets the current version of the Process Engine API.
Returns:
The current version level of the Process Engine 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 user ID. This method invokes a call to the Process Engine 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 invokes a call to the Process Engine 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
Caches user names for methods convertIdtoUserName, convertUserNametoId and getUserNames, for performance enhancement.
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 were no previous calls to the Process Engine to get names, this method makes an RPC call to the Process Engine to get the information. If the method does not find the name in the session's current cache, the method makes another RPC to retrieve updated name information. If the name is not found in the updated cache, an exception is thrown.
Parameters:
aClassName - The specified name of the workflow roster or queue to convert
aQueueClassType - true to convert the name of a workflow queue; 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 was no previous call to the Process Engine get IDs, this method makes an RPC to the Process Engine to retrieve Class ID information. If the system does not find the ID, the method makes another RPC to the Process Engine to retrieve an updated list. If the Class ID is still not found, the method throws an exception.
Parameters:
aClassId - The Class ID of the name being retrieved
aQueueClassType - true to convert the ID of a queue; 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 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:
true means success; false, otherwise.
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 Engine system.
Returns:
A list of the event log names known to the Process Engine.
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.

For compatibility with earlier Image Manager (formerly Panagon 4.2 and earlier) versions only, this method establishes an API audit trail as a log file. Note that this method will not create the specified output file in more recent Image Manager (formerly Panagon) versions.
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 Engine.
Returns:
A VWSystemAdministration object that contains the administration information for the Process Engine.
Throws:
VWException - Thrown if the method cannot get system administration information for the Process Enginesystem.
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 theName 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 Engine.
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 Engine.
Throws:
VWException - Thrown if the method cannot get group names for the Process Engine.
Since:
VWWS3.10

fetchUsers

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

findUsers

public VWSecurityList findUsers(java.lang.String searchPattern,
                                int searchType,
                                int sortType,
                                int maxBufferSize)
                         throws VWException
Fetches a collection of all user names defined within the default LDAP domain, matching them for inclusion in the result collection, according to this method's search pattern and search type arguments.
Parameters:
searchPattern - A String of alphanumeric characters that will be used for comparison to user names to determine if a name matches. The comparison is performed according to the method specified by the searchType parameter. A null search pattern is allowable for a searchType of SEARCH_TYPE_NONE.

searchType - A value that specifies the way the search pattern (see the searchPattern parameters) string is used for comparison, to determine a match for inclusion in the result set. Values of the searchType parameter specify the comparisons as follows:

  • 0: SEARCH_TYPE_NONE — Matches all user names and ignores the searchPattern string. A null search pattern would return all user names, as well. This option may cause performance degradation for large databases.
  • 1: SEARCH_TYPE_CUSTOM — Matches a given user name when the following conditions are met:
    • All of the characters in the pattern match, in order, to the corresponding characters in the user name.
    • There are no characters in addition to those in the search pattern at the beginning or end of the user name.

    For example, if the search pattern were "NameToMatch", the CUSTOM search type causes a match to a single alphanumeric string pattern: "NameToMatch".
  • 2: SEARCH_TYPE_PREFIX_MATCH — Matches a user name when the characters in the pattern match, in order, to the corresponding beginning characters in the user name. For example, if the search pattern were "NameToMatch", the PREFIX_MATCH search type causes a match to "NameToMatcha" or "NameToMatchb", but not "aNameToMatch". Zero or more additional (non-matching) alphanumeric characters may occur at the end of a matching user name. The PREFIX_MATCH search type also causes an exact match to "NameToMatch".
  • 3: SEARCH_TYPE_SUFFIX_MATCH — Matches a user name when an ending series of characters in the pattern match, in order, to a corresponding ending series of characters in the user name. For example, if a search pattern were "NameToMatch", the SUFFIX_MATCH search type causes a match to "aNameToMatch", but not "NameToMatcha". Zero or more additional (non-matching) alphanumeric characters may occur at the beginning of a matching user name. The SUFFIX_MATCH search type also causes an exact match to "NameToMatch".
  • 4: SEARCH_TYPE_CONTAINS — Matches a user name when an imbedded series of characters in the pattern match, in order, to a corresponding imbedded series of characters in the user name. For example, if a search pattern were "NameToMatch", the CONTAINS search type causes a match to "xNameToMatchyy", but not "xNameZToMatchyy". Zero or more additional (non-matching) alphanumeric characters may occur at the beginning or end of a matching name. The CONTAINS search type also causes an exact match to "NameToMatch".
sortType - Value determines the type of sorting the security database server performs on the returned set of records, as follows:

  • 0: SORT_TYPE_NONE — No sorting is performed. For large security databases, use of this option may cause performance degradation and erroneous results.
  • 1: SORT_TYPE_ASCENDING — Ascending sort is performed on the result set.
  • 2: SORT_TYPE_DESCENDING — Descending sort is performed on the result set.

Note If sorting fails on the security database server, an error will be thrown and no results will be returned.

maxBufferSize - Maximum number of elements to return in one fetch. You must specify a value greater than 0 (zero).
Returns:
A VWSecurityList object that holds a collection of user names that match to the input search pattern (refer to parameter searchPattern) argument, using the comparison method specified by the searchType criterion (refer to parameter searchType), within the default LDAP domain.
Throws:
VWException - Thrown for various causes. Causes include if the database security type is not DS_TYPE_LDAP (indicating an LDAP database), or if the database is not correctly configured to complete the sorting that the method call requires.
See Also:
VWSecurityList

findGroups

public VWSecurityList findGroups(java.lang.String searchPattern,
                                 int searchType,
                                 int sortType,
                                 int maxBufferSize)
                          throws VWException
Fetches a collection of all group names defined within the default LDAP domain, matching them for inclusion in the result collection, according to this method's search pattern and search type arguments.
Parameters:
searchPattern - A String of alphanumeric characters that will be used for comparison to group names to determine if a group name matches. The comparison is performed according to the method specified by the searchType parameter. A null search pattern is allowable for a searchType of SEARCH_TYPE_NONE.

searchType - A value that specifies the way the search pattern (see the searchPattern parameters) string is used for comparison, to determine a match for inclusion in the result set. Values of the searchType parameter specify the comparisons as follows:

  • 0: SEARCH_TYPE_NONE — Matches all group names and ignores the searchPattern string. A null search pattern would return all group names, as well. This option may cause performance degradation for large databases.
  • 1: SEARCH_TYPE_CUSTOM — Matches a given group name when the following conditions are met:
    • All of the characters in the pattern match, in order, to the corresponding characters in the group name.
    • There are no characters in addition to those in the search pattern at the beginning or end of the group name.

    For example, if the search pattern were "NameToMatch", the CUSTOM search type causes a match to a single alphanumeric string pattern: "NameToMatch".
  • 2: SEARCH_TYPE_PREFIX_MATCH — Matches a group name when the characters in the pattern match, in order, to the corresponding beginning characters in the group name. For example, if the search pattern were "NameToMatch", the PREFIX_MATCH search type causes a match to "NameToMatcha" or "NameToMatchb", but not "aNameToMatch". Zero or more additional (non-matching) alphanumeric characters may occur at the end of a matching name. The PREFIX_MATCH search type also causes an exact match to "NameToMatch".
  • 3: SEARCH_TYPE_SUFFIX_MATCH — Matches a group name when an ending series of characters in the pattern match, in order, to a corresponding ending series of characters in the group name. For example, if a search pattern were "NameToMatch", the SUFFIX_MATCH search type causes a match to "aNameToMatch", but not "NameToMatcha". Zero or more additional (non-matching) alphanumeric characters may occur at the beginning of a matching name. The SUFFIX_MATCH search type also causes an exact match to "NameToMatch".
  • 4: SEARCH_TYPE_CONTAINS — Matches a group name when an imbedded series of characters in the pattern match, in order, to a corresponding imbedded series of characters in the group name. For example, if a search pattern were "NameToMatch", the CONTAINS search type causes a match to "xNameToMatchyy", but not "xNameZToMatchyy". Zero or more additional (non-matching) alphanumeric characters may occur at the beginning or end of a matching group name. The CONTAINS search type also causes an exact match to "NameToMatch".
sortType - Value determines the type of sorting the security database server performs on the returned set of records, as follows:

  • 0: SORT_TYPE_NONE — No sorting is performed. For large security databases, use of this option may cause performance degradation and erroneous results.
  • 1: SORT_TYPE_ASCENDING — Ascending sort is performed on the result set.
  • 2: SORT_TYPE_DESCENDING — Descending sort is performed on the result set.

Note If sorting fails on the security database server, an error will be thrown and no results will be returned.

maxBufferSize - Maximum number of elements to return in one fetch. You must specify a value greater than 0 (zero).
Returns:
A VWSecurityList object that holds a collection of group names that match to the input search pattern (refer to parameter searchPattern) argument, using the comparison method specified by the searchType criterion (refer to parameter searchType), within the default LDAP domain.
Throws:
VWException - Thrown for various causes. Causes include if the database security type is not DS_TYPE_LDAP (indicating an LDAP database), or if the database is not correctly configured to complete the sorting that the method call requires.
See Also:
VWSecurityList

getSecurityDatabaseType

public int getSecurityDatabaseType()
                            throws VWException
Returns the type of security database.
Returns:
A value that indicates the security data base type.
Throws:
VWException - Thrown for various causes. Causes include if the database security type is not DS_TYPE_LDAP (indicating an LDAP database).
See Also:
VWSecurityList, DS_TYPE_SEC, DS_TYPE_LDAP

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 Process Engine.The work class name saved on the Process Engine will be the name that is returned by the VWWorkflowDefinition.getName() method of of the input workflow definition.
Parameters:
theWorkflow - A workflow definition object.

theWFDocKey - The document identifier. Normally, this would be a unique Content Engine or Content Services document identifier; however, the String may be null, or it may be an arbitrary String if the application does not require the work class to 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, You can use this F_SourceDoc field to retrieve the document containing the VWWorkflow definition for the work class.

theLinked - A boolean control value: true indicates there is a link from a document in a library or object store to the transferring workflow; false indicates there is no such link. Use this flag to ensure that the Process Engine does not remove a workspace that is needed by Content Services or the Content Engine for a document link, which can occur when the Process Engine cleans up unused Process Engine workspaces.

theMakeNewWorkSpace - A boolean control value: true transfers the workflow definition to a new workspace on the Process Engine; false transfers the workflow definition to the current workspace on the Process Engine.
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
Launches a workflow defined by a transferred workflow definition, as specified by a workflow identifier version String derived from a VWTransferResult object or a workflow definition name (work class name).
Parameters:
workflowIdentifier - The "workflow definition name", which is the work class name, or the Process version String obtained from a VWTransferResult.getVersion() method.
Returns:
A VWStepElement object that represents the launch step for the workflow. The workflow will be launched after the launch step has been dispatched with VWStepElement.doDispatch().
Throws:
VWException - This method throws an exception for conditions that include the following:

  • The workflowIdentifier version parameter [like the return value of VWTransferResult.getVersion()] is not in a valid format.
  • The workflowIdentifier version parameter does not apply to this VWSession object's router connection or does not exist.
  • The work class name workflowIdentifier is incorrect.
  • The workflow definition specified by the workflowIdentifier parameter does not exist on the Process Engine.
  • The VWTransferResult object is no longer valid, due to a region initialization.
  • There are network problems connecting to the Process Engine.


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 Engine.
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. Note:
Members of the Administrative group are considered to be members of every group.
Parameters:
groupName - The group name against which to check user membership
Returns:
true if the user is a member of the group specified in the groupName parameter; false, otherwise.
Throws:
VWException - Thrown for various causes. One possible cause is if the group name specified in the groupName parameter is not found.

fetchIsGroup

public boolean[] fetchIsGroup(java.lang.String[] names)
                       throws VWException
Determines whether or not names passed in are groups.
Parameters:
name - List of possible group names
Returns:
true if the name is a group returns true, false, otherwise.
Throws:
VWException - Thrown for various causes.

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 Engine's server.
Returns:
The token associated with the session logon used by the user.
Throws:
VWException - Thrown for various causes. Possible causes could be Content Services or Content Engine errors.

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
Retrieves 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 Engine, given an associated workflow version ID.
Returns:
true if a workflow with the ID specified in the workflowIdentifier parameter exists on the Process Engine; false, otherwise.
Throws:
VWException - Causes includes passing in 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, 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 WorkPlace 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
For the Application Engine only, this method lists the names of the routers configured on the Process Engine's server.
Parameters:
serverURL - the URL/UNC representation of the name of the Process Engine's server.
Returns:
A list names of the routers configured on the Process Engine's server.

getDefaultRouter

public static java.lang.String getDefaultRouter(java.lang.String serverURL)
                                         throws VWException
For the Application Engine only, this method determines the name of the default router configured on the Process Engine's server.
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 Process Engine. 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 transfer(VWWorkflowDefinition, String, boolean, boolean) 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 passing in a workflow identifier that is not associated with any workflow on the Process Engine.
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, which is the work class name on the Process Engine or the VWVersion String property stored by the Content Engine or Content Services.
Throws:
VWException - Causes include a null workflowIdentifier.
Since:
PWWS 4.2

fetchWorkflowDefinition

public VWWorkflowDefinition fetchWorkflowDefinition(int workSpaceId,
                                                    java.lang.String workflowIdentifier)
                                             throws VWException
Deprecated. Replaced by fetchWorkflowDefinition(int,String, boolean) which can handle a workflow definition that references a work class from a previous version of Process that was known as Panagon Visual WorkFlo. It also can represent a workflow definition that explicitly incorporates default terminate or malfunction maps.

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 VWTransferResult 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)

fetchWorkflowDefinition

public VWWorkflowDefinition fetchWorkflowDefinition(int workSpaceId,
                                                    java.lang.String workflowIdentifier,
                                                    boolean convert)
                                             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.
Note
This parameter value is ignored if the workflowIdentifier is a version String.

workflowIdentifier - The workflow definition name, which is the work class name or the Process version String obtained from a VWTransferResult object.
Note
If the workflowIdentifier is a version string, the version string's workspace ID is used.

convert - The value true indicates that the fetched workflow definition should be converted, so that the workflow definition is correct and complete in the following situations:

  • The workflow definition references a work class from a former version of Process called Panagon Visual WorkFlow.
  • The workflow definition was defined with a default terminate or malfunction map and the fetched workflow definition should include such a map.

The value false indicates that the returned workflow definition will be in the same form in which it was transferred to the Process Engine.

Conversion is not necessary if the returned workflow definition does not need to include inherited (not explicitly defined) terminate or malfunction maps, and the referenced work class has not been transferred from a previous version of Process that was known as Panagon Visual WorkFlo.

Returns:
A VWWorkflowDefinition object
Throws:
VWException - Thrown in case of error, such as an invalid input parameter.
See Also:
VWTransferResult, transfer(VWWorkflowDefinition, String, boolean, boolean)

getServerName

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

getDefaultSecurityDomain

public java.lang.String getDefaultSecurityDomain()
                                          throws VWException
Returns the name of the default security domain.
Returns:
The current default security domain.
Throws:
VWException -  

fetchAttributes

public VWAttributeInfo fetchAttributes(int nFlag)
                                throws VWException
Fetches system-wide or region-specific attribute information from the Process Engine 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 Process Engine.

checkSystemWideFlagSetting

public boolean checkSystemWideFlagSetting(int flagOptions)
                                   throws VWException
Checks the system wide flag settings given the VWSystemAdministration System wide flag option.
Returns:
true if the option is enabled; otherwise, false.
Throws:
VWException - Causes include an invalid product ID.
See Also:
VWSystemAdministration


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.