Overview

Code Items are the values displayed in a drop-down menu you see in Paradigm User Interface – fields which would require you to choose from the list. These items will change as your business or institution will also undergo some changes in the future. Paradigm offers a solution to address this concern and lets you edit the Code Items to meet your requirements. This knowledge article will give you a detailed workflow on how you can search, add, and edit Code Items.

Complexity:

Status

colour	Blue
title	Medium

Navigation

Table of Contents

maxLevel	1
minLevel	1
style	square
exclude	Overview\|Workflow\|Video

Workflow

Table of Contents

minLevel	3
maxLevel	4
exclude	How to
style	none

Video

Table of Contents

minLevel	5
maxLevel	5
style	none

Expand

title	Assumptions

Assumptions

The User has the minimum required level to access the system tab;
The User has an understanding that making changes within this section has system wide implications; and
The User has an understanding of the Australian Tertiary Education System / VET Sector.

Expand

title	Key Terms and Concepts

Anchor

	keytop
	keytop

Anchor

	KeyTermsAndConcepts
	KeyTermsAndConcepts

Key Terms and Concepts

NOTE: Some of these items are reportable HEIMS fields and have responses that are predetermined by HEIMS reporting. Please consult the HEIMS website to ensure that your institution is compliant before adding or removing any options.

Select from below the term/concept that you would want to know more in relation to Code Types:

Table of Contents

minLevel	2
maxLevel	2
exclude	Edit / Add New Code Items

Status
title what is a
Code Type?

In Paradigm user interface perspective, we refer the Code Type as the heading of a field which has dropdown menus. In the example below, “Funding Type” is the Code Type.

Status
title what are
Code Items?

Refer to the items under the Code Type. In the example above, the Code Items under the Code Type Id “Funding Type”are “UPFRONT FEES”, “FEE-HELP”, “HECS-HELP”, and “OSS-HELP”.

back to top

Status
colour Red
title required info
System Required Fields

Requirements	Required Fields
System	Code Id Code Id type Code Description
Operationally Viable	Code Id Code Id type Code Description Order Visible

back to top

Status
colour Purple
title code item details form
Code Item Fields

This is an example of the information within the Contact mode drop box or code item. Each item, for this example, has six parts:

Field Name

Brief Overview

Sample Data

Code Id

NOTE: This value should have no spaces and be fewer than 20 characters in length. Replace spaces with underscores.

The code used in the backend of the system for the response.

ON_CAMPUS
HEAR_NEWSPAPER

Code Type Id

Each code item is assigned a type ID that is used to group code items that should appear in the same drop-down menu within the user interface.

CONTACT_MODE
HEAR

Code

NOTE: We recommend making the CODE the same as the value of CODE ID.

This is the value that will be saved in the database.

ON_CAMPUS
HEAR_NEWSPAPER

Order

This is the order that the items will appear in the drop box once added to the system. The number allocated to each option needs to be 2 or 3 digits to ensure that the options appear in the required order. Prefix a number 0 to any number below 10, or to any single digit number.

01
02
03

Visible

The visibility of an option to be able to make available or not an option within the drop box. Hiding an option doesn't remove or re-code it from historical records in the system (for these records it will still be visible), it will just remove it from being used in the future.

Visible
Hidden

Description

Note
BE ADVISED: The description is designed to be for the end users and should be more "user-friendly”, descriptions that users could easily relate depending on the type of options you wanted them to choose.

This is the value that will be seen by users in the drop-down menu, displayed on the user interface.

On Campus
Newspaper

back to top

Implications

NOTE: Some of these items are reportable HEIMS fields and have responses that are predetermined options within HEIMS (HEPCAT / TCSI) reporting. Please consult the HEIMS website to ensure that your institution is compliant before adding or removing any options.

Info
INFO: Code items may be retired by setting the visible field to "hidden". Setting a code to hidden will prevent it from appearing in the appropriate drop-down menu. Note that historical records will still retain the old code item, meaning that retiring old codes will not have an adverse impact upon historical data.

Workflow

Expand

title	A. Search a Code Item

Status
colour Blue
title A.
Search a Code Item

Info
INFO: If you know the exact Code Type Id or a keyword of the code that you want to search, you can do so by typing in the Code Type Id field and click the SEARCH CODE TYPES button after. However, if you want to search for all the Code Items [to be displayed], follow the instructions below.

Status

colour	Green
title	1

,

Status

colour	Green
title	2

,

Status

colour	Green
title	3

Choose the System menu > Search Code Type > Click the SEARCH CODE TYPES button.

Status

colour	Green
title	4

A list of all Code Types will be displayed under the SEARCH CODE TYPE Form. You can filter your search by typing a keyword of the Code Id that you want to search in the Filter Box.

Status

colour	Green
title	5

If you already found the Code Type Id that you are looking for after typing a keyword in the Filter Box, click the 📝 EDIT button on the right to see the Code Items associated to it.

NOTE: If there is only one result of the Code Type that you are trying to search, it will automatically open a form section below, displaying all the code items associated with the Code Type, no need to look for the 📝 EDIT button.

Status

colour	Green
title	6

After clicking the 📝 EDIT button [or after a result has been displayed], an ITEMS ASSOCIATED WITH CODE TYPE Form will appear below the CODE TYPE DETAILS Form which has a list of all the Code Items (both visible and hidden) under the type that you’ve searched.

Info
INFO: In the example above, a list of all Code Items is displayed under the Code Type Id: CONTACT_MODE.

back to top

Expand

title	B. Add a Code Item

Status
colour Blue
title B.
Add a Code Item

Status

colour	Green
title	1

Follow the same instructions [as] above on how to “

Status

colour	Blue
title	A.

Search for a Code Item”, to search for the Code Type where you want to add your new Code Item.

Status

colour	Green
title	2

Once you’ve found the Code Type and its associated Code Items, click the ADD NEW CODE ITEM button.

Status

colour	Green
title	3

A CODE ITEM DETAILS Form will appear below, with all the fields that you need to fill out to add successfully your new Code Item. Refer to the guide below in filling out this form. For more details on the definition of each field, refer to the Key Terms and Concepts section at the top of this page.

Status

colour	Green
title	A

Code Id – Refer to your institution’s naming convention for your Code Items. The best way to check on the format is to check the previous Code Items on the list and follow the same format. Suggested format should be, as in the sample form above, ITEM_CODE_ID_TITLE. Use underscore in place of spaces.

Info
INFO: In the sample form above, the Course Id is set to “PERTITLE_MISC”. Note that it’s the same format as the number [23 result PERTITLE_MX] of the Code Items above.

Status

colour	Green
title	B

Code Type Id – This is the Code Type Id where your newly created Code Item will belong. In the example above, it will be under the Person Title field.

Status

colour	Green
title	C

Code – Copy the Code Id to this field.

NOTE: We recommend making the Code field the same as the value of the Code Id field.

Status

colour	Green
title	D

Order – Enter a number here – a numerical value which will determine the order this option will appear in the drop down box.

NOTE: Prefix any single digit number with a zero. Any order number entered below 10 should start with a zero. e.g. 01, 02, 03, etc.

Info
INFO: In the example above, it is being set to 24 as the user would just want to add the newly created title at the end of the list which currently has 23 titles already.

Status

colour	Green
title	E

Visible – Select a visibility option. Visible will make the option available as soon as it has been saved as a code item, hidden will save it for a later time.

Status

colour	Green
title	F

Description – Enter in a description. This is the text to be displayed on the user screen, this field/data and can have a bit more detail.

NOTE: Some of these items are reportable HEIMS fields and have responses that are predetermined options within HEIMS (HEPCAT / TCSI) reporting. Please consult the HEIMS website to ensure that your institution is compliant before adding or removing any options.

Status

colour	Green
title	4

Click the SAVE CODE ITEM button, to add the new Item Code.

back to top

Expand

title	C. Edit a Code Item

Status
colour Blue
title C.
Edit a Code Item

Status

colour	Green
title	1

Follow the same instructions as above on how to “

Status

colour	Blue
title	A.

Search for a Code Item”, to search for the Code Type where you want to edit your new Code Item.

Status

colour	Green
title	2

Once you’ve found the Code Type and its associated Code Items, click the 📝 EDIT button on the right of the Code Item that you want to edit.

Status

colour	Green
title	3

A CODE ITEM DETAILS Form will appear below, with all the fields that you can edit for that Code Item. Refer to the guide below in editing this form. For more details on the definition of each field, refer to the Key Terms and Concepts section [above] of this page.

NOTE: Code items can be edited but not deleted. The order, visibility and the description can each be edited.

Status

colour	Green
title	A

Order – Edit the number here if you want to change the order of the Code Item. The numerical value you’ve entered will determine the order this option will appear in the drop down box.

NOTE: Prefix any single digit number with a zero. Any order number entered below 10 should start with a zero. e.g. 01, 02, 03, etc. In the example above, it is being set to 04.

Status

colour	Green
title	B

Visible – Edit the visibility depending on how you want this Code Item to be seen in the system. Visible will make the option available as soon as it has been saved as a code item, hidden will save it for a later time.

Status

colour	Green
title	C

Description – Edit the description field if you want a new display option for the user to see under this Code Type. This is the text to be displayed on the user screen, this field/data and can have a bit more detail. You can also edit the Code Id and the Code fields above if you are editing the description – to match your new description, just follow the same format.

Status

colour	Green
title	4

Click the SAVE CODE ITEM button, to apply changes.

back to top

Expand

title	D. Hide a Code Item

Status
colour Blue
title D.
Hide a Code Item

Status

colour	Green
title	1

Follow the same instructions as above on how to “

Status

colour	Blue
title	A.

Search for a Code Item”, to search for the Code Item that you want to hide.

Status

colour	Green
title	2

Once you’ve found the Code Type and the Code Item under it that you want to hide, click the 📝 EDIT button on the right.

Status

colour	Green
title	3

A CODE ITEM DETAILS Form will appear below. Look for the Visible field. Select the “Hidden” option in the drop down list to hide the Item Code.

Status

colour	Green
title	4

Click the SAVE CODE ITEM button to apply the change.

Info
INFO: In the example above, the Code Item “Flexible Learning” will no longer be shown in the drop down list of the Contact Mode Code Type Id field.

back to top

Video

Status
colour Yellow
title How to
Edit / Add New Code Items

Widget Connector

overlay	youtube
_template	com/atlassian/confluence/extra/widgetconnector/templates/youtube.vm
width	700px
url	https://www.youtube.com/watch?v=PsL9jgJQEFM
height	500px

Anchor

	RelatedPages
	RelatedPages

Related Pages

Filter by label (Content by label)

showLabels	false
showSpace	false
cql	label in ( "Status" , "item" ) and label = "status"

Versions Compared

Old Version 67

New Version 68

Key

Overview

Assumptions

Key Terms and Concepts

Status
title what is a
Code Type?

Status
title what are
Code Items?

Status
colour Red
title required info
System Required Fields

Status
colour Purple
title code item details form
Code Item Fields

Implications

Workflow

Status
colour Blue
title A.
Search a Code Item

Status
colour Blue
title B.
Add a Code Item

Status
colour Blue
title C.
Edit a Code Item

Status
colour Blue
title D.
Hide a Code Item

Video

Status
colour Yellow
title How to
Edit / Add New Code Items

Related Pages

Related Questions or Issues

Page Comparison

Versions Compared

Old Version 67

New Version 68

Key

Overview

Assumptions

Key Terms and Concepts

Statustitlewhat is a Code Type?

Statustitlewhat are Code Items?

StatuscolourRedtitlerequired info System Required Fields

StatuscolourPurpletitlecode item details form Code Item Fields

Implications

Workflow

StatuscolourBluetitleA. Search a Code Item

StatuscolourBluetitleB. Add a Code Item

StatuscolourBluetitleC. Edit a Code Item

StatuscolourBluetitleD. Hide a Code Item

Video

StatuscolourYellowtitleHow to Edit / Add New Code Items

Related Pages

Related Questions or Issues

Status
title what is a
Code Type?

Status
title what are
Code Items?

Status
colour Red
title required info
System Required Fields

Status
colour Purple
title code item details form
Code Item Fields

Status
colour Blue
title A.
Search a Code Item

Status
colour Blue
title B.
Add a Code Item

Status
colour Blue
title C.
Edit a Code Item

Status
colour Blue
title D.
Hide a Code Item

Status
colour Yellow
title How to
Edit / Add New Code Items