Difference between revisions of "Configuration mode"

From SmartWiki
Jump to: navigation, search
(→‎Overview)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
Configuration Mode is an option available to all Administrators within the system to provide an easier mechanism for accessing and editing fields as well as to other [[configuration aids]].  
+
==Overview==
 +
'''Configuration Mode''' is an option available to all [[Global User Administrator|Administrators]] within the system. Configuration Mode provides an easier mechanism for accessing and editing fields. Admins can access the configuration from within a record.
  
−
Admins will no longer have to try and trace the field to modify its configuration, and can instead access the configuration from within a record.  
+
Users without an [[Global User Administrator|Administrator]] role are unable to use Configuration Mode.
−
+
 
−
==Using Configuration Mode==
+
==Configuration Checklist==
−
If an Administrator accesses a record in Edit mode then there will a '''Configuration Mode''' icon at the top of the page.
+
The following checklist defines a sequence that you should consider when setting up your copy of [[SmartSimple]] prior to giving people access to the system:
−
::[[Image:ConfigMode1.png|border|400px]]
+
 
 +
* Configure Organization Settings - set [[Branding#Colors_.26_Styles|colour scheme]], [[License Definition|licensing]], [[Backup Server and Testing Instances|backup]] and [[Organization Terminology|terminology]].
 +
* If required, define the [[Custom Fields|custom fields]] required for organisations – add the fields you need to accurately reflect your business.
 +
* Create or upload organization information for both [[Internal|internal]] and [[External|external]] organizations – add organization information to the system.
 +
* Define [[Role|roles]] for people – add the [[Role|roles]] people play in the business to accurately reflect your business.
 +
* Define any [[Custom Fields|custom fields]] for [[Role|roles]] – add the fields you need to accurately reflect the [[Role|roles]] people play in business.
 +
* Define or upload "people" - [[Internal|internal]] or [[External|external]] organizations – add people to the system.
 +
* Subscribe to [[SmartSimple]] [[Applications|applications]] – determine the applications required by each group of people.
 +
* Give Manager Permission to specific [[Role|roles]] – determine which groups of people are responsible for each application and feature.
  
 +
[[Category:Global Settings]][[Category:System Management]]
  
−
If the Administrator clicks on this then there will be a small tab at the top of the page to indicate they are in '''Configuration Mode''', with a Refresh and Close icon.
+
==Using Configuration Mode==
−
::[[Image:ConfigMode2.png|border|250px]]
+
To get into Configuration Mode, the Administrator must first be in '''Edit Mode. '''
  
 +
1. After accessing any record, there will be an '''Edit '''button that takes you into '''Edit Mode.'''
  
−
Then when you scroll over the fields on the record they will be highlighted and can be clicked on.
+
:: [[File:EditButton.png|200px|border]]
−
::[[Image:ConfigMode3.png|border|800px]]
+
2. Select the '''Options '''button, which will produce a drop-down menu. 
  
 +
3. Under '''Settings, '''select '''Configuration Mode. '''
  
−
When clicked a modal widow opens with the configuration page for that field. Changes can be made and saved, and will appear against the field once the page has been refreshed. 
+
:: [[File:ConfigurationMode.png|200px|border]]
−
::[[Image:ConfigMode4.png|border|800px]]
+
There will be a small tab at the top of the page to indicate you are in '''Configuration Mode''', with a Refresh and Close icon.
  
 +
:: [[Image:ConfigMode2.png|250px|border]]
 +
Then, when you scroll over the fields on the record, they will be highlighted and can be clicked on.
  
 +
:: [[Image:ConfigMode3.png|800px|border]]
 +
When a field is clicked, a modal window opens with the configuration page for that field. Changes can be made and saved, and will appear against the field once the page has been refreshed.
  
 +
:: [[Image:ConfigMode4.png|800px|border]]
 
==Configuration Shortcuts / Syntax Checker==
 
==Configuration Shortcuts / Syntax Checker==
 +
When the '''Configuration Mode''' icon is clicked in Edit mode, the '''Configuration Shortcuts''' section also appears on the right side of the screen.
  
−
When the '''Configuration Mode''' icon is clicked in Edit mode the '''Configuration Shortcuts''' section also appears on the right side the screen.
+
:: [[Image:ConfigShortcut.png|200px|border]]
−
::[[Image:ConfigShortcut.png|border]]
+
It includes links to many of the General Settings specific to the entity you are currently accessing.
−
 
 
−
It includes links to many of the General Settings specific to the entity you are currently accessing.  
 
  
 
It also includes a link to the '''Syntax Checker'''. This feature allows administrators to test [[Variables]] syntax and [[Template / Type Formula|Type Formulas]] against actual records.
 
It also includes a link to the '''Syntax Checker'''. This feature allows administrators to test [[Variables]] syntax and [[Template / Type Formula|Type Formulas]] against actual records.
−
::[[Image:SyntaxChecker.png|border|550px|border]]
 
−
 
−
* Click on the link to the '''Syntax Checker'''.
 
−
* Enter variable syntax in field at top of the '''Syntax Checker Tool''' page.
 
−
::*'''NOTE:''' Press "Tab" key to see available keywords
 
−
* Press "Enter" key to process the page
 
−
* Results appear in the grey panel at the bottom.
 
−
 
−
   
 
−
 
  
 +
:: [[Image:Syntax Checker.png|550px|border]]
 +
:
 +
:* Click on the link to the '''Syntax Checker'''.
 +
:* Enter variable syntax in the panel on the left hand side of the '''Syntax Checker Tool''' page.
 +
:*:* '''NOTE:''' Press "Tab" key to see available keywords
  
 +
:* Press "Process Variables" button.
 +
:* Results appear in the grey panel on the right hand side of the '''Syntax Checker Tool''' page.
  
 +
==See Also==
 +
* [[Configuring a SmartSimple Instance]]
 +
* [[Custom fields]]
  
 
[[Category:Custom Fields]] [[Category:Standard Fields]] [[Category:Universal Tracking Application]][[Category:UTA Settings]]
 
[[Category:Custom Fields]] [[Category:Standard Fields]] [[Category:Universal Tracking Application]][[Category:UTA Settings]]

Latest revision as of 13:17, 27 November 2019

Overview

Configuration Mode is an option available to all Administrators within the system. Configuration Mode provides an easier mechanism for accessing and editing fields. Admins can access the configuration from within a record.

Users without an Administrator role are unable to use Configuration Mode.

Configuration Checklist

The following checklist defines a sequence that you should consider when setting up your copy of SmartSimple prior to giving people access to the system:

  • Configure Organization Settings - set colour scheme, licensing, backup and terminology.
  • If required, define the custom fields required for organisations – add the fields you need to accurately reflect your business.
  • Create or upload organization information for both internal and external organizations – add organization information to the system.
  • Define roles for people – add the roles people play in the business to accurately reflect your business.
  • Define any custom fields for roles – add the fields you need to accurately reflect the roles people play in business.
  • Define or upload "people" - internal or external organizations – add people to the system.
  • Subscribe to SmartSimple applications – determine the applications required by each group of people.
  • Give Manager Permission to specific roles – determine which groups of people are responsible for each application and feature.

Using Configuration Mode

To get into Configuration Mode, the Administrator must first be in Edit Mode. 

1. After accessing any record, there will be an Edit button that takes you into Edit Mode.

EditButton.png

2. Select the Options button, which will produce a drop-down menu. 

3. Under Settings, select Configuration Mode. 

ConfigurationMode.png

There will be a small tab at the top of the page to indicate you are in Configuration Mode, with a Refresh and Close icon.

ConfigMode2.png

Then, when you scroll over the fields on the record, they will be highlighted and can be clicked on.

ConfigMode3.png

When a field is clicked, a modal window opens with the configuration page for that field. Changes can be made and saved, and will appear against the field once the page has been refreshed.

ConfigMode4.png

Configuration Shortcuts / Syntax Checker

When the Configuration Mode icon is clicked in Edit mode, the Configuration Shortcuts section also appears on the right side of the screen.

ConfigShortcut.png

It includes links to many of the General Settings specific to the entity you are currently accessing.

It also includes a link to the Syntax Checker. This feature allows administrators to test Variables syntax and Type Formulas against actual records.

Syntax Checker.png
  • Click on the link to the Syntax Checker.
  • Enter variable syntax in the panel on the left hand side of the Syntax Checker Tool page.
    • NOTE: Press "Tab" key to see available keywords
  • Press "Process Variables" button.
  • Results appear in the grey panel on the right hand side of the Syntax Checker Tool page.

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Configuration_mode&oldid=37288’