filenet.vw.api

Class VWSystemConfiguration

  • java.lang.Object
    • filenet.vw.api.VWSystemConfiguration
  • All Implemented Interfaces:
    IVWtoXML, java.io.Serializable

    public final class VWSystemConfiguration
extends java.lang.Object
implements java.io.Serializable, IVWtoXML
    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.

    Since:
    eProcess 4.0
    See Also:
    VWSession.fetchSystemConfiguration(), VWLogDefinition, VWQueueDefinition, VWRosterDefinition, Serialized Form

    • 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.

        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
        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.

      • hasChanged

        public boolean hasChanged()
                   throws VWException
        Returns whether or not this object has changed.
        Returns:
        A boolean value of 'true' if this object has changed; 'false' otherwise.
        Throws:
        VWException
        Since:
        PE 5.0.0.0

      • createQueueDefinition

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

        • Begin with an alphabetic character.
        • Not begin with "F_".
        • Not include 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

      • deleteQueueDefinition

        public void deleteQueueDefinition(java.lang.String theName)
                           throws VWException
        Deletes a queue definition
        Parameters:
        theName - The name of the queue definition to be deleted.
        Throws:
        VWException - Thrown if the method cannot delete a queue definition.
        Since:
        PE 5.0.0.1

      • 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

      • getQueueDefinition

        public VWQueueDefinition getQueueDefinition(java.lang.String name)
                                     throws VWException
        Gets the queue definition with with specified name, for the current isolated region.
        Parameters:
        name - Name of the queue definition.
        Returns:
        A VWQueueDefinition object associated with the current isolated region, or null if the queue definition does not exist.
        Throws:
        VWException - Thrown if this method cannot get the named, existing log definition associated with the current isolated region.

      • 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, or null if there is no default log definition.
        Throws:
        VWException
        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

      • deleteLogDefinition

        public void deleteLogDefinition(java.lang.String theName)
                         throws VWException
        Deletes an event log definition
        Parameters:
        theName - The name of the event log definition to be deleted.
        Throws:
        VWException - Thrown if the method cannot delete an event log definition.
        Since:
        PE 5.0.0.1

      • 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 this method cannot get the log definitions associated with this system.

      • getLogDefinition

        public VWLogDefinition getLogDefinition(java.lang.String name)
                                 throws VWException
        Gets a log definition, specified by name.
        Parameters:
        name - Name of the log definition.
        Returns:
        A VWLogDefinition object associated with the current isolated region, or null if the named log definition does not exist.
        Throws:
        VWException - Thrown if the method 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

      • deleteRosterDefinition

        public void deleteRosterDefinition(java.lang.String theName)
                            throws VWException
        Deletes a roster definition
        Parameters:
        theName - The name of the roster definition to be deleted.
        Throws:
        VWException - Thrown if the method cannot delete a roster definition.
        Since:
        PE 5.0.0.1

      • 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 the current isolated region.
        Returns:
        An array of VWRosterDefinition objects associated with the current isolated region.
        Throws:
        VWException

      • getRosterDefinition

        public VWRosterDefinition getRosterDefinition(java.lang.String name)
                                       throws VWException
        Gets the roster definition with specified name.
        Parameters:
        name - Name of the roster definition.
        Returns:
        A VWRosterDefinition object associated with the current isolated region, or null if the roster definition does not exist.
        Throws:
        VWException - Thrown

      • deleteStepProcessorInfoDefinition

        public void deleteStepProcessorInfoDefinition(VWStepProcessorInfoDefinition theSPDef)
                                       throws VWException
        Deletes a step processor info definition
        Parameters:
        theSPDef - A VWStepProcessorInfoDefinition object reference that represents the step processor definition to be deleted.
        Throws:
        VWException - Thrown if the method 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

      • getStepProcessorInfoDefinition

        public VWStepProcessorInfoDefinition getStepProcessorInfoDefinition(java.lang.String name)
                                                             throws VWException
        Gets a step processor info definition, specified by name.
        Parameters:
        name - Name of the step processor info definition.
        Returns:
        A VWStepProcessorInfoDefinition object associated with the current isolated region, or null if the queue definition does not exist.
        Throws:
        VWException - Thrown if the method cannot get the log definitions associated with with the current isolated region.

      • createApplicationSpaceDefinition

        public VWApplicationSpaceDefinition createApplicationSpaceDefinition(java.lang.String name)
                                                              throws VWException
        Creates an application space definition.
        Parameters:
        name - A String containing the name to assign to the application space definition.
        Returns:
        The VWApplicationSpaceDefinition object for the new application space definition.
        Throws:
        VWException
        Since:
        P8 4.5.0
        See Also:
        VWApplicationSpaceDefinition

      • deleteApplicationSpaceDefinition

        public void deleteApplicationSpaceDefinition(java.lang.String theName)
                                      throws VWException
        Deletes an application space definition
        Parameters:
        theName - The name of the application space definition to be deleted.
        Throws:
        VWException - Thrown if the method cannot delete an application space definition.
        Since:
        PE 5.0.0.1

      • updateApplicationSpaceDefinition

        public void updateApplicationSpaceDefinition(VWApplicationSpaceDefinition theApplicationSpaceDef)
                                      throws VWException
        Updates an application space definition.
        Parameters:
        theApplicationSpaceDef - A VWApplicationSpaceDefinition object for the application space to update.
        Throws:
        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.
        Since:
        P8 4.5.0
        See Also:
        VWApplicationSpaceDefinition

      • getApplicationSpaceDefinitions

        public VWApplicationSpaceDefinition[] getApplicationSpaceDefinitions()
                                                              throws VWException
        Gets all of the application space definitions associated with this system configuration.
        Returns:
        An array of VWApplicationSpaceDefinition objects associated with the current isolated region.
        Throws:
        VWException
        Since:
        P8 4.5.0

      • getApplicationSpaceDefinition

        public VWApplicationSpaceDefinition getApplicationSpaceDefinition(java.lang.String name)
                                                           throws VWException
        Gets an application space definition.
        Parameters:
        name - A String containing the name of the application space.
        Returns:
        A VWApplicationSpaceDefinition object associated with the current isolated region, or null if the specified application space definition does not exist.
        Throws:
        VWException - Thrown if the method cannot get the application space definition associated with with the current isolated region.
        Since:
        P8 4.5.0

      • 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.

      • 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:
        VWSystemConfiguration.getMaxDBOperations()

      • getMaxInstructions

        public int getMaxInstructions()
        Gets the current maximum number of instructions per transaction.
        Returns:
        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 maximize throughput between the workstation and server.
        Parameters:
        theMaxInstructions - An integer representing the maximum number of instructions per transaction.
        See Also:
        VWSystemConfiguration.getMaxInstructions()

      • getServerIDs

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

      • getStatisticsCollection

        public boolean getStatisticsCollection()
        Deprecated. since PE 5.2.0.0
        Gets the current state of the statistics collection option.
        Returns:
        The current boolean value.

      • setStatisticsCollection

        public void setStatisticsCollection(boolean turnOn)
        Deprecated. since PE 5.2.0.0
        Enables or disables the statistics gathering. This value will be reset to false by the PE server.
        Parameters:
        turnOn - this value is ignored by the PE server. Statistics gathering can no longer be enabled.

      • getTrackAttachmentReferences

        public boolean getTrackAttachmentReferences()
        Gets the current state, enabled or disabled, of the attachment tracking option.

        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.

        Returns:
        true if attachment tracking is currently enabled; false if tracking of attachments is disabled.

      • setTrackAttachmentReferences

        public void setTrackAttachmentReferences(boolean turnOn)
        Enables or disables the tracking of attachment references.

        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.

        Parameters:
        turnOn - A boolean value. Specify true to enable tracking of attachment references; specify false to disable tracking of attachment references.

      • 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

      • 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.

      • importConfig

        public java.lang.StringBuffer importConfig(java.io.BufferedReader in)
                                    throws VWException
        Merges isolated region configuration from a file.
        Parameters:
        theFileName - A String containing the name of the file from which to read the VWSystemConfiguration object definition.
        in - A BufferedReader object from which to read the isolated region configuration definition.
        Returns:
        A StringBuffer containing the import log information.
        Throws:
        VWException
        Since:
        PE 5.0.0.0
        See Also:
        VWSystemConfiguration.importConfig(InputStream), VWSystemConfiguration.importConfig(String)

      • getObjectStoreId

        public VWGuid getObjectStoreId()
                        throws VWException
        Deprecated. replaced by VWSession.getObjectStoreId()
        Gets the object store ID for this isolated region.
        Returns:
        A VWGuid object representing the object store ID.
        Throws:
        VWException
        Since:
        PE 5.0.0.0

      • setObjectStoreId

        public void setObjectStoreId(VWGuid newObjectStoreId)
                      throws VWException
        Deprecated. (no replacement method)
        Note: The object store ID can not be set for this isolated region using this method.
        Parameters:
        newObjectStoreId - A VWGuid object representing the object store id for this isolated region.
        Throws:
        VWException - if the VWGuid contains the undefined (default) guid value
        Since:
        PE 5.0.0.0

      • getObjectStoreSymbolicName

        public java.lang.String getObjectStoreSymbolicName()
                                            throws VWException
        Deprecated. Replaced by VWSession.getObjectStoreSymbolicName();
        Gets the object store's symbolic name for this isolated region.
        Returns:
        A String containing the symbolic name for the object store. Null is returned, if the symbolic name value is not set for the object store.
        Throws:
        VWException
        Since:
        PE 5.0.0.0

      • setObjectStoreSymbolicName

        public void setObjectStoreSymbolicName(java.lang.String newObjectStoreSymbolicName)
                                throws VWException
        Deprecated. (no replacement method)
        Note: The object store ID can not be set for this isolated region using this method.
        Parameters:
        newObjectStoreSymbolicName - A String containing the object store's symbolic name for this isolated region.
        Throws:
        VWException
        Since:
        PE 5.0.0.0

      • getIsRetrievedFromServer

        public boolean getIsRetrievedFromServer()
        Returns:
        true if this configuration has been retrieved from the server
        Since:
        PE 5.0.0.0

      • importQueueDefinition

        public void importQueueDefinition(VWQueueDefinition queueDef)
                           throws VWException
        Adds the specified queue definition to the list of queue definitions. If the queue already exists in the list, it is replaced.
        Parameters:
        queueDef - The queue definition to import.
        Throws:
        VWException
        Since:
        PE 5.2.0.2
Process API

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