zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-08-13 04:59:59 +02:00
Code Issues Projects Releases Packages Wiki Activity

doc update

Browse source
This commit is contained in:
zandercymatics 2024-09-12 08:23:10 -06:00
parent cf0671ef20
commit f2c4897419
No known key found for this signature in database
GPG key ID: FF4636ABEC9682B7
1 changed files with 17 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/operations/data_migration.md
View file

@ -863,10 +863,17 @@ Example: `cf ssh getgov-za`
## Create federal portfolio ## Create federal portfolio
This script takes the name of a `FederalAgency` (like 'AMTRAK') and does the following: This script takes the name of a `FederalAgency` (like 'AMTRAK') and does the following:
1. Creates the portfolio record based off of data on the federal agency object itself 1. Creates the portfolio record based off of data on the federal agency object itself.
2. Creates suborganizations from existing DomainInformation records 2. Creates suborganizations from existing DomainInformation records.
3. Associates the SeniorOfficial record (if it exists) 3. Associates the SeniorOfficial record (if it exists).
4. Adds this portfolio to DomainInformation / DomainRequests or both 4. Adds this portfolio to DomainInformation / DomainRequests or both.
Errors:
1. ValueError: Federal agency not found in database.
2. Logged Error: No suborganizations found for agency.
3. Logged Warning: No new suborganizations to add.
4. Logged Warning: No valid DomainRequest records to update.
5. Logged Warning: No valid DomainInformation records to update.
### Running on sandboxes ### Running on sandboxes
@ -887,7 +894,7 @@ Example: `cf ssh getgov-za`
#### Step 5: Running the script #### Step 5: Running the script
```./manage.py create_federal_portfolio "{federal_agency_name}" --both``` ```./manage.py create_federal_portfolio "{federal_agency_name}" --both```
Example: `./manage.py create_federal_portfolio "AMTRAK" --parse_requests --parse_domains` Example (only requests): `./manage.py create_federal_portfolio "AMTRAK" --parse_requests`
### Running locally ### Running locally
@ -898,8 +905,9 @@ Example: `./manage.py create_federal_portfolio "AMTRAK" --parse_requests --parse
| | Parameter | Description | | | Parameter | Description |
|:-:|:-------------------------- |:-------------------------------------------------------------------------------------------| |:-:|:-------------------------- |:-------------------------------------------------------------------------------------------|
| 1 | **federal_agency_name** | Name of the FederalAgency record surrounded by quotes. For instance,"AMTRAK". | | 1 | **federal_agency_name** | Name of the FederalAgency record surrounded by quotes. For instance,"AMTRAK". |
| 2 | **both** | Optional. If True, runs parse_requests and parse_domains | | 2 | **both** | If True, runs parse_requests and parse_domains. |
| 3 | **parse_requests** | Optional. If True, then the created portfolio is added to all related DomainRequests. | | 3 | **parse_requests** | If True, then the created portfolio is added to all related DomainRequests. |
| 4 | **parse_domains** | Optional. If True, then the created portfolio is added to all related Domains. | | 4 | **parse_domains** | If True, then the created portfolio is added to all related Domains. |
Note: While you can specify both at the same time, you must specify either --parse_requests or --parse_domains. You cannot run the script without defining one or the other. Note: Regarding parameters #2-#3, you cannot use `--both` while using these. You must specify either `--parse_requests` or `--parse_domains` seperately. While all of these parameters are optional in that you do not need to specify all of them,
you must specify at least one to run this script.