Menu Custom Changes (MobiAdmin)
- Silas Canning (Unlicensed)
Navigate to Administration -> <Your Company Name> Setup -> Mobi Setup -> and search for the newly created custom menu you created during the Getting Started process in the Menu tab (by default this menu will only display those menus that are custom copies).
The important fields to identify here are as follows:
Code Value: Code Name of the menu as seen in Before you Start.
Description: Enter description- The name of the menu that app users will see
Default type: Double click to select here any Job Type cost centres (e.g. EXM, IMM) for which the menu will show by default. Leaving the field blank means the menu is available for all types (except as set in step 4).
Exclude Type: Double click to select here any Job Type cost centres (e.g. EXM, IMM) for which the menu will NOT show. Leaving the field blank means the menu is available for all types (except as set in step 3).
Branches: Double click to select here any Branches for which the menu is available. Leaving the field blank means the menu is available for all branches.
Parent menu: This determines the parent menu under in which your menu will appear. Parent menus are the bottom bar menus in Mobi. The most common types are Jobs and Daily. E.g.:
Link: This is where the user may control if the report is linked to a Mobi menu or a Mobi review or report. In here the user can ALSO control how the menu behaves (as in under what circumstances it appears).
Every Menu needs to be linked with an actual menu
.– To create a menu for a Review question, the link would read: review.html (all needs to be lowercase).
The specific review that the menu is linked to is then referenced here:
IMPORTANT: If you have custom modified a Review linked to a Menu ensure to relink it here by directing the menu to the new review version.
– To create a menu for a Report, the link would read: reports.html
The specific report(s) that the menu is linked to is then referenced as follows:
IMPORTANT: If you have custom modified a Report linked to a Menu ensure to relink it here by directing the menu to the new report version.
– All other menus are linked by default and cannot be modified.
7. Link Cont’d. Some menus will display a “?” in the Link after the html text. This refers to a parameter that allows the user to control how the menu behaves. For example, if the link field has review.html?isJob=true, then this means that the review question is based on the specific job.
The options are:
Parameter | Description/Use |
|---|---|
isJob=true | This makes the menu JOB specific (instead of Day Specific) E.g. “Client Signoff” |
isJob= false | This makes the menu DAY specific (instead of Job Specific) E.g. “Day Start” |
Lock= true | This would enable a password unlock prompt when closing or navigating away from the menu. Commonly used to prevent the customer from Navigating through Mobi. After completing a Client Signoff. The password is controlled in Mobi Settings. |
isClient=true | This parameter controls whether the menu is client controlled or user controlled. If set to True, the menu becomes un-editable. When set to false it becomes editable. This setting is commonly used on the Materials and Accounts screens |
Call=daily, | This controls the flow of the diary search screen. If call= daily, the daily menus will be displayed after a diary action is selected. If call=global, then the global jobs menu will appear after selecting a diary action. |
Search=today, Search=tomorrow | This parameter sets the default duration for diaries in the Diary search screen. |
Diary=O | This makes the menu ONLY visible when the action being worked on is an Operational action (assigned to diary O) |
Diary=W | This makes the menu ONLY visible when the action being worked on is a Warehouse action (assigned to diary W) |
Diary= True* | This makes the menu DIARY ACTION specific, meaning that on a job that operates over many days, this menu keeps re appearing every day instead of once off, and each linked review or report would display as unanswered, to be completed again. |
Reports=(NAME OF REPORT) | This is used to link the menu to a specific report (when this menu is selected the linked report will automatically load up |
IsEnabled=true | This parameter applies only to the Notes Menu. If set to true, accessing the notes will by default be editable. If set to false then notes will show as un-editable (although users can still edit by clicking the "Edit" button). |
show=true | This parameter tells Mobi to display the review menu in the Jobs menu (otherwise it will just show in the day flow) |
*Important Note:
When the diary flag mentioned above is not set then, there can be errors where a report has previously completed signatures, or a review has review questions pre-answered. The easiest way to find out if a report related issue is linked to this flag is that when generating the same report a second time (on a second date) on Mobi for a different diary action, signatures, images and/or answers are repeated over from a report of a different diary action.
Procedure: N/A – This field is for developers only.
Class: This allows custom class css to be assigned to the menu item. For almost all cases, there are only two classes that are used:
– JobDependent disabled (Note: JobDependent is one word and the capitalisation has to match exactly). When entered into the class field, the menu item is dependent on having a job selected, and if not it will be disabled (i.e.: the user can’t select it).
– diaryDependent disabled: When entered into the class field, the menu is dependent on having a diary action selected. If no diary action is selected, the user won’t be able to select the menu.Comments: Free text entry field that can be used to make notes on what the menu does- it does not impact the functionality of the menu.
Status: Can be Active or Inactive, allowing the user to control which menus are in use (Active) and which are not (inactive).
Shortcut: N/A
Review type: As explained above, this is where menus are linked with the specific review question. Double clicking in here will bring up a list of all the active reviews which can then be selected. (when this menu is selected the linked review loads up
Extra: Used to show whether a menu is beta or live code. If set to Beta, the menu will only show when the version setting is Debug (Mobi Settings)
Lookup Sort: Changes the order in which the menu appears, relatively to other menus under the same parent menu.
Colour: Adjusts the colour of the menu
Icon: Determines which icon to display for the menu. Options are:
Date: N/A
Mobi Setup: This will automatically display “Mobi Custom” when a menu is copied to indicate this is a custom copy of a menu and not a standard menu
Mobi Code: This is the section in which the user can control under which type of job specific diary action (when the menu is set to be used in a Job and Diary action specific flow) the menu displays or does not. This code only applies when the setting “WorkflowJobsFiltering” is set to Key actions. Please note it only applies on the workflow screens (not on the Global Jobs Screen).
– If this section is left Blank, then menu shows for all actions.
– If it shows some key actions (found in Diary actions> Key actions): then the menu will only show for those diary actions and hide for all others.
– If it shows some key actions and then shows HIDE and then more key actions, then it will only for the actions keyed above the HIDE.
– If it says, “DO NOT SHOW IN WORKFLOW”, then it won’t appear in the Job workflow (in other words it will NOT show regardless of the diary action being worked on)Key actions can be added or deleted using the Plus and X icon. An example below: