Table of Contents |
---|
...
Stage Number | Stage | Category | Summary | Environment | Iterations | Estimated Person Time | Estimated Computer Time |
---|---|---|---|---|---|---|---|
1 | Import and parse reference dataset (Optional) | Parsing | This 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. | Once per Bulk Loader process | 1 hour | 10 minutes | |
2 | Import, parse and filter source dataset | Parsing | Import the dataset destined for the EAS. Parse and filter the set. | Once per Bulk Loader process | 90 minutes | 15 minutes | |
Geocode and filter | Geocoding | Geocode the set and filter further based on the geocoder score and status. | ArcMap | Once per Bulk Loader process | 1 hour | 5 minutes | |
4 | Export full set (single batch) or subset (multiple batches) | Geocoding | For large datasets, create one of many subsets that will be run through the Bulk Loader in multiple batches. | ArcMap | One or more batches for each Bulk Loader process | 30 minutes per batch | 5 minutes per batch |
5 | Bulk Load batch (full set or subset) | Bulk Loading | Run the entire batch or each subset batch through the Bulk Loader. | One or more batches for each Bulk Loader process | 1 hour per batch | 5 minutes per batch | |
6 | Extract results | Bulk Loading | Extract 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 / pgAdmin | One or more batches for each Bulk Loader process | 1 hour per batch | 5 minutes per batch |
7 | Cleanup and Restoration | Bulk Loading | Clean up database, restore services and in the event of a failure, restore from backup. | PostgreSQL / pgAdmin | One or more batches for each Bulk Loader process | 1 hour per batch | 5 minutes per batch |
...
Anchor | ||||
---|---|---|---|---|
|
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.
...
Anchorstage3 stage3
Stage 3 - Geocode and filter
stage3 | |
stage3 |
-
Step 3.1 - Geocode source dataset
...
Anchorstage4 stage4
Stage 4 - Export shapefile - full set (single batch) or subset (multiple batches)
stage4 | |
stage4 |
Note | ||
---|---|---|
| ||
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:
For medium-to-large datasets (input sets with over 1,000 records) it is recommended that the Bulk Loading process be run in batches over several days or weeks. Reminder! It is required that the process first be run on a development server to assess the implications of the operation. The remaining steps will document a single batch iteration. Repeat these steps in a multi-batch process. |
...
e.g. R:\Tec\..\Eas\_Task\2018_2019\path\to\archive\bulkloader_process_YYYYMMDD\bulkloader\batch_002NNN\bulkload.shp
- Artifacts
- bulkload.shp - Shapefile for loading into the Bulk Loader in the next stage.
Anchorstage5 stage5
Stage 5 - Run the Bulk Loader
stage5 | |
stage5 |
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.1 - Disable front-end access to EAS
- Notify relevant recipients that the Bulk Loader Process is starting
Disable web service on
<environment>_WEB
(SF DEV WEB, SF QA WEB, SF PROD WEB)Code Block language bash linenumbers true cd /var/www/html sudo ./set_eas_mode.sh MAINT
- Browse to web site, http://eas.sfgov.org/, to confirm the service has stopped. (Expect to see message that EAS is currently out of service.)
...
Halt Services
Warning title Reason for halting services These steps are being performed to facilitate immediate roll-back of the EAS database if the Bulk Load Process ends in failure
SKIP
Turn off the replication serverDisable database replication by shutting down the database service on the replication server (DR PROD DB).Code Block language bash title Stop PostgreSQL linenumbers true sudo#sudo -u postgres -i #/usr/pgsql-9.0/bin/pg_ctl -D /data/9.0/data stop
Turn off downstream database propagation service(s)
Suspend downstream replication to internal business system database (SF PROD WEB).
Code Block language text title stop xmit linenumbers true sudo /var/www/html/eas/bin/xmit_change_notifications.bsh stop
- Backup Database
- Make a backup of the EAS database
- See also Backup the EAS Databases
- Make a backup of the EAS database
...
Connect to the database,
<environment>_DB
, and clear any leftover records from previous Bulk Loader batches.Code Block language sql title TRUNCATE linenumbers true TRUNCATE bulkloader.address_extract, bulkloader.blocks_nearest;
Code Block language sql title VACUUM linenumbers true VACUUM FULL ANALYZE bulkloader.address_extract;
Code Block language sql title VACUUM linenumbers true VACUUM FULL ANALYZE bulkloader.blocks_nearest;
Make note of EAS record counts before the Bulk Loading operation.
Code Block language sql firstline 1 title Record Counts linenumbers true SELECT schemaname,relname,n_live_tup FROM pg_stat_user_tables ORDER BY schemaname,relname,n_live_tup
- Save results in artifact as record_counts_before.csv
- Also save results in Excel spreadsheet artifact as bulkloader BulkLoader_resultsProcess_YYYYMMDD.xlsx(TODO provide path to a template)
Make note of the database partition size on the file system at the current point in time.
Code Block language bash firstline 1 title disk usage linenumbers true date; df /data # 1st of 3
...
Make note of the database partition size on the file system at this point. Compare with size of partition prior to loading to get the total disk space used as a result of running the Bulk Loader.
Code Block language bash firstline 1 title disk usage linenumbers true date; df /data # 2nd of 3
Make note of EAS record counts after the Bulk Load operation.
Code Block language sql firstline 1 title Record Counts linenumbers true SELECT schemaname,relname,n_live_tup FROM pg_stat_user_tables ORDER BY schemaname,relname,n_live_tup
- Save results as artifact record-_counts-_after.csv
- Also save results in Excel spreadsheet artifact as bulkloader BulkLoader_resultsProcess_YYYYMMDD.xlsxxlsx
In the spreadsheet, calculate the difference between the 'before' and 'after' record counts. The results will indicate the number of new base addresses added to the table `public.address_base` and the number of new addresses and units added to the table `public.addresses`.
See dedicated Bulk Loader page, Running the Bulk Loader, for more analysis options.
Anchorstage6 stage6
Stage 6 - Extract results
stage6 | |
stage6 |
-
Step 6.1 - Archive exceptions
...
- Get the unique EAS
change_request_id
created by the Bulk Load operation. The value of<change_request_id>
will be used in the next steps to count addresses added to the EAS.Query the
'public.change_requests'
table for the new'change_request_id'
value.Code Block language sql firstline 1 title change_request_id linenumbers true SELECT change_request_id FROM public.change_requests WHERE requestor_comment LIKE 'bulk load change request' ORDER BY change_request_id DESC LIMIT 1;
- Save the file in the network folder dedicated to artifacts for the Bulk Loader iteration.
- For example,
R:\Tec\..\Eas\_Task\path\to\archive\bulkloader_YYYYMMDD\bulkloader\batch_002NNN\change_request_id.csv
- For example,
- Artifacts
- change_request_id.csv - The unique EAS change_request_id created by the Bulk Load operation.
...
- Get all the address records (including units) added to the EAS during the Bulk Loader operation..
Query the
public.addresses
table on the newchange_request_id
value.Code Block language sql firstline 1 title addresses linenumbers true SELECT * FROM public.addresses WHERE activate_change_request_id = <change_request_id>;
- Save the file in the network folder dedicated to artifacts for the Bulk Loader iteration.
- For example,
R:\Tec\..\Eas\_Task\path\to\archive\bulkloader_YYYYMMDD\bulkloader\batch_002NNN\addresses.csv
- For example,
- Extract sample unit address from the output
- Pick a random record from the results where unit_num is not NULL. Gather the value in the address_base_id field.
- Construct a URL from this value like this: http://eas.sfgov.org/?address=NNNNNN
- Where NNNNNN is the value from the address_base_id field.
- Make note of this URL for use in Step 7 when testing EAS after services are restored.
- Artifacts
- addresses.csv - All the address records (including units) added to the EAS during the Bulk Loader operation.
...
- Get all the base records added to the EAS during the Bulk Loader operation.
Query the
public.address_base
table on the newchange_request_id
value.Code Block language sql firstline 1 title address_base linenumbers true SELECT activate_change_request_id, address_id, public.address_base.* FROM public.address_base, public.addresses WHERE public.address_base.address_base_id = public.addresses.address_base_id AND public.addresses.address_base_flg = TRUE AND public.addresses.activate_change_request_id = <change_request_id>;
- Save the file in the network folder dedicated to artifacts for the Bulk Loader iteration.
- For example,
R:\Tec\..\Eas\_Task\path\to\archive\bulkloader_YYYYMMDD\bulkloader\batch_002NNN\address_base.csv
- For example,
- Extract sample base address from the output
- Pick a random record from the results. Gather the value in the address_base_id field.
- Construct a URL from this value like this: http://eas.sfgov.org/?address=NNNNNN
- Where NNNNNN is the value from the address_base_id field.
- Make note of this URL for use in Step 7 when testing EAS after services are restored.
- Artifacts
- address_base.csv - All the base records added to the EAS during the Bulk Loader operation.
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
date; df /data # 3rd of 3
# Optional step: archive output to 'df.txt' artifact
exit |
-
Step 7.2 - Clean automation machine
...
- If the Bulk Loader failed and corrupted any data then restore from the database backup.
- Follow these steps to restore from backup.
-
Step 7.4 - Restore Services (
Non-production Only)
- TODO: Remove this step if nothing to populate with
- Step 7.5 - Restore Services (
Production Only)
- SKIP
Turn on production-to-replication serviceRe-enable database replication by restarting the database service on the replication server (DR PROD DB).Code Block language bash title Stop PostgreSQL linenumbers true sudo#sudo -u postgres -i #/usr/pgsql-9.0/bin/pg_ctl -D /data/9.0/data start
SKIP
Turn on downstream database propagation service(s)Resume downstream replication to internal business system database (SF PROD WEB).Code Block language text firstline 1 title start xmit sudo#sudo /var/www/html/eas/bin/xmit_change_notifications.bsh start
-
6
Step 7.Anchor step7.5 step7.5 5 - Enable front-end access to EAS
Enable web service on
<environment>_WEB
(SF DEV WEB, SF QA WEB, SF PROD WEB)nable front-end access to EAS
ReviewCode Block language bash linenumbers true cd /var/www/html sudo ./set_eas_mode.sh LIVE
exit
Browse to website, http://eas.sfgov.org/, and review sample addresses gathered in Step 6.3 and Step 6.4
Notify relevant recipients that the Bulk Loader Process is complete
-
Step 7.
76 - Archive artifacts
Notes
Anchor | ||||
---|---|---|---|---|
|
...