Versions Compared

Old Version 108

changes.mady.by.user Dan King (Unlicensed)

Saved on

compared with

New Version 109

changes.mady.by.user Dan King (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: formatting

Table of Contents
Overview

...

Stage NumberStageCategorySummaryEnvironmentIterationsEstimated Person TimeEstimated Computer Time
1Import and parse reference dataset (Optional)ParsingThis optional step in the Bulk Loader process is to cross check an address for a match in a reference data set. If a source address is found in the reference dataset the address makes it to the next step. If not found the address is put aside in an exclusion set for later review.

Python 3

PostgreSQL / pgAdmin

Once per Bulk Loader process1 hour10 minutes
2Import, parse and filter source datasetParsingImport the dataset destined for the EAS. Parse and filter the set.

Python 3

PostgreSQL / pgAdmin

Once per Bulk Loader process90 minutes15 minutes

3

Geocode and filterGeocodingGeocode the set and filter further based on the geocoder score and status.ArcMapOnce per Bulk Loader process1 hour 5 minutes
4Export full set (single batch) or subset (multiple batches)GeocodingFor large datasets, create one of many subsets that will be run through the Bulk Loader in multiple batches.ArcMapOne or more batches for each Bulk Loader process30 minutes per batch5 minutes per batch
5Bulk Load batch (full set or subset)Bulk LoadingRun the entire batch or each subset batch through the Bulk Loader.

EAS <environment>(+)

PostgreSQL / pgAdmin

One or more batches for each Bulk Loader process1 hour per batch5 minutes per batch
6Extract resultsBulk LoadingExtract and archive the list of addresses that were added to the EAS . Also archive the unique EAS 'change request id' associated with this batch. Also archive the addresses that were rejected by the Bulk Loader in this batch.PostgreSQL / pgAdminOne or more batches for each Bulk Loader process1 hour per batch5 minutes per batch
7Cleanup and RestorationBulk LoadingClean up database, restore services and in the event of a failure, restore from backup.PostgreSQL / pgAdminOne or more batches for each Bulk Loader process1 hour per batch5 minutes per batch

...

Anchor
stage1
stage1
Stage 1 - Import and parse reference dataset (Optional)

This optional stage is run once per Bulk Loader process. This stage can be skipped if the reference dataset is already available or if the optional 'filter by reference' step (Step 2.5) is skipped.

...

Anchor
stage3
stage3
Stage 3 - Geocode and filter

  •  

    Step 3.1 - Geocode source dataset

...

Anchor
stage4
stage4
Stage 4 - Export full set (single batch) or subset (multiple batches)

Note
titleA Note note about Batchesbatches

Stages 4, 5 and 6 can be run one time with the results from Stage 3, or they can be run in multiple batches of subsets.

A major consideration of when to run the full set at once versus in batches is the number of records being Bulk Loaded.

The size of each Bulk Loader operation affects the following aspects of the EAS:

  • The disk space consumed by the database server
  • The EAS user interface section that lists addresses loaded in a given Bulk Loader operation
  • The weekly email attachment listing new addresses added to the EAS

For medium-to-large datasets (input sets with over 1000 1,000 records) it is recommended to run that the process first be run on a development server and to assess the implications of the operation. Where appropriate, perform the Bulk Loading process in batches over several days or weeks.

The remaining steps will document one a single batch example iteration of a multi-batch process.

...

Anchor
stage5
stage5
Stage 5 - Run the Bulk Loader

(info) For a complete set of steps and background about the Bulk Loader, see also Running the Bulk Loader, a page dedicated to its input, operation and results.

...

  •  

    Step 5.2 - Halt Services (production only)

Infowarning
titleReason for Halting Serviceshalting services

These steps are being performed to facilitate immediate roll-back of the EAS database if the Bulk Load Process ends in failure.

...

  1. Place EAS web application into maintenance mode

    • Place the Web servers into maintenance mode (SF PROD WEB, DR PROD WEB).


      Code Block
      languagebash
      titlePlace EAS web application into maintenance mode
      linenumberstrue
      cd /var/www/html
sudo ./set_eas_mode.sh MAINT


  2. Turn off the replication server

    • TODO: Add steps

  3. Turn off downstream database propagation service(s)

    • Suspend downstream replication to internal business system database (SF PROD WEB).

      Code Block
      languagetext
      titlestop xmit
      linenumberstrue
      sudo /var/www/html/eas/bin/xmit_change_notifications.bsh stop


...

Anchor
stage6
stage6
Stage 6 - Extract results

  •  

    Step 6.1 - Archive exceptions

Info
titleInfo about the 'address_extract' Tabletable

The Bulk Loader operation in Stage 5 populated an EAS table named 'address_extract' in the 'bulkloader' schema.

It populated the 'address_extract' table with every address it attempted to load.

If any errors occurred on a given address during the load, the Bulk Loader populated the 'exception_text' field with a description of the error.

...

  1. If the Bulk Loader Process was run on the production server then restore services
    1. Turn on production-to-replication service
      • TODO: add steps
    2. Turn on downstream database propagation service(s)

      • Resume downstream replication to internal business system database (SF PROD WEB).

        Code Block
        languagetext
        firstline1
        titlestart xmit
        sudo /var/www/html/eas/bin/xmit_change_notifications.bsh start


    3. Enable front-end access to EAS

      • Place the Web servers into live mode (SF PROD WEB, DR PROD WEB).

        Code Block
        languagebash
        linenumberstrue
        cd /var/www/html
sudo ./set_eas_mode.sh LIVE


...

Anchor
artifacts
artifacts
(**) Artifacts should be saved in a network folder dedicated to the entire instance of a given Bulk Loader process. Artifact names shown are suggestions. Note: For large datasets the entire process could be spread over many days or weeks. Take this into consideration when naming any artifacts and subfolders.

Development stack

(info) This is the stack used for the development and testing of the steps. For best results run the steps with a similar the same or compatible stack.

  1. Stages 1 and 2 (Parsing)
    1. Python 3 (3.6.4)
    2. PostgreSQL (10.3)
    3. pgAdmin (for executing raw SQL)
  2. Stages 3 and 4 (Geocoding)
    1. ArcMap (10.6.1)
  3. Stages 5 and 6 (Bulk Loading)
    1. EAS <environment>(+)
    2. PostgreSQL (10.3)

...