Difference between revisions of "Record Page"

From SmartWiki
Jump to: navigation, search
m
m
 
(16 intermediate revisions by the same user not shown)
Line 4: Line 4:
  
 
=Overview=
 
=Overview=
−
Record pages allow you to view the details of an individual item in an application. They contain both the standard fields and custom fields. Record pages can exist for organizations, users, and Level 1 entities. From the record page, you can perform actions on the record such as edit fields, change the status, add it to a SmartCard, attach notes, assign contacts and accounts, and associate it with a Level 2 Activity. 
+
Record pages allow you to view the details of an individual item in an application. They contain both the [[Standard Field|standard fields]] and [[Custom Fields – General Information|custom fields]]. Record pages can exist for [[Organization|organizations]], users, and [[Level 1 Entity|Level 1 entities]]. From the record page, you can perform actions on the record such as edit fields, change the status, add it to a [[SmartCard]], attach notes, assign contacts and accounts, and associate it with a Level 2 Activity. 
  
 
=Configuration - Essentials=
 
=Configuration - Essentials=
−
When a new record is added to an application, the record page asks for the user to submit information to various standard and custom fields. While the standard fields are pre-defined by the system’s default settings, the custom fields can be created and managed by the Global Administrator. Each unique application will require unique custom fields depending on what is being tracked and what actions are required. 
+
When a new record is added to an application, the record page asks for the user to submit information to various standard and custom fields. While the standard fields are pre-defined by the system’s default settings, the custom fields can be created and managed by the '''Global Administrator'''. Each unique application will require unique custom fields depending on what is being tracked and what actions are required. 
  
  
 +
[[File:Record-Page.png|thumb|none|800px|A sample record page view for a Level 1 used in an application. ]]
  
−
A sample record page view for a Level 1 used in an application. 
 
  
−
{| class="contenttable"
+
 
 +
{| class="wikitable"
 +
|-
 +
!|#
 +
!|Component Name
 
|-
 
|-
 
||1
 
||1
−
||Header
+
||'''Header'''<br />Contains: logo, Main menu items, header button group
 
|-
 
|-
 
||2
 
||2
−
||Action Bar
+
||'''Action Bar<br />'''Contains: History button group and Action bar button group, Pagination control
 
|-
 
|-
 
||3
 
||3
 
||
 
||
 +
'''Action Bar Button Group'''<br />Contains: New (level 1, level 2 and other options), View/edit mode button, Options menu
 +
 
|-
 
|-
 
||4
 
||4
 
||
 
||
 +
'''Title Area'''<br />Contains: Title and High visibility options
 +
 
|-
 
|-
 
||5
 
||5
 
||
 
||
 +
'''High Visibility Options'''<br />Contains: Hide/show instructions, Add to SmartCard, Enable/disable dock
 +
 
|-
 
|-
 
||6
 
||6
 
||
 
||
 +
'''Hierarchical Navigation Bar'''<br />Contains: Links to parent object (UTA > L1 > L2 . L3)
 +
 
|-
 
|-
 
||7
 
||7
 
||
 
||
 +
'''Body'''<br />Contains: Custom/standard fields, tab area
 +
 
|-
 
|-
 
||8
 
||8
 
||
 
||
 +
'''Tab Area'''<br />Contains: Custom fields of the type Layout tabbed section
 +
 
|-
 
|-
 
||9
 
||9
 
||
 
||
 +
'''Left Navigation'''<br />Contains: Main, Notes, Contacts, Invitations, Organization, Level 2s (activities)
 +
 
|-
 
|-
 
||10
 
||10
 
||
 
||
−
|}
+
'''Submit Bar'''<br />Contains: Save and Submit buttons
  
 +
|-
 +
||11
 +
||
 +
'''Tab Bar'''<br />Contains: Tabs, New tab button, Multi task button
  
−
<br />The body area of the Records page contains all your custom fields. 
+
|}
  
−
 
+
The body area of the records page contains all your custom fields. To set up custom fields for all the records in your application, navigate to '''UTA Configuration Settings''' > '''(Level 1)''' tab > '''Custom Fields'''. Configuration settings for each application is located in the gear icon in the action bar. To set up custom fields for organizations, navigate to '''Global Settings''' > '''Organizations''' tab > '''Custom Fields'''. To set up custom fields for users, navigate to '''Global Settings''' > '''Users''' tab > '''Custom Fields'''. 
−
To set up custom fields for all the records in your application, navigate to Configuration Settings > (Level 1) tab > General Settings section > Custom Fields. Configuration settings for each application is located in the gear icon in the action bar. 
 
−
 
 
−
 
 
−
To set up custom fields for organizations, navigate to Global Settings > Organizations tab > General Settings section > Custom Fields. 
 
−
 
 
−
 
 
−
 
 
−
To set up custom fields for users, navigate to Global Settings > Users tab > General Settings section > Custom Fields. 
 
  
 
===Setting Up Custom Fields===
 
===Setting Up Custom Fields===
−
Main Article: Custom Fields – General Information
+
: ''Main Article: [[Custom Fields – General Information]]''
−
 
+
For a simple application, when creating a new custom field, you can select from a predefined list of field types depending on the end use. For example, a record containing a simple field for “About” can have the field type '''Text Box - Multiple Lines'''. A field for “Shipping Address” could have the type '''Special - Geo Mapping'''. See [[:Category:Custom Field Types|Category: Custom Field Types]] for full list of available field types to choose from, including dropdowns, radio buttons, checkboxes, date pickers, and more. 
−
 
+
Once you select the appropriate field type, you can also give the custom field a name in the database ('''Field Name''') and a display name that will be visible to users ('''Caption'''). The '''Display Order''' determines where in the form this custom field appears. The higher the number, the closer to the top of the form the field appears. A '''Description''' is not mandatory and will only be visible to '''Global Administrators''', however filling out a simple description for each custom field will make it easier to track changes and remember what each field is for. 
−
 
+
In the '''Permissions & Availability''' tab, you can further customize who can access the custom field and when. This allows you to tailor access to the custom field to a certain user role, a type category, or when a certain status change has been triggered. 
−
[image goes here]
 
−
 
 
−
 
 
−
 
 
−
For a simple application, when creating a new custom field, you can select from a predefined list of field types depending on the end use. For example, a record containing a simple field for “About” can have the field type Text Box - Multiple Lines. A field for “Shipping Address” could have the type Special - Geo Mapping. See Category: Custom Field Types for full list of available field types to choose from, including dropdowns, radio buttons, checkboxes, date pickers, and more. 
 
−
 
 
−
<br />Once you select the appropriate field type, you can also give the custom field a name in the database (Field Name) and a display name that will be visible to users (Caption). The Display Order determines where in the form this custom field appears. The higher the number, the closer to the top of the form the field appears. A Description is not mandatory and will only be visible to Global Administrators, however filling out a simple description for each custom field will make it easier to track changes and remember what each field is for. 
 
−
 
 
−
 
 
−
 
 
−
In the Permissions & Availability tab, you can further customize who can access the custom field and when. This allows you to tailor access to the custom field to a certain user role, a type category, or when a certain status change has been triggered. 
 
−
 
 
  
  
 
=Configuration - Advanced=
 
=Configuration - Advanced=
−
==Submit & Save Buttons==
+
===Submit & Save Buttons===
−
Main Article: Submit & Save Buttons
+
: ''Main Article: [[Submit & Save Buttons|Submit & Save Buttons]]''
−
 
 
−
 
 
−
 
 
 
Submit & Save buttons are used to perform custom actions upon each record such as saving a record, changing the status, validate input, or add annotations. Like custom fields, submit and save buttons can also be customized to be active only for certain roles, statuses, or record categories. To access the settings of any individual custom field, navigate to the following:
 
Submit & Save buttons are used to perform custom actions upon each record such as saving a record, changing the status, validate input, or add annotations. Like custom fields, submit and save buttons can also be customized to be active only for certain roles, statuses, or record categories. To access the settings of any individual custom field, navigate to the following:
 +
* UTA - '''Configuration Settings''' > '''(Level 1)''' tab > '''Submit & Save Buttons'''
 +
* Organization - '''Global Settings''' > '''Organizations''' tab > '''Submit & Save Buttons'''
 +
* Users - '''Global Settings''' > '''Users''' tab > '''Submit & Save Buttons'''
  
 +
===Record Layout Custom Fields===
 +
: ''Main Articles: [[Custom Field Type: Layout - Title Bar]], ''[[Custom Field Type: Layout - Tabbed Section|''Custom Field Type: Layout - Tabbed Sectio''n]]
 +
Title bars and tabbed sections help organize your records page by grouping together similar custom fields. A title bar separates related content on the same records page. A tabbed section moves blocks of related content onto a separate tab. The placement of custom fields can be controlled through the''' Display Order'''. 
 +
=Settings Explained=
 +
There are various custom fields that can be displayed on the record. To access the settings of any individual custom field, navigate to the following:
  
 +
* UTA - '''Configuration Settings''' > '''(Level 1)''' tab  > '''Custom Fields'''
 +
* Organization - '''Global Settings''' > '''Organizations''' tab > '''Custom Fields'''
 +
* Users - '''Global Settings''' >''' Users''' tab > '''Custom Fields'''
  
−
UTA - Configuration Settings > (Level 1) tab > General Settings section > Submit & Save Buttons
+
Each custom field typically has additional display options under the '''General Settings''' tab.
−
 
 
−
Organization - Global Settings > Organizations tab > General Settings section > Submit & Save Buttons
 
−
 
 
−
Users - Global Settings > Users tab > General Settings section > Submit & Save Buttons
 
−
 
 
−
==Record Layout Custom Fields==
 
−
Main Articles: Custom Field Type: Layout - Title Bar, Custom Field Type: Layout - Tabbed Section
 
−
 
 
−
 
 
−
 
 
−
Title Bars and Tabbed Sections help organize your records page by grouping together similar custom fields. A title bar separates related content on the same records page. A tabbed section moves blocks of related content onto a separate tab. The placement of custom fields can be controlled through the Display Order. 
 
−
 
 
−
==Settings Explained==
 
−
To access the settings of any individual custom field, navigate to the following:
 
−
 
 
−
UTA - Configuration Settings > (Level 1) tab > General Settings section > Custom Fields
 
−
 
 
−
Organization - Global Settings > Organizations tab > General Settings section > Custom Fields
 
−
 
 
−
Users - Global Settings > Users tab > General Settings section > Custom Fields
 
−
 
 
−
 
 
−
 
 
−
==Display Text==
 
−
The Display Text options help you determine how the custom field should be displayed to the user. Caption Location allows you to put the field label name either above, to the right, or the left of the input as well as hiding it altogether. You can also add additional instructions to display to the user if desired. Placeholder text will be greyed out text that pre-populates the input field. This can be useful to showing examples or hinting at the desired input format. Additionally, you also have the ability to add tooltip text. Filling out this section with helpful contextual information will make a small question mark icon appear to the right of the input form. When the user hovers over this icon, you tooltip text will appear. 
 
−
 
 
−
'''<strong> '''</strong>
 
−
 
 
−
==Validation==
 
−
Options within the validation section allow you to mark this custom field as mandatory or add custom validation to ensure the user’s input follows certain parameters. For example, a date of birth custom field may have additional custom validation to ensure the user’s input is a date that is in the past or is limited to a certain range of years. You can also choose what message to display to the user if they fail this validation check. 
 
−
 
 
−
'''<strong> '''</strong>
 
  
−
==Feature Options==
+
===Display Settings===
−
'''<strong> '''</strong>
 
  
−
This section contains any additional features that can be enabled on the custom field. These features vary depending on the custom field type. For example, the Text Box - Single Line and Text Box - Multiple Lines contains a feature option for enabling hashtags as part of the user input. 
+
; Caption Location
 +
: Allows you to put the field label name either above, to the right, or the left of the input as well as hiding it altogether.
  
−
==Value Storage==
+
; Instructions
−
==SmartFields==
+
: (Optional) Text that describes how the user should enter data into the field.
−
Main Article: SmartField View
 
  
−
This section allows you to specify whether the custom field should be included in generated reports or system summaries. 
+
; Placeholder Text
 +
: (Optional) This is greyed out text that pre-populates the input field. This can be useful to showing examples or hinting at the desired input format.
  
−
'''<strong> '''</strong>
+
; Tool Tip
 +
: (Optional) A tooltip will put a special icon beside the caption. When the user hovers over this icon, it will reveal extra text that provides further information or help about the field.
  
−
==Visibility Condition==
+
; Width
−
Main Article: Visibility Condition
+
: (Optional) Allows you to set the total width of the field from a series of dropdown options.
  
−
This section allows you to use additional logical statements to determine whether or not a field is visible. Common visibility condition statements are based on roles, types, statuses, and even field values.
+
; Height
 +
: (Optional) Allows you to set the total height of the field in a percentage or pixel format.

Latest revision as of 10:58, 1 May 2023


Construction warning.png Please note that this page is currently under construction. There is more information to come.


Overview

Record pages allow you to view the details of an individual item in an application. They contain both the standard fields and custom fields. Record pages can exist for organizations, users, and Level 1 entities. From the record page, you can perform actions on the record such as edit fields, change the status, add it to a SmartCard, attach notes, assign contacts and accounts, and associate it with a Level 2 Activity. 

Configuration - Essentials

When a new record is added to an application, the record page asks for the user to submit information to various standard and custom fields. While the standard fields are pre-defined by the system’s default settings, the custom fields can be created and managed by the Global Administrator. Each unique application will require unique custom fields depending on what is being tracked and what actions are required. 


A sample record page view for a Level 1 used in an application. 


# Component Name
1 Header
Contains: logo, Main menu items, header button group
2 Action Bar
Contains: History button group and Action bar button group, Pagination control
3

Action Bar Button Group
Contains: New (level 1, level 2 and other options), View/edit mode button, Options menu

4

Title Area
Contains: Title and High visibility options

5

High Visibility Options
Contains: Hide/show instructions, Add to SmartCard, Enable/disable dock

6

Hierarchical Navigation Bar
Contains: Links to parent object (UTA > L1 > L2 . L3)

7

Body
Contains: Custom/standard fields, tab area

8

Tab Area
Contains: Custom fields of the type Layout tabbed section

9

Left Navigation
Contains: Main, Notes, Contacts, Invitations, Organization, Level 2s (activities)

10

Submit Bar
Contains: Save and Submit buttons

11

Tab Bar
Contains: Tabs, New tab button, Multi task button

The body area of the records page contains all your custom fields. To set up custom fields for all the records in your application, navigate to UTA Configuration Settings > (Level 1) tab > Custom Fields. Configuration settings for each application is located in the gear icon in the action bar. To set up custom fields for organizations, navigate to Global Settings > Organizations tab > Custom Fields. To set up custom fields for users, navigate to Global Settings > Users tab > Custom Fields. 

Setting Up Custom Fields

Main Article: Custom Fields – General Information

For a simple application, when creating a new custom field, you can select from a predefined list of field types depending on the end use. For example, a record containing a simple field for “About” can have the field type Text Box - Multiple Lines. A field for “Shipping Address” could have the type Special - Geo Mapping. See Category: Custom Field Types for full list of available field types to choose from, including dropdowns, radio buttons, checkboxes, date pickers, and more.  Once you select the appropriate field type, you can also give the custom field a name in the database (Field Name) and a display name that will be visible to users (Caption). The Display Order determines where in the form this custom field appears. The higher the number, the closer to the top of the form the field appears. A Description is not mandatory and will only be visible to Global Administrators, however filling out a simple description for each custom field will make it easier to track changes and remember what each field is for.  In the Permissions & Availability tab, you can further customize who can access the custom field and when. This allows you to tailor access to the custom field to a certain user role, a type category, or when a certain status change has been triggered. 


Configuration - Advanced

Submit & Save Buttons

Main Article: Submit & Save Buttons

Submit & Save buttons are used to perform custom actions upon each record such as saving a record, changing the status, validate input, or add annotations. Like custom fields, submit and save buttons can also be customized to be active only for certain roles, statuses, or record categories. To access the settings of any individual custom field, navigate to the following:

  • UTA - Configuration Settings > (Level 1) tab > Submit & Save Buttons
  • Organization - Global Settings > Organizations tab > Submit & Save Buttons
  • Users - Global Settings > Users tab > Submit & Save Buttons

Record Layout Custom Fields

Main Articles: Custom Field Type: Layout - Title Bar, Custom Field Type: Layout - Tabbed Section

Title bars and tabbed sections help organize your records page by grouping together similar custom fields. A title bar separates related content on the same records page. A tabbed section moves blocks of related content onto a separate tab. The placement of custom fields can be controlled through the Display Order. 

Settings Explained

There are various custom fields that can be displayed on the record. To access the settings of any individual custom field, navigate to the following:

  • UTA - Configuration Settings > (Level 1) tab  > Custom Fields
  • Organization - Global Settings > Organizations tab > Custom Fields
  • Users - Global Settings > Users tab > Custom Fields

Each custom field typically has additional display options under the General Settings tab.

Display Settings

Caption Location
Allows you to put the field label name either above, to the right, or the left of the input as well as hiding it altogether.
Instructions
(Optional) Text that describes how the user should enter data into the field.
Placeholder Text
(Optional) This is greyed out text that pre-populates the input field. This can be useful to showing examples or hinting at the desired input format.
Tool Tip
(Optional) A tooltip will put a special icon beside the caption. When the user hovers over this icon, it will reveal extra text that provides further information or help about the field.
Width
(Optional) Allows you to set the total width of the field from a series of dropdown options.
Height
(Optional) Allows you to set the total height of the field in a percentage or pixel format.
Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Record_Page&oldid=41143’