Changes

Jump to: navigation, search

Creating Custom Fields

1,041 bytes added, 20:31, 5 January 2016
no edit summary
==Creating Custom Fields – Step by Step==
In this example you will add [[Custom Fields|custom fields]] to the employee [[Role|role]] information, however; the attributes of the [[Custom Fields|custom fields]] are the same, regardless of the object.
The [[Custom Field|custom field]] list is displayed – currently blank.
[[Image:Creating_custom_fields_2.png|link:|1000px]]
4. Click the '''New Field''' tab.
The '''New Custom Field''' window is displayed.
[[Image:Creating_custom_fields_new_custom_field_4.png|link:|800px]]
* '''Description''' - a general description for the custom field
===Display===
* '''Display Order''' - determines the order in which the fields will be displayed on the page. The display order will start at the number 10 and increment by 10 for each [[Custom Field|custom field]]. The display order can be changed at any time without affecting any data.
* '''On New Record''' - define how the custom field will be displayed on a new record. Options '''"Always Display", "Hide on New Record", "Only Show on New Record"'''.
<u>'''Allow Empty Input Check Box'''</u>==Options==
The '''Allow Empty InputOptions''' check box is field displayed for text and select type fields, and controls if data is mandatory in that below the field. [[Image:Creat5.png]] * If you disable '''Allow Empty Input''' for '''Text''' type fields, the [[User|user]] will have to enter a value into change depending on the text box.* If you disable '''Allow Empty Input''' for '''Select''' field type fields, the [[User|user]] will NOT be able to save the record without selecting a value other than the first value. * '''Appear Mandatory''': Makes the field appear as through it required even though "Allow Empty" is selected. <u>'''Additional Field level Options'''</u> * '''Searchable Check Box''' - the '''Searchable''' check box is used to make the field searchable.* '''Track Changes''' – this setting is used to indicate that all changes to the value in field should be tracked. This tracking includes the original and replacement value, the [[Username|username]] and the date/time that the change was made. In order to see the changes a [[User|user]] needs to be in a [[Role|role]] associated with the '''Manager Permission''' – '''View Custom Field Changes'''. When in this [[Role|role]] an icon is displayed next to the field caption.
[[Image:Creat6.png]]
<u>'''Option Settings'''</u>
The '''Options''' field displayed below the field type will change depending on the field type selected.
* For '''Select one''' or '''Multiple select''' type fields this will contain the list of selection options – separated by semi-colons.
* For '''Text type''' [[Custom Fields|custom fields]], this can contain a default value for the field, or an instruction as to the purpose of the field.
* For '''Calculated''' fields, this contains the expression.
 
* For a multiple column layout, a '''Title Label''' field is used and the default value is set to the number of columns required.
[[Image:Creating_custom_fields_options_5.png|link:]]<ubr />''Options for text and select type fields'' * The '''Allow Empty Input''' check box is displayed for text and select type fields, and controls if data is mandatory in that field.:* If you disable '''Allow Empty Input''' for '''Text''' type fields, the [[User|user]] will have to enter a value into the text box.:* If you disable '''Allow Empty Input''' for '''Select''' type fields, the [[User|user]] will NOT be able to save the record without selecting a value other than the first value.* '''Appear Mandatory''': Makes the field appear as through it required even though "Allow Empty" is selected.* '''Searchable'Services Settings''- the '<''Searchable''' check box is used to make the field value appear in the system search.* '''Track Changes''' – this setting is used to indicate that all changes to the value in field should be tracked. This tracking includes the original and replacement value, the [[Username|username]] and the date/u>time that the change was made.* '''Enable [[KML|KML]]''' - allows KML data (for mapping applications) to be used.* '''Disable Quick Edit''' - checking this box will disable the '''"Quick Edit"''' feature.* '''Disable Field from Global Search''' - this option is used to make the field value appear in '''[[Global Search|Global Searches]]'''.* '''Enable Map Service''' - displays the map icon next to the field name. This icon will launch the [[User|user’s]] selected map service and display a map of the content of the field – provided a valid address is stored in the field.* '''[[Enable Translation Service|Enable Translation Service]]''' - allows for language translation of data entered into text fields, achieved by integration with Google Translate.* '''Read Only''' - uncheck this box to allow users to edit this field.
The services options provide links between In order to see the changes a field’s contents and [[ExternalUser|externaluser]] web servicesneeds to be in a [[Role|role]] associated with the '''Manager Permission''' – '''View Custom Field Changes'''. When in this [[Role|role]] an icon is displayed next to the field caption.
[[Image:Creat7.png]]
* '''Enable Map Service''' – displays the map icon next to the field name. This icon will launch the [[User|user’s]] selected map service and display a map of the content of the field – provided a valid address is stored in the field.
* '''Enable People Search Service''' – displays the '''Search Internet''' icon next to the field name. This icon will launch a variety of search services and display the contact details from those services– provided a valid contact name is stored in the field.
* '''Enable Organisation Search Service''' – displays the '''Search Internet''' icon next to the field name. This icon will launch a variety of search services and display the organisations details from those services– provided a valid organisation name is stored in the field.
<u>'''==Validation Settings'''</u>==
The '''Validation''' fields displayed below the field type will change depending on the field type selected.
[[Image:Creat8Creating_custom_fields_validation.png]]
You can control the validation of any text type [[Custom Field|custom field]].
* '''Basic validation''' consists of date, numeric, and alphabetic validation. If you select date validation, a calendar icon will be displayed to the right of the field name automatically.
* '''Custom validation''' allows you to set input masks for the field. For example '''>100 or @value@>100''' would restrict the value entered to greater than 100. To validate 9 digits SIN number, '''isMatch(@value@, 'NNNNNNNNN', false)'''. See the [[SmartSimple]] wiki for additional examples.
* Message will display a field specific message if the validation criteria are not met.
* For more advanced page level validations you can use the [[Custom Field Type: Special – Browser Script|Custom Field – Special Browser Script]] to add a specific script to any page.
<u* '''Validation Options''' - check-mark enables [[Server-Side Validation|Server-Side Validation]] allowing for consolidated validation error messages to be displayed.* '''Validation Type''' - options include '''"date", "numeric", and "alphabetic"''' validation. If you select date validation, a calendar icon will be displayed to the right of the field name automatically.* '''Javascript Validation''' - allows you to set input masks for the field. For example '''>100 or @value@>100'''Value Stores would restrict the value entered to greater than 100. Tovalidate 9 digits SIN number, '''isMatch(@value@, 'NNNNNNNNN', false)''</u>'. See the [[SmartSimple]] wiki for additional examples.* '''Validation Error Message''' - will display a field specific message if the validation criteria are not met.:* For more advanced page level validations you can use the [[Custom Field Type: Special – Browser Script|Custom Field – Special Browser Script]] to add a specific script to any page.* '''Maximum Count Message''' - sets the maximum character count for the field. Options include check boxes to '''Show Counter''' which will display the character count and '''Count Words''' which will change from counting characters to counting words.* '''Maximum Count Message''' - will display a field specific message if the Maximum Count Message criteria is not met. ==Value Stores To==
[[Image:Creat9Creating_custom_fields_value_storage.png|link:]]
* This setting will take the value for the current field and store it into another field associated with the same [[Entity|entity]].
* For example, you may need two fields, one captioned in English and another captioned in French, but need to store the value into a single field.
<u>'''==Formatting Settings'''</u>==
The formatting settings control the presentation of text type fields.
[[Image:Creat10Creating_custom_fields_formatting.png|link:]]
* '''HeightCaption Style''' – controls the number of lines for a text box. This size bold, underline, italic and highlight attribute when the field is based on the default text size displayed in the client [[Browser|browser]]view mode.::'''Note:''' For Caption Style, put @value@ inside html style tags like <u>@value@</u>
* '''Width''' – controls the width of the next box.
* '''Number Format''' – controls the format of the data when the field is displayed in '''View''' mode. You can use standard setting such as Integer, Decimal, Currency, Percent or custom formats such as $#,###.00.
* '''StyleNumber Precision''' – controls the bold, underline, italic and highlight attribute when the field is - control how many decimal places are displayed in view modefor numbers.
* '''Tool Tip''' – provides mouse over help to the [[User|user]] in the use of the field.
* '''Align''' - control the justification of the text within the field.
* '''Custom HTML Tag''' - Use this field for additional attributes to the field HTML tag. For Example: style="background-color=00ff00" or onfocus="this.value='Populate this text in field when selected'"
<u>'''Role ==Permissions'''</u>& Availability==
Access to a [[Custom Field|custom field]] is controlled by [[Role|role]] based permissions.
To access the '''Role''' and '''Status''' access settings click on the '''Permissions & Availability''' tab next to the General Settings.  [[Image:Creat11Creating_custom_fields_permissions.png|link:]] Field permissions can be controlled by role and by status. 
* '''Allow View Field''' – If you associate this setting with [[Role|roles]], then the field will only be displayed to people with these [[Role|roles]]. If you leave this field blank, then everyone will be able to see the field.
* '''Allow Modify Field''' – If you associate this setting with [[Role|roles]], then the field will only be modifiable by people with these [[Role|roles]]. If you leave this field blank, then everyone will be able to modify the value on the field.
* '''Deny Modify Field''' – If you associate this setting with [[Role|roles]], then the field will not be modifiable by people with these [[Role|roles]]. If you leave this field blank, then everyone will be able to modify the value on the field.
==Creating Custom Fields==
1. Create the following fields for the employee [[Role|role]] you have previously established:
2,004
edits

Navigation menu