Import, Export, and Delete web properties from Adobe Expience Platform Tags, previously known as Launch.

This is a project to automates postman collections using the Reactor API. This project makes it easier to quickly import a Tag property into an Adobe Organization for demo purposes or if you are using the same Tag property across organizations. The collections are generic enough to run with without modifications.

• AEP Tag Tool
  • Overview
  • Installation
  • Command Line Tool
  • Usage
  • Export a Tag
    • Using the Export Collection without NPM:
  • Import a Tag
    • CEDRLP params
    • Using the Import Collection without NPM:
  • Delete tag properties that contain a specific string
  • Customize Settings for the Import
    • Extensions
    • Data Elements
    • Rules
  • Postman Collections

To install the command line tool globally, run:

npm install -g @knennigtri/aep-tag-tool

Export a tag property:

 aep-tag-tool --export -e myEnvironment.postman_environment.json -p PR12345678901234567890

Import a tag property:

 aep-tag-tool --import -e myEnvironment.postman_environment.json -f myConfig.json

Delete a tag properties that contain 2022 in the title

 aep-tag-tool --delete -e myEnvironment.postman_environment.json -s "2022"

aep-tag-tool -h
Usage: aep-tag-tool [ARGS]
 Arguments:
    --export                        Mode to export a given property ID
    --import                        Mode to import a property given a config file
    -C,-E,-D,-R,-L,-P               Options to partially import. See -h import
    --delete                        Mode to delete properties containing a specific string
    -f  <file>                      configuration file [json | yml]. See -h configFile
    -e  <postman_environment.json>  specify an environment file
    -g  <postman_globals.json>      specify a global file
    -p, --pid  <pid>                property ID. Req for export mode
    -s, --search  <str>             search string for properties to delete. Reg for delete mode
    -h, --help
               configfile           config file format
               export               how to use export mode
               import               how to use import mode
               delete               how to use delete mode
    -v, --version                   Displays version of this package

Export mode allows for a web property from AEP Tags to be exported as JSON. Exporting a tag will:

• create a configuration file with the same name as the property
• export extensions
• export data elements
• export rules and their rule components

Export mode requires:

-e <postman_environment.json> specify an environment file

-p, --pid <pid> property ID. Req for export mode

  aep-tag-tool --export -e myEnvironment.postman_environment.json -p PR12345678901234567890

Values can alternatively be set in a configuration file:

1. configFile.environment
2. configfile.propID

  aep-tag-tool --export -f myConfig.json

myConfig.json

{
  "environment": "path/to/myEnvironment.postman_environment.json",
  "propID": "PR12345678901234567890"
}

• Using Postman collection runner on folders - Learn how to use the Export Tag collection
• Using Newman to run the collection folders - See example export bash script

Running through the requests of this collection will create responses that need to be saved to use for Importing into other organizations. You will end up with 1 extensions.json, 1 data-elements.json, and n rulecmp-json files where n is the number of rules in your property

Import mode allows for an exported web property from AEP Tags to be imported into an Adobe organization. Import mode will:

• Create a new web property (configFile.propName)
  • Create a Host adn dev/stage/prod environments
• Add imported extensions (configFile.extensions)
• Create imported data elements (configFile.dataElements)
• Create imported rules (configFile.rules.*)
• Create a Library and publish it

You can optionally specify what to create/import/publish with the CEDRP parameters.

Importing into a different Adobe organization should be used with caution since many extension settings are specific to the Adobe organization they are exported from. These can be updated with a postman_globals.json file if needed. See Customize Settings for the the import.

Import mode requires:

-e <postman_environment.json> specify an environment file

-f <file> configuration [json | yml] file

Configuration [json | yml] file requires:

1. configFile.import.extensions
2. configFile.import.dataElements
3. configFile.import.rules.[rules]

You can specify exactly what you want to create/import/publish with these params. No matter the parameter order, they will always execute in the order below. Default is running all steps.

-C Creates a new property. configFile.import.propertyName is optional.

If -C is not used with the remaining parameters, propID is required.

• -E Imports extensions. configFile.import.extensions is required.
• -D Imports data elements. configFile.import.dataElement is required.
• -R Imports rule components. configFile.import.rules.[rules] is required.
• -L Builds a library of all items the Dev environment
• -P Publishes the library into Prod

• Using Postman collection runner on folders - Learn how to use the Import Tag collection
• Using Newman to run the collection folders - See example import bash script

Quickly delete web properties that might have been created with this tool. Delete mode allows you to search for web properties in an Adobe organization based on a search string. If any web properties contain the search string, they are deleted. This is particularly useful if you are developing your own property to import/export since all properties end with a timestamp. Searching (-s) for 2022-10-25 would delete MyProperty 2022-10-25T20:57:42.049Z, MyProperty 2022-10-25T21:57:42.049Z, and MyProperty 2022-10-25T20:58:42.049Z.

Delete mode requires:

-e <postman_environment.json> specify an environment file

-s, --search <str> search string for properties to delete. Reg for delete mode

Values can alternatively be set in the config file:

1. configFile.environment
2. configfile.delete.searchStr

  aep-tag-tool --delete -e myEnvironment.postman_environment.json -s 2022

Values can alternatively be set in the config file:

1. configFile.environment
2. configfile.delete.searchStr

  aep-tag-tool --export -f myConfig.json

myConfig.json

{
  "environment": "path/to/myEnvironment.postman_environment.json",
  "delete": {
    "searchStr": "PR12345678901234567890"
  }
}

//TODO document custom settings

In this release there is no ability to customize rule settings. If this is a needed feature, fill out a git issue.

The Postman collections apart of this tool can also be used with Postman or npm newman. See the collection docs to learn more.

• Example Environment
  • See configuration instructions: docs/environment.md