Content Comparison

CheckOutPathMap.Config

Configure this script to scan for remote check-in files from Data Uploader.

The script looks like this. Use the attributes description to understand variables.

### checkoutPathMap.config Overview

The `checkoutPathMap.config` file is utilized by CAM to determine document checkout locations during remote check-ins. By default, this configuration file does not exist and must be manually created in the directory `C:\Program Files\Prosperoware.CAM\data`. The match patterns within this file can include multiple criteria, such as:

- User name, PC name, and drive
- User name and drive
- PC name and drive
- Drive

#### Attributes Description

| Attribute           | Description                                 |
|---------------------|---------------------------------------------|
| `match-user-name`   | The name of a WorkSite user.                |
| `match-machine-name`| The name of a user's computer.              |
| `match-drive-name`  |                                             |
| `replace-pattern`    |                                             |
| `replace-start-with` |                                             |

#### Variables Description

| Variable                | Description                |
|-------------------------|----------------------------|
| `@user@`                |                            |
| `@machine@`            | Citrix session             |
| `@checkoutdrive@`      |                            |
| `@userhomedirectory@`  |                            |
| `@userhomedrive@`      |                            |

#### Configuration Example

```xml
<configuration>
    <path match-drive-name="c:" replace-pattern="\\@machine@\@checkoutdrive@$\vvvvv" replace-start-with="@checkoutdrive@" />
</configuration>

CAM processes the checkoutPathMap.config file according to the following sequence:

1. Check for a Matching Pattern

   Starting from the top of the checkoutPathMap.config file, CAM searches for a matching pattern. Once a match is found, CAM will not continue to read the remaining entries in the configuration file. The order of pattern matching is as follows:

   • Check for pattern: username (match-user-name) + machinename (match-machine-name) + drive (match-drive-name)

   • Check for pattern: username (match-user-name) + drive (match-drive-name)

   • Check for pattern: username (match-user-name) + machinename (match-machine-name)

   • The final check is for a drive only.

2. Read and Parse the Replacement Pattern

   CAM compares the replace-start-with value and replaces it with the parsed replace-pattern. For example, if a file is checked out to C:\NrPortbl\file.doc on the machine desktop1, the following pattern designates the path as \\desktop1\c$\yyyy rportbl\file.doc:

   Code Block

3. Code Block
   <path match-drive-name="c:" replace-pattern="\\@machine@\@checkoutdrive@$\yyyy" replace-start-with="@checkoutdrive@:"/>

4. When No Pattern Match Found Occurs

   If no matching pattern is found in the checkoutPathMap.config file, CAM defaults to using the checkout path location recorded in the WorkSite database.

Implementation Notes

1. matchdrivename will be according to the checked-out path. If you have a checkout path on the c drive then pass the matchdrivename like c:\. If you are using a network path for the checked-out document then enter the path like \\machine_ip\ i.e
   94.130.20.199

2. To remotely check in a document for any checked-out document, implement this in the following way:

   1. Grant full access to the service account to the checkout dir.

   2. Add the following line to CheckoutPathMap.config on the Data Uploader server

      <path match-user-name="MyUserID" match-machine-name="MyLocalMachine" match-drive-name="c:" replace-pattern=\\@machine@\@checkoutdrive@$ replace-start-with="@checkoutdrive@"/>