Advanced Setup

Owned by Robin Rodrigue
Last updated: Aug 13, 2021 by Nora Kinal
6 min read



Overview

Overview

This section demonstrates how to configure the more advanced features supplied with the MSA Client. Some of the options may require assistance from Support.

Opening Advanced Setup

From the Admin and Maintenance tab, locate Advanced Setup.

Scheduled Jobs

This option allows you to create and schedule the triggering of re-occurring procedures. The jobs are a series of predefined tasks that can be scheduled to occur on a specific schedule.

  1. From the Admin and Maintenance tab, click on Advanced Setup. Then, select Scheduled Jobs.

  2. Click the Add button.
     

  3. Establish Scheduled Job information. Then, click Add Task.

    1. Description - Enter a description of the new Scheduled Job.

    2. Expected Period - Enter the Expected Period that the work schedule should be performed.

    3. Inactive - Select this option to make the Scheduled Job Inactive. 

    4. Agent Mode Schedule - Use the drop-down menu to establish a frequency and complete details in order for the process(es) to be executed without using the Windows Task Scheduler.

    5. In the event of a failed job, select the Email on Failure checkbox to send an email to notify the user(s) defined in System Settings > Email about the failed scheduled job.

  4. Select a task from the list. Then, click Ok.

  5. Configure additional task information where required.

    1. Backup Database - Select how to handle backups during the scheduled job. Then, click Ok.
      Note: If you choose to use a strong (AES) encryption password and forget your password, backups will be unusable. No password or database recovery is possible. 

    2. Check Alerts - No configurable settings.

    3. MySchoolApps.com Integration - No configurable settings.

    4. Export Data - Select the correct file to export during the scheduled job. Then, click Ok.
      Note: Exports must first be established in Exports. 

    5. Lookup-Not-Found Auto-Match - Select the check box to Update-Statistics Only (no auto-matching). Otherwise, the task will automatically apply and process confident matches during the scheduled job. Then. click Ok.

    6. Process Applications - Select which applications to process during the scheduled job. Then, click Ok.

    7. Recognize Scanned Batches - No configurable settings

    8. Run External Program - If you have an external program you run in conjunction with the MSA Client, complete the requested information. Then, click Ok.

    9. Run Report - Establish report configurations for the scheduled job.
      Report to Run - Use the drop-down menu to select a report from the list. Then, click Setup.
      Format - Select the format of the report.
      Options - Select one or more options to include when exporting the report.
      Run even if there is no data
      Run for each school in the school filter (*Not available for all reports)
      Save as File - Enter the filename and path on your local or network drive. Substitutions may be used in the file format [field!format] (Field may be Today, Yesterday, Tomorrow, SchoolNumber, SiteCode, SchoolName, or SchoolExportCode and standard .Net format codes can be used for "format").
      Send as Email Attachment - Enter the email address(es), Subject, and Body of the message to have the report emailed during scheduled jobs.

      Note: Report setup will vary depending upon the selected report.

  6. Select OK on the Edit Scheduled Job window to save the new scheduled job once you have established all tasks.

     

  7. Run the scheduled job by clicking Run Now.

     
     

Alert Types

The Alert Type maintenance section allows you to ignore specific system alerts.

  1. From the Admin and Maintenance tab, click on Advanced Setup. Then, select Alert Types.

  2. Select an Alert from the list and choose Ignore Alert.

     

  3. Enter a date to re-enable the ignored alert. Then, click Ok.

     

  4. Enter a reason for ignoring the alert the field provided. Then, click Ok.

     

Once you have made necessary changes, click Close in the Alert Type Maintenance window.

Test Databases

This option gives you the ability to create test databases. Test databases will create a copy of the current or another test database and allow you to perform test functions and see results prior to performing functions in the live database.

  1. From the Admin and Maintenance tab, click on Advanced Setup. Then, select Test Databases.

  2. Select Add New to create a new Test Database. If you would like to create a test database for an existing test database, select the database. Then, click Add New.

  3. If another database exists and has been selected, choose if you would like to create a new test database from the Live database or as a copy of the selected database. Then, click Ok.

  4. Enter a name for the Test Database. The system will back up the current database for use as a Test Database.

Advanced Test Database Options

You have the ability to Deploy a Specific Program Version of the software for testing purposes. For example, you may wish to run some tests on a newer release of the program prior to committing the latest version to the entire system.

  1. From the Test Database Maintenance tab, select the test database you would like to make program version changes.

  2. Click Deploy Specific Program Version and select an option.

    1. Check the web for latest - Allows you to run the test database in the latest public release.

    2. Upload a specific version from a file - Allows you to select a file from your local or network drive. Typically this would occur for private Beta release versions.

    3. Reset to using production version - Allows you to revert the test database from latest available or file-submitted version to the current "Live" version.


Once you have selected how you want to proceed, you will see a series of processes running while the selected Test Database is upgraded/downgraded. The changed program version will appear in the list.
When you are done creating Test Databases, click Close.

Exports

Exports allows you to configure specific data within Franklin for exporting.

  1. From the Admin and Maintenance tab, click on Advanced Setup. Then, select Exports.

  2. Click Add New to add a new export. 

  3. Choose which type of Export to add depending on your current school food system. Then, click Ok.
     

  4. Configure the export settings. Then, click Setup.
    Description - Assign a name to the export file.
    Export Type - Denotes the type of export (Not editable).
    Inactive - Place a checkmark in the box to make inactive.
    Automatically overwrite existing files - Automatically overwrites older export files.


  5. Establish an export path(s) on your local or network drive. The, click Ok.

    1. Lunchbox/Mosaic

    2. Cafe Enterprise

    3. WebSMARTT- Initial Application ID to use in export - This number is used to indicate apps which have been exported out of MSA. The app number will be added to the number entered here, i.e. 10,001, 10,010, 10,034.




  6. Click Apply in the Configure Export window. Then, click Test to ensure your export is working properly.

     

Export Settings

You may wish to export your settings to your local or network drive.

  1. From the Setup Exports tab, select the export and click Export Settings.

  2. Locate the path on your local or network drive and enter a filename. Then, click Save.



Import Settings

You may wish to import your settings from an exported file on your local or network drive.

  1. From the Setup Exports tab, select the export and click Import Settings.

  2. Locate the path on your local or network drive. Then, click Open.

  3. Follow Steps 4-6 above to complete the process.

External Plugins

External Plugins are a custom creation for functions such as imports, exports, or other custom settings. For more information, contact Support.

  1. From the Admin and Maintenance tab, click on Advanced Setup. Then, select External Plugins.

  2. You may choose to add, remove, or enable/disable a plugin. You can also check for upgrades for any plugins being utilized.
     

Custom Table Schemas

Custom Table Schemas work in conjunction with some external plugins. Custom Table Schemas allow you to install custom tables in SQL server. For more information, contact Support.

From the Admin and Maintenance tab, click on Advanced Setup. Then, select Custom Table Schemas.