Changes

As an example, let's upload a custom lookup CSV containing university and course information. A sample of this CSV data can be found ''UniversityCourseLookup.csv'' is included in the appendix at the end of this article for reference.

# You will now access step 1 one of the '''Custom Lookup Options Import''' wizard. Upload a CSV containing your custom data. The first row of the CSV must include column headers. A  A sample CSV is provided under the of ''UniversityCourseLookup.csv'Settings Explained''' section below is included in the appendix at the end of this article.

# Select one of the columns for the '''Lookup Key'''. The lookup key is a non-unique identifier that is associated with ''one or more'' records rows in the table. In our example, our lookup key is the "University ID" because this number corresponds to the different universities in our dataset.# The '''Primary Key''' is optional. A primary key is a unique identifier that corresponds to a ''single'' record row in our table. For our example, the primary key is "Course ID" because each row in the table has a uniquely different Course ID that distinguishes it from every other row. Click '''Next''' to continue.

# You will see a warning that notifies you that an existing lookup with the same name already exists. All existing records for rows with that lookup name will be deleted and re-imported with the new updated data. Click '''Next''' to continue and click '''Yes''' on the alert pop-up.

[[File:2021-07-ticket-124709-5.png|thumb|none|800px|A sample list view of an imported custom lookup.]]

[[File:2021-07-ticket-124709-6.png|thumb|none|800px|Attribute-value pairs in the <strong>Lookup Value</strong> are stored in JSON format.]]    

# You should will now see a new toggle called '''Use Custom Lookup Options'''. Toggle this on.# You should will now see additional settings for the custom lookup. Under the '''Lookup Name''' dropdown, select the custom lookup you want to reference. Under '''Option Text Identifier''', type the name of the lookup column whose values you want to populate in the dropdown. In our example, we want to expose the available course names in the dropdown so we will type the name of the column that contains that information: "Course".

===Setting Up a Dynamic Parent-Child Dropdown List===

# In the '''Predefined Options''' field, map the various lookup keys of your custom lookup data to the options you want to surface in the dropdown. In our example, our lookup keys span a range of 100 to 600, which with each 100 increment corresponding to a different university. Mapping the lookup keys in this way will allow the child dropdown we set up later to be filtered by the selected lookup key. For example, if the user selects "Totally Totes College" (with a lookup key mapped to 100), the corresponding child dropdown options will filter the custom lookup data by this lookup key and only returns return the courses available to that university.

To set up a child dropdown list, create # Create a custom field of type '''Select One - Dropdown List''' and set the '''Parent Field''' to the parent dropdown list created above. # Toggle on '''Enable Dynamic Content'''. This # You will expose the now see a new toggle called '''Use Custom Lookup Options'''. When you toggle Toggle this on, you .# You will now see additional settings to specify for the custom lookup. Under the '''Lookup Name'''dropdown, select the desired custom lookup you importedwant to reference. Under '''Option Text Identifier''', type the name of the lookup column whose data values you want to display populate in the dropdown. In our example, we want to expose the available course names in the dropdown so we will type the name of the column that contains that information: "Course".  [[File:2021-07-ticket-124709-9.png|thumb|none|800px|Configuration settings for the child dropdown.]] ====End Result of Parent-Child Dropdown====The available options within the child dropdown will now change depending on the selections made in the parent dropdown. In our example, changing the university in the parent dropdown will change the available courses we can select in the child dropdown.  [[File:2021-07-ticket-124709-4.png|thumb|none|800px]] ===Setting Up Successive Dropdown Lists===In this the previous example, all the predefined options had to be hardcoded into to the custom field configuration settings. This could be a laborious process if the custom data needs regular updates or new entries. The process can be simplified by importing multiple lookups. The section will illustrate how to use successive dropdown lists and reference multiple custom lookups without having to hardcode predefined options. As an example, we want to show set up a chain of parent-child dropdowns for course registration. We want the user to first select from a list of available universities, then select from a list of available faculties at that selected university, and lastly, we want the user to select from a list of available courses under that university faculty. All referenced CSV files are provided in the appendix below. ====Configuring the Parent Dropdown====# Import ''UniversityLookup.csv'' with the "University ID" as the '''Lookup Key''' and the "Primary Key" as the '''Primary Key'''. Set '''Lookup Name''' to "UniversityLookup".# Create a custom field of type '''Select One - Dropdown List''' and give it the caption "University".# Toggle on '''Enable Dynamic Content''' and '''Use Custom Lookup Options'''.# Under '''Lookup Name''', select "University Lookup". Under '''Option Text Identifier''', type the name of the lookup column you want to surface. For our example, we type "University".  [[File:2021-07-ticket-124709-13.png|thumb|none|800px|Configuration settings for the university dropdown.]]   ====Configuring the First Child Dropdown====# Import ''FacultyLookup.csv'' with the "University ID" as the '''Lookup Key''' and the "Faculty ID" as the '''Primary Key'''. Set '''Lookup Name''' to "FacultyLookup".# Create a custom field of type '''Select One - Dropdown List''' and give it the caption "Faculty".# Set the '''Parent Field''' to previously created "University" dropdown custom field.# Toggle on '''Enable Dynamic Content''' and '''Use Custom Lookup Options'''.# Under '''Lookup Name''', select "FacultyLookup". Under '''Option Text Identifier''', type the name of the lookup column you want to surface. For our example, we type "Faculty".  [[File:2021-07-ticket-124709-11.png|thumb|none|800px|Configuration settings for the faculty dropdown.]]   ====Configuring the Second Child Dropdown====# Import ''UniversityCourseLookup.csv'' with the "Faculty ID" as the '''Lookup Key''' and the "Course ID" as the '''Primary Key'''. Set '''Lookup Name''' to "UniversityCourseLookup".# Create a custom field of type '''Select One - Dropdown List''' and give it the caption "Course".# Set the '''Parent Field''' to previously created "Faculty" dropdown custom field.# Toggle on '''Enable Dynamic Content''' and '''Use Custom Lookup Options'''.# Under '''Lookup Name''', select "UniversityCourseLookup". Under '''Option Text Identifier''', type the course nameof the lookup column you want to surface. For our example, we type "Course".

[[File:2021====End Result of Successive Parent-07-ticket-124709-4Child Dropdowns====The available options within the child dropdown will now change depending on the selections made in the parent dropdown. In our example, changing the university in the parent dropdown will change the available faculty listings in the subsequent faculty dropdown. The user's selection in this faculty dropdown will then filter the available options in the course dropdown.png|thumb|none|800px]]

||The Lookup Key is a non-unique identifier used to return all records rows with a matching Lookup Name.

||(Optional) The Primary Key is an optional unique key used to return a single record row that matches the Lookup Name and Primary Key value. Records Rows without a matching Primary Key will be imported as new recordsrows.

===Dropdown SettingsConfiguration Settings===

||(Optional)The name of the column header from your custom dataset whose values are unique for each row. If a '''Primary Key''' was defined when importing the custom lookup, you can leave this field blank.

=Appendix====Sample CSVUniversityLookup.csv=== University ID,Course IDPrimary Key,University<br data-attributes="%20/" />100,100,--- Please Select ---<br data-attributes="%20/" />100,100,Totally Totes College<br data-attributes="%20/" />200,200,Obviously OBVI College<br data-attributes="%20/" />300,300,Artisanal Art College<br data-attributes="%20/" />400,400,Coffee for Me University<br data-attributes="%20/" />500,500,Asymmetrical Universityof Aesthetics<br data-attributes="%20/" />600,600,CourseUniversity of Cold-pressed Flannel===FacultyLookup.csv=== 0University ID,Faculty ID,0Faculty,University<br data-attributes="%20/" />100,100,--- Please Select ---,--- Please Select ---<br data-attributes="%20/" />100,101,Arts & Literature ,Totally Totes College<br data-attributes="%20/" />100,102,Natural Sciences,Totally Totes College<br data-attributes="%20/" />100,103,Humanities,Totally Totes College<br data-attributes="%20/" />100,104,Mathematics,Totally Totes College<br data-attributes="%20/" />200,201,English Literature,Obviously OBVI College<br data-attributes="%20/" />200,202,Physical Sciences,Obviously OBVI College<br data-attributes="%20/" />200,203,History & Humanities,Obviously OBVI College<br data-attributes="%20/" />200,204,Mathematics & Computer Science,Obviously OBVI College<br data-attributes="%20/" />300,301,Literature ,Artisanal Art College<br data-attributes="%20/" />300,302,Biology, Chemistry, and Physics,Artisanal Art College<br data-attributes="%20/" />300,303,History, Anthropology, and Psychology,Artisanal Art College<br data-attributes="%20/" />300,304,Mathematics & Philosophical Sciences,Artisanal Art College<br data-attributes="%20/" />400,401,Faculty of English Literature,Coffee for Me University<br data-attributes="%20/" />400,402,Faculty of Natural Sciences,Coffee for Me University<br data-attributes="%20/" />400,403,Faculty of History,Coffee for Me University<br data-attributes="%20/" />400,404,Faculty of Mathematics & Computing,Coffee for Me University<br data-attributes="%20/" />500,501,Modern Arts & Literature,Asymmetrical University of Aesthetics<br data-attributes="%20/" />500,502,Hard Sciences,Asymmetrical University of Aesthetics<br data-attributes="%20/" />500,503,Modern History & Anthropology,Asymmetrical University of Aesthetics<br data-attributes="%20/" />500,504,Mathematics & Computing,Asymmetrical University of Aesthetics<br data-attributes="%20/" />600,601,Department of English,University of Cold-pressed Flannel<br data-attributes="%20/" />600,602,Department of Science,University of Cold-pressed Flannel<br data-attributes="%20/" />600,603,Department of History,University of Cold-pressed Flannel<br data-attributes="%20/" />600,604,Department of Mathematics,University of Cold-pressed Flannel ===UniversityCourseLookup.csv=== University ID,Course ID,Faculty ID,University,Faculty,Course<br data-attributes="%20/" />100,1000,100,--- Please Select ---,--- Please Select ---,--- Please Select ---<br data-attributes="%20/" />100,1001,101,Totally Totes College,Introduction to Art Arts & Literature,Gothic Literature in the 19th Century<br data-attributes="%20/" />100,1002,102,Totally Totes College,Intermediary Art Natural Sciences,Organic Compounds in Chemistry<br data-attributes="%20/" />100,1003,103,Totally Totes College,Advanced Art Humanities,Introduction to Modern History<br data-attributes="%20/" />100,1004,104,Totally Totes College,Mathematics,Introduction to Music Calculus <br data-attributes="%20/" />100,1005,101,Totally Totes College,Intermediary Music Arts & Literature,Comparitive Mythology & Folklore<br data-attributes="%20/" />100,1006,101,Totally Totes College,Advanced Music Arts & Literature,Introduction to Latin American Literature<br data-attributes="%20/" />200,2001,202,Obviously OBVI College,Introduction to Art Physical Sciences,Fluid Dynamics in Brownian Motion<br data-attributes="%20/" />200,2002,204,Obviously OBVI College,Intermediary Art Mathematics & Computer Science,Advanced Lorentz Transformations<br data-attributes="%20/" />200,2003,201,Obviously OBVI College,Advanced Art English Literature,Analysis of Arthurian Legend<br data-attributes="%20/" />200,2004,202,Obviously OBVI College,Introduction to Music Physical Sciences,Morphology in Evolution<br data-attributes="%20/" />200,2005,202,Obviously OBVI College,Intermediary Music Physical Sciences,Thermodynamics<br data-attributes="%20/" />200,2006,203,Obviously OBVI College,Advanced Music History & Humanities,Early Modern Period<br data-attributes="%20/" />300,3001,303,Artisanal Art College,Introduction to Art History, Anthropology, and Psychology,Architecture of the Roman Empire<br data-attributes="%20/" />300,3002,302,Artisanal Art College,Intermediary Art Biology, Chemistry, and Physics,Anatomy of the Human Body<br data-attributes="%20/" />300,3003,304,Artisanal Art College,Advanced Art Mathematics & Philosophical Sciences,Topology of Non-Euclidean Systems <br data-attributes="%20/" />300,3004,301,Artisanal Art College,Introduction to Music Literature ,Ancient Epics and Poetry<br data-attributes="%20/" />300,3005,303,Artisanal Art College,Intermediary Music History, Anthropology, and Psychology,History of the Dutch Golden Age<br data-attributes="%20/" />300,3006,302,Artisanal Art College,Advanced Music Biology, Chemistry, and Physics,Virology and Epidemiology<br data-attributes="%20/" />400,4001,402,Coffee for Me University,Introduction to Art Faculty of Natural Sciences,Inorganic Compounds in Chemistry<br data-attributes="%20/" />400,4002,401,Coffee for Me University,Intermediary Art Faculty of English Literature,Russian Literature in the 19th Century<br data-attributes="%20/" />400,4003,401,Coffee for Me University,Advanced Art Faculty of English Literature,Proto-Indo European Folklore (Thesis)<br data-attributes="%20/" />400,4004,401,Coffee for Me University,Faculty of English Literature,Introduction to Music English Literature<br data-attributes="%20/" />400,4005,402,Coffee for Me University,Intermediary Music Faculty of Natural Sciences,Nomenclature of Organic Compounds<br data-attributes="%20/" />400,4006,403,Coffee for Me University,Advanced Music Faculty of History,Monarchies Through the Ages<br data-attributes="%20/" />500,5001,504,Asymmetrical University of Aesthetics,Introduction to Art Mathematics & Computing,Polynomial Differentiation<br data-attributes="%20/" />500,5002,501,Asymmetrical University of Aesthetics,Intermediary Art Modern Arts & Literature,Ancient Greek Classics<br data-attributes="%20/" />500,5003,501,Asymmetrical University of Aesthetics,Advanced Art Modern Arts & Literature,Introduction to Renaissance Literature<br data-attributes="%20/" />500,5004,502,Asymmetrical University of Aesthetics,Introduction to Music Hard Sciences,Quantum Mechanics<br data-attributes="%20/" />500,5005,504,Asymmetrical University of Aesthetics,Intermediary Music Mathematics & Computing,Introduction to Algebraic Topology<br data-attributes="%20/" />500,5006,501,Asymmetrical University of Aesthetics,Advanced Music Modern Arts & Literature,Magic Realism in Latin American Literature<br data-attributes="%20/" />600,6001,602,University of Cold-pressed Flannel,Introduction to Art Department of Science,Radiation and Thermonuclear Reactions<br data-attributes="%20/" />600,6002,602,University of Cold-pressed Flannel,Intermediary Art Department of Science,Kinematics and Dynamics<br data-attributes="%20/" />600,6003,603,University of Cold-pressed Flannel,Advanced Art Department of History,Rise and Fall of the Mughal Empire<br data-attributes="%20/" />600,6004,603,University of Cold-pressed Flannel,Introduction to Music Department of History,Neo-Classical Architecture Through the Ages<br data-attributes="%20/" />600,6005,602,University of Cold-pressed Flannel,Intermediary Music Department of Science,Cardiovascular System Processes<br data-attributes="%20/" />600,6006,604,University of Cold-pressed Flannel,Advanced MusicDepartment of Mathematics,Polynomial Field Theory[[Category:Tools]]