Classic View: System Administration > Data Utilities > Data Extract Utilities > Data Extract Zip Tool
Search Terms: Data Extract Zip Tool
The Data Extract Zip Tool functions like the Utility Setup tool, where users can upload a file to export to a third-party system. Unlike the Utility Setup tool, the Zip Tool allows users to upload more than one file to export to a third-party system.
Data Extract Zip Tool Definitions
The following table provides definitions of the data elements available in the Zip Tool Editor.
Field | Description |
|---|---|
Extract Instance Name | Description of the extract. |
Delivery Mode | Indicates how the extract is delivered.
|
| Student Photo Extract | Creates a zip file of the picture directory. Only files for students who have an enrollment record in the selected active school year are included in the file. When this is marked, the following is not available:
|
File Name | File name associated with the extract being generated. Often a third-party tool needs this name. |
| Append Date to Filename | When 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. |
Username | Username used to access the destination server. |
Password | Password used to access the destination server. |
Domain | An identification label, using a string of letters and numbers separated by periods, to name organizations and addresses on the internet and to define a realm of administrative autonomy in the internet. |
Server | A 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. |
| Port | Indicates the value required to connect to the server.
|
Path | Indicates the navigation path the user takes to find the server or files. This needs to be an absolute path and include the /upload indicator. |
| Error Notification | If marked, any errors that occur are sent to the Notifications area of Infinite Campus (see below) to all users within the user group selected in the User Group to Notify dropdown list. |
| User Group to Notify | This 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. |
| Select Instances to Include | Mark the file instances to include in the zip file. These options display every instance of extracts that were previously set up in the DEU Setup. |
| Test Connection | This button checks the connection to the entered server by attempting to write a 1-byte file to the location setup. When it is successful, a pop-up displays indicating the connection is good; when it is not successful, it provides the reason the connection failed. |
| Run Extract | This 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). |
| Data Extract Schedule | Lists the frequency, date, time and day of the week the extract runs. When this needs to stop for any reason, mark the Stop Automated Extract checkbox. When the Frequency value is set to Weekly or Monthly, the Start Time can only be between 10:00pm and 4:00am (2200 to 0400).
|
Create Zip Tool Extract
The creation of new extracts should be done by technical administrators only.
- Select New. A Detail Information section displays.
- Enter the Extract Instance Name.
- Choose the other necessary items for adding the extract by populating and marking the appropriate fields, as defined above.
- 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.
- The Test Connection button checks the connection to the entered server by attempting to write a 1-byte file to the location setup. When it is successful, a pop-up displays indicating the connection is good; when it is not successful, it provides 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).
Create a Student Photo Extract Zip Tool
- Select New. A Detail Information section displays.
- Enter the Extract Instance Name.
- Select the desired Delivery Mode.
- Mark the Student Photo Extract checkbox.
- Enter a File Name, Username, and Server.
- Choose the other necessary items for adding the extract by populating and marking the appropriate fields, as defined above.
- In the Data Extract Schedule, choose the desired Frequency.
- When using Monthly, choose the Start Date, Start Time, and the Day of Month on which the extract should run.
- When using Weekly, choose the Start Date, Start Time, and the Day of Week on which the extract should run.
- 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 generate the extract.
- The Test Connection button checks the connection to the entered server by attempting to write a 1-byte file to the location setup. When it is successful, a pop-up displays indicating the connection is good; when it is not successful, it provides 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).
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.
When the Student Photo Extract zip file has been successfully sent to the destination server, or there was an error, it is logged in Data Extract History.
