See Branding for a discussion of how to configure HomePageItems as part of consistent branding of a module of functionality.
An HomePageItem is created by adding an HomePageItem record, which contains the following fields:
The following Fields can be Read and Written To.
These Fields can be used to load data from Blueprints etc.
They can also be included referred to in Calculations or in Templates.
Field *required | Title | Type | Details |
---|---|---|---|
Name * | Name | text | Name of this HomePageItem – this is used to refer to this HomePageItem when triggering it from another HomePageItem. It is not visible to the user. Maximum length – 60 characters |
IconName | Icon | icon | |
Title | Title | text | The title is the text displayed to the user on the home page or in the menu. Maximum length – 80 characters |
Description | Information Tip | text | Optional detail text that appears as an information tip next to the Title. Maximum length – 500 characters |
SetName | Display Set Name | text | Enter the heading under which this HomePageItem should be displayed on the home page.
Normally, you would group HomePageItems relating to a common set of functionality (‘module’) under a common heading. Maximum length – 30 characters |
SetIconName | Set Icon | icon | Set IconName is an optional Icon that will be displayed alongside the SetName as part of the Set’s heading. |
SetColour | Set Colour | colour | Set Colour is an optional HTML colour. It will be used as the colour of the group box under which this HomePageItem is displayed on the home page. |
DisplayRecordType | Display Record Type | recordtype | Optionally set where this HomePageItem should link to when clicked. Link to an existing record, the Add Record page or a View page. Enter the name of the Record Type.
|
DisplayRecordName | Display Record Name | text | Optionally link to an existing record. Enter the name of a record of the type entered in DisplayRecordType. This will usually be a
Page or View. OR enter ‘add’, then the link will go to the Add Record page for the DisplayRecordType, OR
leave blank then the link will go to the Record Selection page for the DisplayRecordType Maximum length – 255 characters |
SolutionName | Solution Name | text | Optional name of the Solution to which this HomePageItem belongs. This has no functional effect, but ensures that this
record is included if a Solution is extracted as a Blueprint. Maximum length – 50 characters |
FormScript | Form Script | formscript | |
ActionScript | Action Script | actionscript | |
NextRoute | Next Route | text | Maximum length – 100 characters |
SequenceName | Sequence Name | text | If multiple HomePageItems are given the same SequenceName, then only one will be displayed at a time – the lowest SequenceOrder
that satisfies the ShowCalc. By default, when that HomePageItem’s form is completed (and any associated ActionScript executed),
then the next HomePageItem in the Sequence will be displayed (provided, of course, that it satisfies its ShowCalc if set). Maximum length – 60 characters |
SequenceOrder | Sequence Order | number | |
ShowCalc | Show Calc | Calculation | This optional Calculation will determine whether this HomePageItem is offered to the current user. |
isAdminOnly | Admin Only? | logical | |
ViewGroup | View Group | Group | |
EditGroup | Edit Group | Group |
The following Fields can be Read only. They can be referred to in Calculations or in Templates.
Field | Title | Type |
---|---|---|
Created | Created | datetime |
CreatedBy | Created By | Person |
Updated | Updated | datetime |
UpdatedBy | Updated By | Person |