Migrating from Restlet to Talend Cloud - Cloud

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
task
Installation and Upgrade
EnrichPlatform
Talend API Designer
Talend API Tester

Migrating from Restlet to Talend Cloud

Talend Onboard Program is a program allowing Restlet customers to migrate to Talend.

This article explains how to export your data from Restlet Studio and Restlet Client and import it to Talend Cloud API Designer and Talend Cloud API Tester.

To migrate your data, you will:

  • Create your account
  • Create users in Talend Cloud Management Console
  • Export your data from Restlet Studio and/or Restlet Client
  • Import your data to Talend Cloud API Designer and/or Talend Cloud API Tester
  • Share your APIs/projects
Note: The data export and import have to be done for each user.

Signing up to Talend Cloud

Create your Talend Cloud password.

About this task

Once you receive an e-mail from Talend Support, you need to accept the Talend Cloud invitation to access Talend Cloud Management Console, Talend Cloud API Designer and Talend Cloud API Tester.

Procedure

  1. In the e-mail you received, click ACCEPT INVITATION.
  2. In the page that opens, create your password and click SAVE.

Results

You can now access your Talend Onboard Program application. By default, you have all the user roles available with this program. For more information about user roles, see Managing users.

Logging in to Talend Cloud

Log in to Talend Cloud to access Talend Cloud Management Console, Talend Cloud API Designer and Talend Cloud API Tester.

Procedure

  1. Access the Talend Cloud environment at the URL corresponding to your region:
  2. Enter your login and password, then click Log in to open the Talend Cloud homepage.
    Tip: If you work with several domains, you can use your Login Name instead of your email address to connect directly to the domain of your choice. You can find it in your Profile preferences. The Login Name is a combination of the username and the domain name. For example: johndoe@mydomain.talend.com.

Results

You are now logged in and redirected to the Talend Cloud homepage, where you can access your applications: Talend Cloud Management Console, Talend Cloud API Designer and Talend Cloud API Tester.

Managing users

Restlet users cannot be migrated automatically to Talend Cloud, they need to be created in Talend Cloud Management Console.

With Talend Onboard Program, you have access to the user and group management features of Talend Cloud Management Console.

You can create your users and assign roles to them, and you can also add them to groups.

Creating users

Use Talend Cloud Management Console to create and manage users in Talend Cloud web applications.

Procedure

  1. To access the Talend Cloud Management Console homepage, you can either:
    • Click the Launch button at the bottom of the Talend Management Console tile.

    • Click SELECT AN APP and select Management Console from the list of available Talend apps.

  2. Open the USERS page.
  3. Click ADD USER.
  4. Enter the email address, the login name, and the first and last name of the user.
    If the single sign-on option is enabled, ensure that the user's Talend Cloud email address is their username in Okta.
  5. Optional: Assign predefined roles to the new user from the Roles drop-down list for each of the cloud applications.
    The created user cannot log in until a role is assigned.

    Example

  6. Optional: To assign the new user to an existing group, select a group from Group(s) drop-down list.
  7. Click SAVE, or click SAVE AND ADD ANOTHER if you want to create more users.

Results

The new user appears in the list of users.

Talend Cloud Management Console sends an invitation email to the user to join and create a password.

The user details and the assigned roles and groups can be edited directly from the USERS tab.

Predefined user roles

Access the list of user roles on the ROLES page in Talend Cloud Management Console.

When you first access the ROLES page, there is a list of predefined roles. You can add custom roles with different permissions. For more information, see the Talend Cloud Management Console User Guide.

By clicking the role, you can assign it to users on the ROLE DETAILS tab.

Talend Cloud Management Console

Account Administrator
  • Manage users, roles, and groups
  • Access subscription information
  • Configure password policies and single sign-on

Talend Cloud API Designer

API Designer
  • Create and edit API definitions
  • Share API definitions

Talend Cloud API Tester

API Tester
  • Create and edit API tests
  • Share API tests

Creating groups

Use Talend Cloud Management Console to create and manage user groups in your Talend Cloud applications. You can use user groups to share an API or a test project with several users.

Note: You cannot assign roles to a group as they are managed individually for each user. Users from the same group can have different roles.

Procedure

  1. Open the GROUPS page.
  2. Click ADD GROUP.
  3. Enter the group name.
  4. Click SAVE.

Results

The new group appears in the list of groups.

Adding users to groups

Assign users to the created user groups.

Procedure

  1. Open the GROUPS page to access the list of user groups.
  2. Click the name of the group.
  3. Click the pencil icon in the GROUP DETAILS window to access the list of users.
  4. Select the users from the list.

    If the list of users is too long, start typing the user name in the search field.

Results

The selected users are added to the group.

Migrating from Restlet Studio to Talend Cloud API Designer

Migrate your API definitions to Talend Cloud API Designer.

Before you begin

  • You have a Restlet Studio account
  • You have registered for the Talend Onboard Program

About this task

The data export and import have to be done for each user.

Backing up your Restlet Studio data

Export all your API definitions to a ZIP file.

Procedure

  1. Log in to Restlet Studio.
  2. Click Help > Backup to Talend Cloud.
  3. Click Backup.
    You can only export the API definitions that you own. Only a team owner can export the APIs shared with the team. Each member of the team has to migrate his or her own APIs.
  4. Save the .zip file in the directory of your choice.

Results

Your Restlet Studio data is saved and ready to be imported to Talend Cloud API Designer.

Restoring your data to Talend Cloud API Designer

Import your API definitions to Talend Cloud.

Procedure

  1. Log in to Talend Cloud and open Talend Cloud API Designer.
  2. If you are accessing Talend Cloud API Designer for the first time, you need to create an API before you can access the rest of the features:
    • Select Empty API and enter a name, then click Create.
    • Select Tasks API, Contacts API or Petstore API to create an API based on an existing example, then click Create.
  3. Click your name in the top right corner to display a drop-down menu, and click Restore data from Restlet Studio.
    Warning: This import will replace any existing API in your Talend Cloud API Designer account. If you have created an API that you want to keep, you need to export it and import it again after restoring your Restlet data. For more information about importing and exporting API definitions, see the Talend Cloud API Designer User Guide.
  4. Select the .zip file you exported from Restlet.
  5. Click Import, then click Confirm restore.

Results

Your APIs are imported are visible in your APIs list.

Migration impacts

Due to the differences between Restlet Studio and Talend Cloud API Designer, some of your data cannot be migrated or fully restored.

  • Teams are not migrated, they are managed in Talend Cloud Management Console. For more information, see Managing users.
  • API documentation is not restored, you need to republish your documentation once you have restored your APIs. Restlet API documentation is still available until Restlet Studio is discontinued.
  • API mocks are not migrated, you need to enable your mocks once you have restored your APIs. Restlet mock endpoints are still available until Restlet Studio is discontinued.
    Warning: Your Restlet mock endpoint will still be in your contract's endpoints list, you will have to delete it manually.
  • URLs for hosted API documentation and mocks will change once you republish them on Talend Cloud API Designer. The URLs you have defined in Restlet Studio will be served until October 14th, 2019. If you need more time to migrate your systems to new Talend URLs, please contact us.
  • The sharing configuration is not migrated, you need to share your API with the relevant users or groups once you have migrated them.
  • Client SDK and Server Skeleton code generation is no longer available. You can export an OAS definition and generate code using open-source code generation tools. For more information, see the Swagger Codegen Documentation.

Sharing APIs with your team

Once your APIs have been migrated, you can share them with specific users and user groups in your team.

Procedure

  1. Go to API > Open and select your API to open it.
  2. Click Share in the left panel.
  3. Click the + icon next to the name of the user or group you want to share the API with.
    You can also select the user and click ADD AS > Editor.
  4. Once you have added all the relevant users or groups, click SHARE.

Results

The API is now shared with the selected users and groups.

Migrating from Restlet Client to Talend Cloud API Tester

Migrate your test projects, scenarios and environments to Talend Cloud API Tester.

Before you begin

  • You have a Restlet Client account
  • You have registered for the Talend Onboard Program

About this task

The data export and import have to be done for each user.

Backing up your Restlet Client data

Export all your projects and environments to a ZIP file.

Procedure

  1. Log in to Restlet Client.
  2. Click Help > Backup to Talend Cloud.
  3. Click Backup.
    You can only export the API projects that you own. Only a team owner can export the projects shared with the team. Each member of the team has to migrate his or her own projects.
  4. Save the .zip file in the directory of your choice.

Results

Your Restlet Client data is saved and ready to be imported to Talend Cloud API Tester.

Restoring your data to Talend Cloud API Tester

Import your test projects and environments to Talend Cloud.

Before you begin

Make sure you are on a stable network to avoid issues during the process.

Procedure

  1. Click your name in the top right corner to display a drop-down menu, and click Restore data from Restlet Client.
    Warning: This import will replace any existing project in your Talend Cloud API Tester drive. If you have created a project that you want to keep, you need to export it and import it again after restoring your Restlet data. For more information about importing and exporting projects, see the Talend Cloud API Tester User Guide.
  2. Select the .zip file you exported from Restlet.
  3. Click Restore, then click Confirm restore.
  4. Once your data is restored, click Close .

Results

Your projects are imported and visible in your drive on the left panel. Your environments are visible in the top right corner of the window when a project is open.

You can now check that all your projects have been restored properly, and uninstall your Restlet Client extension.

Migration impacts

Due to the differences between Restlet Client and Talend Cloud API Tester, some of your data cannot be migrated or fully restored.

  • Teams are not migrated, they are managed in Talend Cloud Management Console. For more information, see Managing users.
  • The sharing configuration is not migrated, you need to share your API with the relevant users or groups once you have migrated them.
  • Environments can now be shared and you can define public or private variables. Migrated Restlet Client variables are public by default. It is recommended to make sensitive variables private after the migration.
  • Expressions that do not start with $ are not longer valid, your expressions are updated accordingly during the migration process.
  • Names of projects and environments are limited to 256 characters. Longer names will be truncated.
  • The Maven plugin is not longer hosted, it should be installed in your own Maven repository. For more information, see the Talend Cloud API Tester User Guide.
  • You cannot use Talend Cloud API Tester in several tabs.
  • You must me logged in to use Talend Cloud API Tester.

Updating privacy settings for your variables

Make your sensitive variables private before sharing your environments.

About this task

Talend Cloud API Tester allows you to share environments. To avoid sharing sensitive information, you can make some variables private. The variable will be shared with other users with a blank value.

Procedure

  1. In the top right corner of the window, select an environment and click the pencil icon to edit it.
  2. Click the arrow next to Public and click Make private for each variable that should be hidden from other users.

    Example

  3. Once all the relevant variables have been edited, click Close.

Sharing projects with your team

Once your APIs have been migrated, you can share them with specific users and user groups in your team.

Procedure

  1. In the left panel of the REQUESTS or SCENARIOS tab, click the menu to the right of you project name, then click Share.
  2. Click the + icon next to the name of the user or group you want to share the API with.
    You can also select the user and click ADD AS > Editor.
  3. Once you have added all the relevant users or groups, click SHARE.

Results

The API project is now shared with the selected users and groups. Talend Cloud API Tester now allows you to share environments as well. For more information, see the Talend Cloud API Tester User Guide.

What's next?

Discover and use the new features offered in Talend Cloud API Designer and Talend Cloud API Tester.

Once you have created your users, restored your APIs and test projects and shared them with your team, you can start working on your Restlet projects in Talend Cloud API Designer and Talend Cloud API Tester.

In the following sections, you can learn more about the new features available in your apps. For more information, see the Talend Cloud API Designer User Guide and the Talend Cloud API Tester User Guide.

New Talend Cloud API Designer features

This section lists the new features available in Talend Cloud API Designer. For more information, see the Talend Cloud Release Notes.
Feature Description
API Gateway export modes You can export API definitions that are compatible with AWS API Gateway or Azure API Management.
API design enhancements You can use the following elements in your APIs:
  • Data type composition (allOf)
  • Data type polymorphism (anyOf, oneOf)
  • New security schemes such as OpenID Connect or JWT.
  • Reusable components
  • Default response and status ranges
OpenAPI Specification (OAS) v3.0 support You can import and export OAS 3.0 definitions.
Management API Talend Cloud API Designer exposes an API which allows you to manipulate your API definitions from command-line scripts and continuous integration/continuous delivery pipelines.
Enhanced automatic API mocks API mocks now support the following OpenAPI Specification 3.0 features:
  • Response ranges and default responses
  • allOf, anyOf and oneOf combinations
  • Read-only and write-only restrictions
Internationalization The Talend Cloud API Designer application and documentation are available in French and Japanese.

New Talend Cloud API Tester features

This section lists the new features available in Talend Cloud API Tester. For more information, see the Talend Cloud Release Notes.
Feature Description
Enhanced team collaboration You can share test environments and their variables with other users and groups, use private variables within shared environments, and view an activity history for your projects.
Internationalization The Talend Cloud API Tester application and documentation are available in French and Japanese.