Set Infobox Ranges and the Directory to be Searched for Corresponding Infoboxes and Images

$image_locn first last directory|generated|lookup|ibc [ibcname]
$script_locn first last directory|generated|lookup|ibc [ibcname]

This command functionality can be accessed using either of the command names $image_locn or $script_locn.

Unless you are running a fax-on-demand application, for which the $image_locn command command was originally named, we recommend the use of the $script_locn command.  The commands are synonyms: both have the same syntax and functions.

These commands are used to define the user-specific directories in which script files (infoboxes), fax-on-demand image files, and voice description files may be found. Multiple commands are used to specify different folders for different ranges of filenames.

The commands are brought into use when a user profile is assigned to a channel, and the script locations defined by configuration file $script_locn commands are incorporated into the active search list.

In summary, this command specifies folders for:

numeric fax-image filenames to be selected in fax-on-demand applications

voice description files associated with fax-on-demand images

all infobox (.IIF) files, as used in:

fax-on-demand applications

interactive voice response applications (IVR)

voice broadcasts

pre-processing using method infobox on outbound calls

post-processing using method infobox on outbound calls

post-receive processing using method infobox on inbound calls

worker-box (maintenance) tasks

When a fax-on-demand image has been located using these commands, its full path is used in creating a $fax_filename command in any FS that is generated to send the fax. However the $image_locn command is not used in processing such file names already in an FS file; the filename there must always have a full path specification.

The parameters on this command are used as follows:

first defines the starting value of the range of numbers or names affected by this command.
last defines the ending value of the range of numbers or names affected by this command. If you use Unicode infobox names, they may not be located if you use a range ending such as ZZZZZZZZ.  Either prefix Unicode names with an ASCII character, or select a suitable Unicode character as the upper limit of the range.
directory the name of the directory in which the files are to be found, or one of the following keywords:
generated this keyword can be used to identify images that will be created as needed. No check is made that the image exists at fax-on-demand selection time. When this feature is used there must be a $pre_process command specified, which will presumably do the generation of the image. The file name inserted by CopiaFacts in the FS file is of the form n.GEN, where n is the infobox name or number. Your pre-process program may change this and set the correct image type on the $fax_filename command when it has generated the image.
lookup this keyword indicates that the lookup translation specified in the $infobox command will be carried out at this point in the image search. The lookup is only done once per entered infobox number.
ibc this keyword indicates that the infobox files in this range are embedded in an infobox collection (IBC) file with logical name ibcname.
ibcname the logical name of the IBC file containing the infoboxes for this range, as specified on the $load_ibc configuration command. This parameter is required when the ibc keyword is used instead of a directory name.

You may enter multiple $script_locn or $image_locn commands which cover the same range or intersecting ranges. There is no limit to the number of location definitions allowed. The sequence of commands is significant. CopiaFacts looks for an file in the directory corresponding to the first statement with a suitable range. If it finds no image there, it continues looking through the commands until it finds another match on range and directory. This command should normally be placed near the top of the .USR file.

If the directory name is not found, a warning is generated but the user profile is not rejected unless there are no valid image locations defined.

The first and last parameters on this command can be alphanumeric strings of up to 15 characters. Comparisons are numeric if both compared values are numeric, and otherwise are alphanumeric.

When searching for a fax-on-demand image in multiple directories, CopiaFacts also remembers matching voice files (n.VOX) in each directory until the document is found. The last such voice file found is the one used as the description of the document. Voice descriptions can also be supplied for generated files by placing them in a directory specified (for the same image range) ahead of the generated special name.

If you specify remote image updating and the update is to take place in the image directory, and the document to be updated does not already exist, then the document will be placed in the last of the directories searched.

The directory name may contain folder variable expansions such as '@FFBASE', except that FFMERGE currently only supports the FFBASE variable to locate attachments, not others such as FFUSER.  If the name contains embedded blanks, double-quotes must be used.

Default: no user profile locations are added, but any locations defined in the $script_locn configuration command are searched.


All images in one directory:

$image_locn 0 99999999 @FFBASE\image

Break up images into two directories, store control menus with alphabetic names in a third directory:

$image_locn 0 50000000 @FFBASE\image

$image_locn 50000001 99999999 @FFBASE\special_image

$image_locn A ZZZZZZZZ @FFBASE\alpha

Image numbers 00000001 through 99999998 stored in the CopiaFacts standard directory can be sent:

$image_locn 00000001 99999998 @FFBASE\image

Use common document numbers for all languages, but if a specific document is not available in Spanish, the caller will automatically get the English document with the same number.

$image_locn 1 99999999 @FFBASE\spanish

$image_locn 1 99999999 @FFBASE\english

Allow for Unicode infobox names:

$image_locn 0 ■ @FFBASE\unicode ; (this ■ is code point UFFED)