Difference between revisions of "Navigating"

From Keyfax Wiki
Jump to: navigation, search
(Created page with "The terms used throughout this guide when referring to each section of the screen are: File:navigation41.png ==The Main Menu== File:mainmenu41.png File:usermenu...")
 
(The Main Menu)
 
(23 intermediate revisions by the same user not shown)
Line 4: Line 4:
  
 
==The Main Menu==
 
==The Main Menu==
 
+
===Home===
 
[[File:mainmenu41.png]]
 
[[File:mainmenu41.png]]
 
+
===Users===
 
[[File:usermenu41.png]]
 
[[File:usermenu41.png]]
 
+
===Advanced===
 
[[File:advancedmenu(b)41.png]]
 
[[File:advancedmenu(b)41.png]]
  
The Main Menu gives access to:
+
The '''Main Menu''' gives access to:
 
    
 
    
*Hide Menu/Tabs and Exit - hides the menu as required or closes Keyfax
+
*'''Hide Menu/Tabs and Exit''' - hides the menu as required or closes Keyfax
*Scripts - the level at which you would like to edit scripts:
+
[[File:hidemenu41.png]]
*Entities - where the items that a script will comprise of will be created and edited:
+
*'''Scripts''' - The level at which you would like to edit scripts:
*Test - allows the scripts to be tested from an Operator's perspective:
+
*'''Entities''' - Where the items that a script will comprise of will be created and edited:
*Reports - Viewer that allows the reports within Keyfax Inter•View to be run:
+
*'''Test''' - Allows the scripts to be tested from an Operator's perspective:
*Help- where access is available to our help documentation online:
+
*'''Reports''' - Viewer that allows the reports within Keyfax Inter•View to be run:
*Switch EXCLUSIVE - switches the mode between exclusive and non exclusive access:
+
*'''Help'''- Where access is available to our help documentation online:
 
+
*'''Switch''' - Switches the mode between exclusive and non exclusive access:
 
 
 
 
 
 
Tip
 
 
 
Switch EXCLUSIVE is disabled while editing in any tab.
 
•Exit - closes Keyfax:
 
 
 
 
 
 
 
•Users - where users can be created and settings amended:
 
 
 
 
 
 
 
•Advanced- where task templates can be managed and the software configuration and uninstallation options are:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Tip
 
 
 
Multiple tabs can be opened at any one time; as you click on a menu item, a new tab is displayed with the appropriate display. However, editing is only permitted in one tab at a time. An asterisk (*) identifies which tab is currently being edited.
 
 
 
The Navigation Pane
 
 
 
 
 
 
 
The Navigation Pane is where the selection of items (relevant to that tab) are displayed. It will contain a list of items, often in groups and ordered alphabetically. A ‘filter’ is provided in many views allowing users to search the available options.
 
 
 
 
 
 
 
 
 
The Menu Bar
 
 
 
 
 
 
 
The Menu Bar shows icons for viewing and editing items. Icons on the Menu Bar will vary depending on which items are currently being viewed and edited:
 
 
 
- adds a new item
 
 
 
- saves changes
 
 
 
- allows changes to be made to the selected item. Once selected the icon will change to . Selecting this again will stop editing. The  icon will also change to . Once editing is complete this will change to the  icon.
 
 
 
 
 
Tip
 
 
 
Be aware that if the edit tab is greyed out, this is because you are editing in another tab. To rectify this go to the tab identified with an * and save changes.
 
 
 
- restores the item to the last saved position
 
  
 +
Switching to exclusive is disabled while editing in any tab.
  
Tip
+
*'''Exit''' - Closes Keyfax:
 +
*'''Users''' - Where users can be created and settings amended:
 +
*'''Advanced'''- Where task templates can be managed and the software configuration and uninstallation options are:
  
WARNING: This is NOT an undo button. Selecting this will delete any amendments made since the last saved point.
+
Multiple tabs can be opened at any one time; as you click on a menu item, a new tab is displayed with the appropriate display. However, editing is only permitted in one tab at a time. An asterisk (*) identifies which tab is currently being edited.
  
- deletes an item. This will be greyed out if you are trying to delete an entity or level of a script - (topic or category) unless you are logged in exclusively
+
==The Navigation Pane==
  
 +
[[File:navigationpane41.png]]
  
Tip
+
The '''Navigation Pane''' is where the selection of items (relevant to that tab) are displayed. It will contain a list of items, often in groups and ordered alphabetically. A '''Filter''' is provided in many views allowing users to search the available options.
  
WARNING: Once pressing Delete this cannot be undone.
+
==The Menu Bar==
  
- edits the text of a Message.
+
The '''Menu Bar''' shows icons for viewing and editing items. Icons on the bar will vary depending on which items are currently being viewed and edited:
  
- checks the text of a Message for any spelling errors.
+
'''Script Menu Bar'''
 +
<br>
 +
[[File:menubar41.png]]
 +
<br>
 +
'''Message Menu Bar'''
 +
<br>
 +
[[File:messagemenubar41.png]]
  
- displays a list of the scripts that a Message is used in. Selecting a script from the list shows a preview of that script.  
+
*'''Add''' - Adds a new item
 +
*'''Save''' - Saves changes
 +
*'''Edit''' - Allows changes to be made to the selected item. Once selected the icon will change to '''Edit''' with a padlock symbol. Selecting this again will stop editing. The '''Read Only''' icon will also change to '''Editing''' Once editing is complete this will change to the icon.  
  
  - when in the Properties section of a topic, selecting this icon will toggle to the script editing Pane. Once this is selected the icon will change to  to toggle back to the Properties.
+
  Be aware that if the edit tab is greyed out, this is because you are editing in another tab. To rectify this go to the tab identified with an * and save changes.
  
- expand all the script steps within a script.
+
*'''Restore''' - Restores the item to the last saved position
  
  - close all the script steps within a script.
+
  '''WARNING''': This is NOT an undo button. Selecting this will delete any amendments made since the last saved point.
  
- update the currently selected script with the script from the master script set.
+
*'''Delete''' - Deletes an item. This will be greyed out if you are trying to delete an entity or level of a script - (topic or category) unless you are logged in exclusively
  
  - update the master script set with the currently selected script.
+
  '''WARNING''': Pressing '''Delete''' cannot be undone.
  
 +
*'''Text''' - Edits the text of a message.
 +
*'''Spell Check''' - Checks the text of a message for any spelling errors.
 +
*'''References''' - Displays a list of the scripts that a message is used in. Selecting a script from the list shows a preview of that script.
 +
*'''Properties''' - Shows the properties of the script. The icon will change to '''Script''' which will allow you to return to the script view.
 +
*'''Expand''' - Expand all the script steps within a script.
 +
*'''Close All''' - Close all the script steps within a script.
 +
*'''Get Master''' - Update the currently selected script with the script from the master script set.
 +
*'''Set Master''' - Update the master script set with the currently selected script.
  
 +
==The Viewing / Editing Pane==
  
 +
The '''Viewing/Editing Pane''' is the main work space of Keyfax Inter•View. It is where the script or entity editing takes place.
  
The Viewing / Editing Pane
+
[[File:viewingeditingpane41.png]]
  
The Editing Pane is the main work space of Keyfax Inter•View. It is where the script or entity editing takes place.
+
For information on script editing see [[Editing_the_Scripts]]

Latest revision as of 10:24, 5 December 2017

The terms used throughout this guide when referring to each section of the screen are:

Navigation41.png

The Main Menu

Home

Mainmenu41.png

Users

Usermenu41.png

Advanced

Advancedmenu(b)41.png

The Main Menu gives access to:

  • Hide Menu/Tabs and Exit - hides the menu as required or closes Keyfax

Hidemenu41.png

  • Scripts - The level at which you would like to edit scripts:
  • Entities - Where the items that a script will comprise of will be created and edited:
  • Test - Allows the scripts to be tested from an Operator's perspective:
  • Reports - Viewer that allows the reports within Keyfax Inter•View to be run:
  • Help- Where access is available to our help documentation online:
  • Switch - Switches the mode between exclusive and non exclusive access:
Switching to exclusive is disabled while editing in any tab.
  • Exit - Closes Keyfax:
  • Users - Where users can be created and settings amended:
  • Advanced- Where task templates can be managed and the software configuration and uninstallation options are:
Multiple tabs can be opened at any one time; as you click on a menu item, a new tab is displayed with the appropriate display. However, editing is only permitted in one tab at a time. An asterisk (*) identifies which tab is currently being edited.

The Navigation Pane

Navigationpane41.png

The Navigation Pane is where the selection of items (relevant to that tab) are displayed. It will contain a list of items, often in groups and ordered alphabetically. A Filter is provided in many views allowing users to search the available options.

The Menu Bar

The Menu Bar shows icons for viewing and editing items. Icons on the bar will vary depending on which items are currently being viewed and edited:

Script Menu Bar
Menubar41.png
Message Menu Bar
Messagemenubar41.png

  • Add - Adds a new item
  • Save - Saves changes
  • Edit - Allows changes to be made to the selected item. Once selected the icon will change to Edit with a padlock symbol. Selecting this again will stop editing. The Read Only icon will also change to Editing Once editing is complete this will change to the icon.
Be aware that if the edit tab is greyed out, this is because you are editing in another tab. To rectify this go to the tab identified with an * and save changes.
  • Restore - Restores the item to the last saved position
WARNING: This is NOT an undo button. Selecting this will delete any amendments made since the last saved point.
  • Delete - Deletes an item. This will be greyed out if you are trying to delete an entity or level of a script - (topic or category) unless you are logged in exclusively
WARNING: Pressing Delete cannot be undone.
  • Text - Edits the text of a message.
  • Spell Check - Checks the text of a message for any spelling errors.
  • References - Displays a list of the scripts that a message is used in. Selecting a script from the list shows a preview of that script.
  • Properties - Shows the properties of the script. The icon will change to Script which will allow you to return to the script view.
  • Expand - Expand all the script steps within a script.
  • Close All - Close all the script steps within a script.
  • Get Master - Update the currently selected script with the script from the master script set.
  • Set Master - Update the master script set with the currently selected script.

The Viewing / Editing Pane

The Viewing/Editing Pane is the main work space of Keyfax Inter•View. It is where the script or entity editing takes place.

Viewingeditingpane41.png

For information on script editing see Editing_the_Scripts