Difference between revisions of "Status"
(→Button Script Function (Level 1 Only)) |
|||
| Line 70: | Line 70: | ||
|} | |} | ||
| − | ===Button Script | + | ===Submit Button Script (Level 1 Only)=== |
In order to use the Button Script Function you <u>must</u> select a '''Submit Button Status''' so that the '''Submit''' button will appear. | In order to use the Button Script Function you <u>must</u> select a '''Submit Button Status''' so that the '''Submit''' button will appear. | ||
* When you have defined a Button Script Function the Submit button will '''NOT''' cause the status to be changed. Instead it runs the script/function defined here. | * When you have defined a Button Script Function the Submit button will '''NOT''' cause the status to be changed. Instead it runs the script/function defined here. | ||
Revision as of 15:02, 16 July 2009
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.
The Status settings for Level 1, Level 2 and Level 3 are similar, with a few differences outlined below.
Contents
Creating Statuses
Statuses can be created and modified using the Settings page of your UTA.
- For Level 1 statuses click the Statuses link in the Level 1 settings section.
- 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.
- Details of each status are displayed on the right of the page and new statuses are added to the right of the page.
Status Settings
Each status has the following settings:
- 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 clicks the Submit button the status of the record is changed to the selected status. This may trigger a 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.
- 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 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 below).
- Roles That Override Lock - The specific 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 roles that can set the status. If you do not set a role, then any user can set any status.
You can restrict which 'Statuses are available to each Level 1 Template. See here for details.
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.
| Button | Description |
| Save |
|
| Save Draft |
|
| Save & New |
|
| Submit |
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 Button Script Function you must select a Submit Button Status so that the Submit button will appear.
- When you have defined a Button Script Function 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 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.
- You can optionally re-label the Submit button using the Submit Button Label setting).
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:
| Level 1: |
Level 2: |
- 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 Submit Logic for detailed instructions.
