Data Extract Utilities

As of June 30th, 2025, the Data Extract Utility PULL method has been discontinued. Impacts:

  • PULL .bat files previously created with the PULL Client tool (ExtractWizardHelper.bat a.k.a. exportWizard) no longer function. 
  • The PULL Client tool, which is used for authenticating into Infinite Campus, no longer functions correctly and results in a connection error for users still attempting to utilize this method.
  • On the Data Extract Utility screen within Infinite Campus, PULL mode has been renamed to Test Extract. The Test Extract button will continue to function.

It's important to note that customers using other delivery methods (SFTP, FTPS, SMB) have not been affected by this change.

Tool Search: Data Extract Utilities

The Data Extract Utilities tools provide an automated data extract tool for transferring data via a flat file from Infinite Campus servers. The tools can also upload Campus data into third-party software. 

The following tools are available within the Data Extract Utilities:

Screenshot fo Data Extract Utilites Editor.Data Extract Utilities Editor

See the Data Extract Utilities Tool Rights article for information on available tool rights for the Data Extract Utilities. 

Data Extract Utilities Editor

The following table provides definitions of the data elements available in the Data Extract Utilities Editor.

FieldDescription
Extract Instance NameThe name of the Extract.
Delivery ModeThe mode in which the extract will be delivered. Options are:
  • SMB
  • SFTP Legacy (Being Deprecated)
  • SFTP
  • FTPS
ServerThe IP Address of the server connecting to and uploading data from the Data Extract Utility. 
Frequency ScheduledLists the frequency the extract runs.
Extract ModeDisplays how the data will be extracted. Options are:
  • Ad Hoc
  • SQL
  • Prism
StoppedIndicates if the extract has been stopped from sending.
Last RunIndicates if the extract was generated successfully the last time the extract was run.
ActionsAllows the user to edit an extract or show the history of the extract.


Data Extract Tool

The Data Extract tool provides an automated data extract tool for transferring data via a flat file from Infinite Campus servers. This tool can also upload Campus data into third-party software. 

Data Extract Field Definitions

The following table provides definitions of the data elements available in the Data Extract Editor.

You can remove Social Security Numbers from reporting in the 3 default extracts by setting the parameter @includeSSN bit = 0

Your third-party SFTP server must allow list Campus IPs so traffic can pass. For more information, see this article. 

Field

Description

Admin/Vendor Provided Data
Delivery Mode

Indicates how the extract will be delivered. 

  • SMB - Server Message Block. This works with an operating system higher than Windows XP; used in Windows networks to allow resources such as files on one machine to be shared on other machines as if they were local.
  • SFTP Legacy (Being Deprecated) - Secure File Transfer Protocol.

    This is an outdated implementation of SFTP that does not support modern key exchange or cipher algorithms. Once this delivery mode is removed, users should transition to the other SFTP option as soon as possible to avoid disruptions.

  • SFTP - Secure File Transfer Protocol. An encrypted form of file transfer between a local system and any system on the network. This is an updated library that supports modern key exchange algorithms. 
  • FTPS - File Transfer Protocol Secured. An encrypted form of file transfer between a local system and any system on the network. This option also allows different encryption methods:
    • Implicit
    • Explicit
Server

The IP Address of the server connecting to and uploading data from the Data Extract Utility. 

Your third-party SFTP server must allow list Campus IPs so traffic can pass. For more information, see this article. 

Limited to 100 characters

PathThe location on the destination server where the file will be written. This needs to be an absolute path and include the / upload indicator.
UsernameThe username used to access the destination server.
PasswordPassword used to access the destination server.
Port (Default SFTP=22)

Indicates the Port value required to connect to the server.

  • SFTP default = 22
  • FTPS default = 990
SFTP Key Exchange
Only applicable if the SFTP Delivery Mode is selected.
Indicates you want to use the SFTP Key Exchange for this extract.

If you leave the Password field blank, your extract will exclusively authenticate through passwordless SFTP Key Exchange. If you leave the Password field filled in, your extract can fail over to authenticating with username/password authentication in the event your SFTP Key Exchange authentication has an issue.
See the Data Extract Utility SFTP Key Exchange Manager article for more information on this option and process.
SFTP Key Exchange Configuration
Only applicable if the SFTP Delivery Mode is selected and the SFTP Key Exchange checkbox is marked.
If a key pair has been properly configured and tested within the Data Extract Utility SFTP Key Exchange Manager, select the key to be used for authenticating this extract.

See the Data Extract Utility SFTP Key Exchange Manager article for more information on this option and process.
Delivery Configuration
Extract MethodAd Hoc - If choosing Ad Hoc, select any saved filter to which the user has rights. This option generates the same filter as in ad hoc and carries over the same restrictions. It must be completed in 5 minutes. When a user no longer has rights to a filter, the utility stops running on a schedule.

Ad hoc filters used by the Data Extract Utility are automatically scoped to data within the active year. This is the equivalent of running the ad hoc filter for the year marked as Active in School Year Setup.


SQL - Provides a text area to enter a SQL query. If choosing SQL, enter the text of the query used to generate the file.


Prism - Provides a text area to enter a Prism call. If choosing Prism, choose the Prism call for a PDF report and add the Prism information. This option requires a Firefox browser add-on of Convert Form Methods.

User Group to NotifyIf an error occurs while using Data Extract Utilities, this group will be notified via a Notifications message. To utilize this functionality, you must have the Error Notification checkbox marked.
Error Notification

If marked, any errors that occur will send a notification to the Notifications area of Infinite Campus to all users within the user group selected in the User Group to Notify dropdown list. 

screenshot of the notification area of Campus

Use Data WarehouseIf the district has a Data Warehouse, use that database instead of the live database.
File Information
Extract Instance NameThe name of the extract.
File Extension

Extension of the file.


CSV, HTML, TAB, TXT, and custom file extensions can be added through the Core Attribute Dictionary.

screenshot of adding file extensions to the data extract utility

Column Delimiter

Indicates how data in the file will be divided. Options are:

  • TAB - Uses the tab character to separate each of the columns used for storing data.
  • CSV - Comma-separated values file is used for data structured in lists.
  • Tilde (~) - Uses the tilde character (~) to separate each of the columns in the file used for data storage.
  • Vertical Bar (|) - Uses the vertical bar character (|) to separate each of the columns in the file used for data storage.
Output File NameThe file name as it will appear in the destination folder. Often, a third-party tool needs/requires this file name.
Character Set

Select the character encoding standard used in the file.

  • US-ASCII - The American Standard Code for Information is a common character encoding standard for electronic communication.
  • UTF-8 - The Unicode Transformation Format is a variable-width character encoding capable of encoding all valid code points in Unicode using one to four 8-bit bytes.
File Extract Format
Append Date to FilenameWhen selected, includes a date in the file, so as not to overwrite an existing file. Choose the format of the date, either the normal date format of yyyymmdd or date and time format of yyyymmddhhmmssSS. 

Include Header Rows?

When selected, a header row will be included as part of the file.

Include Double Quotes?

When selected, quotes around each piece of data in the column are included.

Data Extract Schedule
Data Extract Schedule

Lists the frequency, date, time, and day of the week the extract runs.

 

Frequency options include:

  • None
  • Daily
  • Weekly
  • Monthly
  • Yearly

If this needs to stop for any reason, mark the Stop Automated Extract checkbox.

Create a New Extract

The creation of new extracts should be done by technical administrators only.

  1. Select the New icon. 
  2. Select Extract and click Submit. The Detail Information section will appear.
  3. Enter the required fields.
  4. Choose the other necessary items for adding the extract by populating and marking the appropriate fields, as defined above.
  5. Click the Save icon when finished. You can modify the extract to determine when it should be generated. 

At this time, a user can select one of the available buttons to test the extract, test the connection to the database, or run the extract. Extracts will be displayed in a new window in the selected format. 

  • The Test Extract button generates the requested information by SQL or Ad hoc. Data is not written to the database or stored in any location.
  • The Test Connection button checks the connection to the entered server by attempting to write a 1-byte file to the location set up. If it is successful, there is a success ribbon displayed, and if it is unsuccessful, it will provide a pop-up with the reason the connection failed.
  • The Run Extract button runs and generates the extract, sends and stores the file where needed (in case of an issue when it is an auto-run extract).

Troubleshooting/Errors

ErrorExplanation
Unable to negotiate key exchange

(client: [list of supported algorithms] / server: diffie-hellman-group14-sha1,diffie-hellman-group-exchange-sha1)"
This error means the SFTP server your Campus site is trying to communicate with does not support new enough algorithms to work with the Data Extract Utility's latest SFTP mode. The issue is that the SFTP server you’re connecting to is only offering up these older key exchange algorithms when your Campus site’s Data Extract Utility client tries to communicate with it:
  • diffie-hellman-group1-sha1
  • diffie-hellman-group-exchange-sha1

SHA1 is now considered an insecure key exchange algorithm, so our latest SFTP implementation does not support it.


You will need to contact the third parties/individuals who administer this SFTP server and request that they update their server/SFTP software to support at least one of the more modern and secure key exchange algorithms mentioned in the "client:" part of the error message.


As soon as the SFTP server is updated to support any of the more secure key exchange algorithms, then you'll be able to use the latest SFTP mode for any connection currently receiving this error. Until this update occurs, you'll need to continue using the legacy SFTP mode.

Data Extract Zip Tool

The Data Extract Zip tool functions like the Data Extract tool, where users can upload a file to export to a third-party system. Unlike the Data Extract tool, the Zip Tool allows users to upload multiple files to export to a third-party system.

Screenshot of the Data Extract Zip editor.Data Extract Zip

Screenshot of the Data Extract Zip editor.Data Extract Zip

Data Extract Zip Tool Definitions

The following table provides definitions of the data elements available in the Zip Tool Editor.

Field

Description

Delivery Mode

Indicates how the extract is delivered. 

  • SMB - Server Message Block. This works with an operating system higher than Windows Xp; used in Windows networks to allow resources such as files on one machine to be shared on other machines as if they were local.
  • SFTP Legacy (Being Deprecated) - This is an outdated version of SFTP which will be deprecated in the future. Users should transition to the other SFTP option as soon as possible to avoid disruptions once this delivery mode is removed.
  • SFTP - Secure File Transfer Protocol. An encrypted form of file transfer between a local system and any system on the network.
  • FTPS - File Transfer Protocol Secured. An encrypted form of file transfer between a local system and any system on the network. This option also allows different encryption methods:

    • Implicit
    • Explicit
ServerA computer that provides client stations with access to files and printers as shared resources to a computer network. Can be an IP address or a server domain name.
PathIndicates the navigation path the user takes to find the server or files. This needs to be an absolute path and include the / upload indicator.
UsernameUsername used to access the destination server.
PasswordPassword used to access the destination server.
Port: (Default=22)

Indicates the value required to connect to the server.

  1. SFTP default = 22
  2. FTPS default = 990
SFTP Key Exchange
Only applicable if the SFTP Delivery Mode is selected.
Indicates you want to use the SFTP Key Exchange for this extract.

If you leave the Password field blank, your extract will exclusively authenticate through passwordless SFTP Key Exchange. If you leave the Password field filled in, your extract can fail over to authenticating with username/password authentication in the event your SFTP Key Exchange authentication has an issue.
See the Data Extract Utility SFTP Key Exchange Manager article for more information on this option and process.
SFTP Key Exchange Configuration
Only applicable if the SFTP Delivery Mode is selected and the SFTP Key Exchange checkbox is marked.
If a key pair has been properly configured and tested within the Data Extract Utility SFTP Key Exchange Manager, select the key to be used for authenticating this extract.

See the Data Extract Utility SFTP Key Exchange Manager article for more information on this option and process.
Delivery Configuration
Student Photo ExtractCreates a zip file of the picture directory. Only files for students with an enrollment record in the selected active school year are included.
When this is marked, the following is not available: 
  • Select Instance to Include section

Note: Photos are generated with a [personID].jpg naming convention. 

This is NOT available in State Edition. 
Select Extracts To Include

Mark the file instances to include in the zip file.

These options display every instance of extracts that were previously created.


This option is not available when the Student Photo Extract is selected.

User Group to NotifyThis group is notified via a Notifications message when an error occurs while using the Data Extract Zip tool. You must have the Error Notification checkbox marked to utilize this functionality. 
Error Notification

If marked, any errors that occur are sent to the Notifications area of Infinite Campus to all users within the user group selected in the User Group to Notify dropdown list.

screenshot of the bell icon

File Information
Extract Instance NameThe name of the extract.

Output File Name

File name associated with the extract being generated. Often a third-party tool needs this name.

File Extract Format
Append Date to FilenameWhen selected, includes a date in the file, so as not to overwrite an existing file. Choose the format of the date, either the normal date format of yyyymmdd or date and time format of yyyymmddhhmmssSS. 
Data Extract Schedule
Data Extract Schedule

Lists the frequency, date, time and day of the week the extract runs.


Screenshot of the data extract schedule

Frequency options include:

  • None
  • Daily
  • Weekly
  • Monthly 
  • Yearly

When this needs to stop for any reason, mark the Stop Automated Extract checkbox.

Create Zip Tool Extract

The creation of new extracts should be done by technical administrators only.

  1. Select New
  2. Select the Zip Extract option and click Submit.
  3. Enter the required fields.
  4. Choose the other necessary items for adding the extract by populating and marking the appropriate fields, as defined above.
  5. Click Save when finished. Additional modifications may be made to the extract to determine when the extract should be generated.

At this time, a user can select the available buttons to test the connection to the server or run the extract.

  1. The Test Connection button checks the connection to the entered server by attempting to write a 1-byte file to the location set up. If it is successful there is a success ribbon displayed and if it is unsuccessful it will provide a pop-up with reason connection failed.
  2. The Run Extract button runs and generates the extract, sends and stores the file where needed (in case of an issue when it is an auto-run extract).

Create a Student Photo Extract Zip Tool

  1. Select New.
  2. Select the Zip Extract option and click Submit. 
  3. Enter the required fields.
  4. Mark the Student Photo Extract checkbox.
  5. Choose the other necessary items for adding the extract by populating and marking the appropriate fields, as defined above.
  6. In the Data Extract Schedule, choose the desired Frequency. 
  7. Click Save when finished. Additional modifications may be made to the extract to determine when the extract should be generated. 

A user can select the available buttons to test the connection to the server or generate the extract.

  1. The Test Connection button checks the connection to the entered server by attempting to write a 1-byte file to the location set up. If it is successful, there is a success ribbon displayed, and if it is unsuccessful, it will provide a pop-up with the reason the connection failed.
  2. The Run Extract button runs and generates the extract, sends and stores the file where needed (in case of an issue when it is an auto-run extract).

When the Student Photo Extract zip file has been successfully sent to the destination server, or there was an error generating the zip file, it is removed from the app server. 

Data Extract History

The Data Extract History tool lists the available extracts that were run and whether they successfully completed or if there was an issue with completion. This is a read-only view and can be used for troubleshooting.

Screenshot of Data Extract Utilities editor with the Show History button.Show History
screenshot of the data extract historyData Extract History