@salesforce/plugin-omnistudio-migration-tool 1.1.1 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1 -1
- package/README.md +19 -48
- package/oclif.manifest.json +1 -1
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,18 +1,31 @@
|
|
|
1
1
|
OmniStudio Migration Tool
|
|
2
2
|
=========================
|
|
3
3
|
|
|
4
|
-
This repository contains the code required to enable the OmniStudio Migration Tool SFDX plugin.
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
### Before You Begin
|
|
6
|
+
1. Confirm you have an OmniStudio Admin license.
|
|
7
|
+
2. Enable Standard OmniStudio Runtime in Setup > OmniStudio Settings.
|
|
8
|
+
|
|
9
|
+
## Running SFDX plugin
|
|
7
10
|
|
|
8
11
|
1. Install SFDX cli using the official documentation located [here](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm).
|
|
9
12
|
2. Authenticate your SFDX cli into the org you are going to use for development. You can follow authentication steps [here](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_auth_web.htm).
|
|
10
|
-
3.
|
|
11
|
-
|
|
12
|
-
|
|
13
|
+
3. In a new terminal session, install the plugin using the following command
|
|
14
|
+
```
|
|
15
|
+
sfdx plugins:install @salesforce/plugin-omnistudio-migration-tool
|
|
13
16
|
```
|
|
14
|
-
|
|
17
|
+
4. To run the migration tool, run the following command from your command line tool:
|
|
18
|
+
```
|
|
19
|
+
// To migrate everything
|
|
20
|
+
sfdx omnistudio:migration:migrate -u YOUR_ORG_USERNAME@DOMAIN.COM --namespace=VLOCITY_PACKAGE_NAMESPACE
|
|
21
|
+
|
|
22
|
+
//to migrate specific components: FlexCards, DataRaptors, Integration Procedures, or OmniScripts, add the following parameters:
|
|
23
|
+
--only=dr
|
|
24
|
+
--only=ip
|
|
25
|
+
--only=os
|
|
26
|
+
--only=fc
|
|
15
27
|
```
|
|
28
|
+
5. An HTML page will be open in your default browser with the results of your migration job.
|
|
16
29
|
|
|
17
30
|
### Usage & parameters
|
|
18
31
|
|
|
@@ -39,45 +52,3 @@ OPTIONS
|
|
|
39
52
|
this command invocation
|
|
40
53
|
|
|
41
54
|
```
|
|
42
|
-
|
|
43
|
-
### Folder structure
|
|
44
|
-
```
|
|
45
|
-
-
|
|
46
|
-
- .vscode VSCode configuration folder
|
|
47
|
-
- bin Tools required to run in developer mode
|
|
48
|
-
- messages JSON files with user messages used in the plugin
|
|
49
|
-
- src
|
|
50
|
-
- commands SFDX plugin commands
|
|
51
|
-
- mappings A list of mappings between vertical and standard objects
|
|
52
|
-
- migration OmniStudio Migration Tool code
|
|
53
|
-
- utils Utilities (network, debugging, logging, etc.)
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
_See code: [src/commands/hello/org.ts](https://github.com/agarcia-sf/omnistudio-migration-tool/blob/v0.0.0/src/commands/hello/org.ts)_
|
|
59
|
-
<!-- commandsstop -->
|
|
60
|
-
<!-- debugging-your-plugin -->
|
|
61
|
-
# Debugging your plugin
|
|
62
|
-
We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the `.vscode` directory of this plugin is a `launch.json` config file, which allows you to attach a debugger to the node process when running your commands.
|
|
63
|
-
|
|
64
|
-
To debug the `hello:org` command:
|
|
65
|
-
1. Start the inspector
|
|
66
|
-
|
|
67
|
-
If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch:
|
|
68
|
-
```sh-session
|
|
69
|
-
$ sfdx hello:org -u myOrg@example.com --dev-suspend
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
Alternatively, to call your command using the `bin/run` script, set the `NODE_OPTIONS` environment variable to `--inspect-brk` when starting the debugger:
|
|
73
|
-
```sh-session
|
|
74
|
-
$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u myOrg@example.com
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
2. Set some breakpoints in your command code
|
|
78
|
-
3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
|
|
79
|
-
4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
|
|
80
|
-
5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
|
|
81
|
-
6. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5).
|
|
82
|
-
<br><img src=".images/vscodeScreenshot.png" width="480" height="278"><br>
|
|
83
|
-
Congrats, you are debugging!
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"1.1.
|
|
1
|
+
{"version":"1.1.2","commands":{"basecommand":{"id":"basecommand","usage":"<%= command.id %> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-omnistudio-migration-tool","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"}},"args":[]},"omnistudio:migration:info":{"id":"omnistudio:migration:info","description":"print a greeting and your org IDs","usage":"<%= command.id %> [-n <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-omnistudio-migration-tool","pluginType":"core","aliases":[],"examples":["sfdx omnistudio:migration:info --targetusername myOrg@example.com --targetdevhubusername devhub@org.com","sfdx omnistudio:migration:info --name myname --targetusername myOrg@example.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"name":{"name":"name","type":"option","char":"n","description":"name to print"}},"args":[{"name":"file"}]},"omnistudio:migration:migrate":{"id":"omnistudio:migration:migrate","description":"print a greeting and your org IDs","usage":"<%= command.id %> [-n <string>] [-o <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-omnistudio-migration-tool","pluginType":"core","aliases":[],"examples":["omnistudio:migration:migrate -u orguser@domain.com --namespace=YOUR_PACKAGE_NAMESPACE","omnistudio:migration:migrate -u orguser@domain.com --namespace=YOUR_PACKAGE_NAMESPACE --only=dr","omnistudio:migration:migrate -u orguser@domain.com --namespace=YOUR_PACKAGE_NAMESPACE --only=ip","omnistudio:migration:migrate -u orguser@domain.com --namespace=YOUR_PACKAGE_NAMESPACE --only=os","omnistudio:migration:migrate -u orguser@domain.com --namespace=YOUR_PACKAGE_NAMESPACE --only=fc"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"namespace":{"name":"namespace","type":"option","char":"n","description":"The namespaced of the package"},"only":{"name":"only","type":"option","char":"o","description":"Migrate a single element: osip | fc | dr"}},"args":[{"name":"file"}]}}}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-omnistudio-migration-tool",
|
|
3
3
|
"description": "This SFDX plugin migrates FlexCard, OmniScript, DataRaptor, and Integration Procedure custom objects to standard objects.",
|
|
4
|
-
"version": "1.1.
|
|
4
|
+
"version": "1.1.2",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
"husky": "^4.3.8",
|
|
45
45
|
"mocha": "^8.4.0",
|
|
46
46
|
"nyc": "^15.1.0",
|
|
47
|
-
"prettier": "^2.
|
|
47
|
+
"prettier": "^2.6.2",
|
|
48
48
|
"pretty-quick": "^3.1.0",
|
|
49
49
|
"sinon": "10.0.0",
|
|
50
50
|
"ts-node": "^10.0.0",
|
|
@@ -115,7 +115,7 @@
|
|
|
115
115
|
}
|
|
116
116
|
},
|
|
117
117
|
"sfdx": {
|
|
118
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-omnistudio-migration-tool/1.1.
|
|
119
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-omnistudio-migration-tool/1.1.
|
|
118
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-omnistudio-migration-tool/1.1.2.crt",
|
|
119
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-omnistudio-migration-tool/1.1.2.sig"
|
|
120
120
|
}
|
|
121
121
|
}
|