Difference between revisions of "Editing the Scripts"

From Keyfax Wiki
Jump to: navigation, search
Line 33: Line 33:
  
 
[[File:scriptitemediting41.png]]
 
[[File:scriptitemediting41.png]]
 +
 +
'''Script Items:'''
 +
 +
*'''Item Type''' – the drop down lists all the available elements.
 +
 +
The available Script links are dependent on the Script Type. Scripts within a Script Set can Link to Scripts within the same set, to Master and Systems Scripts; System Scripts can only Link to System Scripts. Master Scripts can Link to Master Scripts and System Scripts but not to Script Sets.
 +
 +
*'''Filter''' – type in characters to search for particular references. As characters are entered, a  button is displayed which will clear the search.
 +
 +
The contents for each of the item types (the questions, message, etc) will need to have been created in advance - See Section 2 Entities and Section 3 Databoxes.
 +
 +
====Quick Editing==== - By right clicking on the '''Script Set''' or action column a context menu can be viewed, which allows for the creation of a new entity or action, or to edit an existing entity or action.
 +
 +
[[File:rightclickediting41.png]]
 +
 +
====Adding an Action==== - if an action is already in place against a script step, dragging a new action and holding the '''Shift''' key forces the original item down a step, to allow the new action to be added. Clearer guidance has been added above the Script Grid to highlight any error status.
 +
 +
====Duplicating Actions==== - by holding the '''Ctrl''' key and selecting a message, priority, service code or task already being used, these can be duplicated and moved to other positions within the script grid.
 +
 +
====Displaying Properties==== - by double clicking on a script item a new tab will open that displays its current properties.
 +
 +
====Reordering Sections==== - sections can be moved in the script grid by dragging and dropping them to the desired location. This can only be done above or below another whole section, rather then within a section. To aid visibility, the section header is coloured and extends across the script grid.

Revision as of 12:17, 11 December 2017

Script Editing

Open the required Scripts (System, Master or Script Sets). The following menu bar will be displayed:

Scripteditingmenubar41.png

To view the topic properties click Properties on the menu bar. To return to the script select Script on the menu bar. The scripting grid will now be displayed in the editing pane.

Scriptinggrid41.png

Scripting Grid

  • Script Step – the questions and options displayed in a hierarchical tree structure
  • Rec – if checked, the selected response is recorded and added to the enquiry description
  • Act – indicates the type of action:
    • DBW – denotes a Databox Write DBR – denotes a Databox Read
    • LNK – denotes a Link to another Script
    • MSG – denotes a Message
    • PRI - denotes a Priority
    • SVC – denotes a Service Code
    • TSK – denotes a Task
  • Action – displays the selected Action
  • Next Step - indicates the next step to be taken from a drop down menu:
    • Next Step (this is not displayed)
    • End – Script finishes (will then return to any calling Script)
    • Cancel – Script process cancelled
    • Submit - this defines where a Script will terminate and navigate to the reults screen
    • Section – go to designated section of Script (these will be specifically named)

Script Editing

Selecting Edit on the menu bar will change the icon to a lock. This indicates that editing is in operation and editing of other tabs is locked. The navigation pane now contains all the script items available for editing.

Scriptitemediting41.png

Script Items:

  • Item Type – the drop down lists all the available elements.
The available Script links are dependent on the Script Type. Scripts within a Script Set can Link to Scripts within the same set, to Master and Systems Scripts; System Scripts can only Link to System Scripts. Master Scripts can Link to Master Scripts and System Scripts but not to Script Sets.
  • Filter – type in characters to search for particular references. As characters are entered, a button is displayed which will clear the search.
The contents for each of the item types (the questions, message, etc) will need to have been created in advance - See Section 2 Entities and Section 3 Databoxes.

====Quick Editing==== - By right clicking on the Script Set or action column a context menu can be viewed, which allows for the creation of a new entity or action, or to edit an existing entity or action.

Rightclickediting41.png

====Adding an Action==== - if an action is already in place against a script step, dragging a new action and holding the Shift key forces the original item down a step, to allow the new action to be added. Clearer guidance has been added above the Script Grid to highlight any error status.

====Duplicating Actions==== - by holding the Ctrl key and selecting a message, priority, service code or task already being used, these can be duplicated and moved to other positions within the script grid.

====Displaying Properties==== - by double clicking on a script item a new tab will open that displays its current properties.

====Reordering Sections==== - sections can be moved in the script grid by dragging and dropping them to the desired location. This can only be done above or below another whole section, rather then within a section. To aid visibility, the section header is coloured and extends across the script grid.