# System Scripts

System Scripts are Scripts designed to be run at selected times or to provide Scripts that can be used by other Script types – by Master Scripts or Script Sets.

Select **System Scripts** from the Main Menu.&#x20;

The script shown below is a '**Startup**' script and can be tailored to meet your needs. This script is run every time a Keyfax script is launched. In this example, a check is made to see if the current time is between 0800 and 1800. If it falls outside this period, the Tenancy code that was imported from the host (calling) system will be overridden such that an alternative script set is used, i.e. a script set that is specifically for use in an out of hours operation:&#x20;

<figure><img src="/files/DH2Tydq9ogB24X7b04G9" alt=""><figcaption><p>Startup System Script</p></figcaption></figure>

The Navigation pane - shows two Categories of Scripts – **Reserved** and **Custom**.

### **Built-In System Scripts**

{% embed url="<https://youtu.be/CfYxk3iYjhQ>" %}

These Scripts are designed to provide preset functions and by default the following scripts are available:

[**Cancel**](/product-suite/admin/script-levels/system-scripts/cancel.md) - a Script that runs when a script is cancelled

[**Priority Justifications**](/product-suite/admin/script-levels/system-scripts/priority-justifications.md) – a Script that runs when a priority is over-ridden by an Operator on the Results (final) screen

[**Results**](/product-suite/admin/script-levels/system-scripts/results.md) – a Script that runs just before the Results (the final) screen – after other Scripts have completed

[**Special Instructions**](/product-suite/admin/script-levels/system-scripts/special-instructions.md) - a Script that identifies any special instruction and is triggered by Operators from the Special Instructions button on the Results (final) screen within the staff modules

[**Startup**](/product-suite/admin/script-levels/system-scripts/startup.md) **-** These are Scripts that run when Keyfax is started to handle an enquiry or service request

### **Custom System Scripts**

{% embed url="<https://youtu.be/ROiD17rsCZ4>" %}

Custom Scripts are created as required and other Scripts can link to these. For example, Scripts to check ‘How did it happen?’ – a standard question often used against many service requests; a Script to check on ‘Tenant responsibility’ for a service request.

To create a new custom Script, click on **\<New Custom Script>** at the foot  of the Custom Scripts list. Give the script a Name that will make it easy to identify.

<figure><img src="/files/rwJGgJpi0700Elk8dnEv" alt=""><figcaption><p>"How did it happen" System Script</p></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.keyfax.biz/product-suite/admin/script-levels/system-scripts.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
