Changes

Jump to: navigation, search

System Summary

1,898 bytes added, 15:14, 28 June 2019
System Design Summary
The system provides =Overview=The '''System Summary '''section is helpful for providing a number of ways of accessing information on the configuration details for an [[Instance|instance]] of [[SmartSimple]].  
=How to Access the System Summary=
'''Note: '''In order to access this part of the system, you must have [[Global User Administrator|System Administrator]] assigned as a [[User Role|role]]. 
=System Summary feature=1. Click the 9-square menu icon on the top right of your page.
You can access a summary of the system settings through :: {{Icon-Menu}} 2. Under the heading '''Configuration, '''System Summaryselect ''' featureGlobal Settings.  '''
To access :: [[File:Global settings system.png|300px|border]]3. On the first tab (labelled '''System Summary''' use ), scroll down until you see the following steps (you will need {{GUA}} permission to perform this task)heading '''System Log and Summary: '''
1. Click the :: [[Configuration MenuFile:System log and summary.png|Configuration]], [[Global Settings]] [[Menu500px|menuborder]]4. Click on the hyperlink labelled '''System Summary'''.
2:: [[File:System summary.png|400px|border]]=System Summary Features=:: [[File:System summary tabs. Stay within the png|750px|border]]{| class="wikitable"|-||'''System[[Password Policy]]''' tab and scroll down to ||This will display the '''System Log and Summary''' sectioncurrent password policies within the instance.It will include the following details: 
3. Click the * '''System SummaryPassword Settings: ''' link.Length and Complexity The * '''System SummaryIntruder Lockout Settings: ''' consists Number of six tabsAttempts and Lockout Duration* '''Intruder Email Alert: '''Email From, Subject, and Body content 
* '''[[Password Policy]]''' |- displays the current [[Password|password]] policies within the [[Instance|instance]]. * '''System Security''' - Displays ||This will display all [[Manager Permissions]] and Restrictions in the first column , and its correspondence to each [[User|user]] [[Role|role]] as an additional column. The value "Yes" will be displayed in the intersection of the permission and the [[Role|role]] indicates that a [[User|user]] in that [[Role|role]] will have that permission or restriction. * '''[[Role]] Fields''' - Displays all [[Custom Fields|custom fields]] associated with each [[Role|role]] and the details of each field. * '''Company Fields''' - Displays all [[Custom Fields|custom fields]] associated with each organization category and the details of each field. * value '''[[Portal]] ShortcutsYes ''' - Displays all shortcuts used in each [[Role|role]]-based [[Portal|portal]] including the Icon used. * '''[[Notes Permissions]]''' - Displays all notes in the first column and each [[User|user]] [[Role|role]] as an additional columns. The value "Yes" will be displayed in the intersection of what part of the '''Note''' type system it is giving permission for, and the [[Role|which role]] indicates that a [[User|user]] in has that [[Role|role]] will have permission to use that note type.* '''User Mode''' - Displays User mode options and allows for the feature to be switched off and on for the current user. Options include::* Translation Audit Mode: when enabled will highlight those areas of the system that are not going through SmartSimple's language translator tool :* Developer Mode: when activated any system changes made by a particular user are logged and can be ported to the production server. 
=:: [[File:System Design Summary feature=security settings.png|thumb|left|600px|border]] |-Users can generate a word document ||'''Role Fields'''||This will display all the [[Custom Fields – General Information|Custom Fields]] that provides a summary are associated with each user role (split into [[Internal]] vs [[External]]), and the details of the system settings through the each field such as its Type, Name, Field ID, etc. :: [[File:Role fields.png|thumb|left|600px|border]]|-||'''System Design SummaryCompany Fields''' feature||This will display all the [[Custom Fields – General Information|Custom Fields]] associated with each organization category (and split into [[Internal]] vs [[External]]) and the details of each field.  
To access :: [[File:System summary company fields.png|thumb|left|600px|border]]|-||'''System Design SummaryPortal Shortcuts''' use ||This will display all the following steps:[[Portals#Shortcuts|portal shortcuts]] used in each [[User Role|role]]-based [[Portals|portal]], including the '''icon '''used. 
1:: [[File:Portal shortcuts. Click png|thumb|left|600px|border]]|-||'''Notes Permission'''||This will display all the [[Notes Permissions]] in the first column and each [[Configuration MenuUser Role|Configurationrole]]as an additional column. The value '''Yes '''will be displayed at the intersection of the '''Note '''type, and the [[Global SettingsUser Role|role]] indicates that a [[User|user]] in that role will have permission to use that [[MenuNotes Overview#Creating a New Note Type|menunote type]]|-||'''User Mode'''||This will display the User Mode options and allows for the feature to be switched off and on for the current user.
2[[File:User mode. Stay within png|thumb|left|500px|border]]The options include the '''System''' tab and scroll down to the '''System Log and Summary''' section.following: 
3* '''Translation Audit Mode: '''When enabled, this will highlight any areas of the system that are not going through SmartSimple's [[:Category:Translation|language translator]] tool. Click the  * '''System Design SummaryDeveloper Mode: ''' linkWhen enabled, any system changes made by a particular user are logged and can be ported to the production server. 
4. The New System Design Summary window appears, with option to select which modules to include in the system document. Options include: * '''[[Global Settings]]''': summary of Global Settings, including Data Policies and Security Matrices
* '''Tracking Applications''': settings for each individual [[Universal Tracking Application|UTA]]
* '''[[Workflows]]''': settings for each individual workflow
* '''[[Custom Fields]]''': custom field settings. Will automatically select Tracking Applications module if selected.
* '''[[Portal|Portals]]''': details of Portals configured against User Roles.
|} =System Design Summary=You can also generate a word document that provides a summary of the system settings through the '''System Design Summary '''feature.  1. Click on the 9-square menu icon on the top right of your page. :: {{Icon-Menu}} 2. Under the heading '''Configuration, '''select '''Global Settings.''' 3. Scrolling down to the section titled '''System Log and Summary, '''click on the hyperlink '''System Design Summary. ''' :: [[File:System design summary.png|550px|border]] 4. Clicking this will enable a modal window to open. The window will contain different headings, each corresponding to a {{UTA}} within the system or the '''General ''''''System, '''and each with available [[Custom Fields]] or settings that can be enabled as part of the documented summary. :: [[File:Sys design summary.png|700px|border]]{| class="wikitable"|-||'''[[Global Settings]]'''||Provides a summary of Global Settings including Data Policies and Security Matrices.|-||'''[[Workflows Overview|Workflows]]'''||Provides a summary of the settings that have been enabled onto each individual workflow.|-||'''[[Portals]]'''||Provides a summary of each of the portals and portal details that have been configured against [[User Role|user roles]].|-||'''{{UTA}}s'''||Provides a summary of the settings for each individual [[UTA]], including a toggle option to indicate whether the summary should include [[Custom Fields]]. |}5. Once the modules are selected appropriately within each section, click the the '''GenerateGenerate ''' button. A design summary document will automatically begin to be downloaded to onto your local machinecomputer.  * If there were any settings that you did not toggle on, you may always re-generate''' System Design Summary''' documents by toggling on the new options and clicking the '''Generate '''button again.  
==See Also==
* [[Manager Permissions]]
 
[[Category:Global Settings]][[Category:System Management]][[Category:System Auditing]]
2,299
edits

Navigation menu