Difference between revisions of "Script Sets"
From Keyfax Wiki
(→The Viewing/Editing Pane) |
(→Topic Hotspots) |
||
| (25 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | Script Sets contain the elements of the | + | Script Sets contain the elements of the scripts that the operators can access. |
| − | Select | + | Select script sets from the scripts menu to open a new tab. |
==The Navigation Pane== | ==The Navigation Pane== | ||
| − | This contains the | + | This contains the script selection under the selected level. |
[[File:scriptnavigationpane41.png]] | [[File:scriptnavigationpane41.png]] | ||
*'''Level''' – Use to select the level of scripts. | *'''Level''' – Use to select the level of scripts. | ||
| − | **'''Set''' - To view all | + | **'''Set''' - To view all script sets. |
| − | **'''Alias''' | + | **'''Alias''' To view script sets being used as an alias. |
| − | Aliases are useful where one or more different | + | Aliases 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. |
| − | '''Example 1:''' Shows the | + | '''Example 1:''' Shows the script set 'Housing Services (Tenants)' and the associated categories. |
[[File:scriptsets41.png]] | [[File:scriptsets41.png]] | ||
| − | '''Example 2:''' shows that | + | '''Example 2:''' shows that script set 'test' is an alias of script set 'Housing Services (Tenants)'. It is therefore displayed as sub-ordinate to that script set. |
[[File:scriptsetalias41.png]] | [[File:scriptsetalias41.png]] | ||
| Line 25: | Line 25: | ||
==The Viewing/Editing Pane== | ==The Viewing/Editing Pane== | ||
| − | Displays the | + | Displays the properties of the selected script once a script set in the navigation pane has been selected: |
| − | * | + | *'''Bread-crumb''' – this displays the currently selected script set. |
*'''Script Set Properties''': | *'''Script Set Properties''': | ||
| − | **'''Code''' – | + | **'''Code''' – The code for the script set; that should be set to the code passed from the host system (in the startup data file) |
| − | **'''Name''' – | + | **'''Name''' – A descriptive name used for display purposes |
| − | **'''Policy Help page''' – | + | **'''Policy Help page''' – The URL UNC path to the policy pages for the script set. Example URL: http://dev.touch-base.com/kfc32/test.htm example UNC path: FILE:////servername/sharename/file1.doc |
| − | **'''Alias''' | + | **'''Alias for Set''' – The script set that this set utilises. |
| − | To edit any of the settings for the | + | To edit any of the settings for the category, select from the menu bar. 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== | ==Master Category Assignment== | ||
| − | This section provides the facility for selecting the | + | This section provides the facility for selecting the categories to be used for each script set. |
| − | Unassigned Categories – | + | '''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 – | + | '''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 a Category== | ==Assigning a Category== | ||
| − | Categories must be created at | + | Categories must be created at master script level first or they will not be available at script set level. |
| − | To assign a | + | To assign a category, select the required one from the '''Unassigned Categories''' list and click the right arrow. |
| − | + | To remove an assigned category, select the required category from the '''Assigned Category''' list and click left arrow. | |
| + | To view a list of categories for each script set, expand the script set using . Select a category in the navigation pane to view the category properties. | ||
| − | + | The '''Editing Pane''' will now show: | |
| − | + | '''Bread-crumb''' - This displays the currently selected category. | |
| − | + | ===Category Properties=== | |
| − | + | [[File:categoryproperties41.png]] | |
| + | '''Name''' - A descriptive name used for display purposes | ||
| + | '''Master Category''' - The associated master category name is displayed. This is to assist where the category name has been amended at script level. | ||
| − | + | '''Selectable''' (visible) - If this button is checked the topic is visible to operators. | |
| − | + | '''.. Continuation (not visible)''' - If this is checked the topic is not visible to operators and would be used as a continuation script linked to a visible script. | |
| − | + | '''Topics''' - Shows topics that have been set as continuation (not visible) are displayed in the navigation pane with the leading ‘..’ | |
| − | + | '''Test''' - If this is checked the scripts are visible when run using the script test facility ('''Test''' - on the Main Menu), but not visible to operators. | |
| − | + | You can only assign and un-assign categories if you have switched to exclusive mode. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | You can only assign and | ||
==Setting up Topics== | ==Setting up Topics== | ||
| − | |||
| − | This section provides the facility for selecting the | + | This section provides the facility for selecting the topics to be used for the script set. |
| + | [[File:topicassignment41.png]] | ||
| + | *'''Unassigned Topics''' – Shows the full list of Topics for the category that are available for assignment. These are topics that have been set up in the master scripts. | ||
| + | *'''Assigned Topics''' – shows those topics that are already assigned to be used for this category in this script set. script sets can therefore use a unique selection of the topics available. | ||
| − | + | Topics must be created within a category at master script level first or they will not be available at script set level. | |
| − | + | To assign a topic select the required topic from the '''Unassigned Topics''' list and click on the right arrow button. | |
| − | + | To remove an Assigned Topic, select the required Topic from the '''Assigned Topics''' list and click the left arrow button. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Category Images== | ==Category Images== | ||
| Line 101: | Line 95: | ||
===Topic Hotspots=== | ===Topic Hotspots=== | ||
| − | Images with | + | Images with '''Hotspot''' areas are displayed to operators as they select a category. Hotspots are linked to topics within the selected category. By selecting a hotspot, operators are selecting the associated topic. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | Click on '''Topic Hotspots''' to open the hotspot editor. This will display the image and the hotspots with the associated topics that have been created at the master script level. By default, this will be the image displayed to the operators. | |
| − | If changes are made to | + | If changes are made to topics at the Script Set Category level, they also need to be changed in the image, Hotspots and Topics at the Script Set level. |
| − | To edit the | + | To edit the hotspot click on '''Edit''' in the menu bar |
A message will appear: | A message will appear: | ||
| − | + | [[File:hotspotmessage41.png]] | |
| − | + | If '''Yes''' is selected, changes made at script set level will be unique to that script set. | |
| − | |||
| − | + | To continue, select '''Yes''' and the following screen will be displayed: | |
| − | + | [[File:hotspoteditor(a)41.png]] | |
| − | + | ====Set Level Properties==== | |
| − | + | *'''Image''' – Identifies the image file being used – default images are ‘png’ format. ‘Gif’, ‘bmp’ and ‘jpg’ format can also be used. Use the browse button to select an image. | |
| − | Image – | + | *'''Display Text''' – Enter the name for the image to be displayed to operators |
| + | *'''Topic''' – Displays the topics within the selected category. Where a hotspot has not been created is shown to the right of the topic. To create a hotspot for the Topic click the '''+'''; A new hotspot area will be created in the image which can be moved and resized as required (any overlapping areas will be highlighted in red). | ||
| − | + | If you are in exclusive mode and you have overridden the Master Hotspot for this category as detailed above there will be an option to remove the image and all related hotspots. To do so, click on '''Edit''' and then on the '''Remove image and Hotspots''', you can then save your changes. This will align your Set level image with that of the Master set. | |
| − | |||
| − | + | [[File:removehotspotimage2.png|center]] | |
| − | + | [[File:removehotspotimage3.png|center]] | |
| − | + | ===Related Images=== | |
| − | |||
| − | |||
| − | + | Keyfax Inter•View also provides a facility for operators to view additional images appropriate to the selected category; this is visible from the related images tab. Images available within each category are set up at master script level. | |
| − | + | Click on '''Related Images Assignment''' to view the assigned images. The following screen will appear: | |
| + | [[File:relatedimageassignment41.png]] | ||
| + | *'''Breadcrumb''' – This displays the selected script set and category. | ||
| + | *'''Unassigned Images''' – Shows the full list of images for the category available for assignment. These are images that have been set up in the master scripts. | ||
| + | *'''Assigned Images''' – Shows those images already assigned to be used for this category in this script set. script sets can therefore use a unique selection of images available. | ||
| + | You must set up related images categories at the master script level before they are available at script set level. | ||
| − | + | To assign images, select the required image in the '''Unassigned Images''' list and click on the button. To remove an assigned image, select the required image from the '''Assigned Images''' list and click the button. | |
| − | |||
| − | |||
| − | |||
| − | To assign images, select the required image in the Unassigned Images list and click on the button. To remove an | ||
==Topics== | ==Topics== | ||
| − | In the | + | In the navigation pane, select a '''Topic''' to display the topic properties in the editing pane. By default, the topic details will be those inherited from the master scripts. These can be amended at the script set level to present a unique set of script topics for the script set. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | Click '''Edit''' on the menu bar to amend details for the script set | |
| − | + | [[File:topicproperties41.png]] | |
| − | + | *'''Bread-crumb''' – This displays the currently selected topic with its associated script set and category. | |
| − | + | ====Topic Properties:==== | |
| − | Test – | + | *'''Name''' – The displayed name of the Topic |
| + | *'''Key Words''' – Keywords used by the keyword search for Operators when looking for a Topic – use all words that might assist with the selection. | ||
| + | *'''Related Image''' – This is the image displayed to Operators in the viewing pane when they select the ‘Related Images’ tab for the Topic. The drop-down list displays all images available for the Category. Any image selected will be shown display area. If an associated thumbnail image has also been created, this will be displayed in the display area to the right. | ||
| + | *'''Selectable (visible)''' – If this button is checked, the Topic is visible to Operators | ||
| + | *'''.. Continuation (not visible)''' – If this box is checked, the Topic is not visible to Operators and would be used as a continuation Script linked to a visible Script. Topics that have been set as Continuation (not visible) are displayed in the navigation pane with the leading ‘..’ | ||
| + | *'''Test''' – If this is checked, Scripts are visible when run using the Script Test (Test - on the Main Menu) but not to Operators. | ||
Latest revision as of 09:30, 2 October 2019
Script Sets contain the elements of the scripts that the operators can access.
Select script sets from the scripts menu to open a new tab.
Contents
This contains the script selection under the selected level.
- Level – Use to select the level of scripts.
- Set - To view all script sets.
- Alias To view script sets being used as an alias.
Aliases 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.
Example 1: Shows the script set 'Housing Services (Tenants)' and the associated categories.
Example 2: shows that script set 'test' is an alias of script set 'Housing Services (Tenants)'. It is therefore displayed as sub-ordinate to that script set.
The Viewing/Editing Pane
Displays the properties of the selected script once a script set in the navigation pane has been selected:
- Bread-crumb – this displays the currently selected script set.
- Script Set Properties:
- Code – The code for the script set; that should be set to the code passed from the host system (in the startup data file)
- Name – A descriptive name used for display purposes
- Policy Help page – The URL UNC path to the policy pages for the script set. Example URL: http://dev.touch-base.com/kfc32/test.htm example UNC path: FILE:////servername/sharename/file1.doc
- Alias for Set – The script set that this set utilises.
To edit any of the settings for the category, select from the menu bar. 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 a Category
Categories must be created at master script level first or they will not be available at script set level.
To assign a category, select the required one from the Unassigned Categories list and click the right arrow. To remove an assigned category, select the required category from the Assigned Category list and click left arrow. To view a list of categories for each script set, expand the script set using . Select a category in the navigation pane to view the category properties.
The Editing Pane will now show:
Bread-crumb - This displays the currently selected category.
Category Properties
Name - A descriptive name used for display purposes
Master Category - The associated master category name is displayed. This is to assist where the category name has been amended at script level.
Selectable (visible) - If this button is checked the topic is visible to operators.
.. Continuation (not visible) - If this is checked the topic is not visible to operators and would be used as a continuation script linked to a visible script.
Topics - Shows topics that have been set as continuation (not visible) are displayed in the navigation pane with the leading ‘..’
Test - If this is checked the scripts are visible when run using the script test facility (Test - on the Main Menu), but not visible to operators.
You can only assign and un-assign categories if you have switched to exclusive mode.
Setting up Topics
This section provides the facility for selecting the topics to be used for the script set.
- Unassigned Topics – Shows the full list of Topics for the category that are available for assignment. These are topics that have been set up in the master scripts.
- Assigned Topics – shows those topics that are already assigned to be used for this category in this script set. script sets can therefore use a unique selection of the topics available.
Topics must be created within a category at master script level first or they will not be available at script set level.
To assign a topic select the required topic from the Unassigned Topics list and click on the right arrow button.
To remove an Assigned Topic, select the required Topic from the Assigned Topics list and click the left arrow button.
Category Images
Topic Hotspots
Images with Hotspot areas are displayed to operators as they select a category. Hotspots are linked to topics within the selected category. By selecting a hotspot, operators are selecting the associated topic.
Click on Topic Hotspots to open the hotspot editor. This will display the image and the hotspots with the associated topics that have been created at the master script level. By default, this will be the image displayed to the operators.
If changes are made to topics at the Script Set Category level, they also need to be changed in the image, Hotspots and Topics at the Script Set level.
To edit the hotspot click on Edit in the menu bar
A message will appear:
If Yes is selected, changes made at script set level will be unique to that script set.
To continue, select Yes and the following screen will be displayed:
41.png)
Set Level Properties
- Image – Identifies the image file being used – default images are ‘png’ format. ‘Gif’, ‘bmp’ and ‘jpg’ format can also be used. Use the browse button to select an image.
- Display Text – Enter the name for the image to be displayed to operators
- Topic – Displays the topics within the selected category. Where a hotspot has not been created is shown to the right of the topic. To create a hotspot for the Topic click the +; A new hotspot area will be created in the image which can be moved and resized as required (any overlapping areas will be highlighted in red).
If you are in exclusive mode and you have overridden the Master Hotspot for this category as detailed above there will be an option to remove the image and all related hotspots. To do so, click on Edit and then on the Remove image and Hotspots, you can then save your changes. This will align your Set level image with that of the Master set.
Related Images
Keyfax Inter•View also provides a facility for operators to view additional images appropriate to the selected category; this is visible from the related images tab. Images available within each category are set up at master script level.
Click on Related Images Assignment to view the assigned images. The following screen will appear:
- Breadcrumb – This displays the selected script set and category.
- Unassigned Images – Shows the full list of images for the category available for assignment. These are images that have been set up in the master scripts.
- Assigned Images – Shows those images already assigned to be used for this category in this script set. script sets can therefore use a unique selection of images available.
You must set up related images categories at the master script level before they are available at script set level.
To assign images, select the required image in the Unassigned Images list and click on the button. To remove an assigned image, select the required image from the Assigned Images list and click the button.
Topics
In the navigation pane, select a Topic to display the topic properties in the editing pane. By default, the topic details will be those inherited from the master scripts. These can be amended at the script set level to present a unique set of script topics for the script set.
Click Edit on the menu bar to amend details for the script set
- Bread-crumb – This displays the currently selected topic with its associated script set and category.
Topic Properties:
- Name – The displayed name of the Topic
- Key Words – Keywords used by the keyword search for Operators when looking for a Topic – use all words that might assist with the selection.
- Related Image – This is the image displayed to Operators in the viewing pane when they select the ‘Related Images’ tab for the Topic. The drop-down list displays all images available for the Category. Any image selected will be shown display area. If an associated thumbnail image has also been created, this will be displayed in the display area to the right.
- Selectable (visible) – If this button is checked, the Topic is visible to Operators
- .. Continuation (not visible) – If this box is checked, the Topic is not visible to Operators and would be used as a continuation Script linked to a visible Script. Topics that have been set as Continuation (not visible) are displayed in the navigation pane with the leading ‘..’
- Test – If this is checked, Scripts are visible when run using the Script Test (Test - on the Main Menu) but not to Operators.
