Skip to content

Commit e374130

Browse files
authored
Update README.md
1 parent b718e10 commit e374130

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ Item types defined when uploading extracted data must validate the declarations
413413
Extracted data must be normalized.
414414

415415
- Null values: All fields without a value should either be omitted or set to null. For example, if an external system provides values such as "", -1 for missing values, those must be set to null.
416-
- Timestamps: Full-precision timestamps should be formatted as RFC3999 (`1972-03-29T22:04:47+01:00`), and dates should be just `2020-12-31`.
416+
- Timestamps: Full-precision timestamps should be formatted as RFC3399 (`1972-03-29T22:04:47+01:00`), and dates should be just `2020-12-31`.
417417
- References: references must be strings, not numbers or objects.
418418
- Number fields must be valid JSON numbers (not strings)
419419
- Multiselect fields must be provided as an array (not CSV)
@@ -453,9 +453,24 @@ $ echo '{}' | chef-cli fuzz-extracted -r issue -m external_domain_metadata.json
453453

454454
This will reach 'waiting for user input' stage. Wait there.
455455

456+
## Add your token as an environment variable:
457+
458+
Obtain a PAT-token from the Settings/Account tab of the devorg where you deploy your snapin, and export is at DEVREV_TOKEN
459+
456460
## Initialize the context of the sync:
457461

458-
To allow the cli to work in the context of that sync, you have to provide its identifying properties in an environment variable (replacing the values based on the logs of your running import)
462+
To allow the cli to work in the context of that sync, you have to provide its identifying properties in an environment variable.
463+
The recommended method is to run:
464+
```bash
465+
chef-cli ctx switch --env prod
466+
```
467+
468+
This will print the list of airdrop imports in the org. Select the one you like by running
469+
```bash
470+
$ eval $(chef-cli ctx switch --env --prod --id <the id you choose>); chef-cli ctx show
471+
```
472+
473+
If this method doesn't work, you can manually export the variable (replacing the values based on the logs of your running import):
459474

460475
```bash
461476
export AIRDROP_CONTEXT='{"run_id":"1","mode":"initial","connection_id":"x","migration_unit_id":"0716","dev_org_id":"DEV-1kA79wWrRR","dev_user_id":"DEVU-1","source_id":"07-16","source_type":"ADaaS","source_unit_id":"x","source_unit_name":"x","import_slug":"x","snap_in_slug":"x"}'
@@ -467,10 +482,6 @@ Or you can use the interactive helper of the cli:
467482
$ eval $(chef-cli ctx init); chef-cli ctx show > ctx.json
468483
```
469484

470-
## Add your token as an environment variable:
471-
472-
Obtain a PAT-token from the Settings/Account tab of the devorg where you deploy your snapin, and export is at DEVREV_TOKEN
473-
474485
## Use the local UI to create a recipe blueprint for your initial import:
475486

476487
`$ chef-cli configure-mappings --env prod`
@@ -490,6 +501,10 @@ where the options are:
490501
The first function of the local UI is to assemble a 'blueprint' for concrete import running in the test-org, allowing the mapping to be tested out and evaluated.
491502
After it is used for the import, the mappings become immutable, but the chef-cli UI offers a button to make a draft clone, which can be edited again for refinements.
492503

504+
If you are also creating devrev -> external sync, use
505+
506+
`$ chef-cli configure-mappings --env prod --reverse`, which enabled mapping in both directions.
507+
493508
## Use the local UI to create an initial domain mappings
494509

495510
The final artifact of the recipe creation process is the initial_domain_mappings.json, which has to embedded in the extractor.

0 commit comments

Comments
 (0)