Difference between revisions of "Status"

From SmartWiki
Jump to: navigation, search
(→‎Status Translation Settings)
 
(112 intermediate revisions by 11 users not shown)
Line 1: Line 1:
−
The '''Settings''' page within the [[Universal Tracking Application]] allows you to define '''Statuses''' for your Level 1, Level 2 and Level 3 records. The Statuses can be used to track the state or condition of the records.  
+
==Overview==
 +
Statuses represent a core concept within the SmartSimple Cloud platform. Each status represents the '''state''' of the related object. Statuses can be defined with the Universal Tracking application for all types of objects that you create; Level 1 objects and Level 2 and Level 3 activities. You can also use statuses with both contacts and organizations. This article concentrates on the use of Statuses for the Universal Tracking Application but the same logic applies to contact and organization statuses.
  
−
The '''Status''' settings for Level 1, Level 2 and Level 3 are similar, with a few differences outlined below.
+
===Why?===
 +
Statuses can be assigned to all records in SmartSimple Cloud, including [[User|users]] and [[Organization hierarchy|organizations]]. By assigning statuses to [[Entity|entities]] in your system, you are able to track your relationships with anyone and everyone that you interact with, both [[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 [[UTA]].<br>
+
=Configuration - Essentials=
−
[[Image:Statuses.PNG]]
+
==Creating UTA Statuses==
−
* For Level 1 statuses click the '''Statuses''' link in the Level 1 settings section.
+
To edit with statuses within a UTA, you need '''Administrator Access''' for that UTA. If you have this permission, go to the '''Configuration Settings''' on the UTA, signified by the gear icon. Next, choose the Level 1, Level 2, or Level 3 tab, and then click on the '''Statuses''' link.
−
* For Level 2 and Level 3 statuses click the '''Statuses''' link in the Level 2 settings section.  
 
−
::'''Note''''': Level 2 and Level 3 Statuses are both created and managed on the same page.''
 
−
::''By default any statuses you create here will be available to both Level 2 and Level 3 records, but can be restricted to either Level 2 or Level 3 using the '''Status Availability''' section (described below).''
 
  
−
* Existing Statuses are listed on the left of the page.
+
[[Image:ApplicationStatuses.png|600px]]
−
* Details of each status are displayed on the right of the page and new statuses are added to the right of the page.
 
−
[[Image:Uta41.png]]
 
  
−
==Status Settings==
+
The '''Status''' settings for Level 1, Level 2 and Level 3 are similar, with a few differences outlined below.
  
−
Each status has the following settings:
+
* For Level 1 statuses, click the '''Statuses''' link in the Level 1 settings tab, located second from the left in the [[UTA Settings - Settings|UTA Settings]].
 +
* For Level 2 statuses, click the '''Statuses''' link in the Level 2 settings tab, located third from the left in the [[UTA Settings - Settings|UTA Settings]] (if enabled).
 +
* For Level 3 statuses click the '''Statuses''' link in the Level 3 settings tab, located fourth from the left in the [[UTA Settings - Settings|UTA Settings]] (if enabled).
 +
[[Image:ActivityStatuses.png|600px]]
  
−
* '''Name''' - Display name for the '''Status'''.
 
−
* '''Display Order''' - The order that 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 [[User|user]] clicks the '''Submit''' button the status of the record is changed to the selected status.  This may trigger a [[Workflow|workflow]] 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'''.
 
−
* '''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 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 [[#Button Options|Button Options]] 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|user]] can set any status.
 
  
 +
* Details of each status are displayed when you click into a specific status.
  
−
You can restrict which '''Statuses''' are available to each Level 1 Template. See [[Level 1 Templates#Associating Templates with Statuses|here]] for details.
+
==Organization/Contact Statuses==
 +
:* Organization statuses are accessible from [[Global Settings]] > [[Organization|Organizations]] > Statuses.
 +
:* Contact statuses are accessible from [[Global Settings]] > [[User|Users]] > Statuses.
  
−
==Button Options==
 
  
−
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.
+
==Status Settings==
−
 
+
Each status has the following settings:
−
{| border="1"
 
−
|'''Button'''||'''Description'''
 
−
|-
 
−
|Save
 
−
|
 
−
* This button validates all fields in the record, ensuring that mandatory fields and formatting requirement are satisfied.
 
−
* Clicking the Save button does not change the current status.
 
−
|-
 
−
|Save Draft
 
−
|
 
−
* Save Draft saves the record, but performs NO validation.
 
−
* This button should always be used in conjunction with at least the Submit button.
 
−
|-
 
−
|Save & New
 
−
|
 
−
* The Save & New button validates all fields in the record, saves the item, then displays a new record.
 
−
|-
 
−
|Submit
 
−
|
 
−
* The Submit button validates all fields in the record, ensuring that mandatory fields and formatting requirement are satisfied.
 
−
* It saves the record and changes the status to the status defined in the '''Submit Button Status''' section of the original status.
 
−
* ''Note that the label on the Submit button can be defined in the '''Submit Button Label''' section of the status page, so may appear with another name.''
 
−
'''Important:''' If a '''''Button Script Function''''' has been defined the Submit button will run that function, and will '''NOT''' perform the tasks listed above.
 
−
|}
 
  
−
===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.<br>
 
−
You must also create a [[Browser Script]] containing a [[JavaScript]] function that is called within the '''Submit Button Script''' setting.
 
−
* This feature can be used to perform tasks such as confirmation or custom validation of the data on the page, prior to submission.
 
−
* The function must return either a value of '''true''' if the record should be submitted; or '''false''' if the record should not be submitted.
 
−
* Standard and Custom Field validation is performed '''after''' this script is run, provided that the function has returned '''true'''. If the function returns '''false''' no further validation is performed and the record is <u>not</u> saved/submitted.
 
−
* You can optionally re-label the Submit button using the '''Submit Button Label''' setting.
 
  
−
For example, if your Browser Script contains a function called ''custombsubmit'' you would put the following into the '''Submit Button Script''' section:
 
−
:[[Image:Bsf.png]]
 
  
−
The following sample [[JavaScript]] function will prompt the user to confirm if they want to submit the record.
+
===General Tab===
−
<pre>
+
:* '''Status ID''' - Internal unique system ID that can be used to reference the status.
−
function customsubmit()
+
:* '''Name''' - Name for the '''Status'''.
−
{
+
:* '''Caption''' - Default [[Caption|display name]] for the status.
−
var answer = confirm ("Do you really want to submit this?")
+
:* '''Display Order''' - The order that statuses are displayed in the '''Status''' settings and dropdown.
−
if (answer)
+
:* '''Description''' - Any comments or notes you wish to include. '''Note:''' Description only manifests on the configuration page.
−
  {
+
:* '''[[Status Group Name]]''' - Used to mask multiple individual statuses within a single overall status. This is only available in UTA Statuses. 
−
  alert ("Consider it done")
+
:* '''Tooltip''' - a description to be displayed when the user moves their mouse over the caption (when displayed used the Status Indicator). This is only available on level one statuses.
−
  return true
+
:* '''Color Code''' - The color code used to indicate each status. This color will be used in the list view and the details view. Click the color 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.
−
else
+
:* '''Is Default Status''' - Determines the default status to be selected when a new record is created.
−
  {
+
:* '''Is Default Copy Status''' (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 '''Is Copy Status''', copied UTA records will have the same status as the original record.
−
  alert ("Keep filling it in then")
+
:* '''Exclude from Status Indicator''' - Checking this will exclude this status from the [[Status Indicator]] Level 1 Standard field.
−
  return false
 
−
  }
 
−
}
 
−
</pre>
 
−
* ''The "Return False" isn't strictly necessary. If the function does not return True then False is assumed.''
 
  
  
−
If you would like to define a custom script that runs when a record is saved or submitted you can use '''[[savefunc]]'''.
 
  
−
==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 will need to control the status associated with level 2 and level 3 items based on a status change at the level 1 item.
+
====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 be available to record types added here. If you do not set a type, then the status will be available on all record types of this level entity.
  
−
For example, if you have an “abandoned” status for a project tracking [[UTA]] and you set a project 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 '''status trigger'''.
+
====Annotation System Role Permissions====
 +
Only available in UTA Statuses. Roles added here will have different levels of access to Annotation Mode in this status.
  
−
For each level one status change you can control status changed for all level 2 and level 3 items.  You can further control this behavior by restricting the trigger to specific types of level 2 and level 3 items.   Using the previous example you may not wish to change the status on a “reporting” type level 2 activity simply because the project is abandoned.
+
:** '''View Annotation Roles''' - defines the roles that can view annotations that have been added to the object at this status (annotation is only available for UTA objects).
 +
:** '''View and Create Annotation Roles''' - defines the roles that can view and create annotations that have been added to the object at this status.
 +
:** '''Edit Field in Annotation Mode Roles''' - defines the roles that edit fields that have had annotations attached.
 +
:** '''Open Record in Annotation Mode''' - defines the roles that can edit the entire record in annotation mode.
  
−
Status Triggers can be defined by clicking the '''Status Trigger''' link when editing the relevant Status:
+
==Status History==
−
:[[Image:StatusTrigger.png]]
+
If the [[Standard_Level_1_Field_List|Status Standard field]] is configured with [[Track Changes]] enabled then any user with [[Manager 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 status triggers for associated Level 2 records, Level 3 records, and Transactions.
+
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. The duration (in days) can be included when building a report by including data from the "Standard Field Audit Log" dataset.
−
* From '''Level''' 2 you can define status triggers for the associated Level 1 record (the "parent") as well as any associated Level 3 records.
 
−
* '''Level''' 3 status triggers are not supported.
 
  
 +
[[Image:StatusFieldHistory.png|800px|border]]
  
−
* The '''Type''' (or Template for Level 1) is selected in the '''Type Filter''' combo box.
+
==Status Translation Settings==
−
* The current status is selected in the '''Status Filter''' combo box.
+
Specify a status Caption and Group Name for each desired language.
−
* The new status is selected in the '''Set Status To''' combo box.
 
−
* The '''Add Trigger''' button is used to add the new trigger to the trigger list.
 
  
−
So for the defined '''Type/Template''' any associated records that were at the status selected in '''Status Filter''' will be changed to the '''Set Status To''' status.
+
:* When editing a status, select the '''Status Translation Settings''' button from the top of the window.
 +
:* Select the language from the '''Language''' drop-down list.
 +
[[Image:StatusTranslationSettings.png|600px]]
 +
:* Enter the desired '''Caption''' translation and '''Group Name''' and click '''Save'''.
 +
:* The relevant language caption will be displayed to users based on the language specified in their [[Personal Settings]].
  
−
* Any number of triggers can be created.
+
==See Also==
 +
:** [[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 '''[[Submit Logic]]''' for detailed instructions.
+
{| style="background-color: #f0f0f0; border-style: solid; border-width: 2px;" cellpadding="5"
−
==See Also==
+
|-
−
* [[Submit Logic]]
+
||[[Image:Previous.png|link=Status Field Permissions]] &nbsp;[[Status Field Permissions]]
−
* [[Batch Update]]
+
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
−
* [[Level 1 Templates]]
+
||[[Level 1 Templates]] &nbsp;[[Image:Next.png|link=Level 1 Templates]]
 +
|}
  
−
[[Category:Universal Tracking Application]]
+
[[Category:Universal Tracking Application]][[Category:Glossary]][[Category:Process Flow]]

Latest revision as of 14:23, 22 October 2021

Overview

Statuses represent a core concept within the SmartSimple Cloud platform. Each status represents the state of the related object. Statuses can be defined with the Universal Tracking application for all types of objects that you create; Level 1 objects and Level 2 and Level 3 activities. You can also use statuses with both contacts and organizations. This article concentrates on the use of Statuses for the Universal Tracking Application but the same logic applies to contact and organization statuses.

Why?

Statuses can be assigned to all records in SmartSimple Cloud, including users and organizations. By assigning statuses to entities in your system, you are able to track your relationships with anyone and everyone that you interact with, both internally and externally.

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, as well as from any individual organization or applicant record.

Configuration - Essentials

Creating UTA Statuses

To edit with statuses within a UTA, you need Administrator Access for that UTA. If you have this permission, go to the Configuration Settings on the UTA, signified by the gear icon. Next, choose the Level 1, Level 2, or Level 3 tab, and then click on the Statuses link.

ApplicationStatuses.png

The Status settings for Level 1, Level 2 and Level 3 are similar, with a few differences outlined below.

  • For Level 1 statuses, click the Statuses link in the Level 1 settings tab, located second from the left in the UTA Settings.
  • For Level 2 statuses, click the Statuses link in the Level 2 settings tab, located third from the left in the UTA Settings (if enabled).
  • For Level 3 statuses click the Statuses link in the Level 3 settings tab, located fourth from the left in the UTA Settings (if enabled).

ActivityStatuses.png


  • Details of each status are displayed when you click into a specific status.

Organization/Contact Statuses


Status Settings

Each status has the following settings:


General Tab

  • Status ID - Internal unique system ID that can be used to reference the status.
  • Name - Name for the Status.
  • Caption - Default display name for the status.
  • Display Order - The order that statuses are displayed in the Status settings and dropdown.
  • Description - Any comments or notes you wish to include. Note: Description only manifests on the configuration page.
  • Status Group Name - Used to mask multiple individual statuses within a single overall status. This is only available in UTA Statuses. 
  • Tooltip - a description to be displayed when the user moves their mouse over the caption (when displayed used the Status Indicator). This is only available on level one statuses.
  • Color Code - The color code used to indicate each status. This color will be used in the list view and the details view. Click the color 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 a new record is created.
  • Is Default Copy Status (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 Is Copy Status, copied UTA records will have the same status as the original record.
  • Exclude from Status Indicator - Checking this will exclude this status from the Status Indicator Level 1 Standard field.


Permissions and Availability Tab

Role Permissions

  • Allow to Set Roles - The specific roles that can set the status. If you do not set a role, then any user can set any status.
  • Override Lock Roles - The specific 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.

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 be available to record types added here. If you do not set a type, then the status will be available on all record types of this level entity.

Annotation System Role Permissions

Only available in UTA Statuses. Roles added here will have different levels of access to Annotation Mode in this status.

    • View Annotation Roles - defines the roles that can view annotations that have been added to the object at this status (annotation is only available for UTA objects).
    • View and Create Annotation Roles - defines the roles that can view and create annotations that have been added to the object at this status.
    • Edit Field in Annotation Mode Roles - defines the roles that edit fields that have had annotations attached.
    • Open Record in Annotation Mode - defines the roles that can edit the entire record in annotation mode.

Status History

If the Status Standard field is configured with Track Changes enabled then any user with View Field History Permissions will see a small clock and refresh icon under the Status field.


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. The duration (in days) can be included when building a report by including data from the "Standard Field Audit Log" dataset.

StatusFieldHistory.png

Status Translation Settings

Specify a status Caption and Group Name for each desired language.

  • When editing a status, select the Status Translation Settings button from the top of the window.
  • Select the language from the Language drop-down list.

StatusTranslationSettings.png

  • Enter the desired Caption translation and Group Name and click Save.
  • The relevant language caption will be displayed to users based on the language specified in their Personal Settings.

See Also


Previous.png  Status Field Permissions        Level 1 Templates  Next.png
Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Status&oldid=39173’