useractions

See Branding for a discussion of how to configure UserActions as part of consistent branding of a solution of functionality.

An UserAction is created by adding an UserAction record, which contains the following fields:

Read/Write 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 UserAction – this is used to refer to this UserAction when triggering it from another UserAction. 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 – 200 characters
Description	Information Tip	text	Optional detail text that appears as an information tip next to the Title. Maximum length – 500 characters
SetName	Home Page Set Name	text	Enter the heading under which this UserAction should be displayed on the home page. Normally, you would group UserActions relating to a common set of functionality (Solution) under a common heading. If this is left blank then this UserAction will NOT show on the home page as a link. Typically you would only do this if you are using this UserAction to create a solution-wide (i.e. not record-specific) Form such as a setup/maintenance form; AND you intend to link to this form from a Page or the NextRoute of another UserAction. Maximum length – 30 characters
SetIconName	Home Page Set Icon	icon	Set IconName is an optional Icon that will be displayed alongside the SetName as part of the Set’s heading.
SetColour	Home Page Set Colour	colour	Set Colour is an optional HTML colour. It will be used as the colour of the group box under which this UserAction is displayed on the home page.
NextRoute	Next Route	text	This determines where the user is taken next from this UserAction. If no FormScript is included, then clicking on the UserAction will direct the user immediately to the destination defined by this NextRoute. If a FormScript is included, then clicking on the UserAction will bring up the Form first. The ActionScript will be applied to the results from the Form when it is saved, then this NextRoute will be used to determine where the user is routed after the form is saved. You can optionally override this NextRoute by setting a NextRoute variable in the ActionScript e.g. SET NextRoute=”person/view”. This gives you the flexibility to change the user destination based on logic in the ActionScript. You can even set the NextRoute variable to a record, in which case the user will be taken to that record e.g. SET NextRoute = oMyRecord In either case, the syntax of NextRoute is any of the following: To link to a record of any type, specify the RecordType name followed by a space then the name of the record. This can be used for most typical cases such as referring to a specific Page or View e.g. page My Dashboard Page Name or view My View Name To go to an add record form, specify the Recordtype name followed by a space and the word add e.g. Person add Alternatively, you can specify any internal url on its own e.g. person/view or organisation/list Maximum length – 100 characters
FormScript	Form Script	formscript
ActionScript	Action Script	actionscript
ShowCalc	Show Calc	Calculation	This optional Calculation will determine whether this UserAction is offered to the current user. It ONLY affects whether this item will display on the Home Page. Regardless of this setting, you can link to this UserAction directly from elsewhere.
SmallIconCalc	Small Icon Calc	Calculation	This optional Calculation will determine whether this UserAction is shown as a small icon in the footer of the Home Page Block, rather than as a ‘main’ item. You might, for example, have a ‘setup’ page for a Solution, which should appear as a main option at first, but as soon as the options have been set, relegate this to a small icon. In this case you might, for example, set this calculation to test that a particular setting is not empty.
isAdminOnly	Admin Only?	logical
SolutionName	Solution Name	text	Optional name of the Solution to which this UserAction 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
ViewGroup	View Group	Group
EditGroup	Edit Group	Group