Documentation
API
Q&A
Read
AnnouncementsArticlesWebsite tips
Learn
Getting StartedManagerMaestroAnalyticsExchangeWorkspaces
Resources
VideosDownloadsExchange PackagesRelease Notes
Ideas
Contact
Platform
Manager
Maestro
Exchange
Workspaces
Analytics
Springboard

Import Roles

   Journey Manager (JM) The transaction engine for the platform.  |    System Manager / DevOps  |  All versions This feature is related to all versions.

Manager allows you to import a role as a ZIP file. You can use the import functionality to:

  • Roll back one or several roles.
  • Re-create one or several roles in another Manager.
  • Promote one or several roles to other environments.

Manager runs a virus scanning service before an import file is processed, so the antivirus service must be properly configured and enabled. If a virus is detected, the import operation fails and a corresponding record is added to the Error Log.  |  23.04 This feature was introduced in 23.04

You can import a role using one of following options:

Import Using UI

To import a role:

  1. Select Security > Roles and click Import.
    Manager import a role
  2. Click Choose File and locate a role archive ZIP file, which has been previously exported.
  3. Click Proceed To import.
  4. Review the Import Options.
    Manager import a role
  5. Click Import to complete the process. The expected result page is shown below.
    Manager import a role
  6. Select the Detail Messages tab to see more information about the import. This tab pops up open if the import operation has any issues you may need to check and resolve.
  7. Press Close and check the list of roles to verify the imported roles have been added.
Note

You can check the Audit Log and Error Log for successful and failed import operations respectively, whilst the Import Log shows all import operations.

Import Using SDK

The Journey Manager SDK Maven plugin provides the tm-sdk:archive-deploy goal to import a role.

Import Using API

The Journey Manager REST API provides the endpoint URL to import a role.

To call this REST API, you need:

HTTP Request
Both HTTP and HTTPS protocols are supported:
http(s)://<JM_SERVER>/manager/secure/rest/archive/v1/
Parameters
--header ‘Authorization: Basic <USE-NAME-AND-PASSWORD-BASE64-ENCODED>’ - an HTTP header containing 'username:password' encoded as Base64Base64 is a binary to a text encoding scheme that represents binary data in an American Standard Code for Information Interchange (ASCII) string format..
--form ‘archiveFile=@“/Users/my-role.zip”’ - a path to an archive file to be imported.
Response
If successful, this operation returns the following response with a HTTP 200 OK status code.
Example
curl --location --request PUT ‘https://<JM_SERVER>/manager/secure/rest/archive/v1/’ \
--header ‘Authorization: Basic <USE-NAME-AND-PASSWORD-BASE64-ENCODED>’ \
--form ‘archiveFile=@“/Users/my-role.zip”’

Next, learn how to migrate roles.