Installation on Windows Server
For education entities that are using Ed-Fi either on virtual machines or physical hardware, the Windows Server installation path is recommended. You will need a configured, functioning instance of the Ed-Fi ODS API before continuning here. Please see https://www.ed-fi.org/what-is-ed-fi/ed-fi-technology/ for more information.
Provision a Windows Server (2008 R2 or higher) and install Information Internet Server with ASP.NET 4+ from Server Manager. Ensure the application has access to a Microsoft SQL Server database for Data Flow as well.
Obtain the Data Flow repository (master branch) from GitHub (https://github.com/schoolstacks/dataflow/archive/master.zip) and unzip on your local machine. Open in Visual Studio 2015. Right click on the DataFlow solution and click Restore NuGet packages. From the menu, click on Build and Build Solution.
Copy the built DataFlow.Web directory to the Windows Server in the IIS root (typically c:\inetpub\wwwroot).
Please define the following settings in App Settings and Connection Strings (found in web root \bin):
App Settings
| Key | Value |
|---|---|
| EncryptionKey | [random string of characters] |
| FileMode | Local |
| ShareName | [Local writable directory] |
| AllowTestCertificates | [true or false depending on environment] |
Connection Strings
| Key | Value |
|---|---|
| defaultConnection | Data Source=[server];Initial Catalog=[database];Persist Security Info=True;User ID=[user];Password=[password] |
| storageConnection | [Local writable directory] |
The first time the application will run will present the “Register” option below the Email and Password link. Click on this to register your administrative user.
Next, configure the application by entering your Ed-Fi ODS API server credentials. The base URL is the API endpoint in the format of https://[url]/api/v2.0/2017. Enter the API server key and secret. The Test API Connection will show if the information is correct. Below that is customization information if you’d like to add your organization’s branding to the dataflow.
Once, configured Data Flow should show a browser with schools configured in the API:
Copy the compiled DataFlow.Server.FileTransport, DataFlow.Server.ReportingCleanup and DataFlow.Server.TransformLoad projects to C:\janitors on the Windows Server. Edit each service's bin/[release mode]/[janitor name].config to reference the shared configuration in C:\inetpub\wwwroot\bin.
Open Administrative Tools and Task Scheduler. Use the "Create Task" option to create a scheduled task for each janitor (File Transport, Transform Load and Reporting Cleanup). Ensure the task can run whether user is logged on or not. Set a Trigger based on the time schedule each janitor should run (daily, daily with repeat per hour, weekly or monthly). Set an Action to run the [janitor name].exe, starting in the \bin directory of the janitor. Once OK is clicked, set a user to run the scheduled task.
Data Flow should now be configured to run on the Windows Server. Check the Application logs in the Data Flow Admin panel to ensure jobs are running successfully and/or to debug as needed.