Managed Runtime Administration

Manage your organizations, projects, environments, and bundles associated with your Storefront Next storefront with various tools, including the Runtime Admin console, Business Manager, and Account Manager.

Alternatively, perform the administration tasks with the Managed Runtime API.

• For Runtime Admin access, contact your B2C Commerce administrator and ask them to add one of these roles to your account in Account Manager: Managed Runtime User or Managed Runtime Admin.

Organization admins can manage user access and permissions at the organization level, which affects user access across all projects within the organization.

To add a user at the organization level:

1. Log in to Account Manager.
2. Find the users in your organization who need access.
3. Add the Managed Runtime Admin or Managed Runtime User role and save. Users can now log in to Runtime Admin for your organization.

To modify a user’s organization-level permissions:

1. Navigate to Organization Users.
2. Click Edit next to the user’s name.
3. Modify the permissions as needed.
   • Certificates: Allows the user to view, request, manage, and renew TLS certificates.
   • View All Projects: Allows read-only access to all projects within the organization.
4. Click Save.

To remove a user from the organization:

1. Log in to Account Manager.
2. Find the users in your organization who need access.
3. Remove the Managed Runtime Admin or Managed Runtime User role and save.

Projects help you manage multiple environments within an organization. Every Storefront Next project has a corresponding project within Managed Runtime for deploying and hosting the storefront code on Salesforce public cloud infrastructure. The storefront setup in Business Manager automatically creates a project for the storefront.

To find a project via the UI, start in Business Manager or Runtime Admin. To view the project, you must be assigned one of the project roles described in Prerequisites.

If you created your storefront in Business Manager, access your environment variables from the storefront page.

1. In Business Manager, click App Launcher and then select Administration > Sites > Storefronts, and then click your storefront.

2. In the storefront detail page, click the environment, and then click Manage next to Deployments. You’re redirected to the Deployments page in Managed Runtime in a new tab.

3. Click the project name in the header.

To find an existing project in Managed Runtime:

1. Log in to Runtime Admin.
2. Select an organization from the organization menu (top left), if necessary.
3. Click the name of the project.

To quickly switch between projects, use the project menu at the top of the page.

From the Project Settings page:

• Look up the project ID and ensure that it matches a Storefront Next configuration.
• Edit the project ID.
• View and edit the project’s name and URL.
• Delete the project.
• Manage deployment notifications. (See next section.)

To access the Project Settings page:

1. Go to a project’s Overview page.
2. Click Project Settings from the left navigation.

To edit the settings, click Edit, make your edits, and click Update. To discard your edits, click Cancel.

To delete a project, click Delete, enter the project name to confirm, and click Yes, Delete. To keep the project, click No, Keep.

Receive email notifications for any of these deployment events:

• Start Deployment
• Successful Deployment
• Failed Deployment

To add a notification:

1. Go to a project’s Overview page.
2. Click Project Settings from the left navigation.
3. Click Add Notification.
4. Select one or more environments to be notified about.
5. Select one or more deployment events.
6. Enter email addresses for all notification recipients.
7. Click Add Notification.

To edit a notification:

1. Go to a project’s Overview page.
2. Click Project Settings from the left navigation.
3. Click the … button next to the notification.
4. Click Edit.
5. Change any of the notification settings.
6. Click Update Notification.

To remove a notification:

1. Go to a project’s Overview page.
2. Click Project Settings from the left navigation.
3. Click the … button next to the notification.
4. Click Remove.
5. Click Yes, Remove.

Create and manage environments in Business Manager, in the storefront’s page. When you create a storefront in Business Manager, it is preconfigured with the embedded content delivery network (eCDN) and a default domain. The default domain maps the domain to the MRT backend site.

To learn more about environments and other related concepts, see the Managed Runtime Overview.

• Business Administrator role in Account Manager or a role for the Business Manager Module and Organization context with read-write access to storefronts. See Create a Role in B2C Commerce in Salesforce Help.

See Create an Environment in Business Manager.

All supported regions have a paired backup region for failovers. Make sure that your application runs correctly in the selected primary and backup regions:

For any site that uses Storefront Next and Managed Runtime, designate only one bundle at a time as deployed per environment.

1. Go to a project’s overview page.
2. Click the name of the environment you want to deploy to. For example: production.
3. Under Bundles, click Deploy next to the bundle you want to deploy.
4. Click Confirm Deploy.
5. Wait until the deployment is complete.

When the deployment has successfully completed, the bundle appears underneath the heading Deployed Bundle. (For your first deployment to a new environment, the process can take up to an hour to complete.)

For any site that uses Storefront Next and Managed Runtime, you can delete only non-deployed bundles from a project.

1. In the project’s overview page, click an environment.
2. Select one or more bundles that aren’t currently deployed.
3. Click Delete.
4. When asked to confirm, click Delete.
5. Wait until the deletion is completed.

Deletions are handled asynchronously and can take time to process.

Access the environment settings in one of these ways:

• If you created the environment in Business Manager, go to Administration > Sites > Storefronts, click your storefront, and then next to the environment, click the caret dropdown and click Edit. Log in to Runtime Admin opens in a new tab and access Environment Settings.
• Otherwise, log in to Runtime Admin. From your project, click the environment, and then click Environment Settings.

From the Environment Settings page, do these administration tasks:

• Rename an environment or environment ID.
• Change the deployment region.
• Enable or disable Source Maps.
• Add, edit, or remove site IDs associated with an environment.

To access the Environment Settings page for a storefront created in Business Manager:

1. In Business Manager, click App Launcher and then select Administration > Sites > Storefronts, and then click your storefront.
2. In the storefront detail page, click the dropdown next to the environment, and then click Edit. You’re redirected to the Environment Settings page in Managed Runtime.

To access the Environment Settings page in Runtime Admin:

1. Go to a project’s Overview page.
2. Click the name of the environment whose settings you want to edit.
3. Click Environment Settings from the left navigation.

To make edits, click the Edit button next to either the General settings or the Advanced settings. After making your edits, click Update to save your changes or click Cancel to discard your changes.

Managed Runtime supports the ARM processor architecture for Server-Side Rendering (SSR) for Storefront Next. The ARM architecture represents the underlying compute infrastructure used to render your storefront.

ARM processors offer several advantages.

• Enhanced Performance: ARM architecture provides efficient processing capabilities optimized for modern web workloads.
• Modern Infrastructure: Built on the latest cloud computing technologies.

See Environment Variables.

Use a redirect to forward a request from one URL to another. Redirects can help avoid disruptions to the user experience caused by changes to your storefront. For example, consider a seasonal campaign page for spring. When the spring campaign ends and is replaced with a summer campaign, you can redirect from the spring URL to the summer URL.

Redirects is a powerful feature that can have significant security consequences on your storefront, including redirecting to malicious URLs or assets. Be careful when assigning roles to users that give them Redirect access.

Also create redirects using the projects_target_redirect_create API endpoint.

To create a redirect using Runtime Admin:

1. Go to a project’s Overview page.
2. Click the name of the environment where you want to create the redirect.
3. Click URL Redirects from the left navigation.
4. Click Create Redirect.
5. In the Redirect From field, enter a relative URL path. For example, to redirect visitors from the URL www.example.com/winter, enter /winter.
6. In the Redirect To field, enter a relative URL path.
7. If needed, enable forwarding of query parameters and the wildcard path. (For more information, see Forwarding Query Parameters.)
8. From the Redirect Type dropdown menu, select a redirect type based on the HTTP status code. (For more information, see HTTP Status Codes.)
9. Click Create Redirect.

These sections describe each redirect option in detail.

The value that you enter in the Redirect From field must always be a relative path. The Redirect To field can be either a relative path or a full URL. For example, to redirect visitors from www.example.com/spring to www.example.com/summer, set Redirect From to /spring. The Redirect To field can be either /summer or www.example.com/summer.

Add an asterisk (*) to the end of the Redirect From URL to indicate a wildcard. A wildcard matches any (0 or more) characters in the URL. For example, a redirect from /a/* would match /a/, /a/b, and /a/b/c.

A wildcard character can only be used at the end of the Redirect From URL.

Standard redirects are processed first by Managed Runtime, followed by redirects with wildcards.

Most redirects use the Permanent 301 status code, but you can also select Temporary 302. If you’re unsure which HTTP status code to use, consult this status code explainer from MOZ.com.

Some requests contain query string parameters that you also want to include in the redirected request. For example, the relative path /spring-landing-page can be appended with a query string for analytics tracking, such as /spring-landing-page?gclid=123.

To enable query parameter forwarding, go to the Forward section of the form and select Query Parameters. Otherwise, query string parameters from the source URL aren’t included in the redirect URL.

When both the Redirect From and Redirect To URLs have query strings and forwarding is enabled, the redirect URL combines both query strings. The query parameters from the Redirect To URL are appended to the query string in the request. For example, imagine your application receives a request for the relative path /spring?year=2019. If you’ve chosen to redirect /spring to /summer?year=2020, the redirect URL is /summer?year=2019&year=2020 when forwarding is enabled.

You can automatically include any path that comes after the wildcard portion of the Redirect From URL in the Redirect To URL. For example: if /a/* matches /a/b/c in the Redirect From URL, and the Redirect To URL is /z/, the redirect URL is /z/b/c.

To enable wildcard path forwarding, go to the Forward section of the form and select Wildcard Path.

Copy all the redirects from one environment to another using the clone redirects feature.

Also clone redirects using the projects_target_redirect_clone_create API endpoint.

To clone redirects using Runtime Admin:

1. Go to a project’s Overview page.
2. Click the name of the environment that contains the redirects that you want to clone.
3. Click URL Redirects from the left navigation.
4. Click Clone Redirects. The Clone Redirects form appears. The current environment is listed under From Environment (the source).
5. Under To Environment, select the environment that you want to clone the redirects into (the destination).
6. Click Clone n Redirects. (Where n is the number of redirects to be cloned.)

Also edit a redirect using the projects_target_redirect_partial_update API endpoint.

To edit the settings for an existing redirect using Runtime Admin:

1. Go to a project’s Overview page.
2. Click the name of the environment that contains the redirect that you want to edit.
3. Click URL Redirects from the left navigation.
4. Click the ellipsis button (…) next to the redirect.
5. Click Edit.
6. Update the settings.
7. Click Update Redirect.

Delete a redirect using the projects_target_redirect_destroy API endpoint.

To delete a redirect using Runtime Admin:

1. Go to a project’s Overview page.
2. Click the name of the environment that contains the redirect that you want to delete.
3. Click URL Redirects from the left navigation.
4. Click the ellipsis button (…) next to the redirect.
5. Click Delete.
6. Click Yes, Delete Redirect.

If a redirect isn’t working as expected, try these troubleshooting steps:

• Clear your browser cache because redirects are cached.
• Verify that you’re viewing the settings for the correct environment.
• Edit the redirect and verify that the correct values are entered in the Redirect From and Redirect To fields.

Redirects have the following technical limitations:

• Each environment can have a maximum of 10,000 redirects.
• Each environment has its own set of redirects. Keep them in sync using cloning.
• The redirects feature supports simple redirects from one path to another. For complex redirects with conditionals, use Express.js’ redirects support in ssr.js.
• Redirects created with the Runtime Admin tool or the Managed Runtime API don’t run on local development environments.
• Redirects aren’t triggered by page transitions in the Storefront Next app. They can only be triggered by an HTTP request.
• To load a redirect in the context of a storefront, use the managed endpoint /mobify/redirect/$path.

To add a user to a project:

1. Go to a project’s Overview page.
2. Click Users & Permissions from the left navigation.
3. Click New User.
4. Enter the user’s email address. (Make sure that the user is part of your organization and has one of the following roles in Account Manager: Managed Runtime User or Managed Runtime Admin.)
5. Select a role.
6. Click Add User.

To change a user’s role:

1. Go to a project’s Overview page.
2. Click Users & Permissions from the left navigation.
3. Click the … button next to the user’s name.
4. Click Edit.
5. Select a role.
6. Click the popup menu that appears.
7. Select a new role.
8. Click Save.

For a list of user abilities associated with each role, see the Managed Runtime Overview.

To remove a user from a project:

1. Go to a project’s Overview page.
2. Click Users & Permissions from the left navigation.
3. Click the … button next to the user’s name.
4. Click Remove.
5. Click Yes, Remove User.