Manage Integrations

The Manage Integrations screen is used to test, download, schedule, and send integration files for third party systems. You can create individual output files or create a batch of output files based on the information available in the Focus database. Integrations are installed with a SQL query added from the District Reports screen. Some of the integrations on your Focus site have been installed by Focus Support during implementation.

Creating a New Integration

1. In the Setup menu, click Manage Integrations.

On the left side of the screen, Create New is selected by default.

2. Enter a Title for the integration and click Create.

The new integration is added to the list on the left side of the screen and the setup fields for the integration are displayed.

3. Next to Output Location, click none set to enable the field for editing and then enter the output location for the file. This is usually a local directory.

4. Click Save.

5. To define the file transfer settings for the batch of files (if the files will be FTP'd to a vendor), click Edit next to Batch Transfer Settings.

6. Define the file transfer settings (typically provided by the vendor), and click Save.

If file transfer settings are defined for an individual file, then the settings for the individual file will override the batch file transfer settings.

Passwords are stored in plain text. Restrict View access to Manage Integrations to only those users who must have access.

Click the Test Connection button to test the FTP/SFTP settings and add the fingerprint to the server if it exists. A pop-up window will display indicating if the connection was successful or failed.

7. To schedule when the batch of files are output, click Edit next to Scheduled Execution.

8. Select the Run Time.

Typically, jobs should be configured to run at non-peak server load times.

9. Select the Weekdays the job will run.

10. Enter the Priority.

The priority dictates the order jobs are run if multiple jobs are set to run at the same time. The higher the number entered, the higher the priority.

11. Enter the Start Date.

12. If applicable, enter an End Date.

13. Enter an E-mail address to receive the results of the job in an email.

Multiple email addresses can be entered, separated by commas.

14. Click Save.

When the Scheduled Execution settings are defined for an integration, the job is available in Setup > Scheduled Jobs. The schedule settings can be viewed and modified. The Execution History for the job can also be viewed.

15. To zip the files in the batch, click No next to Zip Batch Output to enable the field for editing.

16. Select the check box and click Save.

17. To enter a name for the zipped file, click none set next to Zip File Name to enable the field for editing.

18. Enter the file name and click Save.

19. To enter any notes for the batch, click none set next to Batch Notes to enable the field for editing.

20. Enter the notes and click Save.

21. To select the files to be included in the batch, click Enable modification.

22. Select a report from the Add Report pull-down and click Add.

Only reports set up in District Reports are available for selection.

The file is added and is displayed in the table.

23. Continue adding additional files as needed.

24. Click Disable modification when finished adding files.

25. To edit the file name, click the Filename field, make the change, and click Save.

File names can be static or dynamic. Options for dynamic file names are as follows:

%district% = district number

%date:Ymd% = the date the file was generated

All PHP date formats are supported.

26. Click Edit Options to edit the output format and other options for the file.

27. After settings the options, click Save.

If report variables are being used, the variable values must be specified here.

28. To edit the transfer settings for an individual file, click Edit file transfer settings.

The individual file transfer settings will override the batch transfer settings.

29. Define the file transfer settings and click Save.

Click the Test Connection button to test the FTP/SFTP settings and add the fingerprint to the server if it exists. A pop-up window will display indicating if the connection was successful or failed.

Installing Pre-Existing Integrations

Focus provides pre-existing integrations that can be installed and customized.

1. On the left side of the screen, click Install.

The available integrations are listed on the screen.

2. Click Install next to the integration.

The integration is installed and is added to the list of integrations on the left side of the screen. The setup fields are displayed for customization, following the same procedure as creating a new integration.

Creating a New Integration from the Reports List

A new integration can also be created by clicking Install next to a report in the Reports list.

1. On the left side of the screen, click Reports.

A list of the reports set up in District Reports is displayed.

2. Click Install next to the report to set up as an integration.

The integration is installed, titled with the name of the report, and is added to the list of integrations on the left side of the screen. The setup fields are displayed for customization, following the same procedure as creating a new integration.

Generating Files

Files in an integration can be manually generated, either individually or as a batch.

1. Click the integration on the left side of the screen if not already opened.

2. To generate an individual file, click Generate next to the file, or click Generate all files in this batch to generate all the files.

To only generate certain files, select the check box next to each file before clicking Generate all files in this batch.

A green check mark will display in the Generate column if the file was generated successfully. A red X will display if there were errors in generating the file.

3. Click the icon in the Download column to download the file for review.

Uninstalling a Batch

Uninstalling the batch will completely remove the integration, including all settings associated with it.

1. Click the integration on the left side of the screen if not already opened.

2. Click Uninstall this batch.

3. In the confirmation message, click OK.