Process Class Relationships

filenet.vw.api
Class VWSystemAdministration

java.lang.Object
  |
  +--filenet.vw.api.VWSystemAdministration

public final class VWSystemAdministration
extends java.lang.Object

Use this class to access and modify system-wide administration information or tasks. Examples of tasks managed with the VWSystemAdministration object 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_CONSISTENT_RETURN
          Value of 512, indicating that returns will be consistent with the behavior the return system instruction that is documented in the Help for eProcess Designer, Return system function topic.
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
 void commit()
          Saves system administration changes to the system wide configuration on the workflow server, which take effect only after rebooting the workflow server and restarting the services.
 VWUserInfo createUserInfo()
          Creates an empty VWUserInfo object.
 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 number minutes used for domain-wide statistics that are written 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 number of minutes used for domain-wide statistics that are written the database.
 void setStatisticsSnapshotInterval(int theInterval)
          Deprecated. Not replaced
 void setSystemFlags(int theFlags)
          Sets the system-wide configuration flags; new settings take effect only after rebooting the workflow server and restarting the services. Use commit() to save the flag settings to the workflow server.
 void setSystemWideFlags(int theFlags)
          Deprecated. Replaced by setSystemFlags, which does not save the flag values to the workflow server.
 java.lang.String toString()
          Gets a string representation of the VWSystemAdministration object.
 
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.

SYSTEM_WIDE_LOOP_DETECTION

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

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.

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.

SYSTEM_WIDE_DISABLE_STATISTICS

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

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.

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.

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.

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 the return system instruction that is documented in the Help for eProcess Designer, Return system function topic.
Method Detail

createUserInfo

public VWUserInfo createUserInfo()
                          throws VWException
Creates an empty VWUserInfo object.

Note Use the methods of the VWUserUInfo class to set the values of the new object.

Returns:
A VWUserInfo object
Throws:
VWException -  
See Also:
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 number minutes used for domain-wide statistics that are written the database.
Returns:
The number of minutes between database updates
Throws:
VWException -  

setStatisticsConsolidationInterval

public void setStatisticsConsolidationInterval(int theInterval)
                                        throws VWException
Sets the number of minutes used for domain-wide statistics that are written the database. Valid intervals range from 0 to 1440 (24 hours). A new setting takes effect only after rebooting the workflow server and restarting the services.
Parameters:
theInterval - The number of minutes between database updates.
Throws:
VWException -  

setSystemWideFlags

public void setSystemWideFlags(int theFlags)
                        throws VWException
Deprecated. Replaced by setSystemFlags, which does not save the flag values to the workflow server.

Sets the system-wide configuration flags, saving it to the workflow server. A new setting takes effect only after rebooting the workflow server and restarting the 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 rebooting the workflow server and restarting the 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.

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. Must use commit() to transfer new settings to the system. A new setting takes effect only after rebooting the workflow server and restarting the 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, which take effect only after rebooting the workflow server and restarting the 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.
See Also:
setAttributeInfo(filenet.vw.api.VWAttributeInfo)

setAttributeInfo

public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
Sets a VWAttribute object containing attributes for this object. Must use commit() to transfer (save) new settings to the system 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.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.