Campus Attribute Comparison Report


As of the Campus.2223 (June 2022) Release, this report is no longer be available.


This article contains advanced technical information intended for system administrators. The Campus Attribute Standard and this report will be made available on a state-by-state basis.

PATH: System Administration > Custom > Reports > Campus Attribute Comparison Report

Search Term: Campus Attribute Comparison Report

The Campus Attribute Comparison Report was designed to indicate every attribute and dictionary change that will occur once the Campus Attribute Standard is applied. The Campus Attribute Standard is a core set of attribute and dictionary values which will be applied to the local database to add, replace, rename and correct inconsistencies found throughout existing attribute and dictionary values. The goal of the Campus Attribute Standard is to reduce the negative effect incorrect attributes and dictionaries have on local database items, reporting and overall product functionality. 

This report defines all differences found between the Campus Attribute Standard and the local database and breaks these differences down into each action that will occur and any corrections that will be made. System Administrators should use this report to perform deep analysis of how the Campus Attribute Standard will impact their local databases once it is applied.

Updates to these attributes are pushed to clients through the Campus Updater tool. 

Image 1: Campus Attribute Comparison Report

Relevant Terminology

The following terms are defined in relation to the Campus Attribute Comparison Report and this article.

  • Campus Attribute Standard - The Campus Attribute Standard is a core set of attributes and dictionaries which ensure consistency amongst core fields and tool functionality. When the Campus Attribute Standard is applied, differences in attributes and dictionaries between the local database and the Campus Attribute Standard are renamed, replaced, added, activated or deactivated to the correct values.
  • Attribute / Field- A particular data column in a database table. An attribute is commonly referred to as a "field," but can actually be rendered as a checkbox, date, droplist, etc.
    • Attribute Dictionaries - An attribute/field that takes the format of a droplist generally contains a set of pre-defined codes/values that relate to it. These codes/values are its "dictionary" entries. Most dictionary values are hard-coded by Infinite Campus and locked from local user customization.
  • Types of Attributes
    • Local Client Attribute - Local client attributes are those created and maintained by a client. Infinite Campus does not manage these elements.
    • Campus Standard Attributes - Certain client attributes are considered part of the set of Campus Attribute Standard attributes (i.e., the core and state-specific attributes created for a client by Infinite Campus). These attributes are usually locked from editing/customization by end users.

Generating the Report

The Campus Attribute Comparison Report can be generated at any time and for specific actions that will take place once the Campus Attribute Standard is applied.

Image 2: Generating the Campus Attribute Comparison Report

To generate the report:

  1. Mark the radio button(s) appropriate to the type of information to be displayed by the report:
    • Added - Report will list the Campus Attribute Standard attributes that are not currently present in the local Attribute/Dictionary .
    • Replaced - Report will list the custom client attributes that exist in the local Attribute/Dictionary  but are being replaced with the values existing in the Campus Attribute Standard. 
    • Made Inactive - Report will list the attributes within the local Attribute/Dictionary that will be made inactive.
    • Made Active - Report will list the attributes within the local Attribute/Dictionary that will be made active.
    • Renamed - Report will list custom attributes created by the customer that will be renamed in the application of the Campus Attribute Standard.
  2. To have report data sorted alphabetically by attribute, mark the Sort report alphabetically checkbox.
  3. Click the Pull the Campus Attribute Comparison Report with No Action Items radio button to pull report data for differences which will have no impact and will create no change to the local database.
  4. Select the Format.
  5. Click the Generate Report button. The report will appear in a separate window in the designated format.

Example of the Campus Attribute Comparison Report

See the following PDF for a real-life example of the Campus Attribute Comparison Report: Example of Campus Attribute Comparison Report.pdf

Analyzing Report Results

The following sections will explain each column of the Campus Attribute Comparison Report. 

Action Column

The Action column defines the action being performed to the specified attribute and dictionaries (codes).

  • Attribute / Field Name - The attribute and corresponding element/GUI path or field name being modified by the action. When GUI path is not available, field name will show. In the example below (Image 3), dictionaries (codes) for the Attribute: EmploymentCredential, Element: degreeType, UI display name: Education Level are being modified.
  • Dictionary (Code) - The dictionaries (codes) being modified by the action. In the example below, the dictionary Code: A, Name: Associates is being made inactive.
  • Action being performed -The action being performed by implementation of the Campus Attribute Standard. In the example below (Image 3), the Code within the Attribute is being made inactive.

    Attribute changes are left justified while Dictionary changes are indented. This allows for easier identification between each type of change being made.

Image 3: Action Column

Local Data Column

The Local Data column indicates the current, local database value being modified when the Campus Attribute Standard is applied. In the example below (Image 4), the dictionary (code) A: Associates is currently active in the local database and being inactivated. See the Database Attribute and Dictionary Terms section for definition of each dictionary and attribute term used within the this column (i.e., active, value, dataType, etc).

Image 4: Local Data Column

Final Result Column

The Final Result column indicates the result of the modification made when the Campus Attribute Standard is applied. In the example below (Image 5), the dictionaries (codes) for the attribute (EmploymentCredential.degreeType) will be changed from active (indicated in the Local Data column) to inactive (indicated in the Final Result column). See the Database Attribute and Dictionary Terms section for definition of each dictionary and attribute term used within the this column (i.e., active, value, dataType, etc).

Image 5: Final Result Column

Understanding Report Options

The following sections describe each Campus Attribute Comparison Report option.

Report options include:

 Attributes or Dictionaries that will be Added

This option reports every attribute and dictionary that will be added to the local database once the Campus Attribute Standard is applied.

Image 6: Attributes or Dictionaries that will be Added

The Action column describes the attribute and/or dictionaries being added, and the Final Result column describes the dictionary code and/or field being added as a result of this action.

In the example above, the Attribute: Enrollment, Element: nonPublic, GUI display name: Non-Public Student will be added. This means a new field called Non-Public Student will be available in the UI (if Hide is not checked). This new attribute has no dictionary. In the next row, three dictionaries (codes) will be added to the POSPurchasable.stateCode attribute.

 Attributes or Dictionaries that will be Replaced

This option reports all attributes and dictionaries that will have field values replaced (or modified) once the Campus Attribute Standard is applied.

Image 7: Attributes or Dictionaries that will be Replaced

In the example above, the Attribute: HealthScreening, Element: ecLocation will be changed from a date field to a dropdown list. In the next row, the Attribute: Course, Element: activityCode will be changed from a dated field to an undated field and the dictionary will be changed from unlocked to locked within the Attribute Dictionary. Four field values are being replaced with null or blank values.

 Attributes or Dictionaries that will be made Inactive

This option reports all attributes and dictionaries that will be made inactive once the Campus Attribute Standard is applied.

Image 8: Attributes or Dictionaries that will be Made Inactive

In the example above, four dictionary items for the Attribute: EmploymentCredential, Element: degreeType will be changed from active to inactive. This means these dictionaries/codes will no longer display within Campus.

 Attributes or Dictionaries that will be made Active

This option reports all attributes and dictionaries that will be made active within Campus once the Campus Attribute Standard is applied. 

Image 9: Attributes or Dictionaries that will be Made Active

In the example above, dictionary values for the Attribute: Behavior, Element: weapon are being made active. This means users will now be able to actively use these values when entering Weapon data.,

 Attributes that will be Renamed

When the Campus Attribute Standard needs to deliver an attribute with a specific element but the element already exists on the local database, Campus will rename the local database element. This action is always paired with the addition of a new attribute. This option reports all attributes that will be renamed once the Campus Attribute Standard is applied. 

When the Campus Attribute Standard renames an element, the prefix "c_" is added to the old element and a new is element added. The report may not display them next to each other. See Image 10 for an example of this change.

Image 10: Attributes or Dictionaries that will be Renamed

 Campus Attribute Comparison Report with No Action Items

The Campus Attribute Comparison Report with No Action Items defines all differences found between the local database and the Campus Attribute Standard that will not be changed since they have no impact on consistency or core functionality. Users do not need to modify the differences described within this report however, the Campus Data column provides a recommendation for what Campus believes to be the best value.

Image 11: Example of Campus Attribute Comparison Report with No Action Items

Reporting Deprecated Attributes

When Campus Attribute Standard deprecates an element, the report will indicate this by showing Final Result of deprecated: true (see Image 12).

When attribute values are modified for a deprecated attribute, the report will state "This attribute is deprecated" next to the attribute name (see Image 12).

When a deprecated attribute is being made active, the report will show a Local Data value of deprecated: true with a Final Result of deprecated: false (see Image 12).

Image 12: Reporting Deprecated Attributes

Legacy Deprecation Shown on the No Action Items Report

Before the deprecated flag was added to attributes, elements were deprecated by adding "_dep" or "--dep" and the date to the end of the object name. These attributes are not in the standard, but they may still exist in databases, and will show up on the Campus Attribute Comparison Report (No Action) since it is a difference between the standard and the local database. Because there was no deprecated flag when these attributes were deprecated, they also will not have the deprecated flag set to 1 in the database like most deprecated attributes. These attributes are no longer active and Infinite Campus will not make any change to these attributes through the application of the Campus Attribute Standard.

Image 13: Example of Deprecated Elements on the Campus Attribute Comparison Report with No Action Items

 Database Attribute and Dictionary Terms

The following tables define each attribute and dictionary term reported within the Local Data and Final Result columns. 

Nulls within the database report as 0 within Campus and the Campus Attribute Comparison Report for all attributes with the exception the following: name, defaultValue, dataType, maxSize, comments. 

Attribute Terms

Term

Description

name

A word/set of words that identifies a field via the UI.

defaultValue

The assumed value when there is no value chosen by the user.

dataType

Identifies the type of data stored in the database for this element (i.e., text, date field, drop list).

dated

When this flag is set to 1, the field will retain historical information by setting the date on each entry and create a new entry for each change. If the flag is 0 or Null any change will result in the current row being updated and no date will be set (used for the enrollment split).

seq

Representing sequence, this orders the layout of fields in some parts of the UI.

hide

Toggle which allows the element to be hidden in the UI.

lock

This controls whether or not a user will be able to add or delete a Dictionary and change any of the Dictionary values.

required

This specifies whether or not the user is required to choose a value before saving any form that includes this field.

maxSize

This controls the size of the display box in the GUI.

custom

This specifies whether or not the CampusAttribute was created by a user or by Campus. A value of 1 (True) indicates it is a user created field.

copiesForward

This indicates that the values for this field will be copied to enrollments for the same student in future years.

statusData

This indicates that the values for this field will be stored in one of the Custom tables (e.g. CustomStudent).

statusData and stateTable are mutually exclusive. Only one should be set at a time. (Identifies where the data belongs: custom vs. standard schema table)

comments

Generic information about the attribute, when unlocked the adminstrator can add inforamtion regarding the attribute.

hidePortal

When set to 0 or null the attribute will show via Portal custom tab and portal outline.

stateTable

This indicates that the values for this field will be stored in one of the state specific tables named using the object and the state abbreviation appended (e.g. EnrollmentKY). 

stateTable and statusData are mutually exclusive. Only one should be set at a time.

deprecated

Indicates the attribute has not been removed from the database but is no longer in use within Campus.

nameLock

This indicates whether or not the name of the attribute can be changed. 

defaultValueLock

This indicates the defaultValue of the attribute cannot be changed.

hideLock

This indicates the hide selection of the attribute cannot be changed.

requiredLock

This indicates the required selection of the attribute cannot be changed.

copiesForwardLock

This indicates the copiesForward selection of the attribute cannot be changed.

commentsLock

This indicates the comments of the attribute cannot be changed.

Dictionary Terms

Seq and Active report nulls within the database as 0.

Term

Description

Code

A set of letters or numbers that represents an assigned dictionary value.

Name

A word/set of words that constitutes the designation of a dictionary item.

Value

Has a unique meaning within a set of dictionary items to represent a code/name set. Value is used by stored procedures, reports and views to assist in filtering results.

Seq

Representing sequence, used to order the items in a drop list. Usually, items are first ordered by sequence then by code. Not all droplists will utilize sequence, hardcoded logic may be substituted.

standardCode

Alternative code for a code/name set. standardCode is used by stored procedures, reports and views to assist in filtering results.

Active

Toggle to allow a code/name to be visible via the UI.

Frequently Asked Questions (FAQ)

For a list of frequently asked questions about the Campus Attribute Standard, see the Campus Attribute Standard FAQ article.