Presentation is loading. Please wait.

Presentation is loading. Please wait.

6 th Annual Focus Users’ Conference Manage Integrations Presented by: Mike Morris.

Similar presentations


Presentation on theme: "6 th Annual Focus Users’ Conference Manage Integrations Presented by: Mike Morris."— Presentation transcript:

1 6 th Annual Focus Users’ Conference Manage Integrations Presented by: Mike Morris

2 Manage Integrations Agenda: Manage Integrations is a flexible interface for testing, downloading, sending and scheduling integration files for third-party systems. Installing Reports and Creating New Integrations Specifying File Output Location and Transfer Settings Scheduling Job Execution Specifying File Handling Options Modifying and Adding to Batches Generating Batch Files Viewing Integration Output Reviewing Scheduled Jobs and Execution History

3 Manage Integrations The information contained within any Integration should all be created as SQL- Based Custom Reports. Once a Report has been created, it will then be available in the Integration interface for installation. Installing Integrations via Custom Reports The new Integration will take the title of the Report. All district Custom Reports appear on the Reports tab. Select ‘Install’ to create the report as an integration.

4 Manage Integrations Installing Integrations via Custom Reports Once the Install button next to the report name is pressed, a new tab will appear at the top of the integrations interface that shares the name of that report. This is where integration details can be specified.

5 Manage Integrations The information contained within any Integration should all be created as SQL-Based Custom Reports. Once a Report has been created, it will then be available in the Integration interface for installation. Navigate to Manage Integrations under the Setup Menu in order to begin the process of installing the integration Installing Integrations via Custom Reports (continued) Selecting Create New Integration allows the user to specify a title for the integration and then install one or multiple reports under that title. Once titled, select Create to continue. After selecting Create, the integration will appear in a new tab represented by the title. In order to then add Reports to the integration batch, use the Enable Modification button and select the reports from the drop-down menu.

6 Manage Integrations In addition to the installation of Reports and the creation of New Integrations, Focus also has a number of pre-existing integration configurations stored under the Available Integrations tab. Installing Integrations via Custom Reports (continued) Once the Available Integrations tab has been selected, a series of existing integrations will be shown with Install buttons that can be used to install any of them and specify other file-handling details. Select the appropriate integration from the list and press Install. The newly installed integration will populate as a tab with that name at the top of the Manage Integrations interface.

7 Manage Integrations Once an Integration has been installed, the next step is to configure options related to the Output Location, Transfer Settings and Scheduled Execution if applicable. Specifying Integration Settings To select where the generated “integration-files” will be stored, the Output Location can be specified once the Integration has been installed. This may be done by clicking the Output Location field. Once the field is editable, specify the file path to the desired location on the server. Select the Save button once complete. Please note that if an invalid file path is specified, a Red X may populate during file generation.

8 Manage Integrations Once an Integration has been installed, the next step is to configure the options related to the Output Location, Transfer Settings and Scheduled Execution if applicable. Specifying Integration Settings Typically, all FTP/SFTP settings will be specified by the vendor that the integration is being written for. Specify the Username and Password for the location where the files are being transferred as well as the Protocol (FTP, FTPS, SFTP) and the Host and Port as provided by the vendor. In addition to specifying an Output Location for the file, if files need to be FTP’ed, Transfer Settings can also be specified. Once all of the proper values have been specified, select Save in order to save the File Transfer Settings.

9 Manage Integrations In addition to the configuration of the Output Location and Batch Transfer Settings, the integration can also be created with Scheduled Execution Settings, which will allow the job to run at a specified time and date(s) Specifying Integration Settings (Continued) If scheduling a job, the Runtime for the job can be specified. Typically jobs should be configured to run at non-peak server load time, and can be scheduled down to 15 minute increments. The days of the week for the job’s execution can also be specified. Click the boxes next to each day in order to indicate that the job should run that day. Uncheck any boxes for days on which the job should not run. A job Priority should be specified (500 is most important), as well as an End Date for the job (if applicable) and any email addresses that should receive notification as to the results of the job that is being scheduled. As each of the Integration settings is specified, they’ll appear at the top of the page next to their function:

10 Manage Integrations Configuring File Handling Options For each Report installed as part of an integration, File Options can be specified. Use the Edit Options button related to each of the reports in the batch to specify options for each Report. Among the options to be specified is the Output Format for the file, the option to Include Headers, Quote Fields and define Custom Headers and Field Delimiters (if using CSV). If Variables are being used, the values for the variables will need to be specified here. Define each of the options for the Reports in the batch, hitting Save after each one.

11 Manage Integrations Configuring File Transfer Options and Adding to the Batch For each Report installed as part of an integration, File Transfer Settings can be specified if different from the Batch as a whole. Additionally, more files can be added to the batch if necessary. If an individual file within the batch should have different file handling protocol than the batch itself, this can also be defined using the Edit File Transfer Settings field on the individual report. Should additional Reports need to be added to a batch, the Enable Modification field allows users to add those reports to an existing integration. Select the additional Reports to be added to the batch and hit ‘Add’. Once the report has been added to the batch, its options can be edited as with the previous report. The File Transfer Settings can then be specified using the same method as the previous transfer specifications.

12 Manage Integrations Generating Integrations and Viewing Output Once the Integration has been configured and the options for each report have been specified, the next step is to ensure that the Integration generates appropriately and to view the content in order to ensure that the proper records are being pulled by the report. Selecting Generate will attempt to run the report and save it to the Output Location specified. If the system is able to generate the job successfully, a ✔ will appear. If not, the system will populate an ✖, indicating that the generation was not successful. If the Integration was able to successfully generate, the Download field will populate with a button that allows users to view the output of the job in the file format that was specified. This output will appear with the headers or delimiters that were specified in the options.

13 Manage Integrations Scheduled Jobs and Execution History If the Integration that was created had any scheduled execution settings, those options can be viewed and edited via the Scheduled Jobs screen. For access, navigate to the Setup Menu and select Scheduled Jobs. Any Integrations that were scheduled as jobs can be viewed here, as well as the details related to the job itself. The Job Time, Priority, Day(s) and End Date are visible; as well as an Edit option where changes to these settings can be made. Navigating to the Execution History tab at top-left will show a history of the last 100 scheduled jobs to execute on that site. Selecting the View Output button will show how many results pulled in the report for each of the relevant schools, as well as instances in which no results were found.

14 Manage Integrations Questions? Mike Morris Software Trainer – Focus School Software mikem@focusschoolsoftware.com Phone: (727).388.9973 www.focusschoolsoftware.com Please be sure to complete the comment card for this session and enjoy the rest of the Users’ Conference!


Download ppt "6 th Annual Focus Users’ Conference Manage Integrations Presented by: Mike Morris."

Similar presentations


Ads by Google