filenet.vw.api

Class VWSystemAdministration

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

    public final class VWSystemAdministration
extends java.lang.Object
implements java.io.Serializable, IVWtoXML
    Use this class to access and modify system-wide administration information or tasks. Examples of tasks managed with this class include the following:
    • Initializing and emptying regions
    • Setting up system-wide user information
    • Removing databases
    Since:
    VWWS3.10
    See Also:
    VWSession.fetchSystemAdministration(), Serialized Form

    • Field Detail

      • SYSTEM_WIDE_UNDEFINED

        public static final int SYSTEM_WIDE_UNDEFINED
        Value of 0, indicating the system-wide flag is undefined.
        See Also:
        Constant Field Values

      • SYSTEM_WIDE_LOOP_DETECTION

        public static final int SYSTEM_WIDE_LOOP_DETECTION
        Value of 1, indicating that the server should perform loop detection.
        See Also:
        Constant Field Values

      • 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.
        See Also:
        Constant Field Values

      • 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.
        See Also:
        Constant Field Values

      • SYSTEM_WIDE_DISABLE_STATISTICS

        public static final int SYSTEM_WIDE_DISABLE_STATISTICS
        Value of 16, indicating that statistics should be disabled on the server.
        See Also:
        Constant Field Values

      • 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.
        See Also:
        Constant Field Values

      • 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.
        See Also:
        Constant Field Values

      • 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.
        See Also:
        Constant Field Values

      • 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 of the return system instruction.
        See Also:
        Constant Field Values

      • SYSTEM_WIDE_FLAG_ENABLE_RULES

        public static final int SYSTEM_WIDE_FLAG_ENABLE_RULES
        Value of 1024, indicating that rules engine is enabled.
        See Also:
        Constant Field Values

      • SYSTEM_WIDE_FLAG_ALLOW_ASYNC_RULES

        public static final int SYSTEM_WIDE_FLAG_ALLOW_ASYNC_RULES
        Value of 2048, indicating that the option to run some rules asynchronously is enabled.
        See Also:
        Constant Field Values

    • Method Detail

      • createUserInfo

        public VWUserInfo createUserInfo()
                          throws VWException
        Deprecated. VWUserInfo records are created on the server in P8PE4.0
        This method is not supported in P8PE4.0. VWUserInfo records are now only created on the server. When a user logs in or is part of a launched workflow, a record is automatically created on the server. Use VWSession method fetchUserInfo to fetch an existing record. Use methods on the VWUserInfo object to update and add properties.
        Returns:
        Nothing; this method will throw an exception.
        Throws:
        VWException - If this method is called.
        See Also:
        VWSession.fetchUserInfo(String), 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
        Deprecated. PA should be used for statistics
        Gets the interval (minutes) between updates to the domain-wide statistics stored in the database.
        Returns:
        The number of minutes between database updates
        Throws:
        VWException

      • setStatisticsConsolidationInterval

        public void setStatisticsConsolidationInterval(int theInterval)
                                        throws VWException
        Deprecated. Process Analysis should be used for statistics; see the Process Analysis User's Guide for information.
        Sets the interval (minutes) between updates to the domain-wide statistics stored in the database. Valid intervals range from 0 to 1440 (24 hours). A new setting takes effect only after restarting the workflow services.
        Parameters:
        theInterval - The number of minutes between database updates.
        Throws:
        VWException

      • setSystemWideFlags

        public void setSystemWideFlags(int theFlags)
                        throws VWException
        Deprecated. Replaced by VWSystemAdministration.setSystemFlags(int), which requires VWSystemAdministration.commit() to save the flag values to the workflow server. This deprecated method saved the flag values automatically.
        Sets the system-wide configuration flags, saving it to the workflow server. A new setting takes effect only after restarting the workflow 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 restarting the workflow services. Use VWSystemAdministration.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.
        Throws:
        VWException

      • 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. You must use commit() to transfer new settings to the workflow system. A new setting takes effect only after restarting the workflow services.
        Parameters:
        theSessionTimeOut - An integer indicating 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. The new settings take effect only after restarting the workflow 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.

      • setAttributeInfo

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

      • getDBExecutionConnections

        public VWDBExecuteConnection[] getDBExecutionConnections()
                                                  throws VWException
        Gets the VWDBExecuteConnection objects.
        Returns:
        the current set of VWDBExecuteConnection objects.
        Throws:
        VWException
        Since:
        PE 5.0.0.0

      • fetchDBExecutionConnections

        public VWDBExecuteConnection[] fetchDBExecutionConnections()
                                                    throws VWException
        Re-fetches the system-wide information from the PE server. Warning: Any changes to this object will be overwritten.
        Returns:
        the set of VWDBExecuteConnection objects retrieved from the PE server.
        Throws:
        VWException
        Since:
        PE 5.0.0.0

      • getDBExecutionConnection

        public VWDBExecuteConnection getDBExecutionConnection(java.lang.String theName)
                                               throws VWException
        Gets a VWDBExecuteConnection object.
        Parameters:
        theName -
        Returns:
        the VWDBExecuteConnection object of the given name, if found.
        Throws:
        VWException
        Since:
        PE 5.0.0.0

      • createDBExecutionConnection

        public VWDBExecuteConnection createDBExecutionConnection(java.lang.String theName)
                                                  throws VWException
        Creates a new VWDBExecuteConnection object.
        Parameters:
        theName -
        Returns:
        the new VWDBExecuteConnection object.
        Throws:
        VWException
        Since:
        PE 5.0.0.0

      • deleteDBExecutionConnection

        public void deleteDBExecutionConnection(VWDBExecuteConnection theDBExecuteConnection)
                                 throws VWException
        Deletes the VWDBExecuteConnection object, if found.
        Parameters:
        theDBExecuteConnection -
        Throws:
        VWException
        Since:
        PE 5.0.0.0

      • verifyDBConnection

        public boolean verifyDBConnection(VWDBExecuteConnection dbConnection)
                           throws VWException
        Verifies the VWDBExecuteConnection object.
        Parameters:
        dbConnection -
        Returns:
        true if successful
        Throws:
        VWException
        Since:
        PE 5.0.0.0

      • getLanguagePacks

        public VWLanguagePack[] getLanguagePacks()
                                  throws VWException
        Gets the VWLanguagePack objects.
        Returns:
        the current set of VWLanguagePack objects.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • getLanguagePack

        public VWLanguagePack getLanguagePack(java.util.Locale theLocale)
                               throws VWException
        Gets a VWLanguagePack object.
        Parameters:
        theLocale - The locale of the VWLanguagePack object.
        Returns:
        the VWLanguagePack object of the given locale, if found.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0
        See Also:
        Locale

      • createLanguagePack

        public VWLanguagePack createLanguagePack(java.util.Locale theLocale)
                                  throws VWException
        Creates a new VWLanguagePack object.
        Parameters:
        theLocale - The locale of the VWLanguagePack object.
        Returns:
        The new VWLanguagePack object.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0
        See Also:
        Locale

      • deleteLanguagePack

        public void deleteLanguagePack(VWLanguagePack theLanguagePack)
                        throws VWException
        Deletes the VWLanguagePack object, if found.
        Parameters:
        theLanguagePack - the VWLanguagePack object to delete.
        Throws:
        VWException - Thrown if the specified VWLanguagePack object is not found in the list, and for other various causes.
        Since:
        PE 5.2.0.0

      • getDefaultLocale

        public java.util.Locale getDefaultLocale()
                                  throws VWException
        Gets the default locale setting.
        Returns:
        The default locale setting.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0
        See Also:
        Locale

      • setDefaultLocale

        public void setDefaultLocale(java.util.Locale theLocale)
                      throws VWException
        Sets the default locale.
        Parameters:
        theLocale - The new default locale.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0
        See Also:
        Locale

      • getDateTimeMask

        public java.lang.String getDateTimeMask()
                                 throws VWException
        Gets the date/time mask
        Returns:
        the date/time mask (in DTI format)
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setDateTimeMask

        public void setDateTimeMask(java.lang.String theDateTimeMask)
                     throws VWException
        Sets the date / time mask. This will be validated when the settings are committed to the PE server.
        Parameters:
        theDateTimeMask - this must be a valid DTI format
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setCustomFileBaseDirectory

        public void setCustomFileBaseDirectory(java.lang.String theCustomFileBaseDirectory)
        Sets the custom file base directory. This directory contains the XSL and XSD directories.
        Parameters:
        theCustomFileBaseDirectory - The custom file base directory.
        Since:
        PE 5.2.0.0
        See Also:
        VWSession.fetchFileFromServer(String, int)

      • setPOBrokerServletUrl

        public void setPOBrokerServletUrl(java.lang.String theBrokerServletUrl)
        Sets the process orchestration broker servlet URL value. This property defines the URL and port where WSDL queries and POST requests to the process orchestration framework are sent.
        Parameters:
        theBrokerServletUrl - The broker servlet URL value.
        Since:
        PE 5.2.0.0

      • setPOPublicListenerUrl

        public void setPOPublicListenerUrl(java.lang.String thePublicListenerUrl)
        Sets the process orchestration public listener URL value. This property identifies the public URL for PO references such as WSDL link, soap address. This property is optional. If this property is not defined, the base URL that the applets are dispatched from will be used (e.g. the Workplace XT base URL).
        Parameters:
        thePublicListenerUrl - The public listener URL.
        Since:
        PE 5.2.0.0
        See Also:
        VWSystemAdministration.setPOBrokerServletUrl(String)

      • getAdministratorGroupName

        public java.lang.String getAdministratorGroupName()
                                           throws VWException
        Gets the workflow system's administrator LDAP group name.
        Returns:
        The administrator group name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setAdministratorGroupName

        public void setAdministratorGroupName(java.lang.String theAdminGroupName)
                               throws VWException
        Sets the workflow system's administrator LDAP group name.
        Parameters:
        theAdminGroupName - The administrator group name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • getConfigurationGroupName

        public java.lang.String getConfigurationGroupName()
                                           throws VWException
        Gets the workflow system's configuration LDAP group name.
        Returns:
        The configuration group name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setConfigurationGroupName

        public void setConfigurationGroupName(java.lang.String theConfigGroupName)
                               throws VWException
        Sets the workflow system's configuration LDAP group name.
        Parameters:
        theConfigGroupName - The configuration group name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • getNotificationSettings

        public VWNotificationSettings getNotificationSettings()
                                               throws VWException
        Gets the VWNotificationSettings object, which contains the e-mail notification setting information used by the workflow system.
        Returns:
        the VWNotificationSettings object.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • getRulesListenerHostName

        public java.lang.String getRulesListenerHostName()
                                          throws VWException
        Gets the host name of the server where the rules listener is running.
        Returns:
        The rules listener host name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setRulesListenerHostName

        public void setRulesListenerHostName(java.lang.String theHostName)
                              throws VWException
        Sets the host name of the server where the rules listener is running.
        Parameters:
        theHostName - The rules listener host name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • getRulesListenerPort

        public int getRulesListenerPort()
                         throws VWException
        Gets the rules listener port number.
        Returns:
        The rules listener port number.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setRulesListenerPort

        public void setRulesListenerPort(int theListenerPort)
                          throws VWException
        Sets the rules listener port number.
        Parameters:
        theListenerPort - The rules listener port number.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • getComponentMgrListenerHostName

        public java.lang.String getComponentMgrListenerHostName()
                                                 throws VWException
        Gets the host name of the server where the Component Manager v1 is running.
        Returns:
        the component manager listener host name
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setComponentMgrListenerHostName

        public void setComponentMgrListenerHostName(java.lang.String theHostName)
                                     throws VWException
        Sets the host name of the server where the Component Manager v1 is running.
        Parameters:
        theHostName - The server host name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • getComponentMgrListenerPort

        public int getComponentMgrListenerPort()
                                throws VWException
        Gets the port number of the server where the Component Manager v1 is running.
        Returns:
        The Component Manager v1 listener port.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setComponentMgrListenerPort

        public void setComponentMgrListenerPort(int theListenerPort)
                                 throws VWException
        Sets the port number of the server where the Component Manager v1 is running.
        Parameters:
        theListenerPort - The Component Manager v1 listener port.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • getServerInstanceSettingsItems

        public VWServerInstanceSettings[] getServerInstanceSettingsItems()
                                                          throws VWException
        Gets the VWServerInstanceSettings objects.
        Returns:
        An array containing the current set of VWServerInstanceSettings objects, or null if no items are found.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • getDefaultServerInstanceSettingsItem

        public VWServerInstanceSettings getDefaultServerInstanceSettingsItem()
                                                              throws VWException
        Gets the default VWServerInstanceSettings object.
        Returns:
        The default VWServerInstanceSettings object.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • getServerInstanceSettingsItem

        public VWServerInstanceSettings getServerInstanceSettingsItem(java.lang.String theInstanceName)
                                                       throws VWException
        Gets a VWServerInstanceSettings object.
        Parameters:
        theInstanceName - the name of the VWServerInstanceSettings object to retrieve.
        Returns:
        The VWServerInstanceSettings object with the given instance name, if found.
        Throws:
        VWException - Thrown if the instance name is invalid, or for various other causes.
        Since:
        PE 5.2.0.0

      • getDefaultUserNotificationFlags

        public int getDefaultUserNotificationFlags()
        Gets the number that represents all the default user notification type settings (indicated by NOTIFICATION_*) for the workflow system.
        Returns:
        An integer indicating a bitwise OR of the notification type settings.
        See Also:
        VWUserInfo

      • setDefaultUserNotificationFlags

        public void setDefaultUserNotificationFlags(int theFlags)
                                     throws VWException
        Sets the default user notification flag settings for the workflow system. New users added to the system will have these values set automatically.
        Parameters:
        theFlags - An integer indicating a bitwise OR of the desired notification types (indicated by NOTIFICATION_*).
        Throws:
        VWException - Thrown for various causes, including when the theFlags parameter is outside the range of the bitwise OR value of the notification flags. For additional details on NOTIFICATION_* flag
        See Also:
        VWUserInfo

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

      • toXML

        public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
        Deprecated. Use VWXMLConfiguration.makeXMLBlock(IVWtoXML[]).
        Appends an XML string representing this instance to the buffer specified.

        Warning: This XML string is nonextensible, and cannot be modified in any way.

        Specified by:
        toXML in interface IVWtoXML
        Parameters:
        theBuffer - A StringBuffer that will be appended with the XML content.
        Throws:
        VWException - Thrown if the specified buffer is null.
        See Also:
        VWXMLConfiguration
Skip navigation links
Process API

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