Changes

Status

6,489 bytes removed, 19:23, 22 October 2021
Status Translation Settings
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.
[[Image:status-001ApplicationStatuses.png|400px600px]]
The '''Status''' settings for Level 1, Level 2 and Level 3 are similar, with a few differences outlined below.
* 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:status-002ActivityStatuses.png|400px600px]]
:* Organization statuses are accessible from [[Global Settings]] > [[Organization|Organizations]] > Statuses.
:* Contact statuses are accessible from [[Global Settings]] > [[User|Users]] > Statuses.
 
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.
[[Image:StatusHistoryChartStatusFieldHistory.png|800px|border]]
==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.:*: [[Image:Status-003StatusTranslationSettings.png|400px600px]]:* :** 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]]. ==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. {| border="1"|-||'''Button'''||'''Description'''|-||Save||:** This button validates all fields in the record, ensuring that mandatory fields and formatting requirements 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 requirements 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 '''Caption''' section of the status page, so may appear with another name.'''''Important:''' If a '''''Submit Button Script''''' has been defined the Submit button will run that function, translation and will '''NOT''' perform the tasks listed above. |}=Configuration - Advanced====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 '''falseGroup Name''' if the record should not be submitted.:** Standard and Custom Field validation is performed click '''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 '''Caption''' setting and you can select an icon for the button.For example, if your Browser Script contains a function called ''customsubmit'' you would put the following into the '''Submit Button ScriptSave''' section::*: [[Image:Bsf.png]] The following sample [[JavaScript]] function 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>:** ''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 relevant language caption will be available displayed 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 users based on a status change at the level 1 item. For example, if you have an “abandoned” status for a project tracking language specified in their [[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: :* :*: [[Image:StatusTrigger.png]] 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 2Personal Settings]] |} :** 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==
Smartstaff
282
edits