TracCloudGuideGlobalCustom: Difference between revisions
From Redrock Wiki
No edit summary |
No edit summary |
||
(14 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{TracCloudGuideTabs}} | {{TracCloudGuideTabs}} | ||
<div class="tcWidgetPage"> | |||
<div class="categoryWider"> | |||
{{TracCloudGuideGlobalTOC}} | |||
</div> | |||
<big><b>Custom Fields</big></b><br> | <big><b>Custom Fields</big></b><br> | ||
Custom fields can be configured throughout TracCloud to store additional data that your campus may require. These custom fields can be displayed in student profiles, appointments, visits, faculty, registrations, and more.<br><br> | Custom fields can be configured throughout TracCloud to store additional data that your campus may require. These custom fields can be displayed in [[TracCloudGuideListingsStudents|student profiles]], [[TracCloudGuideBasicsSchedule|appointments]], [[TracCloudGuideListingsVisits|visits]], [[TracCloudGuideListingsFaculty|faculty]], [[TracCloudGuideListingsRegistrations|registrations]], and more.<br><br> | ||
These fields can be viewed just like other fields, and even used in reports. This data can also be imported from your Student Information System just like the rest of the standard fields, more information on that can be found in our Import articles.<br> | These fields can be viewed just like other standard fields, and can even be used in reports. This data can also be imported from your Student Information System just like the rest of the standard fields, more information on that can be found in our Import articles.<br> | ||
[[File: | [[File:5672897.png|800px]] | ||
<br><br> | <br><br> | ||
Line 17: | Line 17: | ||
As a basic example, let’s create a custom field for our students. Maybe we want an extra field to specify a student’s assigned advisor. To begin, open up the Custom Fields section in your System Preferences, scroll to the bottom, and select the <b>+</b> icon. This will add a new item to our list, where we can begin configuring the field.<br> | As a basic example, let’s create a custom field for our students. Maybe we want an extra field to specify a student’s assigned advisor. To begin, open up the Custom Fields section in your System Preferences, scroll to the bottom, and select the <b>+</b> icon. This will add a new item to our list, where we can begin configuring the field.<br> | ||
[[File: | [[File:9576589.png|800px]]<br><br> | ||
* <b>Hamburger icon</b> | * <b>{{#fas:bars}} Hamburger icon</b> | ||
::By clicking-and-dragging this icon, we can move this field throughout our list. This also determines the order the fields appear in within their respective locations.<br><br> | ::By clicking-and-dragging this icon, we can move this field throughout our list. This also determines the order the fields appear in within their respective locations.<br><br> | ||
* <b>Name</b> | * <b>Name</b> | ||
::This is the field name. The field name cannot contain spaces (see Prompt Text later)<br><br> | ::This is the field name. The field name cannot contain spaces (see <i>Prompt Text</i> later in this article)<br><br> | ||
* <b>Pencil icon</b> | * <b>{{#fas:pencil}} Pencil icon</b> | ||
::Opens a menu with additional options, which will be covered later in this article.<br><br> | ::Opens a menu with additional options, which will be covered later in this article.<br><br> | ||
* <b>Login/Logout icons</b> | * <b>{{#fas:right-to-bracket}} {{#fas:right-from-bracket}} Login/Logout icons</b> | ||
::These determine if the field is displayed during the login/logout process on the log listing/kiosk. This even applies to non-visit fields. The student could be asked a question relating to one of their student or registration fields, for example.<br><br> | ::These determine if the field is displayed during the login/logout process on the log listing/kiosk. This even applies to non-visit fields. The student could be asked a question relating to one of their student or registration fields, for example.<br><br> | ||
* <b>Exclamation | * <b>{{#fas:exclamation}} Exclamation icon</b> | ||
::Sets the field to required, so an answer must be provided before continuing/saving.<br><br> | ::Sets the field to required, so an answer must be provided before continuing/saving.<br><br> | ||
* <b>No Access icon</b> | * <b>{{#fas:ban}} No Access icon</b> | ||
::Marks the field as inactive. This is recommended if you aren’t planning on utilizing a field anymore, but don’t want to remove the data associated with it. This way the data is still available if you want to re-enable it again in the future, but it won’t be visible throughout general TracCloud use.<br><br> | ::Marks the field as inactive. This is recommended if you aren’t planning on utilizing a field anymore, but don’t want to remove the data associated with it. This way the data is still available if you want to re-enable it again in the future, but it won’t be visible throughout general TracCloud use.<br><br> | ||
* <b>Speech Bubble</b> | * <b>{{#far:comment-dots}} Speech Bubble</b> | ||
::Displays this field on the student timeline alongside Visit Notes.<br><br> | ::Displays this field on the student timeline alongside Visit Notes.<br><br> | ||
* <b>Hide | * <b>{{#fas:user-large-slash}} Hide from Consultants</b> | ||
::Hides this Custom Field from consultant view (e.g., for Student Visit Remarks).<br><br> | ::Hides this Custom Field from consultant view (e.g., for Student Visit Remarks).<br><br> | ||
* <b>{{#fas:border-none}} Hide on SI Batch Visit Entry</b> | |||
::Hides this field on [[TracCloudGuideBasicsVisits|batch visit entry]].<br><br> | |||
* <b>Location Drop-down</b> | * <b>Location Drop-down</b> | ||
::This determines where the field displays. There are several locations available:<br> | ::This determines where the field displays. There are several locations available:<br> | ||
::<b>Student – Campus / Other Info / Custom1</b> displays within one of | ::<b>Student – Campus / Other Info / Custom1-5</b> displays within one of these tabs on student profiles. The name of the “Custom” tabs can be changed in your [[TracCloudGuideGlobalStudentFields|Student Entry Choices]] preferences.<br> | ||
::[[File:2934944.png|500px]]<br> | ::[[File:2934944.png|500px]]<br> | ||
::<b>Visit – Student / Consultant</b> displays in the visit record. Typically used with “Asked on log in/out” enabled, that way the student or staff member can input this information from the Log Listing/Kiosk view. | ::<b>Visit – Student / Consultant</b> displays in the visit record. Typically used with “Asked on log in/out” enabled, that way the student or staff member can input this information from the Log Listing/Kiosk view. | ||
::<b>Visit - Q2 Raise Hand</b> displays on the <i>Raise Hand</i> prompt for Q2, applying to Q2Remote and when raising a hand from the Log Listing. | ::<b>Visit - Q2 Raise Hand</b> displays on the <i>Raise Hand</i> prompt for [[TracCloudQ2|Q2]], applying to Q2Remote and when raising a hand from the Log Listing. | ||
::<b>Appointment – Student / Consultant</b> will appear during the [[TracCloudGuideBasicsSchedule|appointment booking]] process, with separate tabs containing different questions for students or consultants. This location is also unique in that it's the only custom field location that can be center-specific. After selecting this location and a specific profile, additional options will become available to only show this field for a certain center or exclude it from a certain center. | |||
::<b>Availability</b> appears in [[TracCloudGuideBasicsSchedule|availability blocks]] under the 'Notes' tab. | |||
::<b>Consultant</b> displays in [[TracCloudGuideProfileStaff|consultant profiles]] under the “Contact & Other Data” tab. | |||
::<b> | ::<b>Faculty</b> displays within [[TracCloudGuideListingsFaculty|faculty]] profiles. | ||
::<b> | ::<b>Registration</b> appears within [[TracCloudGuideListingsRegistrations|registration]] records. Frequently used for additional enrollment data or midterm grades. | ||
::<b> | ::<b>Reason</b> appears within each of your [[TracCloudGuideProfileReasons|Reasons]]. Possibly a description of the purpose of the reason, or any additional information that staff may need to reference when making changes later. | ||
::<b> | ::<b>Resource</b> appears in each of your [[TracCloudGuideBasicsResources|Resources]]. Typically used for resource location. | ||
::<b> | ::<b>Section</b> appears in each [[TracCloudGuideListingsSections|section]] record. | ||
::<b> | ::<b>Certification</b> appears within [[TracCloudGuideProfileStaff#Certifications|consultant certifications]]. | ||
::<b> | ::<b>Document</b> appears in the [[TracCloudGuideGlobalDocs|document entry screen and during document upload]].<br><br> | ||
* <b>Profile Drop-down</b> | * <b>Profile Drop-down</b> | ||
::Determines which profile this custom field is active for, including “All Profiles” if preferred.<br><br> | ::Determines which profile this custom field is active for, including “All Profiles” if preferred.<br><br> | ||
* <b>Trash icon</b> | * <b>{{#fas:trash}} Trash icon</b> | ||
::Deletes the custom field. We would recommend deactivating the field instead, but if there’s no data tied to it yet or the data needs to be deleted, then this option is available.<br><br> | ::Deletes the custom field. We would recommend deactivating the field instead, but if there’s no data tied to it yet or the data needs to be deleted, then this option is available.<br><br> | ||
<big><b>More Options</b> (Pencil icon)</b></big><br> | <big><b>More Options</b> ({{#fas:pencil}} Pencil icon)</b></big><br> | ||
After selecting the pencil icon, we’re shown an alternate way to look at the same options as before, as well as a few additional settings.<br> | After selecting the {{#fas:pencil}} icon, we’re shown an alternate way to look at the same options as before, as well as a few additional settings.<br> | ||
[[File: | [[File:9612525.png|800px]] | ||
<br><br> | <br><br> | ||
* <b>Field Name</b> | * <b>Field Name</b> | ||
::This is the internal name of this field. This needs to be a shorter, unique name without spaces, something like “Student_Notes” instead of “Do you have any notes on your visit today?” | ::This is the internal name of this field. This needs to be a shorter, unique name without spaces, something like “Student_Notes” instead of “Do you have any notes on your visit today?”. This will be visible when running reports and on data exports.<br><br> | ||
* <b>Prompt Text</b> | * <b>Prompt Text</b> | ||
::This is the text that’s shown to your users when viewed. Continuing from the example above, this one should be “Do you have any notes on your visit today?” | ::This is the text that’s shown to your users when viewed. Continuing from the example above, this one should be “Do you have any notes on your visit today?”. This is visible in the record itself.<br><br> | ||
* <b>Field Entry Type</b> | * <b>Field Entry Type</b> | ||
::This determines the type of response available. | ::This determines the type of response available. | ||
::<b>Single line entry field</b> allows us to either type in a custom response or select an option from the drop-down menu. | ::<b>Single line entry field</b> allows us to either type in a custom response or select an option from the drop-down menu. | ||
::[[File:2347267.png|450px]] | ::[[File:2347267.png|450px]]<br><br> | ||
::<b>Text Entry Area</b> provides a text box that we can write anything we’d like in. If this option is selected, we can specify how many lines tall this box is by default. | ::<b>Text Entry Area</b> provides a text box that we can write anything we’d like in. If this option is selected, we can specify how many lines tall this box is by default. | ||
::[[File:6641678.png|400px]] | ::[[File:6641678.png|400px]]<br><br> | ||
::<b>Checkbox</b> simply provides a checkbox next to your field name. | ::<b>Checkbox</b> simply provides a checkbox next to your field name. | ||
::[[File:9716451.png|250px]] | ::[[File:9716451.png|250px]]<br><br> | ||
::<b>Multiple Checkboxes</b> provides multiple choices, allowing more than one to be selected at once. | ::<b>Multiple Checkboxes</b> provides multiple choices, allowing more than one to be selected at once. | ||
::[[File:5621189.png|325]] | ::[[File:5621189.png|325]]<br><br> | ||
::<b>Radio Option</b> provides multiple choices, but only allows a single option to be selected. | ::<b>Radio Option</b> provides multiple choices, but only allows a single option to be selected. | ||
::[[File:2535104.png|425px]] | ::[[File:2535104.png|425px]]<br><br> | ||
::<b>Radio Icon Options</b> provides icons that can be selected instead of a checkbox. This requires a specific format in your custom field choices. <b>Sub Delimiter Char</b> should almost always be set to "|" (pipe/vertical bar). The choices must be formatted as: | |||
::<choice value, typically counting up from 1>|<the [https://fontawesome.com/search Font Awesome] icon you want to use>|<title/name of choice>. | |||
::[[File:1749731.png|325px]] [[File:9548710.png|500px]] | |||
<br><br> | |||
::<b>Toggle Option</b> displays as a toggleable choice. By default, Yes/No will be used, but custom options can also be specified in the “Field, Menu or Radio Choices” box. | ::<b>Toggle Option</b> displays as a toggleable choice. By default, Yes/No will be used, but custom options can also be specified in the “Field, Menu or Radio Choices” box. | ||
::[[File:7934219.png|425px]] | ::[[File:7934219.png|425px]]<br><br> | ||
::<b>Menu Field</b> provides a drop-down list of options when selected. | ::<b>Menu Field</b> provides a drop-down list of options when selected. | ||
::[[File:4388069.png|425px]] | ::[[File:4388069.png|425px]]<br><br> | ||
::<b>Image Menu Field</b> provides a drop-down list of icons rather than text options. This requires a specific format in your custom field choices. <b>Sub Delimiter Char</b> should almost always be set to "|" (pipe/vertical bar). The choices must be formatted as: | |||
::<choice value, typically counting up from 1>|<the unicode value of the [https://fontawesome.com/search Font Awesome] icon you want to use>|<title/name of choice>. | |||
::[[File:3225406.png|325px]] [[File:4203911.png|500px]]<br><br> | |||
::<b>Signature</b> provides a box that users can scrawl their signature in. | ::<b>Signature</b> provides a box that users can scrawl their signature in. | ||
::[[File:5057544.png|425px]] | ::[[File:5057544.png|425px]]<br><br> | ||
::<b>Label (non-entry)</b> allows you to add text without being tied to an entry field. | ::<b>Label (non-entry)</b> allows you to add text without being tied to an entry field. | ||
::[[File:7063541.png|400px]] | ::[[File:7063541.png|400px]]<br><br> | ||
::<b>Header (non-entry)</b> is similar to Label, but displays in a larger underlined font. | ::<b>Header (non-entry)</b> is similar to Label, but displays in a larger underlined font. | ||
Line 125: | Line 143: | ||
* <b>Start on a New Line</b> | * <b>Start on a New Line</b> | ||
::Custom Fields are formatted automatically. For example, if you have a 50% width field followed by another 50% width field, they will appear on the same line at the same height in the page. If this box is checked, it forces this custom field to start on a new line regardless of the width of the previous field. | ::Custom Fields are formatted automatically. For example, if you have a 50% width field followed by another 50% width field, they will appear on the same line at the same height in the page. If this box is checked, it forces this custom field to start on a new line regardless of the width of the previous field.<br><br> | ||
* <b>Maximum # of choices allowed</b> ("Multiple Checkboxes" fields only) | |||
::This field allows you to set the maximum number of selections a user can make from the set of choices. If left blank, the user can check up to every box. | |||
[[Category:TracCloud]] | |||
<hr> | |||
<i>See Also</i> | |||
* [[TracCloudGuideGlobalStudentFields|Student Entry Choices]] | |||
* [[TracCloudGuideGlobalBio|Confirm Bio]] | |||
* [[TracCloudST|SurveyTrac]] | |||
</div> |
Latest revision as of 10:31, 17 May 2024
Custom Fields
Custom fields can be configured throughout TracCloud to store additional data that your campus may require. These custom fields can be displayed in student profiles, appointments, visits, faculty, registrations, and more.
These fields can be viewed just like other standard fields, and can even be used in reports. This data can also be imported from your Student Information System just like the rest of the standard fields, more information on that can be found in our Import articles.
Creating a new Custom Field
As a basic example, let’s create a custom field for our students. Maybe we want an extra field to specify a student’s assigned advisor. To begin, open up the Custom Fields section in your System Preferences, scroll to the bottom, and select the + icon. This will add a new item to our list, where we can begin configuring the field.
- Hamburger icon
- By clicking-and-dragging this icon, we can move this field throughout our list. This also determines the order the fields appear in within their respective locations.
- By clicking-and-dragging this icon, we can move this field throughout our list. This also determines the order the fields appear in within their respective locations.
- Name
- This is the field name. The field name cannot contain spaces (see Prompt Text later in this article)
- This is the field name. The field name cannot contain spaces (see Prompt Text later in this article)
- Pencil icon
- Opens a menu with additional options, which will be covered later in this article.
- Opens a menu with additional options, which will be covered later in this article.
- Login/Logout icons
- These determine if the field is displayed during the login/logout process on the log listing/kiosk. This even applies to non-visit fields. The student could be asked a question relating to one of their student or registration fields, for example.
- These determine if the field is displayed during the login/logout process on the log listing/kiosk. This even applies to non-visit fields. The student could be asked a question relating to one of their student or registration fields, for example.
- Exclamation icon
- Sets the field to required, so an answer must be provided before continuing/saving.
- Sets the field to required, so an answer must be provided before continuing/saving.
- No Access icon
- Marks the field as inactive. This is recommended if you aren’t planning on utilizing a field anymore, but don’t want to remove the data associated with it. This way the data is still available if you want to re-enable it again in the future, but it won’t be visible throughout general TracCloud use.
- Marks the field as inactive. This is recommended if you aren’t planning on utilizing a field anymore, but don’t want to remove the data associated with it. This way the data is still available if you want to re-enable it again in the future, but it won’t be visible throughout general TracCloud use.
- Speech Bubble
- Displays this field on the student timeline alongside Visit Notes.
- Displays this field on the student timeline alongside Visit Notes.
- Hide from Consultants
- Hides this Custom Field from consultant view (e.g., for Student Visit Remarks).
- Hides this Custom Field from consultant view (e.g., for Student Visit Remarks).
- Hide on SI Batch Visit Entry
- Hides this field on batch visit entry.
- Hides this field on batch visit entry.
- Location Drop-down
- This determines where the field displays. There are several locations available:
- Student – Campus / Other Info / Custom1-5 displays within one of these tabs on student profiles. The name of the “Custom” tabs can be changed in your Student Entry Choices preferences.
- This determines where the field displays. There are several locations available:
- Visit – Student / Consultant displays in the visit record. Typically used with “Asked on log in/out” enabled, that way the student or staff member can input this information from the Log Listing/Kiosk view.
- Visit - Q2 Raise Hand displays on the Raise Hand prompt for Q2, applying to Q2Remote and when raising a hand from the Log Listing.
- Appointment – Student / Consultant will appear during the appointment booking process, with separate tabs containing different questions for students or consultants. This location is also unique in that it's the only custom field location that can be center-specific. After selecting this location and a specific profile, additional options will become available to only show this field for a certain center or exclude it from a certain center.
- Availability appears in availability blocks under the 'Notes' tab.
- Consultant displays in consultant profiles under the “Contact & Other Data” tab.
- Faculty displays within faculty profiles.
- Registration appears within registration records. Frequently used for additional enrollment data or midterm grades.
- Reason appears within each of your Reasons. Possibly a description of the purpose of the reason, or any additional information that staff may need to reference when making changes later.
- Resource appears in each of your Resources. Typically used for resource location.
- Section appears in each section record.
- Certification appears within consultant certifications.
- Document appears in the document entry screen and during document upload.
- Document appears in the document entry screen and during document upload.
- Profile Drop-down
- Determines which profile this custom field is active for, including “All Profiles” if preferred.
- Determines which profile this custom field is active for, including “All Profiles” if preferred.
- Trash icon
- Deletes the custom field. We would recommend deactivating the field instead, but if there’s no data tied to it yet or the data needs to be deleted, then this option is available.
- Deletes the custom field. We would recommend deactivating the field instead, but if there’s no data tied to it yet or the data needs to be deleted, then this option is available.
More Options ( Pencil icon)
After selecting the icon, we’re shown an alternate way to look at the same options as before, as well as a few additional settings.
- Field Name
- This is the internal name of this field. This needs to be a shorter, unique name without spaces, something like “Student_Notes” instead of “Do you have any notes on your visit today?”. This will be visible when running reports and on data exports.
- This is the internal name of this field. This needs to be a shorter, unique name without spaces, something like “Student_Notes” instead of “Do you have any notes on your visit today?”. This will be visible when running reports and on data exports.
- Prompt Text
- This is the text that’s shown to your users when viewed. Continuing from the example above, this one should be “Do you have any notes on your visit today?”. This is visible in the record itself.
- This is the text that’s shown to your users when viewed. Continuing from the example above, this one should be “Do you have any notes on your visit today?”. This is visible in the record itself.
- Field Entry Type
- Radio Icon Options provides icons that can be selected instead of a checkbox. This requires a specific format in your custom field choices. Sub Delimiter Char should almost always be set to "|" (pipe/vertical bar). The choices must be formatted as:
- <choice value, typically counting up from 1>|<the Font Awesome icon you want to use>|<title/name of choice>.
- Image Menu Field provides a drop-down list of icons rather than text options. This requires a specific format in your custom field choices. Sub Delimiter Char should almost always be set to "|" (pipe/vertical bar). The choices must be formatted as:
- <choice value, typically counting up from 1>|<the unicode value of the Font Awesome icon you want to use>|<title/name of choice>.
- Field, Menu, or Radio Choices and # Lines
- Depending on which Field Entry Type is used, this option will change. “Field, Menu, or Radio Choices” allows you to list out your various options for multiple-choice questions. “# Lines” determines the size of text boxes for essay fields.
- Depending on which Field Entry Type is used, this option will change. “Field, Menu, or Radio Choices” allows you to list out your various options for multiple-choice questions. “# Lines” determines the size of text boxes for essay fields.
- Relative Width
- Start on a New Line
- Custom Fields are formatted automatically. For example, if you have a 50% width field followed by another 50% width field, they will appear on the same line at the same height in the page. If this box is checked, it forces this custom field to start on a new line regardless of the width of the previous field.
- Custom Fields are formatted automatically. For example, if you have a 50% width field followed by another 50% width field, they will appear on the same line at the same height in the page. If this box is checked, it forces this custom field to start on a new line regardless of the width of the previous field.
- Maximum # of choices allowed ("Multiple Checkboxes" fields only)
- This field allows you to set the maximum number of selections a user can make from the set of choices. If left blank, the user can check up to every box.
See Also