Script Sets

What they are and how to use them

Script Sets are used to segregate functional aspects of your operation. For example, you may have built an extensive library of Master Scripts which can be 'wired into' Script Sets. Each Script Set can be limited to provide a discrete set of functions unique to the context, e.g. Out of Hours services that are distinct from office hour operation, services for Leaseholders, services for specific property types or communal areas etc.

Selecting Script Sets from the main menu will open a new tab:

The Navigation Pane contains the Script Selection under the selected Level.

Level – Select Set to view all Script Sets designed to function with their own Scripts.

Select Script Alias to view Script Sets who have their scripts utilised by other Script Sets.

A bit of an explanation about Aliases...

When Keyfax scripts are launched, a code stored in the startup data (that is sent by the calling host) is used to identify which Script Set to use. Historically, for Repairs, the code used is named 'Tenancy'. For Enquiries, the 'Tenure_Code' fulfills this role. It may be that the host system can supply a variety of codes that require the same script set to be used.

Enter Aliases!

These are useful where one or more different Tenancy Types, with different Tenancy Codes behave in the same way and can be represented by one Script Set. One Tenancy Type is selected and a Script Set for it is created. All the other Tenancy Types with their Tenancy Codes are setup as Aliases of this, they look like normal Script Sets but they have no content (images/categories/topics) as they redirect to the Script Set they are an alias of.

Looking at an example use of an Alias. The screenshot below shows the Script Set 'Housing Services (Tenants)' and its associated Categories. Note it has a code of '1'. When a tenancy (or tenure_code) of '1' is received, this Script Set will be launched:

The next screenshot shows the Script Set 'test' is an alias and uses the Scripts from the Script Set 'Housing Services (Tenants)'. It is therefore displayed as subordinate to the Script Set 'Housing Services (Tenants)':

If the host were to supply a tenancy/tenure code of '1' or 'tst' the Script Set 'Housing Services (Tenants)' would always be launched.

Editing Script Set Properties

The Editing Pane displays the Properties of the selected Script Set once a Script Set in the Navigation Pane has been selected:

The Script Set Properties are:

Code – the code for the Script Set; that should be set to the tenancy/tenure code passed from the host system (in the Startup data file)

Name – a descriptive name used for display purposes

Policy Help page – the URL or UNC path to the Policy pages for this Script Set. This can either be a full URL https://www.omfax.co.uk or UNC path: FILE:////servername/sharename/file1.doc

Alias for Set – the Script Set that this set utilises.

NOTE Click Edit to modify any of the settings for the Category. Amendments made at Script Set level will apply only to the Script Set. Script Sets can inherit elements from Master Scripts but display them in a unique way.

Master Category Assignment - this section provides the facility for selecting the Categories to be used for each Script Set.

Unassigned Categories – shows the full list of Categories available for assignment. These are Categories that have been set up in the Master Scripts.

Assigned Categories – shows those Categories already assigned to be used for this Script Set. Script Sets can therefore use a unique selection of the Categories available.

Assigning and Unassigning Categories

NOTE Categories must be created at Master Script Level first or they will not be available at Script Set Level. Also, you must be in Exclusive mode to unassign categories.

To assign a Category, select the required Category from the Unassigned Categories list and click the right arrow.

To unassign an Assigned Category, select the required Category from the Assigned Category list and the left arrow.

In the example below, the Anti-social behaviour Category is the only unassigned Category:

Script Sets Linking to Other Script Sets

Keyfax doesn’t allow jumps between Script Sets so there cannot be any cross-script references.

Deleting Script Sets

DANGER Deleting a Script Set cannot be undone. The Script Set and all Script Set specific data will be permanently deleted from the Keyfax database. We would strongly recommend backing up your Keyfax database before making permeant changes.

To delete a Script Set you'll need Exclusive Mode within Keyfax Administrator Tools. When deleting a Script Set only Script Set specific overrides for the Categories, Topics and Scripts are deleted, no Master Categories, Topics or Scripts are deleted.

PreviousStartup NextCategory Properties

Last updated 2 months ago