Migrating your Drupal 7 portal to the integrated portal

This section provides guidance on how to plan and execute the migration of your Drupal 7 portal assets to the integrated portal.

Step 1: Create an integrated portal

Before migrating your Drupal 7 portal assets, you must create an integrated portal.

To create an integrated portal:

  1. Ensure that you have the appropriate portal roles to manage an integrated portal.
  2. Create an integrated portal.

When you create an integrated portal, a set of starter pages is provided for you to use as a jump-off point. The starter pages contain demo content to help inspire your own portal development as you replace the text and images with your unique content. For more information, see About the sample portal.

Step 2: Build your integrated portal

Build your integrated portal, as described in Steps to build your portal.

At a minimum, you'll need to perform the steps listed in the following table.

Step Description
Develop portal content Such as conceptual and getting started information.

You may choose to create pages, and then copy and paste the page content directly from your existing Drupal 7 portal.

Set up navigation Create the navigation required to match your existing structure.
Customize your theme At a minimum, customize the following components to match your branding requirements:
Add custom scripts Add custom JavaScript code to your portal, as required.
Configure email Configure your SMTP server and the content of email notifications.

Note: Email notification configuration is not available to Apigee hybrid integrated portals at this time.

Manage the default visibility Manage the default visibility for specific resources.
Configure a content security policy Configure a content security policy (CSP) for all pages in your portal to protect against cross-site scripting (XSS) and other code-injection attacks, if desired.

Note: This feature is not available to Apigee hybrid integrated portals at this time.

Step 3: Configure the identity provider

Configure the identity provider on the integrated portal based on the authentication type, as outlined in the following table.

Authentication Description
Built-in identity provider (username/password) Configure the built-in identity provider on the integrated portal.
Single sign-on (SSO) using SAML Configure the SAML identity provider (Beta) on the integrated portal.

Notes:

After developers sign in to the portal, you can manage their account, as described in Manage developer accounts.

Step 4: Control access to resources using audiences

If you use roles in Drupal 7 to control access to a set of resources, such as API documentation or API key creation for an API product, you can achieve this same functionality using audiences on the integrated portal.

Specifically, you can control access to the following resource on the integrated portal using audiences:

  • Pages in your portal
  • Published API products

To add an audience and manage the individual user and developer team assignments, see Manage audiences. When a new user creates an account and signs in to your portal, you'll need to assign them to one or more audiences, as required, as described in Manage the assignments for an audience.

To simplify the migration, you might consider the following tips:

  • Name your audiences after the Drupal roles they are replacing.
  • Manage audience membership using developer teams. Developers create teams to share responsibility for their apps and manage team membership.

Step 5: Publish your APIs

In order to publish APIs and auto-generate API reference documentation using SmartDocs on the integrated portal, you need access to the OpenAPI Specification associated with the API.

Although you may have used an OpenAPI Specification to auto-generate the SmartDocs in Drupal 7, ultimately the content is stored using an internal format without any association to the original OpenAPI Specification. API teams using Apigee Edge typically store OpenAPI Specifications in the Apigee Edge spec store.

Then, publish an API to your portal. Be prepared to:

  • Specify the OpenAPI Specification to use as the documentation source, from the spec store, your local directory, or a URL
  • Set up visibility for the documentation (public, authentication users, or selected audiences)
  • Configure a callback URL, if required
  • Add an image to the display in your API catalog, if desired

Step 6: Share responsibility for an app using developer teams

If your developers use company apps in Drupal 7 to share responsibility for an app, they can achieve this same functionality using developer teams on the integrated portal.

Your developers create developer teams to share responsibility for their apps and manage team membership, as described in Share responsibility for an app using developer teams (Beta).

You might want to educate your developer community about developer teams and encourage them to migrate their apps to use developer teams for sharing responsibility and transition to using the new API keys. Then, you can remove all company apps and related artifacts using the Edge APIs.

Alternatively, you can migrate company apps to developer team apps, as described in the following community article: Migrating company-owned apps to developer teams.

Step 7: Prepare to launch your integrated portal

Before you launch your integrated portal to production, consider performing the steps defined in the following table.

Step Description
Customize your domain Provide your own custom domain name to personalize your site.

Note: This feature is not available to Apigee hybrid integrated portals at this time.

Configure analytics tracking Configure analytics tracking using Google Analytics or your own custom analytics tracking service.
Create a custom search page Create a custom search page and embed a Google custom search engine.