You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The plugin enhances the productivity of CRMA developers and release managers by automating manual procedural tasks related to connected objects. Nowadays, each time a new field is used in recipes, the user tracks the field in notes. Later, when there's a need to migrate the recipe to a higher environment, the user manually checks off each field one by one in the connected objects according to the taken notes.
6
+
This Salesforce CLI (`sf`) plugin automates the configuration of connected objects and fields within **CRM Analytics** > **Data Manager** > **Connections**.
7
7
8
-
The process is highly manual, and forgetting to track certain fields often causes recipe run failures. The run failures highlight one field at a time, and the process should be repeated until the first successful run.
8
+
The plugin upserts (creates if missing, or updates) connected objects (also called replicated datasets) and their fields in the target environment based on the input nodes of either specific recipes or all recipes in your repository.
9
9
10
-
The command, which can be executed locally or inserted into a CI/CD pipeline, verifies the required fields from the recipes and marks them in the environment within seconds.
11
-
12
-
> [!NOTE]
13
-
> Despite the warning message indicating partial support for ESM plugins in OCLIF, rest assured that the plugins will function as expected.
10
+
If you manually configure CRM Analytics via the user interface in your target environments, this plugin is not required. However, if you deploy recipes from one environment to another, it eliminates the error-prone task of manually checking off individual objects and fields in the Data Manager, preventing recipe execution failures.
14
11
15
12
## Install
16
13
@@ -38,48 +35,44 @@ using this links.
38
35
39
36
## Contributing
40
37
41
-
1. Create a new issue before starting your project so that we can keep track of
42
-
what you are trying to add/fix. That way, we can also offer suggestions or
43
-
let you know if there is already an effort in progress.
44
-
2. Fork this repository.
45
-
3. Build the plugin locally.
46
-
4. Write appropriate tests for your changes. Try to achieve at least 75% code coverage on any new code.
47
-
Nuts are required, but code coverage will be based on unit tests only.
48
-
5. Send us a pull request when you are done (linking the issue previously created).
49
-
We'll review your code, suggest any needed changes, and merge it in.
38
+
1.**Create a new issue** before starting your work so we can track what you want to add or fix. This allows us to offer suggestions or let you know if there is already an ongoing effort.
39
+
2.**Fork** this repository.
40
+
3.**Build** the plugin locally.
41
+
4.**Write appropriate tests** for your changes. Aim for at least 75% code coverage on any new code. NUTs (Non-Unit Tests) are required, though code coverage metrics are based on unit tests only.
42
+
5. Run `oclif readme` to update the documentation if commands or flags were changed.
43
+
6.**Submit a pull request** when you are finished, making sure to link the previously created issue. We will review your code, suggest any necessary changes, and merge it.
Copy file name to clipboardExpand all lines: messages/connected-objects.upsert.md
+7-9Lines changed: 7 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,11 @@
1
1
# summary
2
2
3
-
Create/update the analytics connected objects and fields according to the ones mentioned in the given recipes.
3
+
Upsert CRM Analytics Connected Objects and fields according to the ones mentioned in the given recipes.
4
4
5
5
# description
6
6
7
-
Create/update the analytics connected object and fields, keeping the existing ones and adding the new detected.
8
-
The diff check is perfomed comparing the target org connections and the object and fields in the input nodes of the given recipe or recipes (in your repository).
9
-
Use "--all" to consider all recipes in your repository.
10
-
In case a new object is added a connection, the connection mode will be the default one.
7
+
Upsert CRM Analytics Connected Objects (also known as Replicated Datasets) and fields in the target org based on the input nodes of your local recipes.
8
+
Existing connections are preserved, and newly detected objects or fields are added. If a new object connection is created, it uses the default connection mode. Use "--all" to evaluate all recipes in the repository.
11
9
12
10
# examples
13
11
@@ -25,19 +23,19 @@ In case a new object is added a connection, the connection mode will be the defa
25
23
26
24
# flags.recipe-names.summary
27
25
28
-
The name of the recipes you want to evaluate
26
+
The names of the recipes to consider
29
27
30
28
# flags.recipe-names.description
31
29
32
-
The api name of the recipes in your repository, which objects and fields will be considered in the diff check the org connections
30
+
The API names of the recipes in your repository whose input node objects and fields will be configured in the target org
33
31
34
32
# flags.all.summary
35
33
36
-
Evaluate all recipes in your repository
34
+
Consider all recipes in the repository
37
35
38
36
# flags.verbose.summary
39
37
40
-
Print the changed fields into the outcome table
38
+
Enriches the JSON output with a detailed list of the fields added to the target org
0 commit comments