Location File Masks
Uptivity allows you to create location file masks: custom UNC paths, file types, and file names to be used in saving, exporting, and archiving recording files.
This topic explains the variables that can be used in location file masks.
For more information, see New (Edit) Archive Action Page, Export Recordings
Location File Mask Structure
To construct a location file mask, you must type a path that incorporates one or more of the variables shown in the next section.
For example, suppose you need to construct the following path:
"C:\recordings\test\device10\10-100-100.wav"
These are the variables that would be used and the values they represent:
Variable | Value |
---|---|
%P<-1> | test\device10 |
%P<1> | recordings\test |
%P | recordings\test\10 |
%F | 10-100-100 |
Filename Masks in Archive Actions
If no mask is specified, Archiver defaults to "%P\%F"; if only "C:\recordings\" or "C:\recordings" is entered, Archiver defaults to "C:\recordings\%P\%F".
If %P is not used in the file mask, Archiver will determine one on its own using the following process:
- Archiver checks the CTI Core on the server where the file was recorded and obtains the default file mask if possible.
- Archiver tries to match the filename to the default file mask. If it matches, Archiver removes the rest of the path that does not match.
- If the filename does not match, Archiver removes the drive letter only.
- The path is put at the end of the archive location, forming the new path.
The file is then archived, exported, or saved using the generated mask.
Filename Masks in Exporting Recordings
When exporting recorded interactions, you can create different masks and choose which one to use on a case-by-case basis. You can delete masks that are no longer needed.
File masks used for exporting recordings use only filename variables, not path variables. You can use an underscore (_) or hyphen (-) between variables to make the mask easier to read. Masks can be used to create any filename that is legal in your system and that matches any file naming strategy used by your organization.
You cannot edit a filename mask after it has been created, but you can delete filename masks that are no longer needed.
The following image provides some examples of filename masks. The first column shows the mask name, the middle column shows the path, and the last column shows how the filename would appear.
Location File Mask Variables
- %Y
- Four-digit year (for example, 2015). This variable can be used with all file masks.
- %y
- Two-digit year (for example, 15). This variable can be used with all file masks.
- %M
- Two-digit month (for example, 01-12). This variable can be used with all file masks.
- %m
- Month name as a three-letter abbreviation (for example, Jan, Feb, Mar, and so forth). This variable can be used with all file masks.
- %D
- Two-digit day (for example, 01-31). This variable can be used with all file masks.
- %d
- Day of week name (for example, Monday). This variable can be used with all file masks.
- %H
- Hour. This variable can be used with all file masks.
- %N
- Minute. This variable can be used with all file masks.
- %S
- Second. This variable can be used with all file masks.
- %A
- Agent Number (ID); also known as Device Alias. This variable can be used with all file masks.
- %R
- Record ID (Ident). This variable can be used with all file masks.
- %U<1> through %U<15>
- User fields. This variable can be used with all file masks.
- %C
- In file masks for archiving and saving, this variable is a Counter. In file masks for exporting calls, this variable is Caller ID.
- %c
- Dialed Number (DNIS). This variable is used only with file masks for exporting.
- %I
- Device ID. This variable is used only with file masks for exporting.
- %T
- Call Duration. This variable is used only with file masks for exporting.
- %W
- Call Wrap. This variable is used only with file masks for exporting.
- %O
- Call Direction. This variable is used only with file masks for exporting.
- %F
- Filename without path. This variable is used only with file masks for archiving and saving.
- %P
- Path minus root. This variable is used only with file masks for archiving and saving.
- %P<-1>
- Path minus root remove one bottom directory. This variable is used only with file masks for archiving and saving.
- %P<1>
- Path minus root remove one top directory. This variable is used only with file masks for archiving and saving.