This section describes how to use the OnBase Integration for Salesforce Data Migration Utility application to back up the application data and Salesforce Content Migration configurations.
To back up application data and configurations:
- Launch a command prompt with elevated privileges.
- Navigate to the folder on your computer where the OnBase Integration for Salesforce Data Migration Utility application is located.
-
Enter the complete name of the utility
(Hyland.Verticals.OIFS.DataMigration.Admin.exe)
after .\, followed by a space and
backup
For example:.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup
-
To specify the location of the Salesforce organization or the URL from which
you want to back up data, enter
.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n
[URL] where [URL] is the path to the
Salesforce organization URL
For example:.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n https://example.sandbox.my.salesforce.com
-
To specify the Salesforce organization type, enter
.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n https://example.sandbox.my.salesforce.com -t [type] where [type] can be either Sandbox or Production.For example:.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n https://example.sandbox.my.salesforce.com -t Sandbox
-
To specify the user name required to log on to the Salesforce organization,
enter .\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n
https://example.sandbox.my.salesforce.com -t Sandbox -u [user
name] where [user name] is the name of
the user required to log on to the Salesforce organization.
For example:.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n https://example.sandbox.my.salesforce.com -t Sandbox -u example@hyland.com
-
To specify the required password, enter
.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n
https://example.sandbox.my.salesforce.com -t Sandbox -u example@hyland.com
-p [password] where [password] is the
password required to log on to the Salesforce organization.
For example:.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n https://example.sandbox.my.salesforce.com -t Sandbox -u example@hyland.com -p password
-
To specify the required security token, enter
.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n
https://example.sandbox.my.salesforce.com -t Sandbox -u example@hyland.com
-p password -k [token name] where [token
name] is the security token required to authenticate a user on
the Salesforce organization.
For example:.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n https://example.sandbox.my.salesforce.com -t Sandbox -u example@hyland.com -p password -k k5NfcZA7XmGIgnoedA0IZwsFNote: You must enter a token name only if you are using the Bulk API 1.0. The token must be 24 characters long and have a combination of both numbers and letters.
-
To specify the schema file name, enter
.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n
https://example.sandbox.my.salesforce.com -t Sandbox -u example@hyland.com
-p password -k k5NfcZA7XmGIgnoedA0IZwsF -d [schema] where
[schema] is
hfs__migrationconfig_3_0 for OnBase Integration for
Salesforce 3.0.4
For example:.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n https://example.sandbox.my.salesforce.com -t Sandbox -u example@hyland.com -p password -k k5NfcZA7XmGIgnoedA0IZwsF -d hfs__migrationconfig_3_0Note: The schema files are typically included in the OnBase Integration for Salesforce Data Migration Utility application. However, you may create a custom schema file or use a different schema file name, if required. The file must have the .json extension.
-
To specify the output directory, enter
.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n
https://example.sandbox.my.salesforce.com -t Sandbox -u example@hyland.com
-p password -k k5NfcZA7XmGIgnoedA0IZwsF -d hfs__migrationconfig_3_0 -o
[output] where [output] is the full path
to the folder where the backup files will be stored.
For example:.\Hyland.Verticals.OIFS.DataMigration.Admin.exe backup -n https://example.sandbox.my.salesforce.com -t Sandbox -u example@hyland.com -p password -k k5NfcZA7XmGIgnoedA0IZwsF -d hfs__migrationconfig_3_0 -o C:\Backup
-
Press Enter to execute the command.
Note:
- The application data and configurations are stored in folders that have the same name as the Session ID. These folders are located within the output directory you specified earlier.
- You must note the Session ID displayed on the screen after a backup session starts. This is required for resuming a backup session if it is interrupted.