Process Class Relationships

filenet.vw.api
Class VWSystemConfiguration

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

public final class VWSystemConfiguration
extends java.lang.Object

Use this class to access configuration information for an isolated region. The configuration information includes the queues, rosters, logs, and region-wide configuration values for the current isolated region. Create an instance of this class by calling the VWSession.fetchSystemConfiguration() method.

Once you are done creating and/or modifying configuration values, call the VWSystemConfiguration.commit() method to commit changes (update the workspace) on the server.

See Also:
VWSession.fetchSystemConfiguration(), VWLogDefinition, VWQueueDefinition, VWRosterDefinition

Field Summary
static int LOG_ALL
          Integer value that is the sum of all the other logging options. Enables logging for all selections.
static int LOG_BEGIN_SERVICE_OPERATION
          Integer value of 0x00100000 (1048576 decimal). Enables logging when a work performer and work object begin operation.
static int LOG_END_SERVICE_OPERATION
          Integer value of 0x00400000 (4194304 decimal). Enables logging when work performer and work object end operation.
static int LOG_MILESTONES
          Integer value of 0x00000040 (64 decimal). Enables logging for milestones.
static int LOG_NONE
          Integer value of 0. Disables logging for all selections.
static int LOG_SYSTEM_MESSAGES
          Integer value of 0x00010000 (65536 decimal). Enables logging for system messages.
static int LOG_USER_DEFINED_1
          Integer value of 0x40000000 (1073741824 decimal). Enables logging for user-defined message 1.
static int LOG_USER_DEFINED_2
          Integer value of 0x80000000 (2147483648 decimal). Enables logging for user-defined message 2.
static int LOG_WOBJ_ADMINISTRATION
          Integer value of 0x00001000 ( 4096 decimal). Enables logging for work object administration messages.
static int LOG_WOBJ_CREATION
          Integer value of 0x00000100 (256 decimal). Enables logging for work object creation.
static int LOG_WOBJ_EXCEPTION
          Integer value of 0x00000400 (1024 decimal). Enables logging for work object exceptions.
static int LOG_WOBJ_TERMINATION
          Integer value of 0x00000200 (512 decimal). Enables logging for work object termination.
static int LOG_WOBJ_TRACE_INSTRUCTIONS
          Integer value of 0x00000020 (32 decimal). Enables logging for work object trace instructions.
 
Method Summary
 java.lang.String[] commit()
          Saves system configuration changes to the current isolated region.
 VWLogDefinition createLogDefinition(java.lang.String theName)
          Creates a log definition.
 VWQueueDefinition createQueueDefinition(java.lang.String theName, int theQueueType)
          Creates a queue definition.
 VWRosterDefinition createRosterDefinition(java.lang.String theName)
          Creates a roster definition.
 VWStepProcessorInfoDefinition createStepProcessorInfoDefinition()
          Creates a step processor definition.
 void deleteStepProcessorInfoDefinition(VWStepProcessorInfoDefinition theSPDef)
          Deletes a step processor info definition.
 VWAttributeInfo getAttributeInfo()
          Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
 VWLogDefinition getDefaultLogDefinition()
          Gets the default definition for event logging.
 VWExposedFieldDefinition[] getExposedFields()
          Returns all the exposed fields on the queues, the rosters, and the logs.
static java.lang.String getLocalizedString(int theLogType)
          Gets a localized String representation of the log type.
 VWLogDefinition[] getLogDefinitions()
          Gets the log definitions associated with this system configuration object.
 int getLoggingState()
          Gets the value of all the logging states.
 boolean getLoggingState(int theLoggingOption)
          Determines whether or not a logging option is enabled or disabled.
 int getMaxDBOperations()
          Gets the current maximum number of database operations per transaction.
 int getMaxInstructions()
          Gets the current maximum number of instructions per transaction.
 VWQueueDefinition[] getQueueDefinitions()
          Lists all queue definitions for the current configuration.
 VWRosterDefinition[] getRosterDefinitions()
          Gets the roster definitions associated with this system configuration.
 java.lang.Integer[] getServerIDs()
          Lists the all available server IDs.
 boolean getStatisticsCollection()
          Gets the current state of the statistics collection option.
 VWStepProcessorInfoDefinition[] getStepProcessorInfoDefinitions()
          Gets the VWStepProcessorInfoDefinition objects associated with this System Configuration object.
 void setAttributeInfo(VWAttributeInfo theAttributeInfo)
          Sets a VWAttribute object containing attributes for this object.
 int setLoggingState(int newLoggingOptions, boolean turnOn)
          Enables or disables system logging options.
 void setMaxDBOperations(int theMaxOperations)
          Sets the maximum number of database operations executed by the instruction sheet interpreter per transaction, which is used to maximize throughput between the workstation and the server.
 void setMaxInstructions(int theMaxInstructions)
          Sets the maximum number of instructions executed by the instruction sheet interpreter per transaction, which is used to setting to maximize throughput between the workstation and server.
 void setStatisticsCollection(boolean turnOn)
          Enables or disables the statistics gathering.
 java.lang.String toString()
          Gets the String representation of the VWSystemConfiguration object.
 void updateLogDefinition(VWLogDefinition theLogDefinition)
          Updates a log definition.
 void updateQueueDefinition(VWQueueDefinition theQueueDefinition)
          Updates a queue definition.
 void updateRosterDefinition(VWRosterDefinition theRosterDefinition)
          Updates a roster definition.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LOG_NONE

public static final int LOG_NONE
Integer value of 0. Disables logging for all selections. Refer to the setLoggingState(int, boolean) method for information on setting the logging options.

LOG_WOBJ_CREATION

public static final int LOG_WOBJ_CREATION
Integer value of 0x00000100 (256 decimal). Enables logging for work object creation. Refer to the setLoggingState(int, boolean) method for information on setting the logging options.

LOG_WOBJ_TERMINATION

public static final int LOG_WOBJ_TERMINATION
Integer value of 0x00000200 (512 decimal). Enables logging for work object termination. Refer to the setLoggingState(int, boolean) method for more information.

LOG_WOBJ_EXCEPTION

public static final int LOG_WOBJ_EXCEPTION
Integer value of 0x00000400 (1024 decimal). Enables logging for work object exceptions. Refer to the setLoggingState(int, boolean) method for more information.

LOG_WOBJ_ADMINISTRATION

public static final int LOG_WOBJ_ADMINISTRATION
Integer value of 0x00001000 ( 4096 decimal). Enables logging for work object administration messages. Refer to the setLoggingState(int, boolean) method for more information.

LOG_WOBJ_TRACE_INSTRUCTIONS

public static final int LOG_WOBJ_TRACE_INSTRUCTIONS
Integer value of 0x00000020 (32 decimal). Enables logging for work object trace instructions. Refer to the setLoggingState(int, boolean) method for more information.

LOG_BEGIN_SERVICE_OPERATION

public static final int LOG_BEGIN_SERVICE_OPERATION
Integer value of 0x00100000 (1048576 decimal). Enables logging when a work performer and work object begin operation. Refer to the setLoggingState(int, boolean) method for more information.

LOG_END_SERVICE_OPERATION

public static final int LOG_END_SERVICE_OPERATION
Integer value of 0x00400000 (4194304 decimal). Enables logging when work performer and work object end operation. Refer to the setLoggingState(int, boolean) method for more information.

LOG_USER_DEFINED_1

public static final int LOG_USER_DEFINED_1
Integer value of 0x40000000 (1073741824 decimal). Enables logging for user-defined message 1. Refer to the setLoggingState(int, boolean) method for more information.

LOG_USER_DEFINED_2

public static final int LOG_USER_DEFINED_2
Integer value of 0x80000000 (2147483648 decimal). Enables logging for user-defined message 2. Refer to the setLoggingState(int, boolean) method for more information.

LOG_SYSTEM_MESSAGES

public static final int LOG_SYSTEM_MESSAGES
Integer value of 0x00010000 (65536 decimal). Enables logging for system messages. Refer to the setLoggingState(int, boolean) method for information on setting the logging options.

LOG_MILESTONES

public static final int LOG_MILESTONES
Integer value of 0x00000040 (64 decimal). Enables logging for milestones. Refer to the setLoggingState(int, boolean) method for information on setting the logging options.

LOG_ALL

public static final int LOG_ALL
Integer value that is the sum of all the other logging options. Enables logging for all selections. Refer to the setLoggingState(int, boolean) method for information on setting the logging options.
Method Detail

commit

public java.lang.String[] commit()
                          throws VWException
Saves system configuration changes to the current isolated region.

Before calling this method, configuration changes reside only in local memory. The workflow system suspends all database transactions within the isolated region until the commit is complete. For this reason, you should call this method when the current isolated region is relatively inactive.

Returns:
An array of Strings in which each String represents an error encountered while the system attempted to transfer the settings. If the method does not encounter errors, the String contains a null value.
Throws:
VWException - Thrown if the system encounters an error while attempting to transfer the system configuration to the online repository.

createQueueDefinition

public VWQueueDefinition createQueueDefinition(java.lang.String theName,
                                               int theQueueType)
                                        throws VWException
Creates a queue definition.
Parameters:
theName - The queue name, which should conform to the following the guidelines:

  • Begin with an alphabetic character.
  • Avoid beginning with "F_".
  • Contain 30 or fewer characters (bytes).
  • Avoid special characters.
  • Be alphanumeric(underscores are acceptable after the first letter in the name).

theQueueType - An integer value specifying the type of the queue, as defined in VWQueueDefinition class.

Valid values are as follows:

  • 1: Process (QUEUE_TYPE_PROCESS)
  • 2: User-centric (QUEUE_TYPE_USER_CENTRIC)

Returns:
A VWQueueDefinition object that represents the new queue.
Throws:
VWException - Causes include situations where a queue with the name specified in the theName parameter already exists, the queue name specified is invalid because it violates naming conventions, or the queue type specified in the theQueueType parameter is something other than QUEUE_TYPE_PROCESS or QUEUE_TYPE_USER_CENTRIC.
See Also:
VWQueueDefinition

updateQueueDefinition

public void updateQueueDefinition(VWQueueDefinition theQueueDefinition)
                           throws VWException
Updates a queue definition.
Parameters:
theQueueDefinition - The updated queue definition.
Throws:
VWException - Causes include situations where the queue definition does not exist or is invalid.
See Also:
VWQueueDefinition

getQueueDefinitions

public VWQueueDefinition[] getQueueDefinitions()
                                        throws VWException
Lists all queue definitions for the current configuration.
Returns:
An array of VWQueueDefinition objects. Each object represents a queue definition for this isolated region.
Throws:
VWException -  

getDefaultLogDefinition

public VWLogDefinition getDefaultLogDefinition()
                                        throws VWException
Gets the default definition for event logging.
Returns:
A VWLogDefinition object that represents the default log definition for this isolated region.
Throws:
VWException - Thrown if the system cannot find a default log definition.
See Also:
VWLogDefinition

createLogDefinition

public VWLogDefinition createLogDefinition(java.lang.String theName)
                                    throws VWException
Creates a log definition.
Parameters:
theName - A String containing the name of the log definition.
Returns:
A VWLogDefinition object that represents the newly created log definition.
Throws:
VWException - Thrown if the log name specified in the theName parameter already exists or if the system encounters an error while attempting to create the log.
See Also:
VWLogDefinition

updateLogDefinition

public void updateLogDefinition(VWLogDefinition theLogDefinition)
                         throws VWException
Updates a log definition.
Parameters:
theLogDefinition - The updated log definition.
Throws:
VWException - Thrown if the log definition does not exist or if the system encounters an error while attempting to update the log definition.
See Also:
VWLogDefinition

getLogDefinitions

public VWLogDefinition[] getLogDefinitions()
                                    throws VWException
Gets the log definitions associated with this system configuration object.
Returns:
An array of VWLogDefinition objects associated with the current isolated region.
Throws:
VWException - Thrown if it cannot get the log definitions associated with this system.

createRosterDefinition

public VWRosterDefinition createRosterDefinition(java.lang.String theName)
                                          throws VWException
Creates a roster definition.
Parameters:
theName - A String containing the name to be used for the roster definition.
Returns:
A VWRosterDefinition object that represents the newly created roster definition.
Throws:
VWException - Thrown if the roster name specified in the theName parameter already exists or if the system cannot create the roster.
See Also:
VWRosterDefinition

updateRosterDefinition

public void updateRosterDefinition(VWRosterDefinition theRosterDefinition)
                            throws VWException
Updates a roster definition.
Parameters:
theRosterDefinition - The updated roster definition.
Throws:
VWException - Thrown if the roster definition does not exist or if the system encounters an error while attempting to update the roster definition.
See Also:
VWRosterDefinition

getRosterDefinitions

public VWRosterDefinition[] getRosterDefinitions()
                                          throws VWException
Gets the roster definitions associated with this system configuration.
Returns:
An array of VWRosterDefinition objects associated with the current isolated region.
Throws:
VWException - Thrown if it cannot get the roster definitions associated with this system.

createStepProcessorInfoDefinition

public VWStepProcessorInfoDefinition createStepProcessorInfoDefinition()
                                                                throws VWException
Creates a step processor definition.
Returns:
A VWStepProcessorInfoDefinition object that represents the step processor definition.
Throws:
VWException -  
See Also:
VWStepProcessorInfoDefinition

deleteStepProcessorInfoDefinition

public void deleteStepProcessorInfoDefinition(VWStepProcessorInfoDefinition theSPDef)
                                       throws VWException
Deletes a step processor info definition.
Parameters:
theSPDef - A reference to the VWStepProcessorInfoDefinition object that represents the step processor definition to be deleted.
Throws:
VWException - Thrown if it cannot delete a step processor info definition.
See Also:
VWStepProcessorInfoDefinition

getStepProcessorInfoDefinitions

public VWStepProcessorInfoDefinition[] getStepProcessorInfoDefinitions()
                                                                throws VWException
Gets the VWStepProcessorInfoDefinition objects associated with this System Configuration object.
Returns:
An array of VWStepProcessorInfoDefinition objects associated with the current isolated region.
Throws:
VWException - Thrown if it cannot get the VWStepProcessorInfoDefinition objects associated with this System Configuration object.

getLoggingState

public boolean getLoggingState(int theLoggingOption)
Determines whether or not a logging option is enabled or disabled.
Parameters:
theLoggingOption - An integer value that specifies the logging options to check.Valid logging option values are as follows:

Returns:
A Boolean value. This method returns true if the logging option specified in the theLoggingOption parameter is enabled currently; otherwise, this method returns false.

getLoggingState

public int getLoggingState()
Gets the value of all the logging states.
Returns:
An integer value that represents the logging state for the system. This value is the sum of the individual logging state values in the current instance of the VWSystemConfiguration class.

setLoggingState

public int setLoggingState(int newLoggingOptions,
                           boolean turnOn)
                    throws VWException
Enables or disables system logging options.
Parameters:
newLoggingOptions - An integer value specifying the logging options to enable or disable. Combine multiple options by summing them. Valid logging option values are as follows:

turnOn - A Boolean value. Set to 'TRUE' to turn logging on for the options represented by the newLoggingOptions parameter.
Set to 'FALSE' to turn off logging for the options represented by the theLoggingOptions parameter.

If LOG_ALL is passed in and turnOn is 'FALSE', then logging options are set to LOG_NONE. If LOG_NONE is passed in and turnOn is 'FALSE', then logging options are set to LOG_ALL.

Returns:
An integer that represents the logging options that resulted from this method call.
Throws:
VWException - Thrown if it cannot enable or disable system logging options. This can occur if a logging option is invalid, for example.

getMaxDBOperations

public int getMaxDBOperations()
Gets the current maximum number of database operations per transaction.
Returns:
An integer value indicating the current number of allowed database operation for each workflow transaction.

setMaxDBOperations

public void setMaxDBOperations(int theMaxOperations)
Sets the maximum number of database operations executed by the instruction sheet interpreter per transaction, which is used to maximize throughput between the workstation and the server.
Parameters:
theMaxOperations - An integer value specifying the maximum number of database operations per transaction.
See Also:
getMaxDBOperations()

getMaxInstructions

public int getMaxInstructions()
Gets the current maximum number of instructions per transaction.
Returns:
the current maximum number of instructions per transaction

setMaxInstructions

public void setMaxInstructions(int theMaxInstructions)
Sets the maximum number of instructions executed by the instruction sheet interpreter per transaction, which is used to setting to maximize throughput between the workstation and server.
Parameters:
theMaxInstructions - An integer representing the maximum number of instructions per transaction.
See Also:
getMaxInstructions()

getServerIDs

public java.lang.Integer[] getServerIDs()
Lists the all available server IDs.
Returns:
An array of integers values that represent the server Ids for each server.

getStatisticsCollection

public boolean getStatisticsCollection()
Gets the current state of the statistics collection option.
Returns:
A Boolean value. This method returns true if statistic collection is enabled currently. This method returns false if statistic collection is disabled.

setStatisticsCollection

public void setStatisticsCollection(boolean turnOn)
Enables or disables the statistics gathering.
Parameters:
turnOn - A Boolean value. Specify true to enable collection of statistical information; specify false to disable collection of statistical information.

getLocalizedString

public static java.lang.String getLocalizedString(int theLogType)
                                           throws VWException
Gets a localized String representation of the log type.
Parameters:
theLogType - An integer value that represents the log type to be represented by a String. Valid logging option values are as follows:

Returns:
The localized text representation of the log type.
Throws:
VWException - Thrown if the log type specified in the theLogType parameter is invalid.

getExposedFields

public VWExposedFieldDefinition[] getExposedFields()
                                            throws VWException
Returns all the exposed fields on the queues, the rosters, and the logs.
Returns:
An array of VWExposedFieldDefinition objects that define all queue, roster, and log definitions for the current system configuration.
Throws:
VWException -  

getAttributeInfo

public VWAttributeInfo getAttributeInfo()
                                 throws VWException
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
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.
Parameters:
theAttributeInfo - A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
Throws:
VWException -  
See Also:
getAttributeInfo()

toString

public java.lang.String toString()
Gets the String representation of the VWSystemConfiguration object.
Overrides:
toString in class java.lang.Object
Returns:
The name of the current isolated region.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.