Skip to main content

Archive Configurations

Important

Information and features vary according to the roles to which you belong and the permissions associated with those roles. For more information, contact your module manager or your campus support team.

The Archive Configuration page lets you determine what J1 data is automatically and consistently archived. Archiving data improves performance when running reports and queries, and reduces the need to sort and scroll through old data. Your school can determine how many years of data you want to retain in the live table/windows for each data subcategory.

Cleanup configurations within the J1 Desktop Archive Configuration window allow administrators to configure the automatic deletion of old data from the live table for specific subcategories. Deleting old data cleans up the live table and helps improve performance for J1 Desktop and certain J1 Web functions. Administrators can use cleanup configurations to determine how long old data is retained in the live table before it is deleted for each data subcategory.

The Archive Process SQL Agent Job is enabled by default and runs at a time set by the DSU (late Saturday night). The job runs the main stored procedure EXArchiveProcess and then the other stored procedures (EXArchive_xxxxxx) to execute specific archive processes.

For example, EXArchive_EXInternetSubmissions for the "Internet Submissions" selection and EXArchive_EXWebApplicationServices for the "Web Data" selection on the Archive Configuration window.

For each table being archived, the DSU creates, and delivers the following for processing (does not apply to cleanup configurations):

  • A copy of the live table with the name ARCHIVE_xxxxxx, where xxxxxx is the name of the live table, and adds an ARCHIVE_DATE column that shows the date and time of the archive.

  • A new associated view called ALL_xxxxxx, where xxxxxx is the name of the live table. These views UNION the data from the live table and the archive versions of the table.

  • An associated set of EXArchiveCategoryDef and EXArchiveConfiguration table rows that detail the configurable settings available on the Archive Configuration page.

To manage archive configurations, you must belong to a role with the Can manage archive configurations permission enabled. Jenzabar provides this permission with the System Administration role, but your school may have created a customized version of it.

Archive configurations can also be managed using the Desktop's Archive Configuration window. Changes made in J1 Web are saved in Desktop, and vice versa.

Archive configurations are stored in the EXArchiveConfiguration table. Archived data is not stored in this table.

  1. From the Archive Configuration for Category drop-down, select the data category you want to update. The data subcategories appear.

  2. For the data subcategory you want to update, click the Edit icon. The Edit pop-up window appears.

    Warning

    J1 Web Calendar Cleanup, Delete obsolete Section Schedule Calendar rows and Delete obsolete Unavailable Calendar timeslots are the only subcategories that delete data instead of archiving it.

  3. In the Value field, enter:

    • For archive configurations, enter Y if you want the data to be archived from the live table and N if you want the the old data to remain in the live table and not be archived

    • For clean up configurations, enter Y if you want to delete old data and N if you want old data to remain in the table

    • For each "[Unit of time] to retain" listing with a corresponding "Y" entry, enter the amount of time you want to keep or delete the data from the live table. For example, if a subcategory description specifies "Years to retain", you would enter '1' in the Value column to retain that data for 1 year. The numeric value must be at least 1, and decimals are allowed

  4. For each data subcategory that will be archived, enter in the Value column of the "[Unit of time] to retain" row the amount of time you want to keep that data in the live table. For example, if a subcategory description specifies “Years to retain”, you would enter ‘1’ in the Value column to retain that data for 1 year. The numeric value must be at least 1, and decimals are allowed.

  5. Click Update.

  1. Select the checkboxes next to the rows you want to export.

  2. From the Options drop-down, select Download to Excel. The Download to Excel pop-up opens.

  3. Select options for the Excel format and data columns.

  4. Click Download. Your .xlsx or .zip file is saved in the file location that you have set in your browser settings.