Process API

filenet.vw.api
Class VWLoggingOptionType

java.lang.Object
  extended by filenet.vw.api.VWLoggingOptionType

public final class VWLoggingOptionType
extends java.lang.Object

Use this class to set the option type for logging a message on the server. Specify one of the following values as an input for the logMessage of an Instruction Element:


Refer to the Field Detail descriptions for more information about the logging options.

The F_EventType field of an event log will contain values corresponding to the LOGGING_OPTION_TYPEs defined in this class. The constants defined here can be used with VWLogQuery to query for particular types of events in an event log.

Since:
VWWS3.10
See Also:
VWInstructionElement, VWStepElement, VWWorkObject, VWLogElement.getEventType()

Field Summary
static int LOGGING_OPTION_TYPE_USER1_MESSAGE1
          Value of 410. Specifying this option logs message 1 of user 1 on the server.
static int LOGGING_OPTION_TYPE_USER1_MESSAGE2
          Value of 420. Specifying this option logs message 2 of user 1 on the server.
static int LOGGING_OPTION_TYPE_USER1_MESSAGE3
          Value of 430. Specifying this option logs message 3 of user 1 on the server.
static int LOGGING_OPTION_TYPE_USER1_MESSAGE4
          Value of 440. Specifying this option logs message 4 of user 1 on the server.
static int LOGGING_OPTION_TYPE_USER2_MESSAGE1
          Value of 450. Specifying this option logs message 1 of user 2 on the server.
static int LOGGING_OPTION_TYPE_USER2_MESSAGE2
          Value of 460. Specifying this option logs message 2 of user 2 on the server.
static int LOGGING_OPTION_TYPE_USER2_MESSAGE3
          Value of 470. Specifying this option logs message 3 of user 2 on the server.
static int LOGGING_OPTION_TYPE_USER2_MESSAGE4
          Value of 480. Specifying this option logs message 4 of user 2 on the server.
static int LOGGING_OPTION_TYPE_VW_VWEndCleanRepository
          Value of 290. Clean repository finished.
static int LOGGING_OPTION_TYPE_VW_VWEndFullInitialize
          Value of 330. Full initialize finished.
static int LOGGING_OPTION_TYPE_VW_VWEndInitRegion
          Value of 310. Initialize region finished.
static int LOGGING_OPTION_TYPE_VW_VWEndTransfer
          Value of 270. Transfer finished
static int LOGGING_OPTION_TYPE_VW_VWLogVectorChanged
          Value of 230. The flags that control logging were changed.
static int LOGGING_OPTION_TYPE_VW_VWNewConfigMsg
          Value of 265. New or modified workflow roster, work queue, or event log information was saved to the workflow database.
static int LOGGING_OPTION_TYPE_VW_VWNewWorkClassMsg
          Value of 266. New or modified workflow definition was saved to the workflow database.
static int LOGGING_OPTION_TYPE_VW_VWRemoveDatabase
          Value of 340. Database was removed.
static int LOGGING_OPTION_TYPE_VW_VWStartCleanRepository
          Value of 280. Clean repository started.
static int LOGGING_OPTION_TYPE_VW_VWStartFullInitialize
          Value of 320. Full initialize started.
static int LOGGING_OPTION_TYPE_VW_VWStartInitRegion
          Value of 300. Initialize region started.
static int LOGGING_OPTION_TYPE_VW_VWStartTransfer
          Value of 260. Transfer started
static int LOGGING_OPTION_TYPE_VW_VWUserLogin
          Value of 240. User logged in.
static int LOGGING_OPTION_TYPE_VW_VWUserLogout
          Value of 250. User logged out.
static int LOGGING_OPTION_TYPE_VW_WFTerminationMsg
          Value of 165. Workflow (process) terminated.
static int LOGGING_OPTION_TYPE_VW_WOChildCreation
          Value of 130. Work item.
static int LOGGING_OPTION_TYPE_VW_WOChildTermination
          Value of 150. Work item.
static int LOGGING_OPTION_TYPE_VW_WOCompleteSysStepMsg
          Value of 510. Work item, System step is complete
static int LOGGING_OPTION_TYPE_VW_WODeadline
          Value of 172. Work item.
static int LOGGING_OPTION_TYPE_VW_WOEmptyStepMsg
          Value of 500. Work item, Empty step (no queue, no participants) is complete.
static int LOGGING_OPTION_TYPE_VW_WOEvaluateRuleSet
          Value of 115. Work item.
static int LOGGING_OPTION_TYPE_VW_WOException
          Value of 170. Work item.
static int LOGGING_OPTION_TYPE_VW_WOForcedToDelete
          Value of 200. Work item is forced to delete
static int LOGGING_OPTION_TYPE_VW_WOForcedToSkipInstruction
          Value of 180. Work item is forced to skip an instruction
static int LOGGING_OPTION_TYPE_VW_WOForcedToTerminate
          Value of 190. Work item is forced to terminate.
static int LOGGING_OPTION_TYPE_VW_WOMilestoneMsg
          Value of 125. Work item.
static int LOGGING_OPTION_TYPE_VW_WOMovedToServer
          Value of 110. Work item moved from one server to another during normal processing in a multiserver environment.
static int LOGGING_OPTION_TYPE_VW_WONameChanged
          Value of 120. Work item's name is changed.
static int LOGGING_OPTION_TYPE_VW_WOParentCreation
          Value of 140. Work item.
static int LOGGING_OPTION_TYPE_VW_WOParentTermination
          Value of 160. Work item.
static int LOGGING_OPTION_TYPE_VW_WOReminder
          Value of 174. Work item.
static int LOGGING_OPTION_TYPE_VW_WOSystemOperation
          Value of 100. Work item.
static int LOGGING_OPTION_TYPE_VW_WPBeginService
          Value of 350. Step processor or user locks a work item.
static int LOGGING_OPTION_TYPE_VW_WPCheckPoint
          Value of 400. Queue.
static int LOGGING_OPTION_TYPE_VW_WPEndServiceAbnormal
          Value of 370. Queue.
static int LOGGING_OPTION_TYPE_VW_WPEndServiceAbort
          Value of 390. Queue.
static int LOGGING_OPTION_TYPE_VW_WPEndServiceNormal
          Value of 360. Work item is updated and dispatched to the next queue.
static int LOGGING_OPTION_TYPE_VW_WPEndServiceRelease
          Value of 380. Queue.
static int LOGGING_OPTION_TYPE_VW_WPEndServiceReleaseDelegate
          Value of 382. Queue.
static int LOGGING_OPTION_TYPE_VW_WPEndServiceReleaseReassign
          Value of 384. Queue.
static int LOGGING_OPTION_TYPE_VW_WPEndServiceReleaseReturn
          Value of 386. Queue.
static int LOGGING_OPTION_TYPE_VW_WPExitingInstrSheet
          Value of 405. Queue.
static int LOGGING_OPTION_TYPE_VW_WPReturnInstrSheetMsg
          Value of 407. Queue.
static int LOGGING_OPTION_TYPE_VW_WPWOBSaveWithLock
          Value of 365. Work item is saved locked.
static int LOGGING_OPTION_TYPE_VW_WPWorkObjectQueued
          Value of 352. Work object entered a queue.
 
Constructor Summary
VWLoggingOptionType()
           
 
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.
static java.lang.String getLocalizedString(int loggingEventType)
          Gets a localized String representation of the logging option type.
static boolean isUserLoggingOption(int loggingOptionType)
          Determines whether or not the logging option type is one of the available user log message types.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOGGING_OPTION_TYPE_VW_WOSystemOperation

public static final int LOGGING_OPTION_TYPE_VW_WOSystemOperation
Value of 100. Work item. Work item end system operation, (system operation executed, for example - an assignment or a deplay operation)

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOMovedToServer

public static final int LOGGING_OPTION_TYPE_VW_WOMovedToServer
Value of 110. Work item moved from one server to another during normal processing in a multiserver environment.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOEvaluateRuleSet

public static final int LOGGING_OPTION_TYPE_VW_WOEvaluateRuleSet
Value of 115. Work item. Ruleset evaluated.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WONameChanged

public static final int LOGGING_OPTION_TYPE_VW_WONameChanged
Value of 120. Work item's name is changed.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOMilestoneMsg

public static final int LOGGING_OPTION_TYPE_VW_WOMilestoneMsg
Value of 125. Work item. Milestone reached.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOChildCreation

public static final int LOGGING_OPTION_TYPE_VW_WOChildCreation
Value of 130. Work item. Child work object created.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOParentCreation

public static final int LOGGING_OPTION_TYPE_VW_WOParentCreation
Value of 140. Work item. Parent work object created.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOChildTermination

public static final int LOGGING_OPTION_TYPE_VW_WOChildTermination
Value of 150. Work item. Child work object terminated.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOParentTermination

public static final int LOGGING_OPTION_TYPE_VW_WOParentTermination
Value of 160. Work item. Parent work object terminated.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WFTerminationMsg

public static final int LOGGING_OPTION_TYPE_VW_WFTerminationMsg
Value of 165. Workflow (process) terminated.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOException

public static final int LOGGING_OPTION_TYPE_VW_WOException
Value of 170. Work item. Exception occurred.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WODeadline

public static final int LOGGING_OPTION_TYPE_VW_WODeadline
Value of 172. Work item. Deadline expired.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOReminder

public static final int LOGGING_OPTION_TYPE_VW_WOReminder
Value of 174. Work item. Reminder occurred.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOForcedToSkipInstruction

public static final int LOGGING_OPTION_TYPE_VW_WOForcedToSkipInstruction
Value of 180. Work item is forced to skip an instruction

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOForcedToTerminate

public static final int LOGGING_OPTION_TYPE_VW_WOForcedToTerminate
Value of 190. Work item is forced to terminate.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOForcedToDelete

public static final int LOGGING_OPTION_TYPE_VW_WOForcedToDelete
Value of 200. Work item is forced to delete

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWLogVectorChanged

public static final int LOGGING_OPTION_TYPE_VW_VWLogVectorChanged
Value of 230. The flags that control logging were changed.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWUserLogin

public static final int LOGGING_OPTION_TYPE_VW_VWUserLogin
Value of 240. User logged in.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWUserLogout

public static final int LOGGING_OPTION_TYPE_VW_VWUserLogout
Value of 250. User logged out.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWStartTransfer

public static final int LOGGING_OPTION_TYPE_VW_VWStartTransfer
Value of 260. Transfer started

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWNewConfigMsg

public static final int LOGGING_OPTION_TYPE_VW_VWNewConfigMsg
Value of 265. New or modified workflow roster, work queue, or event log information was saved to the workflow database. This process occurs, for example, when you commit changes in the Process Configuration Console.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWNewWorkClassMsg

public static final int LOGGING_OPTION_TYPE_VW_VWNewWorkClassMsg
Value of 266. New or modified workflow definition was saved to the workflow database. This process occurs when you transfer or launch a workflow from the Process Designer.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWEndTransfer

public static final int LOGGING_OPTION_TYPE_VW_VWEndTransfer
Value of 270. Transfer finished

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWStartCleanRepository

public static final int LOGGING_OPTION_TYPE_VW_VWStartCleanRepository
Value of 280. Clean repository started.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWEndCleanRepository

public static final int LOGGING_OPTION_TYPE_VW_VWEndCleanRepository
Value of 290. Clean repository finished.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWStartInitRegion

public static final int LOGGING_OPTION_TYPE_VW_VWStartInitRegion
Value of 300. Initialize region started.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWEndInitRegion

public static final int LOGGING_OPTION_TYPE_VW_VWEndInitRegion
Value of 310. Initialize region finished.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWStartFullInitialize

public static final int LOGGING_OPTION_TYPE_VW_VWStartFullInitialize
Value of 320. Full initialize started.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWEndFullInitialize

public static final int LOGGING_OPTION_TYPE_VW_VWEndFullInitialize
Value of 330. Full initialize finished.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_VWRemoveDatabase

public static final int LOGGING_OPTION_TYPE_VW_VWRemoveDatabase
Value of 340. Database was removed.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPBeginService

public static final int LOGGING_OPTION_TYPE_VW_WPBeginService
Value of 350. Step processor or user locks a work item.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPWorkObjectQueued

public static final int LOGGING_OPTION_TYPE_VW_WPWorkObjectQueued
Value of 352. Work object entered a queue.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPEndServiceNormal

public static final int LOGGING_OPTION_TYPE_VW_WPEndServiceNormal
Value of 360. Work item is updated and dispatched to the next queue.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPWOBSaveWithLock

public static final int LOGGING_OPTION_TYPE_VW_WPWOBSaveWithLock
Value of 365. Work item is saved locked.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPEndServiceAbnormal

public static final int LOGGING_OPTION_TYPE_VW_WPEndServiceAbnormal
Value of 370. Queue. Work item processing ends abnormally.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPEndServiceRelease

public static final int LOGGING_OPTION_TYPE_VW_WPEndServiceRelease
Value of 380. Queue. Work item is updated and unlocked in the same queue.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPEndServiceReleaseDelegate

public static final int LOGGING_OPTION_TYPE_VW_WPEndServiceReleaseDelegate
Value of 382. Queue. Work item is delegated to another user.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPEndServiceReleaseReassign

public static final int LOGGING_OPTION_TYPE_VW_WPEndServiceReleaseReassign
Value of 384. Queue. Work item is reassigned to another user.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPEndServiceReleaseReturn

public static final int LOGGING_OPTION_TYPE_VW_WPEndServiceReleaseReturn
Value of 386. Queue. Work item is returned to a user following delegation.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPEndServiceAbort

public static final int LOGGING_OPTION_TYPE_VW_WPEndServiceAbort
Value of 390. Queue. Work item end user operation abort

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPCheckPoint

public static final int LOGGING_OPTION_TYPE_VW_WPCheckPoint
Value of 400. Queue. Checkpoint occurs during the processing of a work item.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPExitingInstrSheet

public static final int LOGGING_OPTION_TYPE_VW_WPExitingInstrSheet
Value of 405. Queue. Timer or an API doCall occurs

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WPReturnInstrSheetMsg

public static final int LOGGING_OPTION_TYPE_VW_WPReturnInstrSheetMsg
Value of 407. Queue. Submap step is complete and processing returns to the caller step

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_USER1_MESSAGE1

public static final int LOGGING_OPTION_TYPE_USER1_MESSAGE1
Value of 410. Specifying this option logs message 1 of user 1 on the server.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_USER1_MESSAGE2

public static final int LOGGING_OPTION_TYPE_USER1_MESSAGE2
Value of 420. Specifying this option logs message 2 of user 1 on the server.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_USER1_MESSAGE3

public static final int LOGGING_OPTION_TYPE_USER1_MESSAGE3
Value of 430. Specifying this option logs message 3 of user 1 on the server.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_USER1_MESSAGE4

public static final int LOGGING_OPTION_TYPE_USER1_MESSAGE4
Value of 440. Specifying this option logs message 4 of user 1 on the server.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_USER2_MESSAGE1

public static final int LOGGING_OPTION_TYPE_USER2_MESSAGE1
Value of 450. Specifying this option logs message 1 of user 2 on the server.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_USER2_MESSAGE2

public static final int LOGGING_OPTION_TYPE_USER2_MESSAGE2
Value of 460. Specifying this option logs message 2 of user 2 on the server.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_USER2_MESSAGE3

public static final int LOGGING_OPTION_TYPE_USER2_MESSAGE3
Value of 470. Specifying this option logs message 3 of user 2 on the server.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_USER2_MESSAGE4

public static final int LOGGING_OPTION_TYPE_USER2_MESSAGE4
Value of 480. Specifying this option logs message 4 of user 2 on the server.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOEmptyStepMsg

public static final int LOGGING_OPTION_TYPE_VW_WOEmptyStepMsg
Value of 500. Work item, Empty step (no queue, no participants) is complete.

See Also:
Constant Field Values

LOGGING_OPTION_TYPE_VW_WOCompleteSysStepMsg

public static final int LOGGING_OPTION_TYPE_VW_WOCompleteSysStepMsg
Value of 510. Work item, System step is complete

See Also:
Constant Field Values
Constructor Detail

VWLoggingOptionType

public VWLoggingOptionType()
Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


isUserLoggingOption

public static boolean isUserLoggingOption(int loggingOptionType)
Determines whether or not the logging option type is one of the available user log message types. (LOGGING_OPTION_TYPE_USER1_MESSAGE1 through LOGGING_OPTION_TYPE_USER2_MESSAGE4).

Parameters:
loggingOptionType - An integer value associated with the logging option type being validated.
Returns:
A Boolean value. The method returns true if the value specified in the loggingOptionType parameter is valid; otherwise, the method returns false.

getLocalizedString

public static java.lang.String getLocalizedString(int loggingEventType)
                                           throws VWException
Gets a localized String representation of the logging option type.

Parameters:
loggingEventType - An integer value for the logging event type.
Returns:
The localized string representation of the logging event type. If the specified loggingEventType parameter is not a recognized logging event value, the method returns an UnknownEvent message string.
Throws:
VWException - Thrown for low-level system errors.
See Also:
VWLogElement.getEventType()

Process API

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