Difference between revisions of "Status"

Revision as of 15:38, 25 July 2016

Overview

Statuses represent a core concept within the SmartSimple platform. Each status represents the state of the related object. Statuses can be defined with the Universal Tracking application for all the types of objects that you create; Level 1 objects and Level 2 and Level 3 activities. You can also used 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.

Creating UTA Statuses

To work with statuses within a UTA you need the Manager Permission for that UTA. If you have this permission then the Configuration Settings, Level 1, Level 2 setting pages provides access the statuses.

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 page.
• 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).

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

Organization/Contact Statuses

• Organization statuses are accessible from Global Settings > Organizations & Users >Company & Account Settings.
• Contact statuses are accessible from Global Settings > Organizations & Users >User & Contact Settings.
• Use the Organization Statuses link to create a new status.

Referencing Statues as value

You can reference the status of any status based object (Level 1, Level 2, Level 3, Contact or Organization) by referring the object and one of the following status qualifiers.

@Contact.status@ returns the status name for example: Active

• statusid (the numeric identified of the status), statuscaption (the alternative caption of the status) can also be referenced.

• This syntax can be used within Submit Logic Validation script by adding the object type prefix:

"@level1.client.statuscaption@"

The status caption will be references. Example:

Verified

See Submit Logic for detailed instructions.

Status Settings

Each status has the following settings:

General Tab

• Status ID - Internal unique system ID that can be used to reference the status.
• Language - Language each status can be defined in multiple languages.
• Name - Name for the Status.
• Caption - Default display name for the status.
• Tooltip - a description to be displayed when the user moves their mouse over the caption (when displayed used the Status Indicator).
• Display Order - The order that statuses are displayed in the Status combo box.
• Group Name - Used in conjunction with the Arcadia Settings to mask multiple individual statuses with a single overall status.
• Description - Any comments or notes you wish to include. Note: Description only manifest on the configuration page.
• 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 Default Copy Status (Level 2 & 3 only) - When the Copy button is used to create a copy of a Level 2 or Level 3 record, the new record will have the status that has this setting enabled. If no status is set as Is Copy Status, copied Level 2 or Level 3 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.
• Display Buttons - Controls which default Save buttons are available to the user for a record at this status. (See Button Options below).
• Template Page Submit Status - Controls the assigned status when submitted via a template page.

Permissions and Availability Tab

• Status Availability - Only available when configuring Level 2 Statuses. By default any statuses created for a Level 2 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. (See Status Availability below).
• 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.

Annotation Settings

The following settings are used to control the behaviour of the object when annotation has been applied to fields.

• 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 and Level 1 Templates

The final setting on this pave controls the specific templates for which the status is available. You can also restrict which Statuses are available to each Level 1 Template by navigating into the template itself. See here for details.

Translation Options

The system allows a Status to have multiple captions added, potentially one for each language available in the system.

• Select the language from the Language drop-down list.

• In the resulting screen populate the Caption field with an appropriate value for the selected language.
• You can also enter a translation for the Group Name of the status.

• Click Save

• Now when a user, who has this language configured against their Personal Settings, accesses the system then they will see the status labelled using the relevant caption.

Button Options

For each status you determine which of the "Save", "Save Draft" and "Save & New" buttons are available to the 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.

Submit Button Script (Level 1 Only)

In order to use the Submit Button Script you must select a Submit Button Status so that the Submit button will appear.
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 not 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 customsubmit you would put the following into the Submit Button Script section:

The following sample JavaScript function will prompt the user to confirm if they want to submit the record.

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
   }
}

• The "return false" isn't strictly necessary. If the function does not return true then false is assumed.
• Note that JavaScript is case sensitive.

If you would like to define a custom script that runs when a record is saved or submitted you can use savefunc.

Status Availability

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.

The following 3 options are available:

• Available for Tasks - will make it available to both Level 2 and Level 3 records.
• Not available for Tasks - will make it available to Level 3 records only.
• Not available for Level 3 Activities - will make it available to Level 2 records only.

Status Triggers

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.

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.

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.

Status Triggers can be defined by clicking the Status Trigger link when editing the relevant Status:

Which brings you to the Status Trigger page:

• From Level 1 you can define status triggers for associated Level 2 records, Level 3 records, and Transactions.
• 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.

• 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.
• 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.

• Any number of triggers can be created.

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 Also

• Status Lock
• Submit Logic
• Batch Update
• Level 1 Templates
• Status Indicator

Status Field Permissions

Level 1 Templates