PLBCS_CACHEDIR

PLBCS_CACHEDIR Keyword

PLBCS_CACHEDIR={directory}

This optional keyword defines the directory in which cached items are stored. The default is the PLBCSTEMP directory located in the same directory as the executing PLBCLIENT command.

Example:

PLBCS_CACHEDIR=C:\CACHE

The PLBCS_CACHEDIR keyword for the Windows clients allows a UET tag to be specified at the beginning of this keyword's data string. The UET tag must be specified using the format identified as '<keyword>' or '?keyword?'. In both of these UET tag formats, the syntax requires the '<' and '>' characters or the '?' character around the keyword. In this case, the 'keyword' name must exist so it can be retrieved from the client's UET (ie User Environment Table). This change is being implemented to allow the clients to be configured to put any cached data into the Windows APPDATA system directory for a logged on user.

Example of PLBCLIENT INI using UET tag substitution:

[Environment]

PLBCS_CACHEDIR=<APPDATA>\clientcache

When the client executable detects the PLBCS_CACHEDIR UET tag as described, the client retrieves the current APPDATA keyword data for the currently logged on user and replaces the <APPDATA> UET tag in the PLBCS_CACHEDIR string. The resulting string is resolved as follows:

"c:\users\Edward\AppData\Roaming\clientcache"

Note:

1. The client executable does not perform any interpretation of the PLBCS_CACHEDIR other than to replace a properly formatted UET tag with the existing UET keyword data string.

2. If a properly formatted UET tag keyword cannot be found in the UET, the UET tag remains in the PLBCS_CACHEDIR string. In this case, the resulting PLBCS_CACHEDIR is an invalid Windows OS directory name which can not be accessed or created. This method prevents extraneous cache directories from being created because of a typing error for a keyword. The result is that the client caching is disabled.

Example when a UET tag keyword is not found:

[Environment]

PLBCS_CACHEDIR=<NOTFOUND>\clientcache

When the client retrieves this PLBCS_STRING, the UET tag keyword is retrieved and it is NOT found in the UET. In this case, the <NOTFOUND> UET tag remains in the PLBCS_CACHEDIR data string unchanged. The resulting string resolves as follows:

"<NOTFOUND>\clientcache"

3. If the client executable finds an invalid UET tag, the UET tag is NOT removed from the resulting PLBCS_CACHEDIR string.

Example of invalid UET tags:

[Environment]

PLBCS_CACHEDIR=<invalid\clientcache

In this case, there is no trailing '>' tag delimiter.

PLBCS_CACHEDIR=<>\clientcache

In this case, there is no UET tag keyword.

4. The user is responsible for insuring that the UET tag format and that the keyword is available in the UET so it can resolve to a valid directory on the user workstation. The normal use of the UET tag substitution is to provide a means of specifying that an OS UET keyword can be substituted to give a properly formed OS directory path. For the Windows OS, the possible OS keywords that might be used are defined as follows:

[Environment] Multiple examples:

PLBCS_CACHEDIR=<APPDATA>\mydir

PLBCS_CACHEDIR=?LOCALAPPDATA?\mydir

PLBCS_CACHEDIR=<TEMP>\mydir

PLBCS_CACHEDIR=?TMP?\mydir

5. The UET tag keywords are ONLY retrieved from the OS UET. The UET tag keywords are NOT retrieved from an INI file.

6. The '?' character can be used in placed of the '<' and '>' characters that encapsulate the keyword. The '?' character is available because some installation products do not accept the '<' and '>' characters as output to an INI file.