Changes

Jump to: navigation, search

System Variables

3,637 bytes added, 19:55, 29 June 2019
Deleted System Variables
The ==Overview==The '''System VariablesVariables ''' setting on the [[Global Settings]] page allows will allow you to create and edit system-wide variables within your [[instance]].These variables can then be referred to from anywhere within your [[SmartSimple]] copy by using the following syntax: 
: <span style="font -size="3: medium;">@system.''variable name''@</fontspan>'''Example:'''  If you have created a System Variable named '''Tax Rate''' you would use:
@system.tax rate@
A global System Library can be accessed as system variables. The available values and functions can be found under System Variables on the [[Global Settings]] page. The syntax is:
 
: <span style="font-size: medium;">@system.library.''variable name''@</span>
'''Example:'''  To return a list of languages from the global library, you would use:
 
@system.library.language@
* '''Note:''' Library variables are available in all instances but can only be created and edited by SmartSimple.
* '''Note: '''It is best to use and create system variables if you need to repeat something more than twice.
* '''Tip: '''System Variables is a helpful resource should you ever need to restore ID numbers, areas you search, signature, email address, etc.
 
You can also include links - for example, you can make a document of guidelines in [[SmartFolders Overview|SmartFolders]] into an Internet-enabled URL, then upload this link to '''System Variables '''in order to place the documents everywhere. If that document then changes, you would only have to modify the content in one place. Other use-cases for '''System Variables '''might include a set scoring protocol if your system uses a reviewer-scoring process. 
 
===Accessing System Variables===
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. Under the subheading '''System Configuration, '''click on the hyperlink labelled '''System Variables. '''
 
A [[List View Overview|list]] of available system variables will be displayed.
 
:: [[File:Sys variables list.png|900px|border]]
You can use the '''Search '''function on the top right at any point to specify the results of the list of system variables.
===Setting a System Variable===Once you have accessed the list of '''System Variables '''Examplevia [[Global Settings]], you can set new system variables.  1. Click on the '''+ '''icon on the top left of the System Variables list page to create a new system variable. 2. The new system variable form will be displayed:  :: [[File:New sys variable.png|400px|border]]Fill in the fields appropriately: '''Name, Description, '''and '''Value. '''The '''ID '''field will be autopopulated. If '''Note: '''Once you have created set the '''Name '''of a System Variable named system variable and save it, it ''cannot be changed. '' 3. Click '''Tax RateSave ''' when you would use:are done filling out the fields.  The page will reload and the page title will be redisplayed as '''Edit '''rather than '''New, '''with the '''Name '''field now greyed out as it is non-editable.   @Any changes that you make to the system variable from this page will be impacted system-wide for any reference to this specific systemvariable.tax rate@ 
====Update History====
There will be a '''reload '''icon at the top left of your System Variable page.
A global System Library can be accessed as system variables. The available values and functions can be found under System Variables on the :: [[Global SettingsFile:Update history icon.png|40px|border]] page This icon, when clicked, will reveal the '''Update History '''related to any revisions made on this specific system variable. The syntax is:  
<font size="3">@system.library:: [[File:Sys variable update history list.png|800px|border]] By providing information related to each update - including a date and time stamp, the name of the [[User|user]] who made the modification, the comparative difference in the '''Value '''and '''Description 'variable name''@</font>fields, etc - you can keep track of any changes made to this system variable. 
===Deleted System Variables===
The third tab of the '''System Variables '''page is labelled '''Deleted System Variables '''and will provide a [[List View Overview|list]] of all deleted system variables ''for up to ''one year. 
'''Example:'''<pre> Deleted system variables can be restored only up to one year; beyond one year, they will be automatically purged from the system. </pre>To return  Clicking on a list of languages from deleted system variable will allow you to choose to purge it manually or to restore it back into the global library, you would use: @system.library.language@
:: [[File:Deleted sys variables.png|850px|border]]
==System 2==
For example, if on a [[Web Page View]] you have a button that you want to have a different value based on the [[Language|langid]] of the user.
 * Create 2 [[System Variable]]s with :*:* Name: '''Open1''' Value: '''Open''':*:* Name: '''Open2''' Value: '''Ouvert'''
And refer to them on the [[Web Page View]] as follows
<pre>
<input type=button value="@system2.Open@me.langid@@" onclick="doThis()">
</pre>
<pre> <input type="button" value="@system2.Open@me.langid@@" /></pre>
The system will replace @me.langid@ with either 1 or 2 depending if the current user has their primary language set as English or French (Canada). They will pull the relevant System Variable.
 
'''Note:''' Do not use '''@system2.''' variables to populate the "options" for fields such as a [[Combo Box]] or [[Check Boxes]] if you wish to be able to search using those fields. The system will not be able to process the variable when searching from the [[List View]]. If using system2 (with @me.langid@) to process different user languages the [[Custom Field Language Settings]] should be used to obtain the language specific option values.
==Setting a System Variable==
 *# Go to [[Global Settings]]*# Under the [[System Variables and Custom Fields]] Configuration heading, click on the hyperlink for System Variables.*# Click on the "New Variable" button and enter details::*#* '''Name''' will be the variable name referenced in the '''@system.''variable name''@''' syntax.:*#* '''Description''' is an optional narrative description.:*#* '''Value''' will be the value returned by the variable.
If the Value is a date, use the ''yyyy-mm-dd'' date format.
* [[Pandora - Update a System Variable]]
* [[Root Company Variable]]s
 
[[Category:Global Settings]][[Category:Variables]]
2,299
edits

Navigation menu