Purge-Cache
The Purge-Cache webject purges user and group objects from the Windchill participant cache.
The Windchill cache of users and groups optimizes performance by minimizing the number of requests it needs to make of the LDAP directory service.
When LDAP entries defining Windchill users or groups are modified directly without using the Participant Administration utility, then information in the cache can become outdated.
Use the Purge-Cache webject to purge outdated entries from the cache and force Windchill to re-retrieve them from the LDAP directory service.
 |
If you are purging all entries at once (without specifying DIRECTORY_REF or OBJECT_REF) from the Windchill participant cache, then only a Windchill administrative user can execute the webject.
If you are purging a few individual entries from the Windchill principal cache, then a user with write permission to those entries can execute the webject.
|
Syntax
<ie:webject name="Purge-Cache" type="ACT">
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DIRECTORY_REF" data="LDAP_distinguished_name"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
</ie:webject>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DIRECTORY_REF" data="LDAP_distinguished_name"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
</ie:webject>
Parameters
|
Required
|
Interdependent
|
Optional
|
|---|---|---|
|
INSTANCE
|
AUTHORIZATION
|
CONNECTION_ATTEMPTS
|
|
DBUSER
|
CONNECTION_ATTEMPT_INTERVAL
|
|
|
DIRECTORY_REF
|
SESSION_ID
|
|
|
OBJECT_REF
|
||
|
PASSWD
|
|
|
If a parameter is listed in the table but is not defined below, then it has a common parameter definition. For descriptions of those parameters, see Common Webject Parameters section in Adapter Webjects Overview.
|
DIRECTORY_REF
The LDAP distinguished name of a user or group to be removed from the cache. Any valid distinguished name of an existing user or group can be specified. This parameter can be specified multiple times to remove multiple users or groups from the cache at once.
Use this parameter instead of or in addition to OBJECT_REF. If neither of them is specified, all entries are removed from the cache.
OBJECT_REF
Specifies the Unique Federation Identifier (UFID) of a user or group to be removed from the cache. This parameter can be specified multiple times to remove multiple users or groups from the cache at once. It can be used instead of or in addition to DIRECTORY_REF. If neither of them is specified, all entries are removed from the cache.