Skip to content

Commit bfcb9a8

Browse files
agarcia-sfagarcia-sf
authored
Updates to README.md
1 parent 7de698d commit bfcb9a8

File tree

4 files changed

+148
-50
lines changed

4 files changed

+148
-50
lines changed

‎.npmignore‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# -- CLEAN
2+
tmp/
3+
# use yarn by default, so ignore npm
4+
package-lock.json
5+
6+
# never checkin npm config
7+
.npmrc
8+
9+
# debug logs
10+
npm-error.log
11+
yarn-error.log
12+
13+
14+
# compile source
15+
lib
16+
17+
# test artifacts
18+
*xunit.xml
19+
*checkstyle.xml
20+
*unitcoverage
21+
.nyc_output
22+
coverage
23+
test_session*
24+
25+
# generated docs
26+
docs
27+
28+
# ignore sfdx-trust files
29+
*.tgz
30+
*.sig
31+
package.json.bak.
32+
33+
# -- CLEAN ALL
34+
node_modules
35+
36+
# --
37+
# put files here you don't want cleaned with sf-clean
38+
39+
# os specific files
40+
.DS_Store
41+
.idea
42+
out.log
43+
migrationresults.html
44+
DEV.md

‎DEV.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
OmniStudio Migration Tool
2+
=========================
3+
4+
This repository contains the code required to enable the OmniStudio Migration Tool SFDX plugin.
5+
6+
## Running SFDX plugin in developer mode
7+
8+
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+
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. Clone this repository into your local machine.
11+
4. Open the migration tool code folder in VSCode or your prefered editor.
12+
5. In a new command line tool, run the following command:
13+
```
14+
bin/run omnistudio:migration:migrate -u [email protected] --namespace=agarciana46_238 --json
15+
```
16+
17+
### Usage & parameters
18+
19+
```
20+
USAGE
21+
$ sfdx omnistudio:migration:migrate [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
22+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
23+
24+
OPTIONS
25+
-n, --namespace=namespace the namespace of the vertical package
26+
27+
-u, --targetusername=targetusername username or alias for the target
28+
org; overrides default target org
29+
30+
-v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub
31+
org; overrides default dev hub org
32+
33+
--apiversion=apiversion override the api version used for
34+
api requests made by this command
35+
36+
--json format output as json
37+
38+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
39+
this command invocation
40+
41+
```
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 [email protected] --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 [email protected]
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!

‎README.md‎

Lines changed: 20 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,31 @@
11
OmniStudio Migration Tool
22
=========================
33

4-
This repository contains the code required to enable the OmniStudio Migration Tool SFDX plugin.
54

6-
## Running SFDX plugin in developer mode
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
710

811
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).
912
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. Clone this repository into your local machine.
11-
4. Open the migration tool code folder in VSCode or your prefered editor.
12-
5. In a new command line tool, run the following command:
13+
3. In a new terminal session, install the plugin using the following command
14+
```
15+
sfdx plugins:install @salesforce/plugin-omnistudio-migration-tool
1316
```
14-
bin/run omnistudio:migration:migrate -u [email protected] --namespace=agarciana46_238 --json
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 [email protected] --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
1527
```
28+
5. An HTML page will be open in your default browser with the results of your migration job.
1629

1730
### Usage & parameters
1831

@@ -38,46 +51,4 @@ OPTIONS
3851
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
3952
this command invocation
4053
41-
```
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 [email protected] --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 [email protected]
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!
54+
```

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@salesforce/plugin-omnistudio-migration-tool",
33
"description": "This SFDX plugin migrates FlexCard, OmniScript, DataRaptor, and Integration Procedure custom objects to standard objects.",
4-
"version": "1.1.0",
4+
"version": "1.1.1",
55
"author": "Salesforce",
66
"bugs": "https://github.com/forcedotcom/cli/issues",
77
"dependencies": {

0 commit comments

Comments
 (0)