|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWSystemConfiguration
public final class VWSystemConfiguration
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.
VWSession.fetchSystemConfiguration()
,
VWLogDefinition
,
VWQueueDefinition
,
VWRosterDefinition
,
Serialized FormField 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
Value of 0x00100000 (1048576 decimal). Enables logging when a work performer and work object begin operation. |
static int |
LOG_END_SERVICE_OPERATION
Value of 0x00400000 (4194304 decimal). Enables logging when work performer and work object end operation. |
static int |
LOG_MILESTONES
Value of 0x00000040 (64 decimal). Enables logging for milestones. |
static int |
LOG_NONE
Value of 0. Disables logging for all selections. |
static int |
LOG_SYSTEM_MESSAGES
Value of 0x00010000 (65536 decimal). Enables logging for system messages. |
static int |
LOG_USER_DEFINED_1
Value of 0x40000000 (1073741824 decimal). Enables logging for user-defined message 1. |
static int |
LOG_USER_DEFINED_2
Value of 0x80000000 (2147483648 decimal). Enables logging for user-defined message 2. |
static int |
LOG_WOBJ_ADMINISTRATION
Value of 0x00001000 ( 4096 decimal). Enables logging for work object administration messages. |
static int |
LOG_WOBJ_CREATION
Value of 0x00000100 (256 decimal). Enables logging for work object creation. |
static int |
LOG_WOBJ_EMPTY_STEP
Value of 0x00000010 (16 decimal). Enables logging for empty steps, (steps with no queue or participants). |
static int |
LOG_WOBJ_EXCEPTION
Value of 0x00000400 (1024 decimal). Enables logging for work object exceptions. |
static int |
LOG_WOBJ_RULES
Value of 0x00000020 (32 decimal). Enables logging for work object rules. |
static int |
LOG_WOBJ_TERMINATION
Value of 0x00000200 (512 decimal). Enables logging for work object termination. |
static int |
LOG_WOBJ_TRACE_INSTRUCTIONS
Value of 0x00000080 (128 decimal). Enables logging for work object trace instructions. |
Constructor Summary | |
---|---|
VWSystemConfiguration()
|
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. |
java.lang.String[] |
commit()
Saves system configuration changes to the current isolated region. |
VWApplicationSpaceDefinition |
createApplicationSpaceDefinition(java.lang.String name)
Creates an application space definition. |
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. |
VWApplicationSpaceDefinition |
getApplicationSpaceDefinition(java.lang.String name)
Gets an application space definition. |
VWApplicationSpaceDefinition[] |
getApplicationSpaceDefinitions()
Gets all of the application space definitions associated with this system configuration. |
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 |
getLogDefinition(java.lang.String name)
Gets a log definition, specified by name. |
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 |
getQueueDefinition(java.lang.String name)
Gets the queue definition with with specified name, for the current isolated region. |
VWQueueDefinition[] |
getQueueDefinitions()
Lists all queue definitions for the current configuration. |
VWRosterDefinition |
getRosterDefinition(java.lang.String name)
Gets the roster definition with specified name. |
VWRosterDefinition[] |
getRosterDefinitions()
Gets the roster definitions associated with the current isolated region. |
java.lang.Integer[] |
getServerIDs()
Lists the all available server IDs. |
boolean |
getStatisticsCollection()
Gets the current state of the statistics collection option. |
VWStepProcessorInfoDefinition |
getStepProcessorInfoDefinition(java.lang.String name)
Gets a step processor info definition, specified by name. |
VWStepProcessorInfoDefinition[] |
getStepProcessorInfoDefinitions()
Gets the VWStepProcessorInfoDefinition objects associated with this system configuration object. |
boolean |
getTrackAttachmentReferences()
Gets the current state, enabled or disabled, of the attachment tracking option. |
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 maximize throughput between the workstation and server. |
void |
setStatisticsCollection(boolean turnOn)
Enables or disables the statistics gathering. |
void |
setTrackAttachmentReferences(boolean turnOn)
Enables or disables the tracking of attachment references. |
java.lang.String |
toString()
Gets the String representation of the VWSystemConfiguration object. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
updateApplicationSpaceDefinition(VWApplicationSpaceDefinition theApplicationSpaceDef)
Updates an application space definition. |
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 |
---|
public static final int LOG_NONE
setLoggingState(int, boolean)
method
for information on setting the logging options.
public static final int LOG_WOBJ_CREATION
setLoggingState(int, boolean)
method
for information on setting the logging options.
public static final int LOG_WOBJ_TERMINATION
setLoggingState(int, boolean)
method for more information.
public static final int LOG_WOBJ_EXCEPTION
setLoggingState(int, boolean)
method for more information.
public static final int LOG_WOBJ_ADMINISTRATION
setLoggingState(int, boolean)
method for more information.
public static final int LOG_WOBJ_TRACE_INSTRUCTIONS
setLoggingState(int, boolean)
method for more information.
public static final int LOG_WOBJ_EMPTY_STEP
setLoggingState(int, boolean)
method for more information.
public static final int LOG_WOBJ_RULES
setLoggingState(int, boolean)
method for more information.
public static final int LOG_BEGIN_SERVICE_OPERATION
setLoggingState(int, boolean)
method for more information.
public static final int LOG_END_SERVICE_OPERATION
setLoggingState(int, boolean)
method for more information.
public static final int LOG_USER_DEFINED_1
setLoggingState(int, boolean)
method for more information.
public static final int LOG_USER_DEFINED_2
setLoggingState(int, boolean)
method for more information.
public static final int LOG_SYSTEM_MESSAGES
setLoggingState(int, boolean)
method
for information on setting the logging options.
public static final int LOG_MILESTONES
setLoggingState(int, boolean)
method
for information on setting the logging options.
public static final int LOG_ALL
setLoggingState(int, boolean)
method
for information on setting the logging options.
Constructor Detail |
---|
public VWSystemConfiguration()
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.lang.String[] commit() throws VWException
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.
Note: Depending on your application and the calls you are making, you may need to adjust the client timeout value in your Java initiation statement prior to calling this method. For example, under Sun Solaris or using the Sun JVM, you may need to adjust the timeout value in the Java initiation statement as follows:
-Dcom.sun.CORBA.transport.ORBTCPReadTimeouts=100:15000:300:5
VWException
- Thrown if the
system encounters an error while attempting to transfer the
system configuration to the online repository.public VWQueueDefinition createQueueDefinition(java.lang.String theName, int theQueueType) throws VWException
theName
- The queue name, which should conform to the
following the guidelines:
theQueueType
- An integer value specifying the type of
the queue, as defined in VWQueueDefinition class.
Valid values are as follows:
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.VWQueueDefinition
public void updateQueueDefinition(VWQueueDefinition theQueueDefinition) throws VWException
theQueueDefinition
- The updated queue definition.
VWException
- Causes include situations where the
queue definition does not exist or is invalid. VWQueueDefinition
public VWQueueDefinition[] getQueueDefinitions() throws VWException
VWException
public VWQueueDefinition getQueueDefinition(java.lang.String name) throws VWException
name
- Name of the queue definition.
VWException
- Thrown if this method cannot
get the named, existing log definition associated with
the current isolated region.public VWLogDefinition getDefaultLogDefinition() throws VWException
VWException
VWLogDefinition
public VWLogDefinition createLogDefinition(java.lang.String theName) throws VWException
theName
- A String containing the name of the log definition.
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.VWLogDefinition
public void updateLogDefinition(VWLogDefinition theLogDefinition) throws VWException
theLogDefinition
- The updated log definition.
VWException
- Thrown if the
log definition does not exist or if the system encounters an
error while attempting to update the log definition.VWLogDefinition
public VWLogDefinition[] getLogDefinitions() throws VWException
VWException
- Thrown if this method cannot
get the log definitions associated with this system.public VWLogDefinition getLogDefinition(java.lang.String name) throws VWException
name
- Name of the log definition.
VWException
- Thrown if the method cannot
get the log definitions associated with this system.public VWRosterDefinition createRosterDefinition(java.lang.String theName) throws VWException
theName
- A String containing the name to be used for the
roster definition.
VWException
- Thrown if the
roster name specified in the theName parameter already exists
or if the system cannot create the roster.VWRosterDefinition
public void updateRosterDefinition(VWRosterDefinition theRosterDefinition) throws VWException
theRosterDefinition
- The updated roster definition.
VWException
- Thrown if the
roster definition does not exist or if the system encounters an
error while attempting to update the roster definition.VWRosterDefinition
public VWRosterDefinition[] getRosterDefinitions() throws VWException
VWException
public VWRosterDefinition getRosterDefinition(java.lang.String name) throws VWException
name
- Name of the roster definition.
VWException
- Thrownpublic VWStepProcessorInfoDefinition createStepProcessorInfoDefinition() throws VWException
VWException
VWStepProcessorInfoDefinition
public void deleteStepProcessorInfoDefinition(VWStepProcessorInfoDefinition theSPDef) throws VWException
theSPDef
- A
VWStepProcessorInfoDefinition object reference that
represents the step processor definition to be deleted.
VWException
- Thrown if the method cannot
delete a step processor info definition.VWStepProcessorInfoDefinition
public VWStepProcessorInfoDefinition[] getStepProcessorInfoDefinitions() throws VWException
VWException
public VWStepProcessorInfoDefinition getStepProcessorInfoDefinition(java.lang.String name) throws VWException
name
- Name of the step processor info definition.
VWException
- Thrown if the method cannot
get the log definitions associated with
with the current isolated region.public VWApplicationSpaceDefinition createApplicationSpaceDefinition(java.lang.String name) throws VWException
name
- A String containing the name to assign to the application space definition.
VWException
VWApplicationSpaceDefinition
public void updateApplicationSpaceDefinition(VWApplicationSpaceDefinition theApplicationSpaceDef) throws VWException
theApplicationSpaceDef
- A VWApplicationSpaceDefinition object for the application
space to update.
VWException
- Thrown if the application space definition does not exist, or if the
system encounters an error while attempting to update the application space definition.VWApplicationSpaceDefinition
public VWApplicationSpaceDefinition[] getApplicationSpaceDefinitions() throws VWException
VWException
public VWApplicationSpaceDefinition getApplicationSpaceDefinition(java.lang.String name) throws VWException
name
- A String containing the name of the application space.
VWException
- Thrown if the method cannot
get the application space definition associated with
with the current isolated region.public boolean getLoggingState(int theLoggingOption)
theLoggingOption
- An integer value that specifies the
logging options to check. Valid logging option values are as
follows:
LOG_NONE
)
LOG_ALL
)
LOG_WOBJ_CREATION
)
LOG_WOBJ_TERMINATION
)
LOG_WOBJ_EXCEPTION
)
LOG_WOBJ_ADMINISTRATION
)
LOG_WOBJ_TRACE_INSTRUCTIONS
)
LOG_BEGIN_SERVICE_OPERATION
)
LOG_END_SERVICE_OPERATION
)
LOG_USER_DEFINED_1
)
LOG_USER_DEFINED_2
)
LOG_SYSTEM_MESSAGES
)
LOG_MILESTONES
)
LOG_WOBJ_EMPTY_STEP
)
LOG_WOBJ_RULES
)
true
if the
logging option specified in the theLoggingOption parameter is
enabled currently; otherwise, this method returns false
.public int getLoggingState()
public int setLoggingState(int newLoggingOptions, boolean turnOn) throws VWException
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:
LOG_NONE
)
LOG_ALL
)
LOG_WOBJ_CREATION
)
LOG_WOBJ_TERMINATION
)
LOG_WOBJ_EXCEPTION
)
LOG_WOBJ_ADMINISTRATION
)
LOG_WOBJ_TRACE_INSTRUCTIONS
)
LOG_BEGIN_SERVICE_OPERATION
)
LOG_END_SERVICE_OPERATION
)
LOG_USER_DEFINED_1
)
LOG_USER_DEFINED_2
)
LOG_SYSTEM_MESSAGES
)
LOG_MILESTONES
)
LOG_WOBJ_EMPTY_STEP
)
LOG_WOBJ_RULES
)
turnOn
- A boolean value. Set to 'TRUE' to turn logging on
for the options represented by the newLoggingOptions 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.
VWException
- Thrown if the method cannot
enable or disable system logging options. This can occur if a
logging option is invalid, for example.public int getMaxDBOperations()
public void setMaxDBOperations(int theMaxOperations)
theMaxOperations
- An integer value specifying the
maximum number of database operations per transactiongetMaxDBOperations()
public int getMaxInstructions()
public void setMaxInstructions(int theMaxInstructions)
theMaxInstructions
- An integer representing the maximum
number of instructions per transaction.getMaxInstructions()
public java.lang.Integer[] getServerIDs()
public boolean getStatisticsCollection()
true
if statistic
collection is enabled currently. This method returns
false
if
statistic collection is disabled.public void setStatisticsCollection(boolean turnOn)
turnOn
- A boolean value. Specify true
to enable
collection of statistical information; specify
false
to
disable collection of statistical information.public boolean getTrackAttachmentReferences()
Note: When attachment tracking is turned on, only the first 256 bytes are used for tracking purposes. Normally, only IDs that are a URL or UNC are this long. This tracking feature does not limit the ID field within an attachment or attachment object, itself.
true
if attachment tracking is currently
enabled; false
if tracking of attachments is
disabled.public void setTrackAttachmentReferences(boolean turnOn)
Note: When attachment tracking is turned on, the internal ID of attachment being tracked is limited to 256 bytes. If the attachment ID is longer than 256 bytes, the ID will be truncated to the first 256 bytes.
turnOn
- A boolean value. Specify true
to enable
tracking of attachment references; specify false
to
disable tracking of attachment references.public static java.lang.String getLocalizedString(int theLogType) throws VWException
theLogType
- An integer value that represents the log
type to be represented by a String. Valid logging option
values are as follows:
LOG_NONE
)LOG_ALL
)LOG_WOBJ_CREATION
)LOG_WOBJ_TERMINATION
)LOG_WOBJ_EXCEPTION
)LOG_WOBJ_ADMINISTRATION
)LOG_WOBJ_TRACE_INSTRUCTIONS
)LOG_BEGIN_SERVICE_OPERATION
)LOG_END_SERVICE_OPERATION
)LOG_USER_DEFINED_1
)LOG_USER_DEFINED_2
)LOG_SYSTEM_MESSAGES
)LOG_MILESTONES
)LOG_WOBJ_EMPTY_STEP
)LOG_WOBJ_RULES
)VWException
- Thrown if the
log type specified in the theLogType parameter is invalid.public VWExposedFieldDefinition[] getExposedFields() throws VWException
VWException
public VWAttributeInfo getAttributeInfo() throws VWException
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()
public java.lang.String toString()
toString
in class java.lang.Object
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |