Page tree
Skip to end of metadata
Go to start of metadata

This article explains how to execute the importers from the docker host.

Requirements:

You must have:

  • SSDT Utils package installed and up-to-date
  • the district's compose project must be configured for USAS, USPS or both
  • Exports of USAS / USPS

Step-by-step guide

The import scripts below are destructive. When executed, the existing database for the project will be deleted. All information stored in the database will be deleted this includes all data, custom configuration options, installed modules etc.  You must not run these scripts in a district which already has data loaded, unless you intend to replace it.


  1. Navigate to the district's project to run the import
  2. The import scripts require environment variables to define the source and IRN to be imported.  You can use the same values for both USAS and USPS, if the files are in the same location.  Define the following environment variables as follows: 

    export IMP_IRN=999999
    export IMP_URL=ftp://username:password@vmsserver.example.org/
    export IMP_PATH=[.directory] 
  3. To import USAS, do: 

    /ssdt/prod/import-usas.sh

    If you prefer to execute the script in the background then:

    nohup /ssdt/prod/import-usas.sh &
  4. To import USPS, do: 

    /ssdt/prod/import-usps.sh

    If you prefer to execute the script in the background then:

    nohup /ssdt/prod/import-usps.sh &

Explanation

The import scripts assume that the district has been configured with the setup.sh script from /ssdt/prod.  The scripts do the following:

  • will automatically stop and remove any existing database and app containers for the district
  • create a new database container
  • launch the import utility.  This creates a temporary container for the importer and attaches to the database container.  The import process runs in the foreground and will tie up the console until completed
  • after completion, the temporary import container is removed and the app container started

After completion, the directory will contain log file(s) containing the entire import process.  You should review the logs to ensure successful complete and for errors which may need to be reviewed. 

Examples of typical USAS import errors

  • Invalid vendor data:  We're seeing lot of invalid data in the vendor import, such as invalid state abbreviations, postal codes containing a hyphen, missing primary names, etc.  These vendors will import and all YTD amounts will be correct because the transaction data will be associated to the vendor.  However, these vendors will need to be modified and their information updated.  The SSDT Post Import Vendor Report will generate a report of vendors that did not properly import that will aide in the cleanup process.  You can also filter the vendor grid for a primary name of "Template Vendor" to see which vendors did not import properly.

Data cleanup can be done in USAS-R, but if the data will be extracted from Classic again before a final production import, the district could opt to clean up the erroneous data in Classic and save themselves some data entry.

Examples of typical USPS import errors

Requesting SSDT Assistance Troubleshooting Errors

If the ITC and district cannot resolve import related errors, ITC staff can open a support request with the SSDT. Import logs can be securely transferred to the SSDT using the method described in Securely Send Files to SSDT for Support.

Post Import Recommendations

We recommend you immediately execute a backup after completing the import process. From the district's project directory do:

> /ssdt/script/backup-usas.sh

You will also want to review the post import procedures outlined for both USAS and USPS.  These documents can be found the in Appendix section of the online documentation.