Pages

See Branding for a discussion of how to configure Pages as part of consistent branding of a module of functionality.

A Page is defined by adding a Page 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
DisplayContext	Display Context	text	The context for which this Page is displayed. Pages in Global context are used for Dashboards, Reports and information pages that are not specific to an individual Record or Record Type. Pages in Record context are displayed for an individual Record of the specified Record Type. Pages in RecordType context are displayed as a View within that RecordType’s view selector, and will typically contain information that relates to the RecordType and that dynamically updates as the RecordType filter is updated. Permitted values: Global, Record, RecordType
RecordTypeName	Record Type	recordtype	The Record Type for which this Page displays e.g. Person / Organisation / a custom RecordType. Applies only for pages whose DisplayContext is Record or RecordType.
isDashboard	Dashboard Page?	logical	Set if this page is a Dashboard that will contain one or more widgets. Select this to create a dashboard-like page where you fill its content with widgets such as Views, Lists, Charts etc. If this is selected, you will not need to explicitly create Html Content or a Template Script to populate this page.
isSnippet	Snippet?	logical	Set if this page record contains a template snippet that will be made available as a Widget on Dashboard pages. If so, this page will never be displayed on its own as a complete page, but will be available to users to add to any dashboard page for this page’s record type.
Name *	Title	text	The document title, which appears on the cover and also becomes the file name. If left blank, the Page Name is used. Maximum length – 250 characters
IconName	Icon	icon	Optionally specify the icon which will be displayed in the Page header and in any links to this page.
Colour	Colour	colour	Colour is an optional HTML colour. It will be used as the colour of the page icon when displayed.
ParentPage	Parent Page	Page	Optional ParentPage – if selected, then This page will appear in the children menu of the Parent Page.
isHideChildrenMenu	Hide Children Menu?	logical	Set this to hide the menu of any children of this page – you may choose to do this if you deliberately want/need a page with lots of children but do not need all the menu links taking up valuable space.
isCreateDocument	Create PDF Document From Contents?	logical	If set, a PDF document can be created which contains the contents of this page and all of its children and descendants. The document can be generated and re-generated by any user who has Edit rights to this Page, known as the ‘Top Page’ of the document. The most recent version of the document is available to all with View rights to this page, as a link from this page or any of its descendants. Previous versions of the document are retained, and each re-generated document has the timestamp incorporated into its file name. This makes this facility ideal for use in generating internal training and compliance documents, retaining the links between the document content and other pages and records within your application.
isHomePageLink	Show Home Page Link	logical	Select to create a link to this page on the Home Page. If you don’t do this, make sure that you are providing a link to this Page by another means. If this page is a child of another page, or it is has RecordType DisplayScope, then it can be reached anyway. Otherwise, if you don’t provide a link on the Home Page you’ll probably have to refer to it with a link built into another Page’s content.
HomePageSetName	Home Page Set Name	text	This is the name of the Set in which the link to these records will be displayed in the Home Page. You will usually want this to be the same for a logical grouping of items that belong to the same ‘module’ of business functionality. Maximum length – 30 characters
HomePageSetColour	Home Page Set Colour	colour	Optionally specify the colour of the Home Page Set, usually to the standard colour of your relevant ‘module’ of business functionality.
HomePageShowCalc	Home PageShow Calc	Calculation	This optional Calculation will determine whether the link to this Page is actually displayed on the Home Page. You can use this to provide more granular control over when links are displayed. For example, you might only want to display a link to a page after certain conditions have been set, perhaps completing set-up of some initial configuration settings.
DocumentTitle	Document Title (if different)	text	Maximum length – 250 characters
isShowTOC	Show Table of Contents	logical	A Table Of Contents will be generated if this is set.
isLandscape	Landscape Format?	logical	Set to have document generated in Landscape rather than Portrait format
HtmlContent	Content	html	The content of the page, which may optionally contain calculations inserted using template syntax (inside braces {}). If a TemplateScript is also provided, the page will contain this content followed by the evaluation of the TemplateScript.
TemplateScript	Template Script	templatescript	This script will be evaluated as a template and the resulting Html added to the page output following the HtmlContent (if any). Note that, in reality, both the HtmlContent and TemplateScript fields are evaluated as Template Scripts, but in practical terms, the HtmlContent field is set to be edited as Html, making it unsuitable for inserting script structure commands (such as IF, EACH, etc.) – in contrast, raw Html can, of course, be included in this TemplateScript but without the benefit of a full Html Editor to assist its editing.
SetName	Display Set Name	text	Optionally enter the Display Set heading under which this Page link should be displayed on the record’s main display page. If left blank, no link to this Page will be automatically shown on the record’s page, on the assumption that you will provide a link to it manually from a Dashboard Snippet. Maximum length – 30 characters
DisplayAfter	DisplayAfter	text	Optionally specify the name of the field after which this Page link should be displayed in the Display Set specified. Alternatively, enter top to have this Page link display as the first item in the Display Set. Maximum length – 80 characters
Filter	Display Filter	filter	This optional Filter allows for more specific control over when a link to this Page is offered on each record. The filter is evaluated against a record and the link to this Page will only be offered if the Filter passes.
isDontShowIfParent	Don’t show if Parent Page shown	logical	Normally, if a Parent Page is shown on the record page, then you don’t want to include links to all the descendant pages as well. However, if this page is important enough to warrant its own link on the record page, even though it has a parent page, then uncheck this option.
isLocked		logical	Locked pages cannot be edited in the UI. This is typically set on dashboard-type pages in pre-configured applications to ensure that the logic therein cannot be accidentally broken by the users.
ViewGroup	View Group	Group
EditGroup	Edit Group	Group