letters

transcend-io · Aug 4, 2023 · 1072961 · 1072961
1 parent 05467de
commit 1072961
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -18,31 +18,31 @@
  - [vz-derive-integrations-from-data-flows](#vz-derive-integrations-from-data-flows)
  - [vz-derive-per-instance-integrations-from-data-flows](#vz-derive-per-instance-integrations-from-data-flows)
 - [Useful Commands](#useful-commands)
- - [Combine Legal CSV with Transcend Data Flows](#combine-legal-csv-with-transcend-data-flows)
+ - [A) Combine Legal CSV with Transcend Data Flows](#a-combine-legal-csv-with-transcend-data-flows)
  - [Required Environment Variables](#required-environment-variables)
- - [Combine Legal CSV with Transcend Cookies](#combine-legal-csv-with-transcend-cookies)
+ - [B) Combine Legal CSV with Transcend Cookies](#b-combine-legal-csv-with-transcend-cookies)
  - [Required Environment Variables](#required-environment-variables-1)
- - [Generate API keys to Synchronize Cross-Account Data](#generate-api-keys-to-synchronize-cross-account-data)
+ - [C) Generate API keys to Synchronize Cross-Account Data](#c-generate-api-keys-to-synchronize-cross-account-data)
  - [Required Environment Variables](#required-environment-variables-2)
- - [Delete API Keys Cross-Account](#delete-api-keys-cross-account)
+ - [D) Delete API Keys Cross-Account](#d-delete-api-keys-cross-account)
  - [Required Environment Variables](#required-environment-variables-3)
- - [Pull Shared Configuration from `0 - Data Mapping` Account](#pull-shared-configuration-from-0---data-mapping-account)
+ - [E) Pull Shared Configuration from `0 - Data Mapping` Account](#e-pull-shared-configuration-from-0---data-mapping-account)
  - [Required Environment Variables](#required-environment-variables-4)
- - [Transform `transcend.yml` to Remove Non-Syncing Fields](#transform-transcendyml-to-remove-non-syncing-fields)
+ - [F) Transform `transcend.yml` to Remove Non-Syncing Fields](#f-transform-transcendyml-to-remove-non-syncing-fields)
  - [Required Environment Variables](#required-environment-variables-5)
- - [Push a `transcend.yml` to All Accounts](#push-a-transcendyml-to-all-accounts)
+ - [G) Push a `transcend.yml` to All Accounts](#g-push-a-transcendyml-to-all-accounts)
  - [Required Environment Variables](#required-environment-variables-6)
- - [Pull a `transcend.yml` for Each Instance](#pull-a-transcendyml-for-each-instance)
+ - [H) Pull a `transcend.yml` for Each Instance](#h-pull-a-transcendyml-for-each-instance)
  - [Required Environment Variables](#required-environment-variables-7)
- - [Combining Configuration Cross-Instances into the `0 - Data Mapping` -> `Data Inventory` -> `Business Entities` table](#combining-configuration-cross-instances-into-the-0---data-mapping---data-inventory---business-entities-table)
+ - [I) Combining Configuration Cross-Instances into the `0 - Data Mapping` -> `Data Inventory` -> `Business Entities` table](#i-combining-configuration-cross-instances-into-the-0---data-mapping---data-inventory---business-entities-table)
  - [Required Environment Variables](#required-environment-variables-8)
- - [Pull Down Approved Data Flows to YAML Cross-Account](#pull-down-approved-data-flows-to-yaml-cross-account)
+ - [J) Pull Down Approved Data Flows to YAML Cross-Account](#j-pull-down-approved-data-flows-to-yaml-cross-account)
  - [Required Environment Variables](#required-environment-variables-9)
- - [Generate Cross-Instance List of Ad Tech & Site Tech](#generate-cross-instance-list-of-ad-tech--site-tech)
+ - [K) Generate Cross-Instance List of Ad Tech & Site Tech](#k-generate-cross-instance-list-of-ad-tech--site-tech)
  - [Required Environment Variables](#required-environment-variables-10)
- - [Generate Per-Instance List of Ad Tech Data Silos](#generate-per-instance-list-of-ad-tech-data-silos)
+ - [L) Generate Per-Instance List of Ad Tech Data Silos](#l-generate-per-instance-list-of-ad-tech-data-silos)
  - [Required Environment Variables](#required-environment-variables-11)
- - [Update the Consent Manager to Latest Cross-Instance](#update-the-consent-manager-to-latest-cross-instance)
+ - [M) Update the Consent Manager to Latest Cross-Instance](#m-update-the-consent-manager-to-latest-cross-instance)
  - [Required Environment Variables](#required-environment-variables-12)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -58,10 +58,10 @@ This package is distributed through npm and github package registries and assume
 If your codebase is typescript or javascript based, you can add this package as a dev dependency:
 
 ```sh
-# install locally with yarn
+# install the vz cli
 yarn add -D @transcend-io/vz-cli
 
-# install the cli as well
+# install the transcend cli as well
 yarn add -D @transcend-io/cli
 
 # default the cli to use US backend
@@ -71,7 +71,7 @@ export TRANSCEND_API_URL=https://api.us.transcend.io
 export TRANSCEND_API_KEY=FILL_ME
 
 # vz cli commands available within package
-yarn vz-combine-legal-csv \
+yarn vz-combine-legal-csv-data-flows \
  --legalCsv=/Users/test/Desktop/legal.csv \
  --dataFlowExportCsv=/Users/test/Desktop/data-flows.csv \
  --output=/Users/test/Desktop/output.csv
@@ -181,7 +181,7 @@ FIXME
 
 ## Useful Commands
 
-### Combine Legal CSV with Transcend Data Flows
+### A) Combine Legal CSV with Transcend Data Flows
 
 Combine legal's categorizations of vendors, combine those categorizations with what was in Transcend, and push those categorizations back into Transcend.
 
@@ -197,7 +197,7 @@ export LEGAL_FILE=/Users/test/Desktop/legal.csv
 export TRANSCEND_DATA_FLOWS_FILE=/Users/test/Desktop/data-flows.csv
 export COMBINED_TRANSCEND_DATA_FLOWS_FILE=/Users/test/Desktop/data-flows.csv
 export TRANSCEND_API_KEY=SECRET_FILL_ME
-yarn vz-combine-legal-csv --legalCsv=$LEGAL_FILE --dataFlowExportCsv=$TRANSCEND_DATA_FLOWS_FILE --output=$COMBINED_TRANSCEND_DATA_FLOWS_FILE
+yarn vz-combine-legal-csv-data-flows --legalCsv=$LEGAL_FILE --dataFlowExportCsv=$TRANSCEND_DATA_FLOWS_FILE --output=$COMBINED_TRANSCEND_DATA_FLOWS_FILE
 yarn tr-upload-data-flows-from-csv --auth=$TRANSCEND_API_KEY --file=$COMBINED_TRANSCEND_DATA_FLOWS_FILE --trackerStatus=LIVE
 ```
 
@@ -211,11 +211,12 @@ yarn tr-upload-data-flows-from-csv --auth=$TRANSCEND_API_KEY --file=$COMBINED_TR
 | `TRANSCEND_API_URL` | Transcend backend URL | string - url | false |
 | `TRANSCEND_API_KEY` | Transcend API key with scopes `Manage Cookies` | string - api-key | true |
 
-### Combine Legal CSV with Transcend Cookies
+### B) Combine Legal CSV with Transcend Cookies
 
 Combine legal's categorizations of vendors, combine those categorizations with what was in Transcend, and push those categorizations back into Transcend.
 
 Step 1) Download the CSV of data flows that you want to edit from the Admin Dashboard under [Consent Manager -> Cookies](https://app.transcend.io/consent-manager/cookies). You can download cookies from both the "Triage" and "Approved" tabs.
+
 Step 2) Run CLI commands:
 
 ```sh
@@ -238,7 +239,7 @@ yarn tr-upload-cookies-from-csv --auth=$TRANSCEND_API_KEY --file=$COMBINED_TRANS
 | `TRANSCEND_API_URL` | Transcend backend URL | string - url | false |
 | `TRANSCEND_API_KEY` | Transcend API key with scopes `Manage Cookies` | string - api-key | true |
 
-### Generate API keys to Synchronize Cross-Account Data
+### C) Generate API keys to Synchronize Cross-Account Data
 
 This command will generate a JSON file (at ./working/api-keys.json) containing a list of API Keys for each Transcend instance. The API keys have the minimal set of permissions required to synchronize data across all Transcend instances for your account. Each API key will have the same title. These API keys will be available under Infrastructure -> API Keys.
 
@@ -261,7 +262,7 @@ yarn tr-generate-api-keys --email=$TRANSCEND_EMAIL --password=$TRANSCEND_PASSWOR
 | `TRANSCEND_EMAIL` | Your email address that you use to log into Transcend | string - email | false |
 | `TRANSCEND_PASSWORD` | The password you use to log into Transcend | string - password | true |
 
-### Delete API Keys Cross-Account
+### D) Delete API Keys Cross-Account
 
 If you need to delete the API keys generated by the above command, this command can be run to delete API keys across all instances that have a specific title. If you decide to run any cli commands on a CI, you can use these commands to establish a process to cycle API keys.
 
@@ -284,7 +285,7 @@ yarn tr-generate-api-keys --email=$TRANSCEND_EMAIL --password=$TRANSCEND_PASSWOR
 | `TRANSCEND_PARENT_ORGANIZATION_ID` | The ID of the parent organization that has child organizations that need API keys generated for. | string - uuid | false |
 | `TRANSCEND_PASSWORD` | The password you use to log into Transcend | string - password | true |
 
-### Pull Shared Configuration from `0 - Data Mapping` Account
+### E) Pull Shared Configuration from `0 - Data Mapping` Account
 
 There are some consistent settings that we will apply across all Transcend instances. The set of resource settings that can be pulled can be found here. The resources listed in the command below can be pulled and synced into other instances to enforce a consistent configuration across the privacy request in order to:
 
@@ -305,7 +306,7 @@ yarn tr-pull --auth=$TRANSCEND_API_KEY --resources=attributes,identifiers,consen
 | `TRANSCEND_API_URL` | Transcend backend URL | string - url | false |
 | `TRANSCEND_API_KEY` | Transcend API key with scopes `Manage Data Flows` | string - api-key | true |
 
-### Transform `transcend.yml` to Remove Non-Syncing Fields
+### F) Transform `transcend.yml` to Remove Non-Syncing Fields
 
 There are some resources that should not be synced in full from the 0 - Data Mapping instance into the other instances. This command removes the values that should not be synced.
 
@@ -320,7 +321,7 @@ yarn vz-transform-from-parent-for-children --file=$TRANSCEND_YAML
 | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | --------- |
 | `TRANSCEND_YAML` | Transcend yml file format, defined by [`Transcend Input`](https://github.com/transcend-io/cli/blob/d40546cdfd76639ad1c950f913ca9b426a97895f/src/codecs.ts#L749) | string - file-path | false |
 
-### Push a `transcend.yml` to All Accounts
+### G) Push a `transcend.yml` to All Accounts
 
 Once you have a configuration file that encodes the settings that should be set consistently across all instances, you can run
 
@@ -339,7 +340,7 @@ yarn tr-push --auth=$TRANSCEND_API_KEYS_PATH --file=$TRANSCEND_YAML
 | `TRANSCEND_YAML` | Transcend yml file to push. Format defined by [`Transcend Input`](https://github.com/transcend-io/cli/blob/d40546cdfd76639ad1c950f913ca9b426a97895f/src/codecs.ts#L749) | string - file-path | false |
 | `TRANSCEND_API_KEYS_PATH` | Path to the JSON file holding the API keys for each instance. This file can be created in section "Generate API keys to Synchronize Cross-Account Data" | string - file-path | false - file contents are secret (should be git-ignored) |
 
-### Pull a `transcend.yml` for Each Instance
+### H) Pull a `transcend.yml` for Each Instance
 
 If you need to pull the configuration files for all associated Transcend instances, you can do so using the following command:
 
@@ -358,7 +359,7 @@ yarn tr-pull --auth=$TRANSCEND_API_KEYS_PATH --file=$TRANSCEND_YAML_FOLDER --res
 | `TRANSCEND_YAML_FOLDER` | A folder where the `transcend.yml` files will be written. Each file will be named `<instance name>,.yml` | string - file-path | false |
 | `TRANSCEND_API_KEYS_PATH` | Path to the JSON file holding the API keys for each instance. This file can be created in section "Generate API keys to Synchronize Cross-Account Data" | string - file-path | false - file contents are secret (should be git-ignored) |
 
-### Combining Configuration Cross-Instances into the `0 - Data Mapping` -> `Data Inventory` -> `Business Entities` table
+### I) Combining Configuration Cross-Instances into the `0 - Data Mapping` -> `Data Inventory` -> `Business Entities` table
 
 Take the output of each Transcend instance and combine them into a single YML file to sync into the `0 - Data Mapping` [Business Entities](https://app.transcend.io/data-map/data-inventory/business-entities) table in the Transcend dashboard. This view allows for a summarization of various information across all Transcend instances.
 
@@ -384,7 +385,7 @@ yarn tr-push --auth=$TRANSCEND_API_KEY --file=$COMBINED_TRANSCEND_BUSINESS_ENTIT
 | `TRANSCEND_API_URL` | Transcend backend URL | string - url | false |
 | `TRANSCEND_API_KEY` | Transcend API key with scopes `Manage Data Flows` | string - api-key | true |
 
-### Pull Down Approved Data Flows to YAML Cross-Account
+### J) Pull Down Approved Data Flows to YAML Cross-Account
 
 Pull down list of all data flows that are approved
 
@@ -403,7 +404,7 @@ yarn tr-pull --auth=$TRANSCEND_API_KEYS_PATH --file=$TRANSCEND_YAML_FOLDER --res
 | `TRANSCEND_YAML_FOLDER` | A folder where the `transcend.yml` files will be written. Each file will be named `<instance name>,.yml` | string - file-path | false |
 | `TRANSCEND_API_KEYS_PATH` | Path to the JSON file holding the API keys for each instance. This file can be created in section "Generate API keys to Synchronize Cross-Account Data" | string - file-path | false - file contents are secret (should be git-ignored) |
 
-### Generate Cross-Instance List of Ad Tech & Site Tech
+### K) Generate Cross-Instance List of Ad Tech & Site Tech
 
 Create a single export of ad tech and site tech across all Transcend instances.
 
@@ -416,7 +417,7 @@ FIXME
 
 #### Required Environment Variables
 
-### Generate Per-Instance List of Ad Tech Data Silos
+### L) Generate Per-Instance List of Ad Tech Data Silos
 
 1. Pull down the data flows and cookies across all instances
 2. Determine the set of Data Silos for that instance by looking at the services tied to each data flow and cookie
@@ -427,7 +428,7 @@ FIXME
 
 #### Required Environment Variables
 
-### Update the Consent Manager to Latest Cross-Instance
+### M) Update the Consent Manager to Latest Cross-Instance
 
 Use this command to update each consent manager to the latest version, and deploy all active changes. Please be careful using this command, as it will deploy any outstanding changes since the last deploy.
 

diff --git a/yarn.lock b/yarn.lock
@@ -514,7 +514,7 @@ __metadata:
  typescript: ^5.0.4
  yargs-parser: ^21.1.1
  bin:
- vz-combine-legal-csv: ./build/cli-combine-legal-csv.js
+ vz-combine-legal-csv-data-flows: ./build/cli-combine-legal-csv-data-flows.js
  languageName: unknown
  linkType: soft