Transferring data between Remedy SSO servers

Data transfer tool usage considerations

Before exporting and importing the Remedy SSO server configuration, take into account the following considerations:

• Use the data transfer tool when you need to export configuration from one Remedy SSO server (for example, QA server), and import it to another Remedy SSO server (for example, Dev server).
• The data transfer tool is designed to work across the same versions of Remedy SSO. You must not export or import data between different versions of Remedy SSO server.
• The data transfer tool imports all data, except issued tokens, sessions, authorization codes, and SAML signing and encryption certificates.
• You can import all configurations (including general configuration, launchpad settings, registered OAuth2 clients, administrator users, and tenants), or segments of the configuration (one or more realms with branding, associated local users or groups, and the assignments of those users and groups).
• The import job runs as a single transaction. 

Data transfer task overview

To transfer a configuration from one Remedy SSO server to another server, perform the following tasks:

1. Prepare for the data transfer.
2. Export the complete configuration of a source server.
3. Import either the complete configuration or segments of the configuration of a realm to a target server. 

To prepare for data transfer 

Before you use the data transfer tool, perform the following steps:

1. Download Remedy SSO server installation files to a server on which you will run the data transfer tool. 
2. Ensure that the application.properties and data-transfer-tool.jar files are located in the same directory (for example, C:\Program Files\BMC Software\RemedySSO\tools\dataTransferTool). 

To export Remedy SSO configuration 

1. Set the properties of the source server in the application.properties file as required:

   Properties	Value
   datasource.url	<jdbc_connection_string> For example: (MsSQL server) jdbc:sqlserver://<sql_server>:1433;DatabaseName=rsso
   db.type	<mssql|postgres|oracle>
   db.username	<db_username>
   db.password	<db_password_plaintext>

2. In the command line, run either of the following commands:
   • (Interactive shell) java -jar data-transfer-tool.jar
   • (Batch execution) java -jar data-transfer-tool.jar @<full_path_to_command_file.txt>

3. To use the data transfer tool in interactive shell mode, run the following command to export all the data:

   export <filename>

   If you do not specify <filename>, rsso-config-export.zip filename is used.

   Note

   You must not modify the contents of this exported zip file. 

   Make sure the exported file is stored securely. 

To import Remedy SSO configuration 

1. Set the properties of the target server in the application.properties file as required:

   Properties	Value
   datasource.url	<jdbc_connection_string> For example: (MsSQL server) jdbc:sqlserver://<sql_server>:1433;DatabaseName=rsso
   db.type	<mssql|postgres|oracle>
   db.username	<db_username>
   db.password	<db_password_plaintext>

2. Run either of the following commands to use the required operation mode:
   
   • (Interactive shell) java -jar data-transfer-tool.jar
   • (Batch execution)  java -jar data-transfer-tool.jar @<full_path_to_command_file.txt>

• Compete one or more of the following tasks:

  • To import all  configuration
  • To import realms
  • To import and rename realms 
  • To import OAuth clients to a target tenant
  • To import tenants

  To import all Remedy SSO configuration

  import <filename>

  The default file name is rsso-config-export.zip.

  This command results in importing all data from the source file to the target server. If the file contains data of SAAS_TENANT from the source database, it will overwrite data of SAAS_TENANT in the target database.

  To import realms

  Run one of the following commands:

  import <filename> -r <realm_list> -s <source_tenant_ID> -t <target_tenant_ID>

  Or

  import <filename> --realms <realm_list> --sourcetid <source_tenant_ID> --targettid <target_tenant_ID>

  The following table describes the command parameters:

  Parameter	Description
  import <filename>	The default file name is rsso-config-export.zip.
  -r  or --realms	Enter realms that you want to export. For example, <realmId1>,<realmId2>,<realmId3>.  Only specified realms with their related local users and groups are imported. All other configuration in the target database remain unchanged. You can also rename a realm during import.
  -s or --sourcetid	Enter the source tenant from which realms will be imported.
  -t or --targettid	Enter the target tenant to which realms will be imported.

  Note

  If the target tenant has the same realm name as the imported one, it will be overwritten by the realm with the same name from the source tenant along with its local users and roles.

  At the same time, local users of the realm in the target database which do not overlap with the imported ones remain unchanged.

  To import and rename realms

  Run the following command:

  import <filename> -r <realm1>:<realm1NewName>,<realm2>:<realm2NewName>,<realm3>,<realm4>:<realm4NewName> -s <source_tenant_ID> -t <target_tenant_ID>

  Ensure that the new name of a realm corresponds to the following requirements:

  • Can have a maximum of 80 characters, and can contain the following characters: 
    • Asterisk (*)
    • Underscore (_) 
    • Full stop '.',
    • En dash (-)
  • Must not be empty, and must have a unique name. 

  Note

  If you rename a realm during import, and the target server has a realm with the same name, then the target realm is not overwritten, but a new realm is created.

  To import OAuth clients to a target tenant

  Run one of the following commands:

  import <filename> -o <oauth_client_IDs_list> -s <source_tenant_ID> -t <target_tenant_ID>

  Or

  import <filename> --oauthclients <oauth_client_IDs_list> --sourcetid <source_tenant_ID> --targettid <target_tenant_ID>

  The following table describes the command parameters:

  Parameter	Description
  import <filename>	The default file name is rsso-config-export.zip.
  -o or --oauthclients	Enter client IDs that you want to export. For example, <clientID1>,<clientID2>,<clientID3>. When specified, only these OAuth2 clients are imported. All other configuration in the target database remains unchanged.
  -t  or --targettid	Enter the target tenant name to which OAuth clients will be imported.
  -s or --sourcetid	Enter the source tenant name from which OAuth clients will be imported.

  To import tenants

  Run one of the following commands:

  import <filename> -m <source_tenant_ID1> <target_tenant_ID1>

  Or

  import <filename> --many <source_tenant_ID1> <target_tenant_ID1>

  The following table describes the command parameters:

  Parameter	Description
  import <filename>	The default file name is rsso-config-export.zip.
  -m  or --many	Specify tenants which you would like to import from the exported file.

  Note

  If the target database already contains a tenant with the same ID as specified in the list, its data is completely overwritten during import. If SAAS_TENANT is specified in the list, it is always overwritten.