Difference between revisions of "Extension Database Setup"

From Charitylog Manual
Jump to: navigation, search
m (Extension Database Settings)
m (Export/Import)
 
(40 intermediate revisions by 3 users not shown)
Line 7: Line 7:
 
__TOC__
 
__TOC__
  
 +
=Introduction to Extension Databases=
  
 
Extension Databases provide a way for you to add fields, or sets of fields, to the system. They can be used to capture any information which is not catered for in the standard setup.  
 
Extension Databases provide a way for you to add fields, or sets of fields, to the system. They can be used to capture any information which is not catered for in the standard setup.  
Line 13: Line 14:
  
 
To create a new Extension Database click "New Extension Database" or click on the name of an existing Extension Database to edit it. Its important you understand the different locations available for an Extension Database. The below webinar explains this.  
 
To create a new Extension Database click "New Extension Database" or click on the name of an existing Extension Database to edit it. Its important you understand the different locations available for an Extension Database. The below webinar explains this.  
{{#ev:youtube|3XQtEK8LPmo|790}}
+
{{#ev:youtube|FAB52WalfDw|790}}
  
 
=Extension Database Settings=
 
=Extension Database Settings=
The second webinar explains each of the settings. Further information is below.
 
{{#ev:youtube|nRhh_f_J738|790}}
 
  
You can also use Extension Databases to record Outcomes/Evaluations and this webinar explains in more detail.
 
{{#ev:youtube|6PoS31Jqge8|790}}
 
 
On an existing Extension Database or when saving the Extension Database settings for a new one a navigation bar will appear at the top of the section:
 
On an existing Extension Database or when saving the Extension Database settings for a new one a navigation bar will appear at the top of the section:
  
Line 26: Line 23:
  
 
This allows you to move between the following sections of the setup:
 
This allows you to move between the following sections of the setup:
* '''Extension Database Settings''' - This is the general details of where the extension data base will appear and which security groups can access it.
+
* '''The name of the Extension Database is underlined ''' - This is the general details of where the extension data base will appear and which security groups can access it.
* '''Extension Database Sections''' - Sections are used to group questions together to make data entry easier and more logical.
+
* '''All Sections''' - Sections are used to group questions together to make data entry easier and more logical.
* '''Extension Database Fields''' - Fields are the bespoke questions and options that appear in the Extension Database.
+
* '''New Field''' - allows you to add new fields
  
You can now enter or edit:
+
To create a new Extension Database, click on New '''Extension Database'''
  
 
[[File:New_Extension_database.PNG]]
 
[[File:New_Extension_database.PNG]]
  
* '''Name for additional data entry option''' - This is name of the Extension Database and will also be the button label that appears for the user.
+
* '''Extension Database Name'''- This is name of the Extension Database and will also be the button label that appears for the user.
* '''Description''' - This is information about the Extension Database which can only be viewed on this page,
+
* '''Description''' - This is information about the Extension Database which can only be viewed on this page
 +
* '''One record or multiple records for this entry?'''
 +
** '''One Record''' - This displays a single set of fields, if the data is changed the previous entry will be simply over written.  This would be used for questions like 'Do you drive?', if circumstances changed you would simply change the answer to the question.
 +
** '''One or More Records''' - This is used if multiple sets of data is required.  As an example you could have an extension database to record donations given, as you may get more than one donation from the some person.
 
* '''Linked to which main type of record?''':
 
* '''Linked to which main type of record?''':
 
** '''Organisations and People''' - This will be able to be displayed on a record tab or at the footer of the record.
 
** '''Organisations and People''' - This will be able to be displayed on a record tab or at the footer of the record.
Line 41: Line 41:
 
** '''Clubs and Clinics''' - This will appear on the footer of a Club, Clinic or Group details page, for those specified.
 
** '''Clubs and Clinics''' - This will appear on the footer of a Club, Clinic or Group details page, for those specified.
 
** '''Clubs and Clinics Meetings''' - This will appear on the individual occurrence of the Club, Clinic or Group on the incomplete/complete meeting tabs and when a meeting is completed via the wizard or complete button.
 
** '''Clubs and Clinics Meetings''' - This will appear on the individual occurrence of the Club, Clinic or Group on the incomplete/complete meeting tabs and when a meeting is completed via the wizard or complete button.
* '''Tab''' - This option appears when the '''linked to''' option is set to 'Organisations and People'Specify weather the Extension Database is to be displayed on the record footer or which tab. Additional tabs can be setup, see [[Customise_Orgs_%26_People#Additional_Tabs_for_Records|Customise Orgs & People]] for details.
+
* '''Show Fields on Section''' - This option appears when the '''linked to''' option is set to 'Organisations and People'Specify weather the Extension Database is to be displayed on the required section Additional sections can be setup, see [[Customise_Orgs_%26_People#Additional_Tabs_for_Records|Customise Orgs & People]] for details.
* '''Select specific type of record(s)''' -
 
** '''Organisations and People''' linked - Select the record type(s) that the Extension Database will be displayed on.
 
** '''Referrals''' linked - Select which project(s) the Extension Database will be used with.  See [[Project_Set_Up#Additional_Data_Collection_tab|Project Setup]] for further configuration options.
 
** '''Clubs and Clinics''' linked - Select which Club, Clinic or Group(s) that should display the Extension Database.
 
 
* '''Available to users in these groups''' - Select which [[Group Access|Groups]] of users can access the Extension Database.
 
* '''Available to users in these groups''' - Select which [[Group Access|Groups]] of users can access the Extension Database.
* '''One record or multiple records for this entry?'''
 
** '''One Record''' - This displays a single set of fields, if the data is changed the previous entry will be simply over written.  This would be used for questions like 'Do you drive?', if circumstances changed you would simply change the answer to the question.
 
** '''One or More Records''' - This is used if multiple sets of data is required.  As an example you could have an extension database to record donations given, as you may get more than one donation from the some person.
 
 
* '''Maximum number of column Headers to be viewable when selecting from multiple records?''' - When selecting 'One or More' you can specify the number of columns displayed for the Extension Database.
 
* '''Maximum number of column Headers to be viewable when selecting from multiple records?''' - When selecting 'One or More' you can specify the number of columns displayed for the Extension Database.
 
* '''Active?''' - When set to 'Yes' the Extension Database will be dis[played and can be reported on.
 
* '''Active?''' - When set to 'Yes' the Extension Database will be dis[played and can be reported on.
Line 56: Line 49:
 
* '''Save and edit Sections''' - Saves any changes and moves to the page to create sections, if required.
 
* '''Save and edit Sections''' - Saves any changes and moves to the page to create sections, if required.
 
* '''Save and edit Fields''' - Saves any changes and moves to the page to create the fields to record the data.
 
* '''Save and edit Fields''' - Saves any changes and moves to the page to create the fields to record the data.
* '''Save and Close''' - This is displayed on existing Extension Databases, saves the changes and returns to the list of existing Extension Databases.
 
  
 
=Extension Database Sections=
 
=Extension Database Sections=
  
Sections are display on Record Footer extension databases, and are not displayed if the extension database is place on a record tab.
+
Section Headings will be displayed if you add an Extension Database to display One or More. They won't appear if you have just added fields to an existing section such as the Personal Details page. The following webinar gives an example of how section headings can be used for things like assessments.  
 +
 
 +
{{#ev:youtube|bAHllGk4i-k|790}}
  
 
[[File:ExtDB_sections.PNG]]
 
[[File:ExtDB_sections.PNG]]
Line 74: Line 68:
  
 
To create a new section click on the lick 'Create a new Extension Database Section...'.  Type the required label for the section and click go to create it.
 
To create a new section click on the lick 'Create a new Extension Database Section...'.  Type the required label for the section and click go to create it.
 
[[File:ExtDB_newsection.PNG]]
 
  
 
The section will be created and added to the list of existing sections (if any).
 
The section will be created and added to the list of existing sections (if any).
Line 91: Line 83:
 
[[File:ExtDB_reorder.PNG]]
 
[[File:ExtDB_reorder.PNG]]
  
=Extension Database Fileds=
+
=Extension Database Fields=
 +
 
 +
An Extension Data base can contain a series of different field types.  After you have completed the field options click 'Save Details' to create the field. The following webinar explains the different types of fields available.
  
An Extension Data base can contain a series of different field types.  After you have completed the field options click 'Save Details' to create the field.
+
{{#ev:youtube|bbTWspcJu1U|790}}
  
 
==Single Row Text==
 
==Single Row Text==
Line 102: Line 96:
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 +
* '''Field Type''' - Option to select which of these field types you wish to use.  '''Once a field has been created the field type cannot be changed.'''  Set to 'Single Row Alphanumeric String'.
 +
* '''Appear in Reports''' - allows you to specify if data entered will appear in your reports. Useful if you want to add a free text box, but don't need that data for reporting purposes.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Single Row Alphanumeric String'.
 
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
* '''Filter By Field''' - This option is displayed when at least one field has been created and '''is only used for 'Select from Option Dropdown List' and 'Radio Buttons' field types'''.
 
 
* '''Field length''' - This determines the length of the field and the maximum number of characters that can be entered.
 
* '''Field length''' - This determines the length of the field and the maximum number of characters that can be entered.
 
* '''Default Value''' - You can populate the field with the details specified.
 
* '''Default Value''' - You can populate the field with the details specified.
Line 113: Line 107:
 
** '''Not Required - No Rules''' - The field will be displayed but can be left blank.
 
** '''Not Required - No Rules''' - The field will be displayed but can be left blank.
 
** '''Warning - Warn if not filled in''' - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
 
** '''Warning - Warn if not filled in''' - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
* '''Shortcut Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
+
* '''Access Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
Line 125: Line 119:
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 +
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Multi Row Text Input'.
 +
* '''Include in Reports''' - you can decide to include this data in reports.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Multi Row Text Input'.
 
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
* '''Filter By Field''' - This option is displayed when at least one field has been created and '''is only used for 'Select from Option Dropdown List' and 'Radio Buttons' field types'''.
+
* '''Default Value''' - can be used if you want a value to be automatically entered into this field. Use with caution as people may have to delete any text before entering their own.
 
* '''Field Entry Requirement'''
 
* '''Field Entry Requirement'''
 
** '''Not Required - No Rules''' - The field will be displayed but can be left blank.
 
** '''Not Required - No Rules''' - The field will be displayed but can be left blank.
 
** '''Warning - Warn if not filled in''' - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
 
** '''Warning - Warn if not filled in''' - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
* '''Shortcut Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
+
* '''Access Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
Line 146: Line 141:
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 +
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Numeric Only'.
 +
* '''Include in Reports''' - allows you to choose if this data will appear in reports. 
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Numeric Only'.
 
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
* '''Filter By Field''' - This option is displayed when at least one field has been created and '''is only used for 'Select from Option Dropdown List' and 'Radio Buttons' field types'''.
 
 
* '''Field length''' - This determines maximum number of digits (including decimal point), this works alongside the numeric maximum.
 
* '''Field length''' - This determines maximum number of digits (including decimal point), this works alongside the numeric maximum.
 
* '''Decimal Places''' - Specify the number of decimal places that are required, please keep in mind the field length.
 
* '''Decimal Places''' - Specify the number of decimal places that are required, please keep in mind the field length.
Line 160: Line 155:
 
* '''Numeric Minimum''' - The minimum value a user can enter.
 
* '''Numeric Minimum''' - The minimum value a user can enter.
 
* '''Numeric Maximum''' - The maximum value a user can enter, this must comply with the field length.
 
* '''Numeric Maximum''' - The maximum value a user can enter, this must comply with the field length.
* '''Shortcut Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
+
* '''Access Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
Line 172: Line 167:
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 +
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Numeric Only'.
 +
* '''Include in Reports''' - allows you to decide if you would like to include this data in reports.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Numeric Only'.
 
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
* '''Filter By Field''' - This option is displayed when at least one field has been created and '''is only used for 'Select from Option Dropdown List' and 'Radio Buttons' field types'''.
 
 
* '''Field length''' - This determines maximum number of digits (including decimal point), this works alongside the numeric maximum.
 
* '''Field length''' - This determines maximum number of digits (including decimal point), this works alongside the numeric maximum.
 
* '''Decimal Places''' - Specify the number of decimal places that are required, please keep in mind the field length.
 
* '''Decimal Places''' - Specify the number of decimal places that are required, please keep in mind the field length.
Line 186: Line 181:
 
* '''Numeric Minimum''' - The minimum value a user can enter.
 
* '''Numeric Minimum''' - The minimum value a user can enter.
 
* '''Numeric Maximum''' - The maximum value a user can enter, this must comply with the field length.
 
* '''Numeric Maximum''' - The maximum value a user can enter, this must comply with the field length.
* '''Shortcut Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
+
* '''Access Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
Line 197: Line 192:
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 +
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Date'.
 +
* '''Include in Reports''' - allows you to report on data entered
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Date'.
 
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
* '''Filter By Field''' - This option is displayed when at least one field has been created and '''is only used for 'Select from Option Dropdown List' and 'Radio Buttons' field types'''.
+
* '''Default Date Value''' - You can populate the field with the date the record is entered or left empty.
* '''Default Value''' - You can populate the field with the date the record is entered or left empty.
 
 
* '''Field Entry Requirement'''
 
* '''Field Entry Requirement'''
 
** '''Not Required - No Rules''' - The field will be displayed but can be left blank.
 
** '''Not Required - No Rules''' - The field will be displayed but can be left blank.
 
** '''Warning - Warn if not filled in''' - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
 
** '''Warning - Warn if not filled in''' - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
* '''Shortcut Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
+
* '''Access Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
Line 219: Line 214:
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 +
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Multi Row Text Input'.
 +
* '''Include in Reports''' - allows you to report on data entered
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Multi Row Text Input'.
 
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
* '''Filter By Field''' - This allows the dropdown list to be filtered by another drop down list (does not work with radio buttons).  The options that have been selected on a previous question can filter what options can be selected on this question.  From the list select the dropdown list that is to be used to filter this question.
 
 
* '''Option Details''' - This is the items that will appear in the drop down list.
 
* '''Option Details''' - This is the items that will appear in the drop down list.
** '''Default''' - When ticked this option will automatically be selected when entering a new record.
+
** '''Default''' - When ticked this option will automatically be selected when entering a new record. It is worth considering if you want this value saved if the extension database is not manually changed before saving a client record.
 
** '''Option Text''' - This is the name displayed in the dropdown list.
 
** '''Option Text''' - This is the name displayed in the dropdown list.
** '''[[Display Order]]''' - The order the option will be displayed in the dropdown list.
+
* '''Filter By Field''' - This allows the dropdown list to be filtered by another drop down list (does not work with radio buttons)The options that have been selected on a previous question can filter what options can be selected on this questionFrom the list select the dropdown list that is to be used to filter this question.
** '''Selection list for the filter''' - Select which answers of the previously selected question that the current option is available to be selectedIf you are using the filter and nothing is selected then the option cannot be selected.  If the option is to be available to all then all answers to the previous question must be selected.
 
** '''Active''' - If set to yes then this option can be selected from the drop down list.
 
** '''Plus Icon [[File:Icon_plus.PNG]]''' - Creates a new line for the next option.
 
 
* '''Inactive Option Display'''
 
* '''Inactive Option Display'''
 
** '''Do not display inactive options''' - Options that have been set as inactive will not be displayed in the dropdown list.
 
** '''Do not display inactive options''' - Options that have been set as inactive will not be displayed in the dropdown list.
Line 238: Line 230:
 
** '''Not Required - No Rules''' - The field will be displayed but can be left blank.
 
** '''Not Required - No Rules''' - The field will be displayed but can be left blank.
 
** '''Warning - Warn if not filled in''' - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
 
** '''Warning - Warn if not filled in''' - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
* '''Shortcut Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
+
* '''Access Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
Line 252: Line 244:
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Field Label''' - This is the name/question that is displayed to the user.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 +
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Multi Row Text Input'.
 +
* '''Include in Reports''' - allows you to report on data entered
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
 
* '''Allow collaborator API access?''' - Used for API connections if your system links to a third party system.  When set to yes you can then specify the API name to be used.
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Multi Row Text Input'.
 
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Link to Spreadsheet''' - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to.  See  [[Extension_Database_Setup#Spreadsheet_Calculations_Result|Spreadsheet Calculations Result]] for further details.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
 
* '''Spreadsheet cell''' - Specify the cell in the spreadsheet that the field feeds into.
* '''Filter By Field''' - This allows the dropdown list to be filtered by another radio button field (does not work with dropdown lists).  The options that have been selected on a previous question can filter what options can be selected on this question.  From the list select the radio button field that is to be used to filter this question.
+
** '''Option Text''' - This is the name displayed in the dropdown list.
 
* '''Option Details''' - This is the items that will appear in the drop down list.
 
* '''Option Details''' - This is the items that will appear in the drop down list.
 
** '''Default''' - When ticked this option will automatically be selected when entering a new record.
 
** '''Default''' - When ticked this option will automatically be selected when entering a new record.
** '''Option Text''' - This is the name displayed in the dropdown list.
 
 
** '''[[Display Order]]''' - The order the option will be displayed in the dropdown list.
 
** '''[[Display Order]]''' - The order the option will be displayed in the dropdown list.
 
** '''Selection list for the filter''' - Select which answers of the previously selected question that the current option is available to be selected.  If you are using the filter and nothing is selected then the option cannot be selected.  If the option is to be available to all then all answers to the previous question must be selected.
 
** '''Selection list for the filter''' - Select which answers of the previously selected question that the current option is available to be selected.  If you are using the filter and nothing is selected then the option cannot be selected.  If the option is to be available to all then all answers to the previous question must be selected.
Line 266: Line 258:
 
** '''Plus Icon [[File:Icon_plus.PNG]]''' - Creates a new line for the next option.
 
** '''Plus Icon [[File:Icon_plus.PNG]]''' - Creates a new line for the next option.
 
* '''Radio Button Display''' - Select the required display option.
 
* '''Radio Button Display''' - Select the required display option.
 +
* '''Filter By Field''' - This allows the dropdown list to be filtered by another radio button field (does not work with dropdown lists).  The options that have been selected on a previous question can filter what options can be selected on this question.  From the list select the radio button field that is to be used to filter this question.
 
** '''On one row''' - Ideal for less options and is displayed across the screen.
 
** '''On one row''' - Ideal for less options and is displayed across the screen.
 
** '''Multi rows/Stacked''' - Ideal for options with a long names or larger quantity of options.
 
** '''Multi rows/Stacked''' - Ideal for options with a long names or larger quantity of options.
Line 278: Line 271:
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
  
==Dropdown List of Orgs/People by type==
+
==Look up List of Orgs/People by type==
  
This field displays a dropdown list of Organisations and People on the system.  
+
This field displays a look up list of Organisations and People on the system.  
  
 
[[File:extdb_orgslist.png]]
 
[[File:extdb_orgslist.png]]
Line 287: Line 280:
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 
* '''Description''' - This is displayed as help text via a question mark icon [[File:Icon_greenquestionmark.PNG]].  This is note displayed when the fields are displayed on a tab.
 
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Dropdown List of Orgs/People by type'.
 
* '''Field Type''' - Option to select which of these field types you wish to use.  Once a field has been created the field type cannot be changed.  Set to 'Dropdown List of Orgs/People by type'.
 +
* '''Include in Reports''' - allows you to report on data entered
 
* '''Dropdown List of Organisations / People by Type''' - Selected the required record types that will be available to be selected.
 
* '''Dropdown List of Organisations / People by Type''' - Selected the required record types that will be available to be selected.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
 
* '''Appear in Section''' - If you are using sections you can specify which section this option appears in.
Line 293: Line 287:
 
** '''Not Required - No Rules''' - The field will be displayed but can be left blank.
 
** '''Not Required - No Rules''' - The field will be displayed but can be left blank.
 
** '''Warning - Warn if not filled in''' - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
 
** '''Warning - Warn if not filled in''' - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
* '''Shortcut Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
+
* '''Access Key''' - Specify a shortcut key so the user can jump directly to this field when entering data.  Please note that different operating systems and browser also use shortcut keys, this will override this option.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''[[Display Order]]''' - The order that this field will be displayed on the page or section.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
 
* '''Active''' - When set to 'Yes' this field will be displayed to the user.
  
==Spreadsheet Calculations Result==
+
=Extension Database for Outcomes=
 +
Extension databases are widely used for things like outcomes or impact measurement tools. They are custom to your requirements, easy to input and provide useful data for reporting on outcomes/impact. The following webinar explains how they can be set up.
 +
 
 +
{{#ev:youtube|3o6codfk6Hk|790}}
 +
 
 +
=Extension Databases for Record Types=
 +
You can add custom fields to any of your record types such as Client, Staff, Volunteer etc. These are great to extend the reporting information or to simply add additional useful information to that record. The following webinar illustrates how this can be set up.
 +
 
 +
{{#ev:youtube|_m9C5ET-b2Y|790}}
 +
 
 +
=Spreadsheet Calculations Result=
 
The Spreadsheet Calculations Result field uses the fields linked to a spreadsheet template and adds a button for the user to calculate results based on the data entered.  The template needs to be upload via [[System Uploads]] and set to be used with extension databases.  When the user clicks the calculate button when entering data the system reads the formulas in the corresponding spreadsheet to return the result.  This allows administrators to add templates containing a wide range of formulas, including standard additions, subtractions, multiplications, IF Formulas, VLOOKUP formulas and more.  It is not possible to use conditional formatting, tables (including pivot) and array based formulas that require curly brackets {}.  The results that are produced from the calculations will be save when the record is saved.   
 
The Spreadsheet Calculations Result field uses the fields linked to a spreadsheet template and adds a button for the user to calculate results based on the data entered.  The template needs to be upload via [[System Uploads]] and set to be used with extension databases.  When the user clicks the calculate button when entering data the system reads the formulas in the corresponding spreadsheet to return the result.  This allows administrators to add templates containing a wide range of formulas, including standard additions, subtractions, multiplications, IF Formulas, VLOOKUP formulas and more.  It is not possible to use conditional formatting, tables (including pivot) and array based formulas that require curly brackets {}.  The results that are produced from the calculations will be save when the record is saved.   
 
{{#ev:youtube|LcKtbkyRtyI|790}}
 
{{#ev:youtube|LcKtbkyRtyI|790}}
Line 353: Line 357:
 
[[File:CalcExtDBCalcResults.PNG]]
 
[[File:CalcExtDBCalcResults.PNG]]
  
==Filter Fields==
+
=Filter Fields=
  
 
For dropdown lists and radio button you can filter the options displayed from fields, depending what was selected in a previous field.  The diagram below shows two question.  If on question one the answer one is selected the for question two answers one and two will be available for selection.  If answer two was selected on question one then answers three and for will be selectable on question two.
 
For dropdown lists and radio button you can filter the options displayed from fields, depending what was selected in a previous field.  The diagram below shows two question.  If on question one the answer one is selected the for question two answers one and two will be available for selection.  If answer two was selected on question one then answers three and for will be selectable on question two.
Line 359: Line 363:
 
[[File:ExtDB_filterdiag.png]]
 
[[File:ExtDB_filterdiag.png]]
  
=How to setup a Spreadsheet linked extension database video"=
+
=Export/Import=
  
{{#ev:youtube|UUPtKODttdQ|790}}
+
You can also import an existing Extension Database into your system, saving you from creating it from scratch. This could be because you are working as part of a consortium and you all have to use the same outcome/assessment tool, or it could be because you have already set it up on your training/test site. Setting an extension database up on your [https://wiki.dizions.co.uk/index.php/Update_Replica_Databases Replica Database] is a great way to test if it functions correctly. You can do a trial run with some entries and ensure it reports correctly. Once its set up you can simply export the extension database from your replica site and import it into your live site.
  
----
+
The following video explains how this can be done.
[[File:helpheader_small.png|right]]
+
 
 +
{{#ev:youtube|CvpXlcRxeAU|790}}
  
 +
To start, click on the extension database you wish to export.
  
= October 2021 Release =
+
[[File:EDBExport1.png]]
  
 +
You will then see a preview and you can Export.
  
Subject to your systems update date (defined by the system administrator via cog > general settings > organisation details) there will be the ability to place a new tab on an organisation/person record as part of the extension database set up process.  
+
[[File:EDBExport2.png]]
  
 +
Once exported, you can save the Excel file in a safe location for import later. To import, log into the system you wish to import the extension database to. Ensuring they are both on the same version. Click on the Import button at the top of the Extension Database Menu.
  
This means, if you intend on creating a new tab for your extension database to be placed on, you can do this in one process.
+
[[File:EDBExport3.png]]
Once in the extension database set up, and once you have opted for the placement to be ‘on a tab’, you will see an option for ‘new tab’ in the drop-down list for ‘show fields on tab’.
 
  
[[File:October_extension_database.png]]
+
You can then browse for the file, and select it for import.  
  
 +
[[File:EDBExport4.png]]
  
A drop down will then appear, giving you the chance to name the tab.
+
You can now preview the fields which will be imported but you can go ahead and click on Import and it will be ready to use.  
  
 +
[[File:EDBExport5.png]]
  
You can then progress by selecting ‘Save and Edit Fields’ and creating the new fields as usual.  
+
Once imported, you may find you need to amend relevant settings for Group Access along with which section you wish the extension database to appear.  
  
 +
[[File:EDBExport6.png]]
  
Once saved, go to Cog > Orgs & People A-J > Customise Orgs & People > Edit Tabs for relevant Org/Person types. Your new tab will appear in the ‘not used’ section. Simply drag this over to the right and choose the placement to activate the tab.
+
----
 +
[[File:helpheader_small.png|right]]

Latest revision as of 15:01, 30 May 2023

Helpheader small.png


Cl EDBS 1.png


Introduction to Extension Databases

Extension Databases provide a way for you to add fields, or sets of fields, to the system. They can be used to capture any information which is not catered for in the standard setup.

The Extension Database Setup page lists the Extension Databases that are already set up on your system (if there are any). You can amend existing Extension Databases and create new ones.

To create a new Extension Database click "New Extension Database" or click on the name of an existing Extension Database to edit it. Its important you understand the different locations available for an Extension Database. The below webinar explains this.

Extension Database Settings

On an existing Extension Database or when saving the Extension Database settings for a new one a navigation bar will appear at the top of the section:

ExtDB navbar.PNG

This allows you to move between the following sections of the setup:

  • The name of the Extension Database is underlined - This is the general details of where the extension data base will appear and which security groups can access it.
  • All Sections - Sections are used to group questions together to make data entry easier and more logical.
  • New Field - allows you to add new fields

To create a new Extension Database, click on New Extension Database

New Extension database.PNG

  • Extension Database Name- This is name of the Extension Database and will also be the button label that appears for the user.
  • Description - This is information about the Extension Database which can only be viewed on this page
  • One record or multiple records for this entry?
    • One Record - This displays a single set of fields, if the data is changed the previous entry will be simply over written. This would be used for questions like 'Do you drive?', if circumstances changed you would simply change the answer to the question.
    • One or More Records - This is used if multiple sets of data is required. As an example you could have an extension database to record donations given, as you may get more than one donation from the some person.
  • Linked to which main type of record?:
    • Organisations and People - This will be able to be displayed on a record tab or at the footer of the record.
    • Referrals - This allows the Extension Database to be displayed on the history tab, referral edit screen or appear when recording a contact. See Project Setup for further details.
    • Clubs and Clinics - This will appear on the footer of a Club, Clinic or Group details page, for those specified.
    • Clubs and Clinics Meetings - This will appear on the individual occurrence of the Club, Clinic or Group on the incomplete/complete meeting tabs and when a meeting is completed via the wizard or complete button.
  • Show Fields on Section - This option appears when the linked to option is set to 'Organisations and People'Specify weather the Extension Database is to be displayed on the required section Additional sections can be setup, see Customise Orgs & People for details.
  • Available to users in these groups - Select which Groups of users can access the Extension Database.
  • Maximum number of column Headers to be viewable when selecting from multiple records? - When selecting 'One or More' you can specify the number of columns displayed for the Extension Database.
  • Active? - When set to 'Yes' the Extension Database will be dis[played and can be reported on.

Once the above options have been completed you can then select one of the following save buttons:

  • Save and edit Sections - Saves any changes and moves to the page to create sections, if required.
  • Save and edit Fields - Saves any changes and moves to the page to create the fields to record the data.

Extension Database Sections

Section Headings will be displayed if you add an Extension Database to display One or More. They won't appear if you have just added fields to an existing section such as the Personal Details page. The following webinar gives an example of how section headings can be used for things like assessments.

ExtDB sections.PNG

Sections allow you to break up fields into logical sections. Example:

Section 1: Assessment one
Date:
Range of questions

Section 2: Assessment two
Date:
Range of questions

To create a new section click on the lick 'Create a new Extension Database Section...'. Type the required label for the section and click go to create it.

The section will be created and added to the list of existing sections (if any).

To edit an existing section click on the sections name. From here you can specify if the heading;

  • Displays as a title, the name.
  • Displays as just a dividing line.
  • Displays as a blank line.

To delete a section click the Bin Icon Icon Bin.PNG.

Reordering Sections

Click on the 'Enable Reorder' button to Enable reordering, from here you can drag and drop the sections to the required position, or use the A-Z or Z-A option. Once complete you can then click 'Disable Reorder'.

ExtDB reorder.PNG

Extension Database Fields

An Extension Data base can contain a series of different field types. After you have completed the field options click 'Save Details' to create the field. The following webinar explains the different types of fields available.

Single Row Text

This will display a single line text box based on the field length.

EDBEF 1.png

  • Field Label - This is the name/question that is displayed to the user.
  • Description - This is displayed as help text via a question mark icon Icon greenquestionmark.PNG. This is note displayed when the fields are displayed on a tab.
  • Field Type - Option to select which of these field types you wish to use. Once a field has been created the field type cannot be changed. Set to 'Single Row Alphanumeric String'.
  • Appear in Reports - allows you to specify if data entered will appear in your reports. Useful if you want to add a free text box, but don't need that data for reporting purposes.
  • Appear in Section - If you are using sections you can specify which section this option appears in.
  • Allow collaborator API access? - Used for API connections if your system links to a third party system. When set to yes you can then specify the API name to be used.
  • Link to Spreadsheet - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to. See Spreadsheet Calculations Result for further details.
  • Spreadsheet cell - Specify the cell in the spreadsheet that the field feeds into.
  • Field length - This determines the length of the field and the maximum number of characters that can be entered.
  • Default Value - You can populate the field with the details specified.
  • Field Entry Requirement
    • Not Required - No Rules - The field will be displayed but can be left blank.
    • Warning - Warn if not filled in - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
  • Access Key - Specify a shortcut key so the user can jump directly to this field when entering data. Please note that different operating systems and browser also use shortcut keys, this will override this option.
  • Display Order - The order that this field will be displayed on the page or section.
  • Active - When set to 'Yes' this field will be displayed to the user.

Multi Row Text

Displays a text box.

EDBEF 5.png

  • Field Label - This is the name/question that is displayed to the user.
  • Description - This is displayed as help text via a question mark icon Icon greenquestionmark.PNG. This is note displayed when the fields are displayed on a tab.
  • Field Type - Option to select which of these field types you wish to use. Once a field has been created the field type cannot be changed. Set to 'Multi Row Text Input'.
  • Include in Reports - you can decide to include this data in reports.
  • Appear in Section - If you are using sections you can specify which section this option appears in.
  • Allow collaborator API access? - Used for API connections if your system links to a third party system. When set to yes you can then specify the API name to be used.
  • Link to Spreadsheet - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to. See Spreadsheet Calculations Result for further details.
  • Spreadsheet cell - Specify the cell in the spreadsheet that the field feeds into.
  • Default Value - can be used if you want a value to be automatically entered into this field. Use with caution as people may have to delete any text before entering their own.
  • Field Entry Requirement
    • Not Required - No Rules - The field will be displayed but can be left blank.
    • Warning - Warn if not filled in - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
  • Access Key - Specify a shortcut key so the user can jump directly to this field when entering data. Please note that different operating systems and browser also use shortcut keys, this will override this option.
  • Display Order - The order that this field will be displayed on the page or section.
  • Active - When set to 'Yes' this field will be displayed to the user.

Number

Allows only numbers to be used and totals on displayed reports.

EDBEF 2.png

  • Field Label - This is the name/question that is displayed to the user.
  • Description - This is displayed as help text via a question mark icon Icon greenquestionmark.PNG. This is note displayed when the fields are displayed on a tab.
  • Field Type - Option to select which of these field types you wish to use. Once a field has been created the field type cannot be changed. Set to 'Numeric Only'.
  • Include in Reports - allows you to choose if this data will appear in reports.
  • Appear in Section - If you are using sections you can specify which section this option appears in.
  • Allow collaborator API access? - Used for API connections if your system links to a third party system. When set to yes you can then specify the API name to be used.
  • Link to Spreadsheet - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to. See Spreadsheet Calculations Result for further details.
  • Spreadsheet cell - Specify the cell in the spreadsheet that the field feeds into.
  • Field length - This determines maximum number of digits (including decimal point), this works alongside the numeric maximum.
  • Decimal Places - Specify the number of decimal places that are required, please keep in mind the field length.
  • Default Value - Specify a default value that will be prepopulated.
  • Field Entry Requirement
    • Not Required - No Rules - The field will be displayed but can be left blank.
    • Warning - Warn if not filled in - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
  • Numeric Minimum - The minimum value a user can enter.
  • Numeric Maximum - The maximum value a user can enter, this must comply with the field length.
  • Access Key - Specify a shortcut key so the user can jump directly to this field when entering data. Please note that different operating systems and browser also use shortcut keys, this will override this option.
  • Display Order - The order that this field will be displayed on the page or section.
  • Active - When set to 'Yes' this field will be displayed to the user.

Money

Allows only numbers to be used and totals on displayed reports.

EDBEF 3.png

  • Field Label - This is the name/question that is displayed to the user.
  • Description - This is displayed as help text via a question mark icon Icon greenquestionmark.PNG. This is note displayed when the fields are displayed on a tab.
  • Field Type - Option to select which of these field types you wish to use. Once a field has been created the field type cannot be changed. Set to 'Numeric Only'.
  • Include in Reports - allows you to decide if you would like to include this data in reports.
  • Appear in Section - If you are using sections you can specify which section this option appears in.
  • Allow collaborator API access? - Used for API connections if your system links to a third party system. When set to yes you can then specify the API name to be used.
  • Link to Spreadsheet - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to. See Spreadsheet Calculations Result for further details.
  • Spreadsheet cell - Specify the cell in the spreadsheet that the field feeds into.
  • Field length - This determines maximum number of digits (including decimal point), this works alongside the numeric maximum.
  • Decimal Places - Specify the number of decimal places that are required, please keep in mind the field length.
  • Default Value - Specify a default value that will be prepopulated.
  • Field Entry Requirement
    • Not Required - No Rules - The field will be displayed but can be left blank.
    • Warning - Warn if not filled in - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
  • Numeric Minimum - The minimum value a user can enter.
  • Numeric Maximum - The maximum value a user can enter, this must comply with the field length.
  • Access Key - Specify a shortcut key so the user can jump directly to this field when entering data. Please note that different operating systems and browser also use shortcut keys, this will override this option.
  • Display Order - The order that this field will be displayed on the page or section.
  • Active - When set to 'Yes' this field will be displayed to the user.

Date

Allows entry of a date, useful when reporting on certain periods.

EDBEF 4.png

  • Field Label - This is the name/question that is displayed to the user.
  • Description - This is displayed as help text via a question mark icon Icon greenquestionmark.PNG. This is note displayed when the fields are displayed on a tab.
  • Field Type - Option to select which of these field types you wish to use. Once a field has been created the field type cannot be changed. Set to 'Date'.
  • Include in Reports - allows you to report on data entered
  • Appear in Section - If you are using sections you can specify which section this option appears in.
  • Allow collaborator API access? - Used for API connections if your system links to a third party system. When set to yes you can then specify the API name to be used.
  • Link to Spreadsheet - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to. See Spreadsheet Calculations Result for further details.
  • Spreadsheet cell - Specify the cell in the spreadsheet that the field feeds into.
  • Default Date Value - You can populate the field with the date the record is entered or left empty.
  • Field Entry Requirement
    • Not Required - No Rules - The field will be displayed but can be left blank.
    • Warning - Warn if not filled in - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
  • Access Key - Specify a shortcut key so the user can jump directly to this field when entering data. Please note that different operating systems and browser also use shortcut keys, this will override this option.
  • Display Order - The order that this field will be displayed on the page or section.
  • Active - When set to 'Yes' this field will be displayed to the user.

Select from Option Dropdown List

This will display a dropdown list that the user can select one option from.

EDBEF 6.png

  • Field Label - This is the name/question that is displayed to the user.
  • Description - This is displayed as help text via a question mark icon Icon greenquestionmark.PNG. This is note displayed when the fields are displayed on a tab.
  • Field Type - Option to select which of these field types you wish to use. Once a field has been created the field type cannot be changed. Set to 'Multi Row Text Input'.
  • Include in Reports - allows you to report on data entered
  • Appear in Section - If you are using sections you can specify which section this option appears in.
  • Allow collaborator API access? - Used for API connections if your system links to a third party system. When set to yes you can then specify the API name to be used.
  • Link to Spreadsheet - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to. See Spreadsheet Calculations Result for further details.
  • Spreadsheet cell - Specify the cell in the spreadsheet that the field feeds into.
  • Option Details - This is the items that will appear in the drop down list.
    • Default - When ticked this option will automatically be selected when entering a new record. It is worth considering if you want this value saved if the extension database is not manually changed before saving a client record.
    • Option Text - This is the name displayed in the dropdown list.
  • Filter By Field - This allows the dropdown list to be filtered by another drop down list (does not work with radio buttons). The options that have been selected on a previous question can filter what options can be selected on this question. From the list select the dropdown list that is to be used to filter this question.
  • Inactive Option Display
    • Do not display inactive options - Options that have been set as inactive will not be displayed in the dropdown list.
    • Display inactive options as not selectable - This will display inactive options, which cannot be selected by the user.
  • Field Entry Requirement
    • Not Required - No Rules - The field will be displayed but can be left blank.
    • Warning - Warn if not filled in - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
  • Access Key - Specify a shortcut key so the user can jump directly to this field when entering data. Please note that different operating systems and browser also use shortcut keys, this will override this option.
  • Display Order - The order that this field will be displayed on the page or section.
  • Active - When set to 'Yes' this field will be displayed to the user.

Radio Button List

As "Select from Option List", but options will be displayed as clickable buttons. Only one button can be selected at a time.

  • You can choose whether the buttons display "On one row" (side by side), or "Multi Rows/Stacked" (one above the other).

EDBEF 7.png

  • Field Label - This is the name/question that is displayed to the user.
  • Description - This is displayed as help text via a question mark icon Icon greenquestionmark.PNG. This is note displayed when the fields are displayed on a tab.
  • Field Type - Option to select which of these field types you wish to use. Once a field has been created the field type cannot be changed. Set to 'Multi Row Text Input'.
  • Include in Reports - allows you to report on data entered
  • Appear in Section - If you are using sections you can specify which section this option appears in.
  • Allow collaborator API access? - Used for API connections if your system links to a third party system. When set to yes you can then specify the API name to be used.
  • Link to Spreadsheet - If the extension database is using excel to produce calculations and the field is as part of the calculations, specify the spreadsheet template that field is used to input in to. See Spreadsheet Calculations Result for further details.
  • Spreadsheet cell - Specify the cell in the spreadsheet that the field feeds into.
    • Option Text - This is the name displayed in the dropdown list.
  • Option Details - This is the items that will appear in the drop down list.
    • Default - When ticked this option will automatically be selected when entering a new record.
    • Display Order - The order the option will be displayed in the dropdown list.
    • Selection list for the filter - Select which answers of the previously selected question that the current option is available to be selected. If you are using the filter and nothing is selected then the option cannot be selected. If the option is to be available to all then all answers to the previous question must be selected.
    • Active - If set to yes then this option can be selected from the drop down list.
    • Plus Icon Icon plus.PNG - Creates a new line for the next option.
  • Radio Button Display - Select the required display option.
  • Filter By Field - This allows the dropdown list to be filtered by another radio button field (does not work with dropdown lists). The options that have been selected on a previous question can filter what options can be selected on this question. From the list select the radio button field that is to be used to filter this question.
    • On one row - Ideal for less options and is displayed across the screen.
    • Multi rows/Stacked - Ideal for options with a long names or larger quantity of options.
  • Inactive Option Display
    • Do not display inactive options - Options that have been set as inactive will not be displayed in the dropdown list.
    • Display inactive options as not selectable - This will display inactive options, which cannot be selected by the user.
  • Field Entry Requirement
    • Not Required - No Rules - The field will be displayed but can be left blank.
    • Warning - Warn if not filled in - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
  • Shortcut Key - Specify a shortcut key so the user can jump directly to this field when entering data. Please note that different operating systems and browser also use shortcut keys, this will override this option.
  • Display Order - The order that this field will be displayed on the page or section.
  • Active - When set to 'Yes' this field will be displayed to the user.

Look up List of Orgs/People by type

This field displays a look up list of Organisations and People on the system.

Extdb orgslist.png

  • Field Label - This is the name/question that is displayed to the user.
  • Description - This is displayed as help text via a question mark icon Icon greenquestionmark.PNG. This is note displayed when the fields are displayed on a tab.
  • Field Type - Option to select which of these field types you wish to use. Once a field has been created the field type cannot be changed. Set to 'Dropdown List of Orgs/People by type'.
  • Include in Reports - allows you to report on data entered
  • Dropdown List of Organisations / People by Type - Selected the required record types that will be available to be selected.
  • Appear in Section - If you are using sections you can specify which section this option appears in.
  • Allow collaborator API access? - Used for API connections if your system links to a third party system. When set to yes you can then specify the API name to be used.
  • Field Entry Requirement
    • Not Required - No Rules - The field will be displayed but can be left blank.
    • Warning - Warn if not filled in - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
  • Access Key - Specify a shortcut key so the user can jump directly to this field when entering data. Please note that different operating systems and browser also use shortcut keys, this will override this option.
  • Display Order - The order that this field will be displayed on the page or section.
  • Active - When set to 'Yes' this field will be displayed to the user.

Extension Database for Outcomes

Extension databases are widely used for things like outcomes or impact measurement tools. They are custom to your requirements, easy to input and provide useful data for reporting on outcomes/impact. The following webinar explains how they can be set up.

Extension Databases for Record Types

You can add custom fields to any of your record types such as Client, Staff, Volunteer etc. These are great to extend the reporting information or to simply add additional useful information to that record. The following webinar illustrates how this can be set up.

Spreadsheet Calculations Result

The Spreadsheet Calculations Result field uses the fields linked to a spreadsheet template and adds a button for the user to calculate results based on the data entered. The template needs to be upload via System Uploads and set to be used with extension databases. When the user clicks the calculate button when entering data the system reads the formulas in the corresponding spreadsheet to return the result. This allows administrators to add templates containing a wide range of formulas, including standard additions, subtractions, multiplications, IF Formulas, VLOOKUP formulas and more. It is not possible to use conditional formatting, tables (including pivot) and array based formulas that require curly brackets {}. The results that are produced from the calculations will be save when the record is saved.

Complete the following details:

EDBEF 8ssc.PNG

  • Field Label - This is the name/question that is displayed to the user.
  • Description - This is displayed as help text via a question mark icon Icon greenquestionmark.PNG. This is note displayed when the fields are displayed on a tab.
  • Appear in Section - If you are using sections you can specify which section this option appears in.
  • Allow collaborator API access? - Used for API connections if your system links to a third party system. When set to yes you can then specify the API name to be used.
  • Field Type - Option to select which of these field types you wish to use. Once a field has been created the field type cannot be changed. Set to 'Numeric Only'.
  • Link to Spreadsheet - If the extension database is using excel to produce calculations and the field is as part of the calculation, specify the spreadsheet template that field is used to input in to. See .
  • Spreadsheet cell - Specify the cell in the spreadsheet that contains the formula for the calculation.
  • Required input fields - Select the fields that are used with this calculation (these are determined by the formula in the spreadsheet).
  • Field length - This determines maximum number of digits (including decimal point), this works alongside the numeric maximum.
  • Decimal Places - Specify the number of decimal places that are required, please keep in mind the field length.
  • Default Value - Specify a default value that will be prepopulated.
  • Field Entry Requirement
    • Not Required - No Rules - The field will be displayed but can be left blank.
    • Warning - Warn if not filled in - The field will be displayed with a yellow background (not when set as radio buttons) and a pop up will be displayed if left blank when saving.
  • Numeric Minimum - The minimum value a user can enter.
  • Numeric Maximum - The maximum value a user can enter, this must comply with the field length.
  • Shortcut Key - Specify a shortcut key so the user can jump directly to this field when entering data. Please note that different operating systems and browser also use shortcut keys, this will override this option.
  • Display Order - The order that this field will be displayed on the page or section.
  • Active - When set to 'Yes' this field will be displayed to the user.

Example

In this example we are going to use a basic calculation by adding up some input fields to calculate a persons expenditure. There are three fields, Rent, Food and Bills, and the calculator will add these up. I an spreadsheet A1, A2 &a3 would be left blank and A4 will have the formula =A1+A2+A3 or =SUM(A1:A3). The spreadsheet is the uploaded called expenditure. The fields are then set up as follows;

Field 1

CalcExtDBCalcF1.PNG


Field 2

CalcExtDBCalcF2.PNG


Field 4

CalcExtDBCalcF3.PNG


Field 4

CalcExtDBCalcF4.PNG


User input field

The user will be displayed the screen below, on clicking 'Calculate' the result will be display and saved when the save button is pressed.

CalcExtDBCalcResults.PNG

Filter Fields

For dropdown lists and radio button you can filter the options displayed from fields, depending what was selected in a previous field. The diagram below shows two question. If on question one the answer one is selected the for question two answers one and two will be available for selection. If answer two was selected on question one then answers three and for will be selectable on question two.

ExtDB filterdiag.png

Export/Import

You can also import an existing Extension Database into your system, saving you from creating it from scratch. This could be because you are working as part of a consortium and you all have to use the same outcome/assessment tool, or it could be because you have already set it up on your training/test site. Setting an extension database up on your Replica Database is a great way to test if it functions correctly. You can do a trial run with some entries and ensure it reports correctly. Once its set up you can simply export the extension database from your replica site and import it into your live site.

The following video explains how this can be done.

To start, click on the extension database you wish to export.

EDBExport1.png

You will then see a preview and you can Export.

EDBExport2.png

Once exported, you can save the Excel file in a safe location for import later. To import, log into the system you wish to import the extension database to. Ensuring they are both on the same version. Click on the Import button at the top of the Extension Database Menu.

EDBExport3.png

You can then browse for the file, and select it for import.

EDBExport4.png

You can now preview the fields which will be imported but you can go ahead and click on Import and it will be ready to use.

EDBExport5.png

Once imported, you may find you need to amend relevant settings for Group Access along with which section you wish the extension database to appear.

EDBExport6.png


Helpheader small.png