Contents

What's New
Introduction to TIBCO iProcess Products
TIBCO Product Overview 1
TIBCO Product Overview 2
Understanding Product Usage
TIBCO iProcess® Engine
TIBCO iProcess® Workspace
TIBCO iProcess® Developer
TIBCO Business Studio
TIBCO ActiveMatrix BusinessWorks
TIBCO Enterprise Message Service
TIBCO Hawk
TIBCO iProcess Engine
TIBCO iProcess Objects Server
TIBCO iProcess Objects Director
TIBCO iProcess Server Objects
TIBCO iProcess Technology Plug-ins
TIBCO iProcess Web Services Plug-in
TIBCO iProcess Workspace (Browser)
TIBCO iProcess Workspace Lite
TIBCO iProcess Workspace Plug-ins
TIBCO iProcess Workspace (Windows)
TIBCO Rendezvous
Introduction to the TIBCO iProcess Engine
TIBCO iProcess Engine Architecture
The Role of the TIBCO iProcess Engine
iProcess Physical Architecture
Installing the iProcess Engine on a Single Server
Installing the iProcess Engine on a Node Cluster
TIBCO iProcess Workspace and TIBCO iProcess Engine Communication
TIBCO iProcess Engine Process Structure
Process Sentinels
Foreground Processes
Mbox Sets
Background Processes
Event Handling
Where is TIBCO iProcess Engine Case Data Stored
How Work Items Appear in Work Queues
Sending Instructions From the TIBCO iProcess Workspace to the TIBCO iProcess Engine
Mbox Sets
User Access to iProcess Engine Work Queues
24*7 TIBCO iProcess Engine Operation
The iProcess Engine and Hardware Clustering
Using the TIBCO iProcess Suite in a Multilingual Environment
Overview
Globalization Options in the iProcess Suite
Advantages of UTF-8 Encoding
Issues with UTF-8 Encoding
iProcess Names
Recommendations
Configuring the iProcess Suite Using UTF-8
TIBCO iProcess Engine
iProcess Clients
The LDAPCONF Utility
TIBCO Business Studio
iProcess Plug-ins
Globalization Support Using Native Encoding
Using iProcess Suite in a Single-Byte Native Encoding Environment
Using iProcess Suite With a Multi-Byte Character Encoding Environment
Implementing iProcess Suite in an International Environment with Native Encoding
TIBCO iProcess Engine Processes
Foreground Processes
Work Queue Server
Allocation of Work Queues to WIS Processes
RPC Pool Server
RPC Listeners
Work Item Server
WIS Mbox Daemon
Mbox Sets and Message Queues
Transaction Control of Messages
Background Processes
Background
Case Prediction Processor(s)
Database Queue Daemon
Deadline Manager
IAPJMS Process
RPC Background Process
Introduction to Transactional Business Process Automation
Overview
What is a Local Transaction?
Example of a Local Transaction
What is a Distributed Transaction?
Transaction Scope
Oracle Server Transaction Scope
DB2 Transaction Scope
SQL Server Transaction Scope
Using Distributed Transactions with MSDTC
Using Enterprise Application Integration Steps in Procedures
What is MSDTC?
Examples of Transaction Control
Case Data Updates to the SQL Server using MSDTC
External Updates Using EAI Steps
Transaction Failures and Rollbacks
Poison Transactions
iProcess Mbox Sets
Overview
What are iProcess Messages?
Definition of Mbox Sets
Configuring Mbox Sets
Transaction Management of Messages
UNIX Oracle Transaction Implementation
Windows SQL Server Transaction Implementation
UNIX DB2 Transaction Implementation
Monitoring Activities
Overview
Activity Publishing
Work Queue Delta Publication
How Messages are Processed From the BG Process to the IAPJMS Process
How Activity Messages are Processed From the IAPJMS Process to the External Application
How Messages are Processed From the WIS Process to the IAPJMS Process
How Work Queue Delta Messages are Processed From the IAPJMS Process to the External Application
Understanding the Message Types
IAP Message Types
WQD Message Types
Database Failure and Failover
Overview
TIBCO iProcess Engine Behavior
TIBCO iProcess Workspace Behavior
iProcess Objects and iProcess Server Objects Behavior
TIBCO iProcess Engine Configuration Requirements
Oracle (Windows, UNIX or Linux)
SQL Server and DB2 (UNIX or Linux)
Process Management
Responsibilities of the Process Sentinels
Distribution and Hierarchy of Process Sentinels
Master and Slave Responsibilities
How Processes are Controlled by the Process Sentinels
Starting the TIBCO iProcess Engine Processes
Determining Where Processes Run
Restarting Failed Processes
Restarting Failed Process Sentinels
Shutting Down Processes
Configuring the Process Sentinels
Network Communication
TIBCO iProcess Workspace and TIBCO iProcess Engine Network Communication
Function of a Portmapper
The TIBCO iProcess Engine RPC Service
TCP/IP
TIBCO iProcess Engine to TIBCO iProcess Engine Network Communication in a Node Cluster
Using the TIBCO iProcess Engine in a Firewalled Environment
What is a Firewall?
iProcess RPC and Firewall Access
Port/RPC Number Resource Logging
Using Oracle Events Through a Firewall
Using JMX Through a Firewall
Controlling the iProcess Engine
Starting iProcess Engine
Windows Version
UNIX Version
Stopping iProcess Engine
Windows Version
UNIX Version
Forcing the iProcess Engine to Shutdown
Configuring iProcess Engine Events Server
Configuring iProcess Engine Time Zone
Setting the Time Zone
Error Handling
Using the iProcess Engine Configuration Files
SWDIR\swdefs
SWDIR\etc\language.lng\staffico
File Format
Tools Entry Format
SWDIR\etc\staffpms
Specifying if Client Passwords are Required on Login
Enabling Multiple Logins
Specifying the Working Week
Changing the Date Format Using the staffpms File
Setting Database Connection Options
Controlling Access to the iProcess Engine (for UNIX)
Specifying How iProcess Validates Users
Configuring Signals That Threads are Blocked From Receiving
Enabling UTF-8
Configuring Log Files Directory
SWDIR\etc\sqloptim
SWDIR\etc\language.lng\audit.mes
SWDIR\etc\language.lng\auditusr.mes
SWDIR\etc\language.lng\stafferr.mes
SWDIR\etc\language.lng\staffw.mes
Changing the Long Date Format
SWDIR\etc\language.lng\staff.mes
Changing the Long Date Format
SWDIR\etc\swerwarn.mes
Tuning the iProcess Engine Using SWDIR\etc\staffcfg Parameters
Editing the SWDIR\etc\staffcfg File
SWDIR\etc\staffcfg File Format
Using Multiple Copies of SWDIR\etc\staffcfg
SWDIR\etc\staffcfg Parameters
WQS Section
WQS_DEFAULTPRIORITY
WQS_URGENTPRIORITY
WQS_ROUND_ROBIN
WIS_MAXFILEDESC
WQS_QUEUE_WEIGHTING
WQS_SHARED_MEMORY_QUEUES
WIS_AGE_USE_WORKING_DAYS
FORM Section
MAX_SCRIPT_CALL_DEPTH
MAXVLD
STAFFPRO Section
LDAP_DIT
LDAP_POOL_SIZE
MODTIME_PERM
PROCDEF_CACHESIZE
LID_CLIENT_TIMEOUT
RESEND_ORIGINAL_TIMESTAMP
LAST_MODIFIED_TIME
STAFF Section
UIDCRPERIOD
RPCSVR_TIMEOUT
PWD_PERIOD
START_TX_RX
RPCXFRSIZE
MAX_USERS_PER_PROCESS
PRE_LOAD_POOL_SERVERS
USER_LOAD_ALLOCATION
WQ_SORT_ITEM
DYNDEADPRED
IAPSCHEMA
IAPSCHEMA2_1
DBSIZES Section
MEMOATTMAX
DBPOOL Section
POOLSIZE
POOLGROWSIZE
MAXPOOLSIZE
POOLCONNTIMEOUT
CDQP Section
CDQPMAXGLOBAL
CDQPMAXQUEUE
NETWORK Section
IPPROTOCOL
Obsolete Parameters
Administering Servers
Show all Server Details
Update Server Details
Add a Server
Remove a Server
Find a Server’s Details
Find the Master Server
Define a Server as the Master Server
Move Processes From One Server to Another
Administering iProcess Engine Server Processes
Introduction
Server Processes
Sequence Number Caching
Using SWDIR\util\swadm to Administer Server Processes
Show Server Processes
Run a New Process
Disable a Process
Enable a Process
Delete a Process
Test Events
Using SWDIR\util\swsvrmgr to Administer Server Processes
View Process Status
Issue a Start-up Event
Issue a Start New Event
Issue a Restart Event
Issue a Shutdown Event
Issue a Pause or Unpause Event
Write a Shared Memory Debug Log File to Disk
Resynchronize Timestamps with Windows Time
Administering Process Attributes
Using SWDIR\util\swadm to Administer Process Attributes
Display All Process Attributes
Set a Process Attribute
Delete a Process Attribute
Alphabetical List of Process Attributes
General iProcess Engine Configuration
DBGMEMSIZE_KB
DEPLOY_XSL_OUT_ENCODING
EAI_NEEDS_MSDTC
ENABLE_JMX_LISTENER
EXACT_OPERATION_TIMESTAMP
FREE_WIS_SESSION
LDAP_UV
LOGON_OS_LOCATION
MIGRATE_LIVE_CASES
NORMALISE_CASE_DATA
RPC_TIMEOUT
SPO_USERMUTEX_WAITTIME
TIMEZONE
WARN_ERROR_LOG_SIZE
WINTIME_RESYNC_NOTICE
WINTIME_RESYNC_PERIOD
WINTIME_RESYNC_TOLERANCE
XPC_READ_UNCOMMITTED
Process Management Configuration
BG_LEAVER_DESTINATION
BG_LEAVER_SUPER_AS_DEST
CHECKFREQ
DMD_PROCESS_INTERVAL
FORCE_DEADLINE_PRIORITY
MAINCASE_START_AUTOCOMMIT
MAX_AGE_BEFORE_RESETPOST
MINFREEKB
MN_UNLOCKER
PM_AUTO_BOOT
PROCESS_AUTO_DUMPLOG
PROCESS_AUTO_RESTARTS
PROCESS_MAX_RESTARTS
PROCESS_MIN_RESTART_PERIOD
PROCESS_SLEEP
SUBCASE_START_AUTOCOMMIT
UNPROCESSED_DL_POST_LIMIT
USE_PRIORITY_DEADLINES
WIS and WQS Process Configuration
AUDIT_OPENKEEP
CCOUNT_CACHE_REFRESH
AUDIT_OPENKEEP
IGNORE_PACK_CHANGED
RESTART_WIS_CACHE_THRESHOLD
RETRY_OFF_FOR_RAC
RPC_SVR_CONTROL
RPC_SVR_NUM_THREADS
SHMKEY_ID
WIS_CACHE_POOL_SIZE
WIS_CACHE_THRESHOLD
WIS_CACHE_WAIT_TIME
WIS_CDQP_DATA_RECACHE_BATCH
WIS_CHECK_STAFFO_RETRY_COUNT
WIS_FILTER_THREAD_BOUNDARIES
WIS_FILTER_THREAD_POOL_SIZE
WIS_INDEX_REFRESH
WIS_LOCK_POOL_SIZES
WIS_NEW_ITEM_BATCH_SIZE
WIS_QCHANGE_EXTENDED_CHECK
WIS_SESSION_TIMEOUT
WIS_SESSION_TIMEOUT_SHUTDOWN
WIS_UNCACHE_PERIOD
WIS_UPDATE_LENGTH
WIS_UPDATE_PERIOD
WIS_USE_PRIORITY_ESCALATION
WQS_GATHER_RPC_STATS
WQS_NUM_SEARCH_SLOTS
WQS_PERSIST_SHMEM
WQS_SESSION_TIMEOUT
WQS_WIS_USER_COUNT
Message and Mbox Processing Configuration
DBQD_MAX_CACHED_MESSAGES
DBQD_MAX_FIL_SESSIONS
EMPTYMBOXSLEEP
EMPTYMBOXSLEEP_INC
EMPTYMBOXSLEEP_MAX
IQL_RETRY_COUNT
IQL_RETRY_DELAY
MBSET_DEQUEUE_TIMEOUT
MBSET_READ_BG
MBSET_READ_PREDICT
MBSET_READ_WIS
MBSET_WRITE_BG
MBSET_WRITE_PREDICT
MBSET_WRITE_WIS
THRESHOLD_FAIL_TIMES_TO_REPORT_IQL_MESSAGE
USE_NEXT_MESSAGE_TO_DEQUEUE
Sequence Numbering Configuration
CNUM_SEQ_CACHE
REQID_SEQ_CACHE
WAITID_SEQ_CACHE
Transaction Control Configuration
BG_MAX_ACTIONS_PER_TRANS
CHECK_EAIWITHDRAW_ONPURGE
EAI_STEP_TIMEOUT
Activity Monitoring and Work Queue Delta Configuration
AUDIT_CASEDATA_CHANGED
IAPJMS_LANGUAGE
IAPJMS_PORTNO
IAPJMS_PUBLISH
IAPJMS_ROLLBACK
IAPJMS_SYNCHRONOUS
IAPJMS_TIMEOUT
IAPJMS_TOPICNAME
IAPJMS_SIMPLETOPIC
JVMPROPS
PUBLISH_SYS_EVENT_METHOD
SE_WORKER_PORTNO
SEJMS_TOPICNAME
SHUTDOWN_MIGRATION_MESSAGE
SWLIB_PATH
SYSTEM_EVENT_LOGGING
WQDJMS_PORTNO
WQDJMS_TOPICNAME
Case Prediction Configuration
ENABLE_CASE_PREDICTION
MAX_PREDICTION_LOOPS
TIBCO iProcess Workspace (Windows) Configuration
CSTART_AUTO_REFRESH
DISABLE_CASE_COUNTING
DISABLE_USER_CHECK
DISABLE_USER_LIST
OS_USER_LOCATIONS
RPC_BLOCK
Procedure Configuration
AUTO_PURGE_DELAY
DEF_MAJOR_VERS
DEF_MINOR_VERS
FIL_PROCDEF_CACHE_SIZE
MAX_SUB_PROCEDURE_DEPTH
RESTART_SPO_CACHE_PROC
PROC_VER_COMMENT
PROC_VER_INC
PROC_VER_NUM_INSTANCES
SPO_CACHE_PROC
iProcess Objects Director
Administering Message Queues and Mbox Sets
Introduction
Using SWDIR\util\swadm to Administer Mbox Sets, Message Queues, and Messages
Show Mbox Sets
Add an Mbox Set
Add a Message Queue to an Mbox Set
Delete a Message Queue From an Mbox Set
Rename an Mbox Set
Delete an Mbox Set
Show Message Queues
Add a Message Queue
Update a Message Queue
Delete a Message Queue
Show Messages in a Queue
Count Messages in a Queue
Show Details of a Message
Restore Dead Messages to a Queue
Delete Messages From a Queue
Default Message Handling Configuration
Default Mbox Sets
Default Message Queues
How WIS Processes Send Messages to BG Processes
How non-WIS Processes Send Messages to BG Processes
How BG Processes Send Messages to WIS Processes
How BG Processes Send Messages to the Prediction Process
Administering Procedure Objects
Show Procedures and Libraries
Output
Errors
Examples
Tidy Instances of Procedures
Administering Firewall Port Ranges
Overview
Using Port Ranges with a Node Cluster
How Port Range Information is Stored
How to Set up and use a Port Range
Port Range swadm Commands
ADD_RANGE
DEL_RANGE
MOD_RANGE
SET_RANGE
SHOW_PORTS
SHOW_RANGES
ADD_AQ_PORT_RANGE
MOD_AQ_PORT_RANGE
DEL_AQ_PORT_RANGE
iProcess Engine Metrics
Using SWDIR\util\swadm to Query iProcess Engine Metrics
Output (-o)
Start Time (-s) and End Time (-e)
Latest Entries (-l)
Export to CSV (-w)
Administering Activity Monitoring and Work Queue Delta Publication
Overview
Enabling Activity Monitoring
Filtering Message Event Request (MER) Messages
Configuring the iProcess Activity Publication (IAP) Configuration Files
Configuring the IAP JMS Properties File
Configuring the IAPJMS Classpath File
Updating the IAP Security Principle and Credentials
Resetting the User Name and Password
Deleting the User Name and Password
Testing the Password
Using SWDIR\util\swadm to Administer Work Queue Delta Publication
List Subscriptions
Clear Subscriptions
Administering System Events
Configuring System Events Information
Removing System Events Information from the iProcess Database
Administering the Work Queue Server and Work Item Server Processes
Overview
The WQS Process
Configuring WQS RPC Request Processing
Configuring the Assignment of Queues to WIS Processes
Configuring When the WQS/WIS Shared Memory is Written to the Database
The WIS Process
Monitoring the WIS Processes
Configuring WIS RPC Request Processing
Configuring How Work Queues are Filtered
Configuring Queue Updates
Configuring When WIS Processes Cache Their Queues
Configuring CDQP Updates
Troubleshooting Work Queues
Administering Case Data Normalization
Overview
Enabling Case Data Normalization
Using the Case Data Normalization Utility
Managing EAI Step Server Plug-ins
Overview
Register/Re-register (upgrade) an EAI Plug-In
Unregister (Remove) an EAI Plug-In
Modify an Existing EAI Plug-In Entry
List Existing EAI Plug-In Registry Entries
Reload an EAI Plug-in
Get Release Version Stored in EAI Plug-In
Possible Errors When Using sweaireg
Administering Global Variables
Using SWDIR\util\swadm to Administer Global Variables
Display Global Variables
Add or Update a Global Variable
Delete a Global Variable
Import All Global Variables
Export All Global Variables
Enabling ASLR
Export and Import iProcess Configuration
Administering Security in iProcess Engine
iProcess Engine Log Files
System Backup Guidelines
Backup and Recovery of iProcess Case Data
Backup and Recovery of iProcess Engine Configuration Files
iProcess Engine Directory Structure
Understanding Audit Trails
Using the plist Utility to Obtain Information About TIBCO iProcess Engine Facilities
Overview of the plist Utility
Node Information
Procedure Information
Installed and Uninstalled Table Information
Role Information
Long Term Locked Item Information
Mail Item Information
User Information
WIS Queue Information
Case Information
Subcase Information
Step Information
Field Information
Step Status Information
Audit Trail Information
Group Membership Information
Attribute Value Information
Outstanding Mail Information
Procedure Version Information
Queue Participation Information
Queue Redirection Information
Pool Server Performance Information
Mbox Information
Information about OS or UVAPI Users
System Event Information
Using the TIBCO iProcess Objects Director
Overview
Multiple Instances of TIBCO iProcess Objects Director
Starting and Stopping TIBCO iProcess Objects Director
TIBCO iProcess Objects Director Version
TIBCO iProcess Objects Server TCP Port Configuration
Configuring TIBCO iProcess Objects Director
TCP and UDP Ports When Running Multiple Instances of the Director
Accessing a TIBCO iProcess Objects Director
Connecting to a TIBCO iProcess Objects Server via a Director
Director-Related Properties and Methods
Pageable Lists/SWXLists of Work Items
TIBCO iProcess Objects Director Logging
Introduction
Overview
Message Timeout
TIBCO iProcess® Objects Server Version
Starting/Stopping the TIBCO iProcess® Objects Server
Start / Stopping a UNIX TIBCO iProcess® Objects Server as the Background User
Running Multiple Instances of the TIBCO iProcess® Objects Server
Adding and Deleting Instances of the TIBCO iProcess® Objects Server
Number of Instances
Implementation
Starting/Stopping Multiple TIBCO iProcess® Objects Servers
Configuration Parameter Instances
Log File Names
Accessing Multiple Instances of the TIBCO iProcess® Objects Server
Multiple Instance Limitations
Configuring the TIBCO iProcess® Objects Server
Configuration Parameters
Multiple Instances of Configuration Parameters
Accessing Configuration Parameters Through the Object Model
General Parameters
NumThreads
SALMaxSessions
SALSessionTimeout
SALWaitTimeout
SALNumPDSessions
SerializeSALLogin
SALRPCSize
SALRPCTimeout
NumFiles (UNIX Only)
StackSize (UNIX Only)
CacheProcEAIStep
TCP Parameters
TCPServiceName
TCPResolveName
BindToPrimaryIPAddr (Windows Only)
TCPMaxClients
TCPQLength
TCPRequestPages
TCPResponsePages
UDP Parameters
SWEOServiceDesc
UDPServiceName
Anonymous Parameters
AnonymousLogin
AnonymousUserName'X'
AnonymousSWUserName'X'
AnonymousPrivilege'X'
AnonymousPoolSize'X'
Disk Log Parameters
Using the Configuration Tool
Using Process Attributes
TRACE_MSG
LOG_CATEGORIES
LOG_LEVEL
WriteErrsToEventLog (Windows Only)
LOG_FILE_MAX_SIZE
LOG_FILE_MAX_ARCHIVES
UseSysLog (UNIX Only)
Memory Log Parameters
Using the Configuration Tool
Using Process Attributes
MEMLOG_LEVEL
MEMLOG_CATEGORIES
MEMLOG_TRACE_MSG
User Parameters
CheckOSUser
SEOPasswordRequired
AuditUserAdmin
MultipleLogins
ImplicitMoveSysInfo
DBConnectionAccess
IAPConfigAccess
Audit Trail Parameters
StartCaseDescription
StartCaseStepName
TerminationUser
TerminationDescription
TerminationStepName
SuspendedDescription
SuspendedStepName
ResumedDescription
ResumedStepName
JumpToStepName
Cache Parameters
CacheProcUpdate
CacheStartSessUpdate
CacheUserUpdate
CacheRoleUpdate
CacheTableUpdate
CacheListUpdate
CacheSemaphoreMaxtries
CacheSemaphoreWait
WQSAbandonedPeriod
TIBCO iProcess® Objects Server Log
Introduction
Types of TIBCO iProcess® Objects Server Logs
On-Disk Log File
In-Memory Log File
Name and Location of the TIBCO iProcess® Objects Server Log
On-disk Log File
In-memory Log File
Archiving TIBCO iProcess® Objects Server Log Files
Controlling the Server Log
Using the Object Model
Using the TIBCO iProcess Objects Server Configuration Utility (Windows Only)
Using the TIBCO iProcess Objects Server Configuration File (UNIX Only)
Setting the Level of Detail to Log
Logging Request/Response Messages in the Server Log
Filtering the Server Log by Category
Setting the Size of the Server Log File
Resetting the Server Log
Audit Log
Introduction
Activating/Deactivating the Audit Log
UNIX System Log
Using the UNIX System Log
Introduction
TIBCO iProcess Administration Console Overview
Configuring TIBCO iProcess Administration Console
Host Name
Properties
HTTPS Configuration
The CORS Filter Configuration on TIBCO iProcess Administration Console
Debugging
Running TIBCO iProcess Administration Console
Starting the Administration Console
Stopping the Administration Console
Logging In
Dashboard
Notifications
Logging Out
Standard Functionality
Overview
Layout
Tabs
Tables
Panels
Tooltips
Infinite Scroll
Pagination
Filtering Information
Sorting Information
Toggle Switch
Administration
Overview
Process Operations
Macro Operations
Process-Specific Operations
Queue Messages
For Oracle Database Server
For SQL Server and DB2 Database Server
Filtering Queue Messages
Deleting Messages
Restoring Dead Messages
Configuration
Process Attributes
Process Attributes
Editing a Process Attribute
Creating a Process Attribute
Deleting a Process Attribute
Global Variables
Editing the Value of a Global Variable
Creating a Global Variable
Deleting a Global Variable
Exporting Global Variables
Importing Global Variables
MBox Set
Overview
Configuring a Writing Process
Configuring a Reading Process
Adding an MBox Queue
LDAP
Overview
Setting Connection Information
Setting Search Parameters
Setting Attribute Mappings
Synchronization
Database Settings
Overview
Connecting to a Database Server
Updated Database Passwords
Debug Settings
Overview
Configuring Debug Settings for iProcess Engine
Configuring Debug Settings for iProcess® Objects Server (SPO)
Configuring Debug Settings for iProcess® Director
Configuring Debug Settings for the EAIJAVA Log
Port Range
Adding, Editing, or Deleting an RPC Port Range
Adding, Editing, or Deleting an AQ Port Range (For Oracle Users Only)
Other Configuration Options
Overview
Date Format
UTF-8
Custom UVAPI
Utilities
System Events
Filtering Events
Exporting Events
Purging Events
Queue Information
Exporting Queue Information
Log Viewer
Filtering Logs
Sorting Logs
Viewing Logs
Filtering Logs for a Specific Time
Downloading Logs
Monitoring
Overview
Configuring Per Minute Graphs
Configuring Hourly Graphs
Configuring Daily Graphs
VIEW and EDIT Graphs Configuration
Details
Overview
Viewing or Downloading Information
Troubleshooting
Http Failure Error in Cloud Environment
Using the swutil Utility
Using swutil
Running swutil Commands as Different Users
Cases and Case Data
Starting a Case
Extracting Case Data (Interactive)
Extracting Case Data (Extended)
Output Formats
Closing Cases
Purging Cases
Updating Prediction for Cases
Migrating Old Case Memo data
Work Items
Resending Work Items
Clearing Locked Work Queue Items
Checking Work Queue Items
Example
Output of the Command
Removing Work Queue Items
Example
Output of the Command
Events
Issue an Event
System Event Monitoring
Exporting System Event Configurations
Importing System Event Configurations
Format of the System Event Configurations
Activity Monitoring
Overview
Exporting Activity Monitoring Configuration Information
Importing Activity Monitoring Configuration Information
Audit Trails
Create a User-Defined Audit Trail Entry
Defining Audit Trail Entries
Case Data Queue Parameters
Overview of Case Data Queue Parameters (CDQPs)
Importing CDQP Configuration Data
CDQP Control File
Resetting CDQP Configuration Data
Defining CDQPs
Example CDQP Definitions
Mapping CDQPs to Queues
Default User and Group Queue Mappings
Example Queue Mappings
CDQP Command Errors
Exporting CDQP Configuration Data
Export File Format
Export File Examples
swutil QINFO Exit Codes and Error Messages
Procedures and Procedure Libraries
Overview of Importing/Exporting Procedures and Libraries
Import a Procedure
Import a Procedure Interactively
Import Procedures Using Command Line Options
Import a Procedure Library
Import a Procedure Library Interactively
Import a Procedure Library Using Command Line Options
Display Commit/Rollback Messages When Importing Procedures or Procedure Libraries
Export a Procedure
Export a Procedure Interactively
Export Procedures Using Command Line Options
Export a Procedure Library
Export a Procedure Library Interactively
Export a Procedure Library Using Command Line Options
Procedure Versions
Release a Procedure Version
Withdraw a Procedure Version
Delete a Procedure Version
swutil PROC command errors
Users and Groups
Command Line Invocation
Control File Format
Control Instructions
Reset
Change Attribute
Change User
Change Group
Change Attribute Value
Change Membership
Export Format
Security
Roles
Command Line Invocation
Control File Format
Control Instructions
Example Control File
Queue Participation
Command Line Invocation
Control File Format
Control Instructions
Reset
Reset Queue Participants
Add Participants
Example Control File
Queue Redirection
Command Line Invocation
Control File Format
Control Instructions
Reset
Reset Queue Redirection
Redirect Queue
Example Control File
Lists
Import a List
Export a List
iProcess Tables
Extract a Table
Delete a Table
Import an iProcess Table
Export a Table
Moving System Information
Move System Information
Batch Processing Cases
Overview
Running swbatch
Command File Format
swbatch Commands
Start a Case
Issue an Event
Close a Case
Purge a Case
Troubleshooting
1945-Database Error While Inserting PMOBJECTS_SECURITY
Overview
Using the iProcess Engine With an LDAP Directory Service
Why Use LDAP?
How Does iProcess Work With LDAP?
Differences from Normal iProcess Operation
How to Set Up the iProcess Engine to Work With an LDAP Directory
The LDAPCONF Utility
Using LDAPCONF
Creating and Maintaining iProcess User Data in the LDAP Directory
LDAP Directory Entries and Attributes
Attributes That Map to iProcess Properties
Application Specific Attributes
Managing User Information
Adding a User to the LDAP Directory
Adding a Group to the LDAP Directory
Defining Group Membership
Adding a Role to the LDAP Directory
Deleting a User, Group or Role
Changing the Membership of a Group
Changing a Role Assignment
Creating, Deleting or Editing Attributes
Configuring the Interface to the LDAP Server
Overview
Setting up the Connection
Defining Search Criteria
Mapping LDAP Directory Attributes to iProcess Properties
Upgrading iProcess
Testing the LDAP Interface
Viewing Configuration Settings
Testing the Interface
Verifying the Data
Using the LDAP Directory
Configuring iProcess to Obtain User Data from the LDAP Directory
The LDAP_DIT Flag
Synchronizing iProcess User Data with the LDAP directory
Automating Synchronization
Configuring iProcess to use LDAP User Validation
Setting up the Proxy User
LDAPCONF Commands
CONNECT
SEARCH
ATTRIB
VIEW
TEST
MOVESYSINFO
Introduction
Format of System Messages
Format of Message Descriptions
Message Categories
Debugging
Enabling and Disabling Debugging
The Maximum Size of Log Files
System Message Descriptions
1601
1609
1613
1631
1636
1642
1644
1645
1646
1647
1649
1667
1670
1671
1672
1673
1674
1676
1682
1694
1712
1713
1714
1715
1723
1792
1793
1794
1795
1796
1810
1811
1814
1815
1840
1850
1851
1852
1853
1854
1855
1856
1857
1858
1861
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1891
1892
1893
1894
1896
1898
1899
1900
1901
1902
1903
1904
1938
1939
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
Socket Error Codes
Introduction
Document Scope
Overview
Configuring Virtual Machines
Configuring an Imported Virtual Machine (RHEL)
Configuring an Amazon Machine Image or Azure Virtual Machine
Configuring Security Groups
Examples of Security Groups for TIBCO iProcess Engine on AWS
Configuring Security Groups When iProcess Workspace (Windows) Is Installed in AWS
Configuring Security Groups When iProcess Workspace (Windows) Is Installed on an External Machine
Configuring Security Groups When iProcess Workspace (Browser) is used to Connect to iProcess Engine
Examples of Security Groups for TIBCO iProcess Engine on Azure
Configuring Security Groups When iProcess Workspace (Windows) Is Installed in Azure
Configuring Security Groups When iProcess Workspace (Windows) Is Installed on an External Machine
Configuring Security Groups When iProcess Workspace (Browser) Is used to Connect to iProcess Engine
Configuring Cloud Databases for iProcess Engine
Sample Configuration for Oracle Database on Amazon RDS
Sample Configuration for SQL Database on Microsoft Azure
CORs Filter Configuration
Configuring TIBCO iProcess Technology Plug-ins
Setting Parameters
Support for EAICOM
Related Documents
Known Issue
Troubleshooting
Authentication Error
Introduction
What is iProcess User Validation?
System Requirements
Installation
UNIX Platform
Windows Platform
Using the User Validation API
The iProcess Encryption Layer Object
The Header File
Compiling Your UVAPI Package
The TIBCO iProcess User Validation API Sample Application
Build Instructions
The TIBCO iProcess User Validation API
Developing a Replacement User Validation Package
Thread Safety
Internal Function Names
Interface Support
Password Validation on Windows Systems
Creating a Session Handle
Design Issues
API Interfaces
uva_initialise
uva_terminate
uva_next_user
uva_next_user_ex
uva_user_info
uva_user_info_ex
uva_change_password
uva_change_password_ex
uva_check_password
uva_check_password_ex
uva_set_user_identity
uva_set_user_identity_ex
uva_get_user_identity
Return Values
TIBCO Documentation and Support Services
Legal and Third-Party Notices