Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Documentation for 5.3 #1081

Closed
JoernBerkefeld opened this issue Aug 16, 2023 · 1 comment · Fixed by #1094
Closed

[TASK] Documentation for 5.3 #1081

JoernBerkefeld opened this issue Aug 16, 2023 · 1 comment · Fixed by #1094
Assignees
Labels
chore Jira issue-type "Task" documentation Improvements or additions to documentation
Milestone

Comments

@JoernBerkefeld
Copy link
Contributor

JoernBerkefeld commented Aug 16, 2023

MetadataType CLI argument Retrieved by Default retrieve deploy (create) deploy (update) delete changeKey buildTemplate retrieveAsTemplate Description
Data Designer Attribute Groups attributeGroup Yes Yes - - - - - - Groupings of Attribute Sets (Data Extensions) in Data Designer.
Data Designer Attribute Sets attributeSet Yes Yes - - - - - - Data Extensions linked together in Attribute Groups in Data Designer.
Automation: Verification Activity verification Yes Yes Yes Yes Yes - Yes - Check DataExtension for a row count

deploy

Command: mcdev deploy [business unit] [metadata type] [metadata key] [--fromRetrieve] [--refresh] [--changeKeyValue=yourNewKey] [--changeKeyField=otherFieldInJson] [--execute] [--schedule] [--fixShared]

...

deploy & --fixShared:

If you deploy Shared Data Extensions, mcdev will force you to do that via Parent BU to avoid issues with SFMC APIs. Due to another bug, if one of these shared data extensions is used in an attribute group on a child BU, SFMC fails to update the field information on the attribute group and as a result you cannot select added or renamed fields in places like journey builder.

Example: user will be asked to select which BUs should be checked & potentially fixed

mcdev deploy MyProject/DEV dataExtension --fixShared
mcdev deploy MyProject/DEV dataExtension "key1,key2" --fixShared

Example: user will be asked to select which BUs should be checked & potentially fixed, but the BUs "buName1" and "buName2" are pre-selected

mcdev deploy MyProject/DEV dataExtension "key1" --fixShared="buName1,buName2"

Example: user will be asked to select which BUs should be checked & potentially fixed, but all BUs are pre-selected

mcdev deploy MyProject/DEV dataExtension "key1" --fixShared=*

Example: user will NOT be asked to select BUs; the BUs "buName1" and "buName2" are selected to be checked & potentially fixed

mcdev deploy MyProject/DEV dataExtension "key1,key2" --fixShared="buName1,buName2" --y
mcdev deploy MyProject/DEV dataExtension "key1" --fixShared=* --y

Supported types for deploy & fixShared:

Name CLI Argument Effect
DataExtension dataExtension Triggers update of relevant attribute groups on selected BUs

Automation

Adding Verification Activities

When Verifications are created, they automatically get a new ID assigned. That same field also acts as key as there is no other field. This comes with the unique challenge of not being able to use the templating system nor pre-defined keys during deployments to ensure the automation can a) work and b) be deployed. To circumvent the issue, make sure to deploy verifications and automations at the same time. That way, the key as seen in the deploy folder is auto-replaced with the newly generated one in all automations that you are trying to deploy.

How does the mapping work?
The system tracks the key in the deploy folder vs the new key on a per-BU basis. That way, the mapping even works in massive multi-BU deployments.

@JoernBerkefeld
Copy link
Contributor Author

done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Jira issue-type "Task" documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant