Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 4.12 KB

DEV.md

File metadata and controls

83 lines (59 loc) · 4.12 KB

OmniStudio Migration Assistant

This repository contains the code required to enable the OmniStudio Migration Assistant SFDX plugin.

Running SFDX plugin in developer mode

  1. Install SFDX cli using the official documentation located here.
  2. Authenticate your SFDX cli into the org you are going to use for development. You can follow authentication steps here.
  3. Clone this repository into your local machine.
  4. Open the migration assistant code folder in VSCode or your prefered editor.
  5. In a new command line assistant, run the following command:
bin/run omnistudio:migration:migrate -u agarcia-vertical238@na46.salesforce.com

Usage & parameters

USAGE
  $ sfdx omnistudio:migration:migrate [-f] [-v <string>] [-u <string>] [--loglevel
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub org

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

  -a, --allversions                                                                 migrate all versions

Folder structure

-
  - .vscode                                             VSCode configuration folder
  - bin                                                 Tools required to run in developer mode
  - messages                                            JSON files with user messages used in the plugin
  - src
    - commands                                          SFDX plugin commands
    - mappings                                          A list of mappings between vertical and standard objects
    - migration                                         OmniStudio Migration Assistant code
    - utils                                             Utilities (network, debugging, logging, etc.)

See code: src/commands/hello/org.ts

Debugging your plugin

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.

To debug the hello:org command:

  1. Start the inspector

If you linked your plugin to the sfdx cli, call your command with the dev-suspend switch:

$ sfdx hello:org -u myOrg@example.com --dev-suspend

Alternatively, to call your command using the bin/run script, set the NODE_OPTIONS environment variable to --inspect-brk when starting the debugger:

$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u myOrg@example.com
  1. Set some breakpoints in your command code
  2. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
  3. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
  4. 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.
  5. 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).

    Congrats, you are debugging!