Process API

filenet.vw.api
Class VWSystemAdministration

java.lang.Object
  extended by filenet.vw.api.VWSystemAdministration
All Implemented Interfaces:
IVWtoXML

public final class VWSystemAdministration
extends java.lang.Object
implements IVWtoXML

Use this class to access and modify system-wide administration information or tasks. Examples of tasks managed with this class include the following:

Since:
VWWS3.10
See Also:
VWSession.fetchSystemAdministration()

Field Summary
static int SYSTEM_WIDE_DELETE_PARENT
          Value of 4, indicating that the server should delete parent work objects when the children do not merge.
static int SYSTEM_WIDE_DISABLE_NOTIFICATION
          Value of 64, indicating that e-mail notification should be disabled on the server.
static int SYSTEM_WIDE_DISABLE_STATISTICS
          Value of 16, indicating that statistics should be disabled on the server.
static int SYSTEM_WIDE_DISABLE_TERMINATE
          Value of 32, indicating that logging of workflow termination events (F_EventType 165) should be disabled on the server.
static int SYSTEM_WIDE_FLAG_ALLOW_ASYNC_RULES
          Value of 2048, indicating that the option to run some rules asynchronously is enabled.
static int SYSTEM_WIDE_FLAG_CONSISTENT_RETURN
          Value of 512, indicating that returns will be consistent with the behavior of the return system instruction.
static int SYSTEM_WIDE_FLAG_ENABLE_RULES
          Value of 1024, indicating that rules engine is enabled.
static int SYSTEM_WIDE_FLAG_NO_ANALYSIS_ENG
          Value of 256, indicating that the analysis engine should be disabled on the server.
static int SYSTEM_WIDE_LOOP_DETECTION
          Value of 1, indicating that the server should perform loop detection.
static int SYSTEM_WIDE_REMOVE_EXPIRED_TIMERS
          Value of 2, indicating that the server should remove expired timers from parent work objects.
static int SYSTEM_WIDE_UNDEFINED
          Value of 0, indicating the system-wide flag is undefined.
 
Method Summary
static java.lang.String _get_FILE_AUTHOR()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_DATE()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_REVISION()
          For FileNet internal use only, do not call.
 void commit()
          Saves system administration changes to the system-wide configuration on the workflow server.
 VWUserInfo createUserInfo()
          Deprecated. VWUserInfo records are created on the server in P8PE4.0
 void deleteUserInfo(java.lang.String theUserName)
          Deletes information about a specified user.
 VWUserInfo fetchUserInfo(java.lang.String theUserName)
          Fetches information about a specified user.
 VWAttributeInfo getAttributeInfo()
          Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
 int getSessionTimeOut()
          Gets the number minutes before a client/server session timeout.
 int getStatisticsConsolidationInterval()
          Gets the interval (minutes) between updates to the domain-wide statistics stored in the database.
 int getStatisticsSnapshotInterval()
          Deprecated. Not replaced
 int getSystemWideFlags()
          Gets an integer that represents the combined system-wide configuration flags.
 void initializeRegion()
          Initializes the current region.
 void removeAllRegions()
          Deletes information for all isolated regions.
 void removeLinkFlag(java.lang.String theDocument)
          Deletes the linked-document indicator from a transferred work space.
 void removeRegion()
          Deletes the current isolated region and information that pertains to it.
 void removeWorkflowDatabase()
          Deletes all workflow information from the database.
 void setAttributeInfo(VWAttributeInfo theAttributeInfo)
          Sets a VWAttribute object containing attributes for this object.
 void setSessionTimeOut(int theSessionTimeOut)
          Sets the number of minutes used for all client/server sessions.
 void setStatisticsConsolidationInterval(int theInterval)
          Sets the interval (minutes) between updates to the domain-wide statistics stored in the database.
 void setStatisticsSnapshotInterval(int theInterval)
          Deprecated. Not replaced
 void setSystemFlags(int theFlags)
          Sets the system-wide configuration flags.
 void setSystemWideFlags(int theFlags)
          Deprecated. Replaced by setSystemFlags(int), which requires commit() to save the flag values to the workflow server. This deprecated method saved the flag values automatically.
 java.lang.String toString()
          Gets a string representation of the VWSystemAdministration object.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string representing this instance to the buffer specified.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SYSTEM_WIDE_UNDEFINED

public static final int SYSTEM_WIDE_UNDEFINED
Value of 0, indicating the system-wide flag is undefined.

See Also:
Constant Field Values

SYSTEM_WIDE_LOOP_DETECTION

public static final int SYSTEM_WIDE_LOOP_DETECTION
Value of 1, indicating that the server should perform loop detection.

See Also:
Constant Field Values

SYSTEM_WIDE_REMOVE_EXPIRED_TIMERS

public static final int SYSTEM_WIDE_REMOVE_EXPIRED_TIMERS
Value of 2, indicating that the server should remove expired timers from parent work objects.

See Also:
Constant Field Values

SYSTEM_WIDE_DELETE_PARENT

public static final int SYSTEM_WIDE_DELETE_PARENT
Value of 4, indicating that the server should delete parent work objects when the children do not merge.

See Also:
Constant Field Values

SYSTEM_WIDE_DISABLE_STATISTICS

public static final int SYSTEM_WIDE_DISABLE_STATISTICS
Value of 16, indicating that statistics should be disabled on the server.

See Also:
Constant Field Values

SYSTEM_WIDE_DISABLE_TERMINATE

public static final int SYSTEM_WIDE_DISABLE_TERMINATE
Value of 32, indicating that logging of workflow termination events (F_EventType 165) should be disabled on the server.

See Also:
Constant Field Values

SYSTEM_WIDE_DISABLE_NOTIFICATION

public static final int SYSTEM_WIDE_DISABLE_NOTIFICATION
Value of 64, indicating that e-mail notification should be disabled on the server.

See Also:
Constant Field Values

SYSTEM_WIDE_FLAG_NO_ANALYSIS_ENG

public static final int SYSTEM_WIDE_FLAG_NO_ANALYSIS_ENG
Value of 256, indicating that the analysis engine should be disabled on the server.

See Also:
Constant Field Values

SYSTEM_WIDE_FLAG_CONSISTENT_RETURN

public static final int SYSTEM_WIDE_FLAG_CONSISTENT_RETURN
Value of 512, indicating that returns will be consistent with the behavior of the return system instruction.

See Also:
Constant Field Values

SYSTEM_WIDE_FLAG_ENABLE_RULES

public static final int SYSTEM_WIDE_FLAG_ENABLE_RULES
Value of 1024, indicating that rules engine is enabled.

See Also:
Constant Field Values

SYSTEM_WIDE_FLAG_ALLOW_ASYNC_RULES

public static final int SYSTEM_WIDE_FLAG_ALLOW_ASYNC_RULES
Value of 2048, indicating that the option to run some rules asynchronously is enabled.

See Also:
Constant Field Values
Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


createUserInfo

public VWUserInfo createUserInfo()
                          throws VWException
Deprecated. VWUserInfo records are created on the server in P8PE4.0

This method is not supported in P8PE4.0,user info records are created on the server only. When a user logs in or is part of a launched workflow, a record is automatically created on the server. Use VWSession method fetchUserInfo to fetch a an existing record. Use methods on the VWUserInfo to update and add properties.

Returns:
null
Throws:
VWException
See Also:
VWSession.fetchUserInfo, VWUserInfo

deleteUserInfo

public void deleteUserInfo(java.lang.String theUserName)
                    throws VWException
Deletes information about a specified user.

Parameters:
theUserName - The name of the user
Throws:
VWException
See Also:
VWUserInfo

fetchUserInfo

public VWUserInfo fetchUserInfo(java.lang.String theUserName)
                         throws VWException
Fetches information about a specified user.

Parameters:
theUserName - The name of the user
Returns:
A VWUserInfo object that is associated with the user specified by the theUserName parameter
Throws:
VWException - Causes include the situation where the user specified in the theUserName parameter does not exist in this domain.
See Also:
VWUserInfo

getStatisticsConsolidationInterval

public int getStatisticsConsolidationInterval()
                                       throws VWException
Gets the interval (minutes) between updates to the domain-wide statistics stored in the database.

Returns:
The number of minutes between database updates
Throws:
VWException

setStatisticsConsolidationInterval

public void setStatisticsConsolidationInterval(int theInterval)
                                        throws VWException
Sets the interval (minutes) between updates to the domain-wide statistics stored in the database. Valid intervals range from 0 to 1440 (24 hours). A new setting takes effect only after restarting the workflow services.

Parameters:
theInterval - The number of minutes between database updates.
Throws:
VWException

setSystemWideFlags

public void setSystemWideFlags(int theFlags)
                        throws VWException
Deprecated. Replaced by setSystemFlags(int), which requires commit() to save the flag values to the workflow server. This deprecated method saved the flag values automatically.

Sets the system-wide configuration flags, saving it to the workflow server. A new setting takes effect only after restarting the workflow services.

Parameters:
theFlags - An integer that specifies the bitwise OR operation value of the system-wide flags shown in the VWSystemAdministration field summary.
Throws:
VWException

setSystemFlags

public void setSystemFlags(int theFlags)
                    throws VWException
Sets the system-wide configuration flags. New settings take effect only after restarting the workflow services. Use commit() to save the flag settings to the workflow server.

Parameters:
theFlags - An integer that specifies the bitwise OR operation value of the system-wide flags shown in the VWSystemAdministration field summary.
Throws:
VWException

getSystemWideFlags

public int getSystemWideFlags()
                       throws VWException
Gets an integer that represents the combined system-wide configuration flags.

Returns:
An integer value indicating the result of a bitwise OR operation on the flags configuring the system, as defined by the system-wide configuration flags shown in the VWSystemAdministration field summary.
Throws:
VWException

getSessionTimeOut

public int getSessionTimeOut()
                      throws VWException
Gets the number minutes before a client/server session timeout.

Returns:
The number of minutes before a session will timeout.
Throws:
VWException

setSessionTimeOut

public void setSessionTimeOut(int theSessionTimeOut)
                       throws VWException
Sets the number of minutes used for all client/server sessions. You must use commit() to transfer new settings to the workflow system. A new setting takes effect only after restarting the workflow services.

Parameters:
theInterval - The number of minutes before a client/server session times out.
Throws:
VWException

commit

public void commit()
            throws VWException
Saves system administration changes to the system-wide configuration on the workflow server. The new settings take effect only after restarting the workflow services.

Note: Before calling this method, configuration changes, including attributes set with setAttributeInfo(), reside only in local memory.

Throws:
VWException

getStatisticsSnapshotInterval

public int getStatisticsSnapshotInterval()
                                  throws VWException
Deprecated. Not replaced

The workflow system no longer supports getting the snap shot interval.

Returns:
Always returns 0
Throws:
VWException

setStatisticsSnapshotInterval

public void setStatisticsSnapshotInterval(int theInterval)
                                   throws VWException
Deprecated. Not replaced

The workflow system no longer supports setting the snap shot interval.

Throws:
VWException

initializeRegion

public void initializeRegion()
                      throws VWException
Initializes the current region. Calling this method saves a set of base classes in the region.

Throws:
VWException

removeRegion

public void removeRegion()
                  throws VWException
Deletes the current isolated region and information that pertains to it.

Throws:
VWException

removeAllRegions

public void removeAllRegions()
                      throws VWException
Deletes information for all isolated regions.

Throws:
VWException

removeWorkflowDatabase

public void removeWorkflowDatabase()
                            throws VWException
Deletes all workflow information from the database.

Throws:
VWException

removeLinkFlag

public void removeLinkFlag(java.lang.String theDocument)
                    throws VWException
Deletes the linked-document indicator from a transferred work space. This indicator may be placed in a transferred work class by the theLinked parameter with VWSession.transfer(VWWorkflowDefinition, String, boolean, boolean).

Parameters:
theDocument - The work class name from which to remove the linked-document indicator.
Throws:
VWException - Causes include a situation where the work class name does not exist on the current isolated region.

getAttributeInfo

public VWAttributeInfo getAttributeInfo()
                                 throws VWException
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. These are normally system-wide attributes, since this object is not associated with any individual session.

Returns:
A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
Throws:
VWException
See Also:
setAttributeInfo(filenet.vw.api.VWAttributeInfo)

setAttributeInfo

public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
Sets a VWAttribute object containing attributes for this object. You must use commit() to transfer (save) new settings to the workflow server. These attributes will normally be system-wide, since they are not associated with any individual session.

Parameters:
theAttributeInfo - A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
Throws:
VWException
See Also:
getAttributeInfo(), commit()

toString

public java.lang.String toString()
Gets a string representation of the VWSystemAdministration object.

Overrides:
toString in class java.lang.Object
Returns:
A string containing a text representation of the VWSystemAdministration object, which contains system information for the current isolated region.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Specified by:
toXML in interface IVWtoXML
Parameters:
theBuffer - A StringBuffer that will be appended with the XML content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.