Changes

Configuring a SmartSimple Instance

1,301 bytes added, 15:34, 19 October 2022
no edit summary
=Overview=[[Configuration ChecklistSmartSimple]]==is a cloud-based platform that prides itself on its total flexibility; we have highly configurable options for almost every part of our system, so that you can easily tailor your [[instance]] to your company's direct needs as well as your personal preferences. This page will bring you through the general chronological steps for configuring a SmartSimple instance. By the end of it, you will have built the foundations for a system that is designed for your unique business aims. 
The following checklist defines a =Configuration - Essentials===Configuration Checklist==Prior to beginning your configuration, read over this sequence that you should consider when setting up your copy of [[SmartSimple]] prior to giving people (before anyone is given access to into the system:* Configure Organisation Settings – set colour scheme, licensing, backup and terminology).* If required, define These highlight the custom fields required for organisations – add the fields general topics/areas that are configurable and that will help you need to accurately reflect make your business.* Create or upload organisation information for both internal and external organisations – add organisation information to the system.* Define roles an ideal tech solution 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 organisations – 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 featurecompany.
{| class=="wikitable"|-||'''Configuration Organization Settings'''||Set a [[Branding|colour scheme]], [[License definition|licensing]], [[Backup Server and Testing Instance|backup instance]] and customized [[Organization Terminology|terminology]].|-||'''Custom Fields'''||If required, define the [[Custom Fields]] required for your organizations. These are fields that you might need to accurately reflect your business, but go beyond the standard '''Name, Phone Number, Address '''etc. |-||'''[[Internal]] and [[External]] Organization Information'''||Create or import organization information for the organizations in your system's [[Organization hierarchy|organization hierarchy]]. |-||'''[[Global SettingsUser Role|Roles]]=='''||Define the roles that people play in your business.
[[Global Settings]] '''Example: '''If you are accessed though the [[Configuration Menu|Configuration]]a research-based company serving university grants, Global Settings [[Menu|menu]]. This page contains key global settings in a set of sections. This [[Menu|menu]] and related tabs are only available you might want to system administratorsmake roles labelled '''Peer-Reviewer, ''''''Professor, Departmental Lead '''etc.
1|-||'''[[User]] Imports'''||Define or upload "people" (users/contacts) into their respective substrata of your [[Organization hierarchy|organization hierarchy]]. Click the |-||'''[[Configuration MenuGlobal User Administrator|ConfigurationSystem Administrator]]/Manager Permissions '''||Give high-level permissions to specific roles and choose your {{GUA}}s. Determine which groups of people will be responsible for each application and feature in your SmartSimple copy. |}<pre>Tip: Keep this page open while opening hyperlinks from this page. Although other articles will give more specific instructions for configuring certain features, this page will be helpful by providing a broad sequence of areas required for successful configuration. </pre>==Menu and Global Settings ==If you are a [[MenuGlobal User Administrator|menuSystem Administrator]], you will have access to '''Global Settings. '''Users with SysAdmin permissions will be able to access all functions within the system and to customize roles, security, feature visibilities, etc. Be cautious with who you assign in a SysAdmin role, as their access into the system has the potential to make wide and immediate impact. 
The Global Settings page <pre> No matter what, best practice is displayed. This page is organised into a thirteen sections:* [[Branding & Visual Settings]] – how this copy of [[SmartSimple]] will look.* [[Database to test configuration and File Storage Status]] – count companies and people – plus changes to your system in the ability to restore deleted companies or contacts.* [[Login & Security Settings]] – how you wish Backup Instance prior to control access security.* [[Business Configuration Settings]] – how modifying the system should be customized to your specific business needslive instance.</pre>* The [[ObjectSync Settings]] – provides ability to syncronise companies and [[User|users]] between instances.* [[Branch & Account Settings]] – company [[Sign-Up Pages|signup pages]], [[Custom Field|custom fields]] Backup Server and NAIC codes.* [[User & Contact SettingsTesting Instance]] – user signup pages, custom fields.* [[Association Settings]] – provides ability to link users to more than one company.* [[People Online Settings]] – select the fields that will be displayed when you move your mouse over a user listed in the People online list.* [[Smart Folder]] Settings – if SmartFolders are enabled the amount of space required, and if you require use of not retain any changes into the on-line editing features.* live [[Organisational Terminologyinstance]] ; the company and people terminology you wish to use in this backup is overwritten nightly with that day's production copy of SmartSimple.* [[Phone Number Format]] – determines the acceptable format for phone numbers.* [[Data Loading & Backup Settings]] – controls scheduled data loading and scheduled backups. 
You can use the In order to properly configure your system, you must know where your '''menu icon '''Quick Linkis as well as ''' combo box at the top of the page to move to the specific section without scrollingGlobal Settings. ==[[Branding & Visual Settings]]=='''
These settings are used to control Your menu icon is located on the overall visual top right of your page, and branding settings. 1. Click on the '''Colours & Fonts''' link to review the visual settingslooks like a 9-square icon. 
==[[Using a Theme]]==:: {{Icon-Menu}} The '''Global Settings '''area of the system is available under the heading '''Configuration. '''
As an alternative to setting your own colours, you can download a colour theme from the See [[SmartSimple:Category:Global Settings|Global Settings]] wiki and apply that theme to your copyfor a full list of the available features in a set of sections. 
1. Launch a new :: [[BrowserFile:Menu and global settings.png|600px|browserborder]] window'''Note''': We aim to end support for the '''Classic '''Interface after our upcoming November 2019 Upgrade. For this reason, we encourage all clients to switch to the '''Arcadia '''Interface now, and to use the '''Arcadia''' Interface configuration options.
2==[[Branding & Visual Settings|Branding]]==* See [[Branding]] for more detailed information. Go to '''http://www.smartsimple.org''' 
3As part of the implementation process, SmartSimple or its partners will configure the look and feel of your system for you. Type '''Theme''' into Anyone with SysAdmin privileges will then be able to change the branding and visual settings of the search boxsystem at any time. 
The Page text matches are displayed. ====Accessing Branding & Visual Settings====41. Click on the link for '''Themes'''9-square menu icon on the top right of your page.
The Instructions are listed on the page and the themes listed below :: {{Icon-Menu}} 2. Under the instructionsheading '''Configuration, '''select '''Global Settings. '''
53. Follow Click onto the instructions on the pagesecond tab, labelled '''Branding.'''
:: [[File:Branding.png|700px|border]]
=====Colors & Styles=====
You have the freedom to adjust the colours and style choices of fonts in your system. All colour settings will affect all users: What a {{GUA}} sees will be the same colours that an applicant sees.
 
See [[Branding#Colors & Styles|Colors & Styles]] for more. 
 
=====Login Pages=====
=====Logo, Header, Web Alias and Email Domain=====
=====Terminology=====
==[[Using the Colour Picker]]==
Colours are selected by clicking the colour palette icon to the right of the colour box.
Colours are selected by clicking the colour palette icon to the right of the colour box. 1. Click the '''Colour pallet''' the square icon of a colour next to any branding settingthat allows colour change. 
The colour pallet is displayed.
2. Click the '''Cancel''' button.
:: [[File:html font colour.png|300px|border]]
If you need to match colours exactly with your organisation web site, you can view the HTML source of your organisation web page and find the hex codes for “colour”.
Alternatively, you can use a program such as Photoshop to “sample” an image and determine the correct colour.
 
 
==[[Login Screen Content]]==
 
You can further “brand” the login page by creating your own login page.
The Login screen content is displayed.
[[Image:Glob7.png]] 
2. Modify the content as required.
<u>'''Title Type'''</u>
The Title Type defines whether text or a login should be displayed in the top left corner of the main window. [[Image:Glob8.png]] 
When the organisation first registers, the title text displayed on the top left of the [[SmartSimple]] page is set to the organisation name.
This setting is used to upload and display a logo, or other image files that you may wish to display on the login page, and in the top left corner of the [[SmartSimple]] main window.
For the best presentation, this image should be pre-sized to '''133 by 46 pixels'''.
If you need to resize the image you can use a program such as '''Adobe Photoshop''' that allows you to set an exact height and width in pixels.
You can define alternative text to be displayed on the login page, and in the top left corner of the SmartSimple main window as an alternate to the image.
==[[Database and File Storage Status]]==
This section displays the current number of Branches ([[Internal|internal]]), Accounts ([[External|external]]), Users ([[Internal|internal]]) and Contact ([[External|external]]) in this [[Instance|instance]] of [[SmartSimple]].
A list of deleted companies/accounts, users/contacts is also displayed. You can review the deleted companies or contacts by clicking on the word “deleted”.
==[[Database and File Storage Status|Storage Summary]]==
:: [[File:Storage summary1.png|900px|border]]
This section displays the current number of Branches ([[Internal|internal]]), Accounts ([[External|external]]), Users ([[Internal|internal]]) and Contact ([[External|external]]) in this [[Instance|instance]] of [[SmartSimple]].
A list of deleted companies/accounts, users/contacts is also displayed. You can review the deleted companies or contacts by clicking on the word “deleted”.
You can then review the list and either restore one or more contact, or purge (permanently delete) from the system.
 
The total storage used by the instance is calculated by clicking the Re-calculate Storage button.
==[[Login & Security Settings]]==
==[[Security Settings]]==
These setting are used to control system security.
:: [[File:Security settings1.png|570px|border]]:: [[File:Security settings2.png|800px|border]]
==[[Password Policy]]==
 
[[Password Policy]] is used to control the length and complexity of passwords, the number of retries that the [[User|user]] is allowed, and the lockout time for the account if they exceed the number of retries.
1. Click the '''Password PolicyAnd Activation Policies''' link.
The '''Password Policy''' window is displayed.
:: [[File:Password and activation policies.png|800px|border]]
The following password settings are available:
'''Complexity''' – the level of complexity required in the [[Password|password]], the options are:
 * '''No Restriction''' – any character can be used. This is the default.
* '''Alpha Only''' – only letters can be used.
* '''Alpha & Numeric''' – letters and numbers must be used in the password.
* '''Alpha & Numeric & Special characters''' – letters, numbers and special characters must be used. The following special characters are allowed:
~ ! @ # $ % ^ & * ( ) { } [ ] ; : ' " < > ?
If you enable special characters, the special character list will be displayed to the user when they change their password.
[[Image:Glob12.png]] :: [[File:Intruder alert settings.png|700px|border]]
'''Intruder Lockout Settings''' – these settings determine the actions that should be taken if someone attempts to log into your copy of [[SmartSimple]].
 
* Number of Attempts''' – the number of attempts to log in with an account before the account is locked.
* Lockout Duration''' – the duration of the account lockout. The [[User|user]] will not be able to log in during this period. Period can be set to 5 minutes, 15 minutes, 30 minutes, 1 hour, 3 hours, 12 hours, 24 hours or forever (until unlocked by [[Administrator|administrator]]).
'''Intruder Email Alert''' – these settings define who should be informed by email if an intruder alert is detected.
 * '''Email From''' – the “from” address for the email. If you do not set this value, the address: '''support@smartsimple.com''' will be used.
* '''Email To''' – select the [[Internal|internal]] person to receive the email.
* '''Subject''' – the subject of the email. See below for the variables that you can use in the subject.
* '''Body''' – the body of the alert email. See below for the variables that you can use in the body.
'''Intruder Alert Email Variables ''' – because the [[User|user]] in not logged into the system the amount of information available is limited to IP Address '''@ip@''', the attempted username '''@username@''' and time '''@time@'''. ==[[Intruder Log]]==
==[[Login & Security Settings|Intruder Log]]==
The '''View Log''' tab is used to access the '''Intruder Alert''' log.
2. Click the '''View Log''' tab.
 
[[Image:Glob13.png]]
* The list can be sorted by clicking the column title.
* You can filter the list by [[Username|username]], year, and month.
==[[<u>'''View Locked Users]]=='''</u>
The '''View Locked Users''' link will display all currently locked [[User|users]].
==[[User Email Templates]]==
 
This '''organisation settings''' page is also used to manage content for the '''default new user''' and '''request password''' emails.
* The '''New User''' email message is sent to a [[User|user]] when you enable their access to SmartSimple for the first time.
* The '''Request Password''' email message is sent to a [[User|user]] when they request a new [[Password|password]] from the login page, or when you reset a [[User|user’s]] password in the user details page.
:: [[File:Password email template.png|800px|border]]
:
:* The '''New User''' email message is sent to a [[User|user]] when you enable their access to SmartSimple for the first time.
:* The '''Request Password''' email message is sent to a [[User|user]] when they request a new [[Password|password]] from the login page, or when you reset a [[User|user’s]] password in the user details page.
You can alter the text as required.
==[[Enable SSL (Secure Socket Layer)]]==
 
Secure Socket Layer ([[SSL]]) is an industry standard encryption technique that encrypts all the information transmitted between the user’s [[Browser|browser]] and the [[SmartSimple]] server.
Anyone intercepting this information over the Internet would be unable to decrypt the information.
1. Click the '''Enable SSL''' check box. [[Image:Glob15.png]] 
If your organisation is using a dedicated [[SmartSimple]] Server, you will need to purchase an SSL certification for this feature to function.
If you are using a SmartSimple server, then you can enable this feature at any time.
==[[Login & Security Settings#Web Alias|Setting the Web Alias]]== 
The web [[Alias|alias]] defines the prefix to your copy of [[SmartSimple]].
2. Set the '''Web Alias''' as required.
[[Image:Glob16.png]] 
The Web Alias should be set before other [[User|users]] begin to use the system.
==[[Setting an E-mail Domain]]==
 
Setting the organisation e-mail domain lets [[User|users]] from your organisation domain log in without keying their entire e-mail address.
3. Set the '''Email Domain''' as required.
[[Image:Glob17.png]] 
Users of the system that are not in your email domain must use their full email address to log into [[SmartSimple]].
==[[Session Timeout]]==
The session timeout feature will automatically log out any [[User|user]] if their session remains inactive for the defined number of minutes.
The session timeout feature will automatically log out any [[User|user]] if their session remains inactive for 4. Set the defined number of minutes'''Session Timeout''' as required.
4. Set the '''Session Timeout''' as required[[Image:Glob18.png]] We recommend that you always set this option. Generally, 30 or 60 minutes are acceptable timeout periods. <u>'''Business Configuration Settings'''</u>
==The Business Configuration settings provide access to key features to personalize this [[Instance|instance]] of [[Business Configuration SettingsSmartSimple]]==for specific business needs.
The Business Configuration settings provide access to key features to customize this [[Instance|instance]] of [[SmartSimpleImage:Glob19.png]] for specific business needs.
==[[<u>'''ObjectSync Settings]]=='''</u>
This feature supports sharing information between [[Instance|instances]] of [[SmartSimple]].
==[[Branch & Account Settings]]==
* '''Branch Custom Fields''' – [[Custom Fields|custom fields]] associated with [[Internal|internal]] companies.
* '''Account Custom Fields''' – [[Custom Fields|custom fields]] associated with [[External|external]] companies.
* '''User and Contact Signup Pages''' – used to manage [[External|external]] web pages where people can register as contacts.
* '''Branch and Account Signup Pages''' – used to manage [[External|external]] web pages where companies can register.
* '''Company Parent''' - enables the display of a parent organisation in the list views throughout the system. This feature is useful if the organisations you deal with are subsidiaries, and you need to be aware of the parent organisations.
* '''Resources''' – displays the company resource tab, only required when using job costing.
* '''NAIC Codes''' - the '''North American Industry Classification System''' (NAICS, pronounced Nakes) was developed as the standard for use by US, Canadian, and Mexican agencies in classifying business establishments. Enable this setting if you wish to track organisations by NAIC codes. You can set two codes for each organisation, a primary and secondary code.
* '''Display UTA Items''' – displays tracking items from the [[Universal Tracking Application]] associated as a set of tabs on the company record.
[[Image:Glob20.png]] ==[[User Company & Account Settings|Company & Contact Account Settings]]== :: [[File:Organization settings.png|850px|border]]: :* '''User Branch Custom Fields''' – [[Custom Fields|custom fields]] associated with [[Internal|internal]] [[User|users]]companies.:* '''Contact Account Custom Fields''' – [[Custom Fields|custom fields]] associated with [[External|external]] contactscompanies.:* '''Default User Settingsand Contact Signup Pages''' – the default system settings that will be set for each new used to manage [[UserExternal|userexternal]] or contactweb pages where people can register as contacts.:* '''Disable Pre-load People ListBranch and Account Signup Pages''' – this option is used to improve performance when you have in excess of 50,000 contacts in your copy of manage [[SmartSimpleExternal|external]]. Enabling this option will disable the display of contacts in all '''Search People''' web pageswhere companies can register.:* '''Enforce HomepageCompany Parent''' - you can force all [[User|users]] to enables the display of a parent organisation in the same web page when they first log into list views throughout the system. This feature is useful if the organisations you have customers using the system deal with are subsidiaries, and want you need to present them with some specific information such as your own organisation web sitebe aware of the parent organisations.:* '''HomepageResources''' – specifies a web page to be used displays the company resource tab, only required when using job costing.:* '''NAIC Codes''' - the '''North American Industry Classification System''' (NAICS, pronounced Nakes) was developed as the homepagestandard for use by US, Canadian, and Mexican agencies in classifying business establishments. Enable this setting if you wish to track organisations by NAIC codes. You can set two codes for each organisation, a primary and secondary code.[[Image:Glob22.png]]:* '''LanguageDisplay UTA Items''' – displays tracking items from the default language for all new [[User|usersUniversal Tracking Application]]associated as a set of tabs on the company record.
==[[User & Contact Settings|User & Contact Settings]]==
:: [[File:User settings.png|850px|border]]
:
:* '''User Custom Fields''' – [[Custom Fields|custom fields]] associated with [[Internal|internal]] [[User|users]].
:* '''Contact Custom Fields''' – [[Custom Fields|custom fields]] associated with [[External|external]] contacts.
:* '''Default User Settings''' – the default system settings that will be set for each new [[User|user]] or contact.
:* '''Disable Pre-load People List''' – this option is used to improve performance when you have in excess of 50,000 contacts in your copy of [[SmartSimple]]. Enabling this option will disable the display of contacts in all '''Search People''' pages.
:* '''Enforce Homepage''' - you can force all [[User|users]] to the same web page when they first log into the system. This feature is useful if you have customers using the system and want to present them with some specific information such as your own organisation web site.
:* '''Homepage''' – specifies a web page to be used as the homepage.
:* '''Language''' – the default language for all new [[User|users]].
Checking this box does not override the home page setting for each [[User|user]], but simply defines the first page they will see when logging in.
==[[Default User Settings]]==
 The default user setting options provide you with a way of controlling the setting each [[User|user]] will have when they first log into the system. We recommend that you set these values before setting up any additional users.
1. Click the '''Default User Settings''' link.
You can set the following values:
==[[<u>'''Default User – Display Options]]=='''</u>
:* '''Left Navigation Style''' – choose '''Static''' for [[Menu|menus]] that don’t expand or dynamic for [[Menu|menus]] that open and close.:* '''UTA Tabs''' – used to control the presentation of tabbed fields when the [[Universal Tracking Application]] is used.:* '''Font Size''' – choose a larger font size for your view of the system.:* '''Number of Records Per page''' – defines the number of records per page you wish to see when information is displayed as a list. You can choose 20, 40, 60, 80 or 100.:* '''Text Editor''' – enables and disables the Rich Text/HTML Editor.:* '''Publish Pin Board''' – make your personal Pin board visible to other people.:* '''List View Thumbnail Size''' – determines the size of images in reports.<u>'''Default User – Regional Settings'''</u>
==[[Default User – Regional Settings]]==These options determine your regional settings.
These options determine your regional settings. * '''Input Date Format''' – the individual [[User|user’s]] preferred entry format for date time values.* '''Input Short Date Time Format''' – the individual [[User|user’s]] preferred short display format for date time values. * '''Input Long Date Time Format''' – the individual [[User|user’s]] preferred link format for date time values.* '''Time Difference''' – used to set your local time.* '''Home Currency''' – the default currency for this [[User|user]]Image:Glob24. This currency will be referenced in applications such as [[Sales Trackingpng]] and Expense Tracking. This currency will be assumed to be the default currency for this user.* '''Language''' – the language that you wish to use. Currently you can select from seven languages.* '''Internet Map Service''' – determines the Internet service you wish to use when displaying maps.
:* '''Input Date Format''' – the individual [[User|user’s]] preferred entry format for date time values.
:* '''Input Short Date Time Format''' – the individual [[User|user’s]] preferred short display format for date time values.
:* '''Input Long Date Time Format''' – the individual [[User|user’s]] preferred link format for date time values.
:* '''Time Difference''' – used to set your local time.
:* '''Home Currency''' – the default currency for this [[User|user]]. This currency will be referenced in applications such as [[Sales Tracking]] and Expense Tracking. This currency will be assumed to be the default currency for this user.
:* '''Language''' – the language that you wish to use. Currently you can select from seven languages.
:* '''Internet Map Service''' – determines the Internet service you wish to use when displaying maps.
1. Click the [[Global Settings]] tab to return to the [[Global Settings]] page.
==[[Association Settings]]==
These settings provide the ability to link the same person to any number of organisations.
These setting provide the ability to link the same person to any number of organisations[[Image:Glob25.png]] [[Associates]]/[[Associations]] – enabling this feature will allow you to associate a single contact with multiple companies. The [[Associates]] tab will be displayed in each company record – to show associated people. The [[Associations]] tab will be displayed on each contact record to display the companies that they are associated with.
==[[People Online Settings]]==
These settings control the fields displayed when you mouse over [[User|users]] listed in the people online.
 
[[Image:Glob26.png]]
These settings control the fields displayed when you mouse over [[User|users]] listed in the people online.
==[[SmartFolder Settings]]==
These settings are only displayed when you enable the [[Smart Folder]] application.
 
[[Image:Glob27.png]]
These settings are only displayed when you enable the [[Smart Folder]] application. :* '''On-Line Editing''' – provides [[User|users]] with the ability to open, edit, and save edited files to [[SmartSimple]]. This feature is used in conjunction with a desktop plug-in that must be downloaded and installed in any workstation where you wish to use this feature.:* Size Subscribed – defines the amount of disk storage required for [[Smart Folder|SmartFolders]] – up to 5 GB.
==[[Organisational Terminology]]==
You can define specific terminology for some basic [[SmartSimple]] objects.
 
[[Image:Glob28.png]]
You can define specific terminology for some basic [[SmartSimple]] objects.
These terms relate to both [[Internal|internal]] and [[External|external]] “organisations” – singular and plural and internal and external “users” – singular and plural.
These settings define the accepted formats for phone numbers of varying length.
==[[Data Loading & Backup Settings]]==
* [[Autoloader]] – used to define scheduled upload of data from [[Smart Folder|SmartFolders]] into company, contact, and [[Application|applications]].
* [[Backup Settings]] – used to define backups of the [[SmartSimple]] database into [[Smart Folder|SmartFolders]]. Backup files can also be emailed.
 
==[[Setting the Number of Licenses Required]]==
 
Before anyone else will be able to log into the system, you will need to increase the number of [[License Definition|licenses]].
 
1. Click the '''Licensing''' tab.
* Set the number of [[Internal]] Licenses to the number of people in your organisation that will be using the system.
* Set the number of [[External]] Licenses to the number of people in other organisations that you wish to access your copy of [[SmartSimple]].
* You can adjust the number of licenses at any time.
You will not be able to enable [[User|userImage:Glob29.png]] accounts if there are insufficient licenses.
You will still be able to upload contacts; however, if you attempt to enable their access, you will be warned to increase the number of licenses==[[Data Loading & Backup Settings|Data Loading & Backup Settings]]==[[Image:Dataloadingandbackup2.jpg|link=]]
If you attempt to upload contacts using the '''Import Wizard''' and enable their access, the upload will fail if there are insufficient licenses.{{DataLoadingandBackupDefinition}}
==See Also==
:* [[Configuration mode]]
:* [[Custom fields]]
[[Category:System Management]][[Category:Global Settings]]
Smartstaff, administrator
61
edits