Open topic with navigation

TIBCO iProcess® Engine 11.9.1

# Alphabetical List of Process Attributes

The following table describes the available process attributes.

Note: Process attributes that are used by the `DIRECTOR` process are not listed in this table. See TIBCO iProcess Objects Director Administrator’s Guide for more information about attributes that are used by the `DIRECTOR` process.

Attribute | Description
AUDIT_CASEDATA_CHANGED | Defines whether or not to log the case data changes in the audit trail when these changes are made by iProcess Insight, iProcess Workspace (Browser), or the `setCaseData` TIBCO iProcess Server Objects interface, rather than by normal step processing.
AUDIT_OPENKEEP | Controls whether the Open Work Item and Keep Work Item audit trail entries are enabled.
AUTO_PURGE_DELAY | Defines the number of days to delay the auto-purge operation.
BG_LEAVER_DESTINATION | Defines the destination queue to which work items are redirected when the owner of the work items has been deleted.
BG_LEAVER_SUPER_AS_DEST | Defines the redirect location of work items for a currently deleted user.
BG_MAX_ACTIONS_PER_TRANS | Defines the limit of actions per workflow transaction.
CCOUNT_CACHE_REFRESH | Enables you to define the refresh period for updating the cached list of cases currently on the system.
CHECK_EAIWITHDRAW_ONPURGE | Defines whether or not iProcess checks if any outstanding delayed-release EAI steps have been successfully withdrawn before committing the purge transaction.
CHECKFREQ | Defines the number of loops to process before the background process checks for `sw_error.log` files, which are located in the `SWDIR``\logs` directory and available disk space.
CNUM_SEQ_CACHE | Defines the number of case numbers to be cached.
CSTART_AUTO_REFRESH | Defines whether or not the list of available procedures in the TIBCO iProcess Workspace’s Case Start dialog is automatically refreshed.
DBGMEMSIZE_KB | Defines the size of the shared memory segment (in Kb) that should be allocated for shared memory debug logs.
DBQD_MAX_CACHED_MESSAGES | Defines the number of messages that are cached by the `DBQD` process when it requests a block of messages from a database message queue.
DBQD_MAX_FIL_SESSIONS | Defines the number of concurrent threads that the `DBQD` process uses to process RPC requests for messages from its cache from `BG` or `WISMBD` processes.
DEF_MAJOR_VERS | Defines the default major version number that TIBCO iProcess Modeler will use when a new procedure is saved.
DEF_MINOR_VERS | Defines the default minor version number that TIBCO iProcess Modeler will use when a new procedure is saved.
DEPLOY_XSL_OUT_ENCODING | Defines the character set to be used for output encoding.
DISABLE_CASE_COUNTING | Defines whether case counts are displayed for procedures in the Live (Dead) Cases column of the Case Administrator dialog box, when a user starts iProcess Administrator from iProcess Workspace (Windows).
DISABLE_USER_CHECK | Defines whether or not a new user name is validated as an O/S user account when you add an iProcess user from the User Manager tool of TIBCO iProcess Administrator.
DISABLE_USER_LIST | Defines whether or not the Possible iProcess User List button is displayed in the User Manager tool of TIBCO iProcess Administrator.
DMD_PROCESS_INTERVAL | Defines the times during the day when the Deadline Manager checks the iProcess database for expired deadlines.
EAI_NEEDS_MSDTC | Defines the EAI server plug-ins that need to use the Microsoft Distributed Transaction Coordinator (MSDTC).
EAI_STEP_TIMEOUT | Defines a time threshold (in milliseconds) for the duration of processing an EAI step.
EMPTYMBOXSLEEP | Defines how long the Mbox Daemons will remain idle when all Mbox queues in the Mbox set are empty.
EMPTYMBOXSLEEP_INC | Defines the number of seconds to increment the EMPTYMBOXSLEEP value by when a `BG` or `WISMBD` process requests a message from an empty Mbox.
EMPTYMBOXSLEEP_MAX | Defines the maximum value (in seconds) that EMPTYMBOXSLEEP can be set to.
ENABLE_CASE_PREDICTION | Defines whether or not background case prediction is enabled on the node. Note: This attribute does not affect on live case prediction or case simulation.
ENABLE_JMX_LISTENER | Enables the JMX server that is loaded into RPC_TCP_LI to allow the existing clients to connect to the iProcess Engine. Note: This attribute is effective only after you restart the iProcess Engine.
EXACT_OPERATION_TIMESTAMP | Defines whether the `audit_date` timestamp, which is written in the `audit_trail` table, records when the user operates a specified instruction or when the `BG` processes a specified instruction.
FIL_PROCDEF_CACHE_SIZE | Defines the maximum number of procedure definitions that can be cached in memory by the `BG`, `WIS` and `SPO` processes.
FORCE_DEADLINE_PRIORITY | Defines a priority value for case deadlines that override all other priorities set for case deadlines.
FREE_WIS_SESSION | Defines whether the WIS session, which is used to retrieve work items, should be freed up in the WIS memory or not after the lock, keep, forward, release, undo, or unlock operation.
IAPJMS_LANGUAGE | Defines the character set to be used for output encoding for messages published to the `IAPJMS` process from the `BG` or `WIS` process.
IAPJMS_PORTNO | Defines the port number that is used for message communications between the `BG` process and the IAPJMS library.
IAPJMS_PUBLISH | Defines whether or not the `BG` process is enabled to publish audit activities to the `IAPJMS` process.
IAPJMS_ROLLBACK | Defines whether or not failed message transactions should be rolled back.
IAPJMS_SIMPLETOPIC | Defines whether or not the JMS topic name is static or dynamically configured at run-time.
IAPJMS_SYNCHRONOUS | Defines whether message delivery is synchronous or asynchronous.
IAPJMS_TIMEOUT | Defines how long the `IAPJMS` process should wait before it times out if there is a network error.
IAPJMS_TOPICNAME | Defines the topic name for the JMS destination if activity monitoring is enabled.
IGNORE_PACK_CHANGED | Defines whether users may keep or release work items even if pack data has changed.
IQL_RETRY_COUNT | Defines how many times a failed message in a message queue is retried before being moved to the exception queue.
IQL_RETRY_DELAY | Defines the delay (in seconds) between each retry attempt for a failed message in a message queue, before the message is moved to the exception queue.
JVMPROPS | Defines the JVM attributes that should be specified for the Java Virtual Machine when it is started.
LOGON_OS_LOCATION | Defines the default location where passwords should be validated when a user attempts to log in to this iProcess Engine node.
MAINCASE_START_AUTOCOMMIT | Defines whether or not to insert a Transaction Control step automatically as the first step of all main cases.
MAX_AGE_BEFORE_RESETPOST | Defines the time limit in seconds before the Deadline Manager will re-post unprocessed deadline messages.
MAX_PREDICTION_LOOPS | Defines the maximum number of times to loop during the prediction process.
MAX_SUB_PROCEDURE_DEPTH | Determines the maximum number of nested sub-procedures supported by the server.
MBSET_DEQUEUE_TIMEOUT | Defines a time threshold (in milliseconds) for the duration of dequeuing a message from an Mbox set.
MBSET_READ_BG | Defines the unique identifier of the Mbox set to be used by a `BG` process when dequeuing messages received from a `WISMBD` process.
MBSET_READ_PREDICT | Defines the unique identifier of the Mbox set to be used by a `BGPREDICT` process when posting case changes messages to a `BG` process.
MBSET_READ_WIS | Defines the unique identifier of the Mbox set to be used by a `WISMBD` process when dequeuing messages received from a `BG` process.
MBSET_WRITE_BG | Defines the unique identifier of the Mbox set to be used by a process when writing to a `BG` process.
MBSET_WRITE_PREDICT | Defines the unique identifier of the Mbox set to be used by a `BGPREDICT` process when posting case changes messages to a `BG` process.
MBSET_WRITE_WIS | Defines the unique identifier of the Mbox set (as defined in the `mbox_set` table) to be used by the `BG` process when writing to a `WISMBD` process.
MIGRATE_LIVE_CASES | Defines whether or not to migrate only live cases from previous versions to a new version when deploying from TIBCO Business Studio to TIBCO iProcess Engine.
MINFREEKB | Defines the amount of disk space (in Kilobytes) required for the background process to run.
MN_UNLOCKER | Defines who has permission to unlock the work items.
NORMALISE_CASE_DATA | Defines whether or not case data normalization is enabled.
OS_USER_LOCATIONS | Defines where iProcess Engine should obtain the list of users when it populates the Possible iProcess User List in the User Manager tool of TIBCO iProcess Administrator.
PM_AUTO_BOOT | Defines whether or not the Process Sentinels automatically start the server processes after the Process Sentinels have started.
PROC_VER_COMMENT | Defines whether or not, in TIBCO iProcess Modeler, a user has to enter a comment whenever they save a procedure.
PROC_VER_INC | Defines whether or not, in TIBCO iProcess Modeler, a procedure’s version number will be incremented whenever it is saved.
PROC_VER_NUM_INSTANCES | Defines the maximum number of instances of a procedure version.
PROCESS_AUTO_DUMPLOG | Defines whether or not, if a process fails, the Process Sentinels automatically write to disk the contents of that process’ debug shared memory segment.
PROCESS_AUTO_RESTARTS | Defines whether or not a server process will automatically restart after a failure.
PROCESS_MAX_RESTARTS | Defines the maximum number of times the Process Sentinels will attempt to restart a failed process.
PROCESS_MIN_RESTART_PERIOD | Defines time (in seconds) during which Process Sentinels suspends or restarts a failed process.
PROCESS_SLEEP | Defines the amount of time the Process Sentinels will remain idle for.
PUBLISH_SYS_EVENT_METHOD | Defines in which way you want to publish system events.
REQID_SEQ_CACHE | Defines the number of REQ IDs to be cached.
RESTART_SPO_CACHE_PROC | Determines how many of the latest versions of the procedure definition to cache when the iProcess Objects Server process restarts or quick starts.
RESTART_WIS_CACHE_THRESHOLD | Defines the number of items that must exist in a work queue for it to be cached when the `WIS` process restarts or quick starts.
RETRY_OFF_FOR_RAC | Determines whether to enable the retry function that retrieves work items from the `staffo` database table for the configured Oracle RAC.
RPC_BLOCK | Defines whether or not iProcess Workspace (Windows) can access iProcess Engine.
RPC_SVR_CONTROL | Allows the batching of RPC calls to reduce the overhead in processing RPC calls individually.
RPC_SVR_NUM_THREADS | Defines the maximum number of threads that the `WIS` and `WQS` processes can use to process RPC requests from client applications.
RPC_TIMEOUT | Defines the timeout period (in seconds) that an RPC request waits for a response from the iProcess Engine process.
SE_WORKER_PORTNO | Defines the port number that is used for message communications between the “worker” process (Process Sentinel) and the processes that audit system events if you want to publish system events using TIBCO Hawk Agent.
SEJMS_TOPICNAME | Defines the JMS topic name for the JMS destination that is used to publish system events, if publishing system events is enabled.
SHMKEY_ID | Defines the UNIX shared memory key that is allocated (using the ftok system call) when the `WQS` process is started.
SHUTDOWN_MIGRATION_MESSAGE | Defines whether or not to contain the audit trail message (with message ID `34`), which writes the information about procedure migration, in the published Monitor Event Detail message.
SPO_CACHE_PROC | Determines how many of the latest versions of the procedure definition to cache when the iProcess Objects Server process starts normally.
SPO_USERMUTEX_WAITTIME | Defines the maximum amount of time (in milliseconds) that an iProcess Objects Server process should take to acquire for a mutual exclusion lock (mutex) before processing a message if multiple SSO clients use the same user name to log in to TIBCO iProcess Engine. If the time for acquiring a user’s mutex is over the time specified by the `SPO_USERMUTEX_WAITTIME` attribute, the duration will be recorded and later reported in the `sw_warn` log.
SUBCASE_START_AUTOCOMMIT | Defines whether or not to insert a Transaction Control step automatically as the first step of all sub-cases.
SWLIB_PATH | Defines the directory where the `IAPJMS` process will look for the Java libraries that it needs.
SYSTEM_EVENT_LOGGING | Defines whether you want to audit system events after installing or upgrading to TIBCO iProcess Engine 11.9.0.
TIMEZONE | Defines the time zone that this node will operate in.
UNPROCESSED_DL_POST_LIMIT | Sets a limit on the number of unprocessed deadline messages that are posted by the Deadline Manager.
USE_NEXT_MESSAGE_TO_DEQUEUE | Defines the ways to purge vast quantities of cases in the Oracle AQs.
USE_PRIORITY_DEADLINES | Defines whether to set the priority for the case deadlines by using the value of the `SW_CP_VALUE` field if the value of the `FORCE_DEADLINE_PRIORITY` attribute is set to the default value, `0`.
WAITID_SEQ_CACHE | Defines the number of Wait IDs to be cached.
WARN_ERROR_LOG_SIZE | Defines the maximum size (in bytes) of the `sw_warn` and `sw_error` log files before the files stop logging error messages.
WINTIME_RESYNC_NOTICE | Defines the notice period (in seconds) that iProcess Engine processes are given before a resynchronization takes place.
WINTIME_RESYNC_PERIOD | Defines the interval (in seconds) at which iProcess Engine checks to see if its timestamps are in step with Windows system time.
WINTIME_RESYNC_TOLERANCE | Defines the interval (in seconds) at which iProcess Engine checks to see if its timestamps are in step with Windows system time.
WIS_CACHE_POOL_SIZE | Defines the size (in threads) of the pool of threads that is used to perform caching of work queues.
WIS_CACHE_THRESHOLD | Defines the number of items that must exist in a work queue for it to be cached when the `WIS` process starts normally.
WIS_CACHE_WAIT_TIME | Defines the maximum amount of time (in seconds) that an RPC processing thread in the `WIS` process waits for a work queue to be cached.
WIS_CDQP_DATA_RECACHE_BATCH | Defines the number of work items that the CDQP update thread will update in a single operation when updating `CDQP` field values for a `WIS` process’ queues.
WIS_CHECK_STAFFO_RETRY_COUNT | Defines the number of times the `WIS` process attempts to retrieve the unfound work items from the `staffo` database table because a delay occurred between two Oracle RAC instances. Note: This attribute is only used on configured Oracle RAC.
WIS_FILTER_THREAD_BOUNDARIES | Defines the count boundary at which a work queue will be split into multiple blocks of work for filtering purposes, based on the number of work items in the queue
WIS_FILTER_THREAD_POOL_SIZE | Defines the number of threads in the queue filtering thread pool, used to process additional blocks of filtering work
WIS_INDEX_REFRESH | Defines the interval (in seconds) after which an index on a queue will be refreshed by a `WIS` process.
WIS_LOCK_POOL_SIZES | Defines the number of locks in the internal lock pool used by the `WIS` process
WIS_NEW_ITEM_BATCH_SIZE | Defines the number of new item requests to be batched together.
WIS_QCHANGE_EXTENDED_CHECK | Defines whether or not a change in the lock status of a work item is counted as a change to the work item.
WIS_SESSION_TIMEOUT | Defines the timeout period (in seconds) after which a `WIS` process will automatically shut down, starting from the time at which it was last accessed (by a TIBCO iProcess Workspace, SAL application or TIBCO iProcess Objects Server).
WIS_SESSION_TIMEOUT_SHUTDOWN | Defines the timeout period (in seconds) after which a `WIS` process will automatically shut down, starting from the time at which iProcess Engine was shut down.
WIS_UNCACHE_PERIOD | Defines the time (in minutes) after which the cached work queue that waits to be handled by the `WIS` process is cleared from the cache, starting from the time at which the client who last accessed this work queue logs off. Note: This attribute only applies to the work queues that contain work items with count less than the count defined in the `WIS_CACHE_THESHOLD` attribute.
WIS_UPDATE_LENGTH | Defines the maximum amount of time (in seconds) that the queue update thread in the `WIS` process performs updates before going back to idle state.
WIS_UPDATE_PERIOD | Defines how often the queue update thread in the `WIS` process wakes up and updates the queues handled by the `WIS` process.
WIS_USE_PRIORITY_ESCALATION | Allows the use of priority escalation in the `WIS` process to be disabled.
WQDJMS_PORTNO | Defines the port number that is used for work queue delta messages between the `WIS` process and the `IAPJMS` process.
WQDJMS_TOPICNAME | Defines the default topic name for the JMS destination used by the `WIS` process for work queue delta publication.
WQS_GATHER_RPC_STATS | Allows the gathering of RPC call stats within the `WQS` process to be configurable.
WQS_NUM_SEARCH_SLOTS | Defines the maximum number of slots available in the SWRPCMTS multi-threaded RPC server shared library for threads to perform queue searching.
WQS_PERSIST_SHMEM | Defines how often (in seconds) the contents of the WQS/WIS shared memory are written to the `wqs_index` table in the database.
WQS_WIS_USER_COUNT | Defines the number of `WIS` processes that should be dedicated to handling user queues and group queues respectively.
XPC_READ_UNCOMMITTED | Allows configuration of uncommitted reads during an XPC SELECT.

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO iProcess® Engine

Copyright © 1994-2024. Cloud Software Group, Inc. All Rights Reserved.