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
Copy file name to clipboardExpand all lines: README.md
+70-16Lines changed: 70 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,45 @@
1
1
# OmniStudio Migration Assistant
2
2
3
+
The Omnistudio Migration Assistant is a command-line interface (CLI) plugin that you install via Salesforce CLI. It creates records for your omnistudio components on the Salesforce standard objects.
4
+
3
5
### Before You Begin
4
6
5
-
Read and follow the directions in the Omnistudio migration documentation: https://help.salesforce.com/s/articleView?id=sf.os_migrate_omnistudio_custom_objects_to_standard_objects.htm&type=5
7
+
- Review the migration phases in [Migration Process from Omnistudio for Managed Packages to Omnistudio](https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_omnistudio_custom_objects_to_standard_objects.htm&language=en_US&type=5)
8
+
9
+
- Install Salesforce CLI on your computer. See : [Install Salesforce CLI](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm).
10
+
11
+
## Install and Run the Omnistudio Migration Assistant
12
+
13
+
1. Install SF 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).
14
+
2. Authenticate Salesforce CLI in your migration sandbox (the org you are going to use for development) using the `sf org login web` command and then enter your username and password in the new browser tab that appears. See [Salesforce CLI Command Reference org login Commands](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm).
15
+
16
+
`sf org login web --instance-url=<Org URL>`
17
+
18
+
When prompted, enter your username and password, and connect. The command-line interface shows the message "Authentication Successful"
6
19
7
-
## Running SFDX plugin
20
+
For example:
21
+
`username@userdomain ~ % sf org login web --instance-url=https://usa794org-5b.my.salesforce.com`
8
22
9
-
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).
10
-
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).
11
-
3. In a new terminal session, install the plugin using the following command
23
+
You then see the authorization message.
24
+
Successfully authorized [email protected] with org ID 00DHp000004ArLWMA0
25
+
26
+
You can also authenticate using a consumer key (client ID) and secret key through connected apps. See [Authorization Through Connected Apps and OAuth 2.0](<[text](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_oauth_and_connected_apps.htm)>).
27
+
28
+
3. In a new terminal session, Install the Omnistudio Migration Assistant by running the `sf plugins install` command. For example
-n, --namespace=namespace the namespace of the vertical package
106
+
107
+
-u, --targetusername=targetusername username or alias for the target
108
+
org; overrides default target org
109
+
110
+
-v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub
111
+
org; overrides default dev hub org
112
+
113
+
--apiversion=apiversion override the api version used for
114
+
api requests made by this command
115
+
116
+
--json format output as json
117
+
118
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
119
+
this command invocation
120
+
121
+
-a, --allversions migrate all versions and not
122
+
and not just the active ones.
123
+
124
+
--only=only specify components to migrate:
125
+
dr (DataRaptors), ip (Integration Procedures),
126
+
os (OmniScripts), fc (FlexCards)
127
+
128
+
--relatedobjects=relatedobjects specify related objects to assess:
129
+
'apex' for Apex classes
130
+
```
131
+
132
+
> **Note:** LWC (Lightning Web Components) assessment/migration functionality is temporarily disabled in the current version. LWC features will be re-enabled in a future releases.
79
133
80
-
> **Note:** LWC (Lightning Web Components) migration functionality is temporarily disabled in the current version. This includes LWC migration, assessment, and report generation features. These features will be re-enabled in a future release. Apex migration functionality remains fully available. The `--relatedobjects` flag accepts all values ('apex', 'lwc', 'apex,lwc'), but LWC-related operations will not be executed.
134
+
> Apex migration functionality remains fully available. The `--relatedobjects` flag only accepts values ('apex')
81
135
82
136
Terms:
83
137
Notwithstanding anything stated in the terms and conditions agreed between Salesforce (‘SFDC’) and you (‘Customer’), the use of the OmniStudio Migration Assistant (‘Assistant’) is designed to facilitate the migration and it’s going to modify your custom code and by deploying and using the Assistant you hereby provide your consent to automate the migration process and enable a smooth transition. Customer shall access and use the Assistant only as permitted to the Customer and shall not compromise, break or circumvent any technical processes or security measures associated with the services provided by SFDC.
0 commit comments