|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWSystemAdministration
Use this class to access and modify system-wide administration information or tasks. Examples of tasks managed with the VWSystemAdministration object include the following:
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 |
public static final int SYSTEM_WIDE_UNDEFINED
public static final int SYSTEM_WIDE_LOOP_DETECTION
public static final int SYSTEM_WIDE_REMOVE_EXPIRED_TIMERS
public static final int SYSTEM_WIDE_DELETE_PARENT
public static final int SYSTEM_WIDE_DISABLE_STATISTICS
public static final int SYSTEM_WIDE_DISABLE_TERMINATE
public static final int SYSTEM_WIDE_DISABLE_NOTIFICATION
public static final int SYSTEM_WIDE_FLAG_NO_ANALYSIS_ENG
public static final int SYSTEM_WIDE_FLAG_CONSISTENT_RETURN
Method Detail |
public VWUserInfo createUserInfo() throws VWException
Note Use the methods of the VWUserUInfo class to set the values of the new object.
VWException
- VWUserInfo
public void deleteUserInfo(java.lang.String theUserName) throws VWException
theUserName
- The name of the userVWException
- VWUserInfo
public VWUserInfo fetchUserInfo(java.lang.String theUserName) throws VWException
theUserName
- The name of the userVWException
- Causes include the situation where the
user specified in the theUserName parameter does not exist in
this domain.VWUserInfo
public int getStatisticsConsolidationInterval() throws VWException
VWException
- public void setStatisticsConsolidationInterval(int theInterval) throws VWException
theInterval
- The number of minutes between database updates.VWException
- public void setSystemWideFlags(int theFlags) throws VWException
theFlags
- An integer that specifies the bitwise OR operation
value of the system-wide flags shown in the
VWSystemAdministration field summary.VWException
- public void setSystemFlags(int theFlags) throws VWException
commit()
to save the flag settings
to the workflow server.theFlags
- An integer that specifies the bitwise OR operation
value of the system-wide flags shown in the VWSystemAdministration
field summary.VWException
- public int getSystemWideFlags() throws VWException
public int getSessionTimeOut() throws VWException
VWException
- public void setSessionTimeOut(int theSessionTimeOut) throws VWException
theInterval
- The number of minutes before a client / server
session times out.VWException
- public void commit() throws VWException
Note: Before calling this method, configuration changes, including attributes set with setAttributeInfo(), reside only in local memory.
VWException
- public int getStatisticsSnapshotInterval() throws VWException
VWException
- public void setStatisticsSnapshotInterval(int theInterval) throws VWException
VWException
- public void initializeRegion() throws VWException
VWException
- public void removeRegion() throws VWException
VWException
- public void removeAllRegions() throws VWException
VWException
- public void removeWorkflowDatabase() throws VWException
VWException
- public void removeLinkFlag(java.lang.String theDocument) throws VWException
VWSession.transfer(VWWorkflowDefinition, String, boolean, boolean)
.theDocument
- The work class name from which to remove
the linked-document indicator. VWException
- Causes include a situation where the
work class name
does not exist on the current isolated region.public VWAttributeInfo getAttributeInfo() throws VWException
setAttributeInfo(filenet.vw.api.VWAttributeInfo)
public void setAttributeInfo(VWAttributeInfo theAttributeInfo) throws VWException
theAttributeInfo
- A VWAttribute object containing
attributes for this object, as paired labels (keywords) and
values in String format. VWException
- getAttributeInfo()
,
commit()
public java.lang.String toString()
toString
in class java.lang.Object
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |