Changes

Jump to: navigation, search

Status

1,650 bytes removed, 19:23, 22 October 2021
Status Translation Settings
The ==Overview==Statuses represent a core concept within the SmartSimple Cloud platform. Each status represents the '''Settingsstate''' page within of the related object. Statuses can be defined with the [[Universal Tracking Application]] allows application for all types of objects that you to define '''Statuses''' for your create; Level 1, objects and Level 2 and Level 3 recordsactivities. The Statuses You can be used to track also use statuses with both contacts and organizations. This article concentrates on the state or condition use of Statuses for the Universal Tracking Application but the recordssame logic applies to contact and organization statuses.
The '''Status''' settings for Level 1===Why?===Statuses can be assigned to all records in SmartSimple Cloud, Level 2 including [[User|users]] and Level 3 [[Organization hierarchy|organizations]]. By assigning statuses to [[Entity|entities]] in your system, you are similarable to track your relationships with anyone and everyone that you interact with, with a few differences outlined belowboth [[Internal|internally]] and [[External|externally]].
==Creating Statuses==A good use-case for the benefits of statuses is if you have an organization's '''Status '''as '''Registered, '''but not yet '''Verified. '''Once their status is switched into '''Verified, '''you are able to enter that information to change their status in your [[SmartSImple]] [[instance]], and both the status and record will be updated simultaneously. You can create as many status options as you need; they can be modified and updated in your [[Global Settings]], [[UTA Settings - Settings|UTA Settings]], as well as from any individual organization or applicant record.
'''Statuses''' can be created and modified using the '''Settings''' page of your [[=Configuration - Essentials===Creating UTA]].<br>[[Image:Statuses.PNG]]==* For Level 1 To edit with statuses click the within a UTA, you need '''StatusesAdministrator Access''' link in the Level 1 settings sectionfor that UTA.* For Level 2 and Level 3 statuses click If you have this permission, go to the '''StatusesConfiguration Settings''' link in on the UTA, signified by the Level 2 settings sectiongear icon. ::'''Note''''': Level 2 and Level 3 Statuses are both created and managed on Next, choose the same page.''::''By default any statuses you create here will be available to both Level 2 and Level 3 records1, but can be restricted to either Level 2 , or Level 3 using tab, and then click on the '''Status AvailabilityStatuses''' section (described below)link.''
[[Image:ApplicationStatuses.png|600px]] The '''Status''' settings for Level 1, Level 2 and Level 3 are similar, with a few differences outlined below. * Existing For Level 1 statuses, click the '''Statuses are listed on ''' link in the Level 1 settings tab, located second from the left of in the page[[UTA Settings - Settings|UTA Settings]].* Details of each status are displayed on For Level 2 statuses, click the '''Statuses''' link in the Level 2 settings tab, located third from the right of left in the page and new [[UTA Settings - Settings|UTA Settings]] (if enabled).* For Level 3 statuses are added to click the '''Statuses''' link in the Level 3 settings tab, located fourth from the right of left in the page[[UTA Settings - Settings|UTA Settings]] (if enabled).[[Image:Uta41ActivityStatuses.png|600px]]
==Status Settings==
Each * Details of each status has the following settings:are displayed when you click into a specific status.
* '''Name''' - Display name for the '''Status'''.==Organization/Contact Statuses==:* '''Display Order''' - The order that Organization statuses are displayed in the '''Status''' combo box.* '''Description''' - Any comments or notes you wish to include (these don't manifest anywhere except on this page).* '''Submit Button Status''' - This feature is used to present the user with a '''Submit''' button. You associate an additional status with this submit button. When the accessible from [[User|userGlobal Settings]] clicks the '''Submit''' button the status of the record is changed to the selected status. This may trigger a > [[WorkflowOrganization|workflowOrganizations]] or lock the item if the new status has the '''Lock on Status''' enabled. The '''Submit''' button will be displayed if a '''Status''' is selected in this section.* '''Submit Button Label''' - Defines the label for the '''Submit''' button. If no label is provided the button will say '''Submit'''> Statuses.:* '''Submitted URL''' - When the '''Submit''' button is pressed at this status, instead of remaining on the view of the current record the user will be redirected to the URL defined in this section. If no [[URL]] is entered the current record will stay in view.::'''''Note:''' If a Status is shared between Level 2 and Level, both will be redirected to the same [[URL]]. To avoid this create separate Contact statuses for each Level. Also, parameters cannot be passed through this [[URL]].''* '''Colour Code''' - The colour code used to indicate each status. This colour will be used in the list view and the details view. Click the colour palette button to display a colour picker.* '''Lock On Status''' - This setting is used to lock the record so that it cannot be changed until it is unlocked. * '''Is Default Status''' - Determines the default status to be selected when the item is saved or submitted.* '''Is Copy Status''' (Level 2 & 3 only) - * '''Display Buttons''' - Controls which buttons are available to the user for a record at this status. (See accessible from [[#Button Options|Button OptionsGlobal Settings]] below).* '''Button Script Function''' (Level 1 only) - Allows you to define a function or script that is called when the '''Submit''' button is clicked. (See [[#Button Options|Button Options]] below).* '''Roles That Override Lock''' - The specific [[Role|roles]] that can unlock a locked item. If you enable '''Lock on Status''' and do not set a role, then the item cannot be unlocked.::'''''Note:''' Any [[Role]] with the UTA [[Manager Permission]] will be able to override the '''Lock on Status''' setting, even if not specified here.''* '''Roles that Can Set This Status''' - The specific [[Role|roles]] that can set the status. If you do not set a role, then any > [[User|userUsers]] can set any status> Statuses.
You can restrict which '''Statuses''' are available to each Level 1 Template. See [[Level 1 Templates#Associating Templates with Statuses|here]] for details.
==Button OptionsStatus Settings==Each status has the following settings:
For each status you determine which of the "Save", "Save Draft" and "Save & New" buttons are available to the [[User|user]] with the '''Display Buttons''' setting mentioned above.
The '''Submit''' button is not included in the '''Display Buttons''' options. The '''Submit''' button will be displayed whenever the '''Submit Button Status''' has been defined.
{| border="1"==General Tab===:* '''Status ID''' - Internal unique system ID that can be used to reference the status.|:* '''ButtonName'''||- Name for the '''DescriptionStatus'''.|:* '''Caption''' -|SaveDefault [[Caption|display name]] for the status.:* This button validates all fields '''Display Order''' - The order that statuses are displayed in the record, ensuring that mandatory fields '''Status''' settings and formatting requirement are satisfieddropdown.:* Clicking '''Description''' - Any comments or notes you wish to include. '''Note:''' Description only manifests on the Save button does not change the current statusconfiguration page.|:* '''[[Status Group Name]]''' -|Save Draft|* Save Draft saves the record, but performs NO validationUsed to mask multiple individual statuses within a single overall status. This is only available in UTA Statuses. :* This button should always '''Tooltip''' - a description to be displayed when the user moves their mouse over the caption (when displayed used in conjunction with at least the Submit buttonStatus Indicator). This is only available on level one statuses.|:* '''Color Code''' -|Save & New|* The Save & New button validates all fields color code used to indicate each status. This color will be used in the record, saves list view and the item, then displays a new recorddetails view.|-|Submit|* The Submit Click the color palette button validates all fields in the record, ensuring that mandatory fields and formatting requirement are satisfiedto display a colour picker.:* It saves the record and changes the status to the status defined in the '''Submit Button Lock On Status''' section of - This setting is used to lock the original statusrecord so that it cannot be changed until it is unlocked.:* ''Note that the label on the Submit button can be defined in the '''Submit Button LabelIs Default Status''' section of - Determines the default status page, so may appear with another nameto be selected when a new record is created.'':* '''Important:Is Default Copy Status''' If a (UTA Statuses only) - When the ''Copy''button is used to create a copy of a UTA record, the new record will have the status that has this setting enabled. If no status is set as 'Button Script Function''Is Copy Status''' has been defined the Submit button will run that function, and copied UTA records will have the same status as the original record.:* '''NOTExclude from Status Indicator''' perform - Checking this will exclude this status from the tasks listed above[[Status Indicator]] Level 1 Standard field.|}
===Submit Button Script (Level 1 Only)===
In order to use the Submit Button Script you <u>must</u> select a '''Submit Button Status''' so that the '''Submit''' button will appear.
* '''IMPORTANT:''' When you have defined a Submit Button Script the Submit button will '''NOT''' cause the status to be changed. Instead it runs the script/function defined here.
* This feature can be used to create a [[Custom Field Type: Special – Browser Script|Browser Script]] that will perform custom validation of the data on the page, and can then optionally change the status or execute the submit function as part of the script.
* Standard field validation is performed '''after''' this script is run if the function has returned the value '''true'''.
* You can optionally re-label the Submit button using the '''Submit Button Label''' setting).
The following sample of a [[Browser Script]] will prompt the user to confirm if they want to submit the record.
<pre>
function customsubmit()
{
var answer = confirm ("Do you really want to submit this?")
if (answer)
{
alert ("Consider it done")
return true
}
else
{
alert ("Keep filling it in then")
return false
}
}
</pre>
==Status Triggers=Permissions and Availability Tab=======Role Permissions====:* '''Allow to Set Roles''' - The specific [[Role|roles]] that can set the status. If you do not set a role, then any [[User|user]] can set any status.:* '''Override Lock Roles''' - The specific [[Role|roles]] to which the ''Lock On Status'' setting does not apply. If you enable '''Lock on Status''' and do not set an ''Override Lock Role,'' then the item cannot be unlocked.:*: '''''Note:''' Any [[Role]] with the UTA [[Manager Permission]] will be able to override the '''Lock on Status''' setting, even if not specified here.''
Sometimes you ====Availability====:* '''Available Status''' - Only available on User and Organization statuses. Statuses added here are available to be selected from this status.:* '''Enabled on Record Types''' - Only available in UTA Statuses. This status will need be available to control record types added here. If you do not set a type, then the status associated with level 2 and level 3 items based will be available on a status change at the all record types of this level 1 itementity.
For example, if you ====Annotation System Role Permissions====Only available in UTA Statuses. Roles added here will have an “abandoned” status for a project tracking [[UTA]] and you set a project different levels of access to that status then you may need to set an “abandoned” status for all level 2 (or level 3 items) related to that project. This effect is achieved through a '''Annotation Mode in this status trigger'''.
For each level one status change you :** '''View Annotation Roles''' - defines the roles that can control view annotations that have been added to the object at this status changed (annotation is only available for all level 2 UTA objects).:** '''View and level 3 items. You Create Annotation Roles''' - defines the roles that can further control view and create annotations that have been added to the object at this behavior by restricting status.:** '''Edit Field in Annotation Mode Roles''' - defines the trigger to specific types of level 2 and level 3 itemsroles that edit fields that have had annotations attached. Using :** '''Open Record in Annotation Mode''' - defines the previous example you may not wish to change roles that can edit the status on a “reporting” type level 2 activity simply because the project is abandonedentire record in annotation mode.
==Status Triggers can be defined by clicking History==If the '''[[Standard_Level_1_Field_List|Status Trigger''' link when editing the relevant Status::Standard field]] is configured with [[Track Changes]] enabled then any user with [[Image:StatusTrigger.pngManager Permissions - System Permissions|View Field History Permissions]]will see a small clock and refresh icon under the Status field.
Which brings you to the Status Trigger page:
{|align=top
|-
|'''Level 1:'''<br>
:[[Image:StatusTrigger2.png|border|Level 1]]
|'''Level 2:'''<br>
:[[Image:StatusTrigger3.png|border|Level 2]]
|}
* From '''Level 1''' you can define When they click on the History icon then they will see a breakdown of the history plus a bar chart showing the amount of time spent in each status triggers for associated Level 2 records, Level 3 records, and Transactions.* From '''Level''' 2 you The duration (in days) can define status triggers for the associated Level 1 record (be included when building a report by including data from the "parentStandard Field Audit Log") as well as any associated Level 3 records.* '''Level''' 3 status triggers are not supporteddataset.
[[Image:StatusFieldHistory.png|800px|border]]
* The '''Type''' (or Template for Level 1) is selected in the '''Type Filter''' combo box.* The current status is selected in the '''==Status Filter''' combo box. Translation Settings==* The new Specify a status is selected in the '''Set Status To''' combo box.* The '''Add Trigger''' button is used to add the new trigger to the trigger listCaption and Group Name for each desired language.
So for :* When editing a status, select the defined '''Type/TemplateStatus Translation Settings''' any associated records that were at button from the top of the window.:* Select the language from the status selected in '''Status FilterLanguage''' will be changed to drop-down list.[[Image:StatusTranslationSettings.png|600px]]:* Enter the desired '''Caption''' translation and '''Group Name'''and click ''Set Status To'Save''' status.:* The relevant language caption will be displayed to users based on the language specified in their [[Personal Settings]].
==See Also==:* Any number of triggers can be created.* [[Status lock|Status Lock]]:** [[Submit Logic]]:** [[Batch Update]]:** [[Level 1 Templates]]:** [[Status Indicator]]
==Submit Logic==
* This feature provides for the creation of any number of submission rules that control a submission process.
* When a submission process is controlled by submission logic, then values at other levels can be validated.
* Values are validated based on the sequence defined within the submission logic.
* From Level 1 the submission rules can access any field at Level 1, account/contact fields, as well as aggregated fields at Level 2 and/or Level 3.
* The Submit Logic feature is associated with a particular status. Associating the conditions with each status allows for different statuses to control sets of Submit Logic rules.
See '''{| style="background-color: #f0f0f0; border-style: solid; border-width: 2px;" cellpadding="5"|-||[[Submit LogicImage:Previous.png|link=Status Field Permissions]]''' for detailed instructions.==See Also==* &nbsp;[[Submit LogicStatus Field Permissions]]* ||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;||[[Batch UpdateLevel 1 Templates]]* &nbsp;[[Image:Next.png|link=Level 1 Templates]]|}
[[Category:Universal Tracking Application]][[Category:Glossary]][[Category:Process Flow]]
Smartstaff
282
edits

Navigation menu