Menu Operation Guide

Created by Migration Bot, Modified on Fri, 23 Oct at 2:29 PM by Migration Bot

Originally written by John Hardwick, last updated Oct 24, 2023, on the Swan Retail knowledge base (FRS).


Based on SwanFRS 1205

Overview

SwanFRS offers the ability to have user specific menus. This document details how to make the most of the menu structure and its features.

 SwanFRS offers the ability to have bespoke reports embedded into the menu / move your reports into your own menu folders and control which users have access to them.

 This document details how to configure the menu system.

Configuration

Roles

Menu Location: System Admin  > Security > Set Up Roles

Prior to building users, it is recommended that the role be created.

 A role is a ‘job’ specification which will allow a pre-determined set of tasks to be performed.  Details of how to set up roles and the available tasks is documented within the implementation manual.

If the role requires the operator to regularly check the status of customer orders, ticking the Show Sales Orders On SwanFRS Menu presents a list of sales orders on the main menu.  The list is controlled by the operator’s default search profile as seen within Find Sales Orders.

Find Sales Orders

SwanFRS offers the ability to set a series of search profiles.  The first profile listed (as shown) below is used to populate the order list on the main dashboard.

 In the example above the Deliverables profile is used to populate the list of customer orders on the main menu.

For more details re how to configure search profiles refer to the Find Sales Order Profiles Guide.

Report Roles

SwanFRS uses the concept of a role to control access to reports.  A report can only have one role linked to it and therefore a different approach is required to ensure controlled access is possible.

 When considering reports, it is recommended to group reports into lists where there is a commonality to the data available.

 Create a role to cover this grouping (as in the example below)

The type of reports linked to pack 1 would be order book and showroom stock availability, pack 2 could be turn over and demand, pack 3 group could be reports showing margin and profit.

It is possible to delete a role once the role is unlinked from all users.

The role does not have any privileges.  It is there only to enable users who have the SAL-REP3 role to select reports linked to it.

Mobile Users

It is possible define a user as mobile. I.e., their default place of work could be one of several locations.

To set a user as mobile click the mobile user tick box. This generates the BA Links button.

When operating without business areas this allows the operator to select any ‘active’ location at time of logging in.

 When operating with Business area it is necessary to select BA LINKS generates the following page in which it is possible to define which area(s) the user can work from.

At time of login, once a valid login and password has been entered, the routine will allow the operator to choose their place of work for this session.

The operator may only choose locations available within the drop-down list.  Once chosen, subject to permissions, the working location can be changed by selecting the swap locations from the side panel menu.

Where permissions allow this is also the point where it is possible to change the working date for the session.

It is possible to alter the working location and working date at any stage by selecting the appropriate option from the side panel.

User Roles

Without a role, the user will simply be able to login to SwanFRS but will not be able to process a transaction.  To achieve this, the user must be given one or more role.

 This is achieved via the roles section of the users’ detail page.

The roles control access to reports and routines within the system, for example If these roles do not include the ability to view or create purchase orders then the purchase order menu will not be visible on screen

Operation

Reporting

It is possible to add your own / bespoke Crystal reports to the system which are then embedded into the SwanFRS reporting menu structure.  Please note however that bespoke reports are not supported by Swan.  Swan can provide training for Crystal, details available upon request.

Reporting Menus

Menu Location: System Admin  > Reports > Set Up Report Submenus

Sub menus within the reporting folder can be modified as required.

 It is possible to change the menu title and / or create new report menus via this routine.

A menu will only be visible when one or more reports are available for your login code.

Report Links

Menu Location: Administrator > Reports > Set Up Report Links

It is possible to add / remove / change the names of reports within the reporting menu along with changing each reports access role.

 It is possible to change the menu title and / or create new report menus via this routine.

The  icon allows a report to be removed from the menu structure completely.  This option is not available for embedded system reports.

It is possible to have duplicate reports within different menu folders.

Publishing Your Own Crystal Reports

Design your report using the Crystal report designer tool.

If you have Crystal 10 (or earlier) please refer to the Publishing your Pre-Version 11 Crystal Reports Guide.

If you have Crystal 11 (or above) save the finished version of the report on the SwanFRS application server in the C:\inetpub\wwwroot\Reports folder (this path may vary on your server) code.

It is recommended that you name your report with a version suffix (e.g., Report name 1.rpt).  This will assist with version control should you need to change the report.

Any non-standard report added to the reporting menu is excluded from the standard support agreement.  Any Swan support required for these reports may incur additional support costs.

Once saved on the application server, open SwanFRS and select the Setup Report Links routine.

This will generate a page like that shown below –

To create a new report, click NEW button or use the option on the side panel.

Specify the following –

Field

Contents

Report Name  

Specify the name of the report as it is to appear in the reports menu.

This name should be unique

Report File Name

Specify the actual name of the report as created within Crystal® without the .rpt suffix

Folder

Choose a report subfolder from the list.

Access Role

Choose the role this report will be available for

Bespoke

Set this field to Yes if the report is not to be altered by an upgrade script.  I.e., freeze the report from automatic updates.

Label Print

Only applicable for ‘label’ type reports, tick instructs SwanFRS to show this report as a label either displayed on the side panel or accessible via the Print Labels option displayed in key programs within the system.

Favourites Label

Only used for ‘labels’, ticking tells SwanFRS this label is to appear on the side panel of key stock related programs such as Warehouse Stock Search.

Report Side Menu Name 

Applicable only to ‘Favourite Labels’ this field allows the operator to ‘name’ the label design as desired thus making it easier for the operator to work out which label to send the stock item to for printing.

 Once the report has been configured select the rebuild menu button to add it to the menu system where it will be available for use by all users holding the specified access role.

To remove a report from the listing entirely set the report to a role that is not linked to any user.

System Audits

Reports are generally available within the reports menu folder and are selected by the operator.  Audits are system generated reports occurring when an action is selected or completed (for example the purchase order)

Audits are effectively Crystal® reports and are therefore modifiable (subject to having access to the Crystal® designer application).  Where modified it is necessary to tell SwanFRS to call this bespoke version rather than the standard. 

System audits are listed with the Folder of System report. Modify with caution. (As in the screen example below)

To change an audit, specify the alternate Report File Name (all other fields are prohibited) and if required set the bespoke tick box prior to clicking the REBUILD MENU button.

Both system audits and report changes may be overwritten at time of upgrade – to retain your version of the audit ensure the Bespoke tick box is set.  This will freeze the audit – any changes to the ‘standard’ will not be applied – If a system enhancement is required it will be necessary to re-apply your changes to the standard or to extract the standard modifications incorporating them into your version of the audit.

Menu Operation

When the SwanFRS desktop icon has been selected the login, screen will be presented.

To gain access to the system a valid username and password must be supplied.

 By logging into SwanFRS, you are agreeing to the End User Licence Agreement (EULA) which is accessible by clicking into the EULA hyperlink displayed on the login page.

Once logged into SwanFRS a screen like that shown below will be displayed.

The following screen shot has been modified to highlight the key elements of the display.

Each red circle indicates a different area of the home page identified below

1

Main Menu

This is a dynamic list of all the routines the user is allowed access to.

2

Keyword Search

The feature allows you to search for a routine without having to navigate the menu system.

3

Information Area

This section displays user specific information

4

Company News

Where configured the menu will present a series of messages (set by company) providing information to the operator.

5

Significant Sales Orders

Where configured the menu will present the operator with a list of customer orders that are significant to the operator. 

6

Messages

Where configured the menu will present the operator with a list of messages assigned to the operator. 

Operators Menu

The menu displayed across the top of the page with the blue (system default) colour is user specific. 

 This menu is always visible when operating SwanFRS allowing the operator to pause their current action by selecting an alternative menu option.

 It consists of three elements

SwanFRS Logo

Clicking the SwanFRS icon returns control back to the main login dashboard clearing all program histories (I.e., Clears the back button history generated when navigating through SwanFRS.).

Favourites

This menu item only displays when the operator has ‘favourite’ programs selected.

The user may define a series of routines commonly used.  This removes the need to locate the option within the menu system.

The number of options is not limited but effectively cannot exceed the number of routines available in the user’s default menu listing.

To select a favourite simply click on the item in the pick list to select.

Favourites are created and modified via the Modify favourites option which resides with the information area (right hand side of the menu bar). 

Creating Favourites

To create or modify the list of favourites click on the Modify favourite’s option in the user’s information area.  This produces the following screen.

To add an option to the favourites menu, enter a number (range 0 to 300) into the Selected Order column.  To remove a favourite, remove the value.

The routine will sequence the favourites selected using the number assigned to it.  Where duplicate numbers have been specified the routine will use the title of the option (alphabetical list within like order number)

If a routine becomes blocked from the user which is also a favourite the system will cease to offer the favourite.

Features Access

The list of accessible ‘user’ features is listed to the right of the ‘SwanFRS’, ‘Favourites’ in the menu bar.

 This consists of a title which when selected will display the programs available to the operator.

Items listed within the menu header are listed alphabetically except for ‘favourites’ which are automatically listed first, the assumption being that since it’s a favourite you will use it more often than other choices and therefore it should be elevated to the top of the list.

Custom Menu Features Search

It is possible to create a series of custom menu catalogue search options on within the sales menu.  This provides a shortcut search to a ‘group’ of products rather than using the Search Catalogue option.

To configure the hierarchy searching initially visit the Setup Product Hierarchy routine.

Setting the hierarchy group to ‘can search catalogue’ and then ‘add to sales’ menu generates a new menu item on the standard menu system.

Clicking the option from the menu displays all the products with the hierarchy set.

Keyword Search

SwanFRS offers the ability to key in a series of letters or numbers which will instruct SwanFRS to search for matching items.

Entering a series of alpha (numeric) characters in the keyword search instructs SwanFRS to search for programs containing those characters in either the program name of description.

SwanFRS will only show matches for processes the operator has access to.

To select simply click the program name or if the search did not find the desired routine, rekey in the search option shown above the results list or select the action required from the menu.

Entering a numeric value instructs SwanFRS to search for data elements matching the search number.

The program will show, subject to the operator being able to view the data, matching information.

The table below shows the privilege required to view the corresponding data element.

 Search option

Constraint

Delivery notes

PLAN_DELIVERIES

Goods receipt note

VIEW_RECEIVE_GOODS

Internal order

INTERNAL_ORDER

Purchase order

VIEW_PO

SKU

VIEW_STOCK

Return to vendor (supplier)

RETURN_TO_SUPPLIER

Sales order

SALES_ORDER

Service

VIEW_SERVICE

Inventory / Stock ID

VIEW_STOCK

Transfer note

TRANSFER_STOCK_LOCAL

Write on note

WRITE_OFF_STOCK

Write off note

WRITE_ON_LOCAL

 Information Area

The information area is accessed by clicking the operator’s avatar or the small down arrow to the right of this.

The information area, subject to operator privilege will allow the operator to view, change the following data areas.

List item

Details

Operator’s name

This is the only place the operator’s full name is displayed in SwanFRS.

Clicking allows the operator to change their user profile details.

XXX Messages

This is a notification advising the operator there are XXX messages waiting for them to process.

The number is also presented on the menu bar to the left of the operator’s avatar.

Clicking displays full page of messages for the operator to progress.

Trading Location

This is the operator’s current working location.

Till Number

Where configured the linked ‘EPOS Till’ is identified.

Working Date

The date displayed is used as the ‘transaction’ date and allows empowered operators to back date transactions. (SwanFRS retains the actual date of the action for audit purposes).

Modify Favourites

Clicking allows the operator to change their favourites.

Swap Location

Where configured, this option allows the operator to change their trading location without having to log out and back in again.

Change Password

This option allows the operator to change their own password.

Information

Where configured this allows the operator to run an external browser.

System Admin

Where available, this option lists all the ‘set up’ programs accessible by the operator.

System Settings

This option, where accessible, opens the application parameters routine.

Version

This item displays the current version of SwanFRS.

Log Out

This option allows the operator to log out of SwanFRS and immediately releases the license count.

Company News

Where configured the menu displays a series of messages.  This is displayed at the top of the main dashboard.

Where suitably empowered, messages are created and modified via the Modify News / Updates option.

News items will automatically expire at a pre-set date

Creating News

To create or modify the list of favourites click on the Modify News / Updates option.  This produces the following screen.

Sales Orders

When configured, the list of sales orders is displayed towards the top of the main dashboard page and is controlled via the ‘first’ Find Sales Order profile saved against the operator.

 The primary order profile name is displayed on screen.

Messages

This section, where switched on, lists the system and colleague generated messages waiting for the operator to act on.

Files from the Confluence page

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article