Product, Sandbox, and Deployment IDs

Overview of product management tools in the Developer Portal.

Epic Online Services (EOS) features a robust product-management system that can help you keep your game updated, support your players, manage your game's finances, and provide usage reports and other statistical data. Once you have created an account and registered an Organization, you can set up Products that your Organization owns, configure services, and manage settings for identity providers and platforms that are available for that product. This makes configuring services across multiple storefronts and platforms straightforward and simple. This page provides a reference for the product management levels that are available and explains how each of them relates to games using the EOS SDK.

Overview

Click image for full size.

Data in the EOS environment is organized into four tiers: Global, Product, Sandbox, and Artifact. Each of these tiers is a subdivision of the previous tier, with the division of information between them working as follows:

  • At the Global level, Organizations contain Products.

  • Products contain a series of Sandboxes, which are broad distribution environments. These are typically divided into Development, Staging, and Production.

  • Sandboxes contain Artifacts, which can be any distributable asset, including individual Deployments of the game itself.

The following example illustrates this hierarchy in practice:

  • Organization: Epic Games

    • Product: Jazz Jackrabbit

      • Sandbox: Development

        • Deployment: DevGame01

      • Sandbox: Staging

        • Deployment: QATestGame01

        • Deployment: AlphaGame

        • Deployment: BetaGame

      • Sandbox: Live

        • Deployment: LiveGame

For information about Organizations, refer to the Organization Management reference page. The following sections will provide you with information about managing Products, Sandboxes, and Deployments through the Products page.

Managing Products

The user lands on an Organization Dashboard after logging in, which gives quick access to all of their Products and allows them to create more.

Click image for full size.

You can manage your Organization's product settings from the Product Settings page.

Click image for full size.

The Product Settings page is broken into several sub-sections that each contain essential product information. These include Sandboxes, Identity Providers, and Client Credentials. Identity Providers and Client Credentials each have their own pages that you can refer to for more information. The sections below provide information about managing Sandboxes and Deployments.

General Information

Click image for full size.

The General Information section includes the following data:

Item

Description

Product ID

An identifier that is assigned when your Product is created. It is unique across the entire EOS environment, and can not be changed once it is assigned.

Product Name

The friendly name of your Product. You may change this by typing a new name in the box, then clicking the Change Name button.

Product Slug

A short name for your Product.

Product Cover Image

A cover image to display when viewing the Products page.

Sandboxes

A Sandbox represents a high-level distribution environment for a game that is applicable across many different platforms. Sandboxes contain store-related information, mod configurations, and entries for specific deployments of a game.

You may view and edit your product's sandboxes by scrolling down to the Sandboxes section on the Product Details page.

Click image for full size.

By default, new Products include the following pre-defined Sandboxes:

Pre-defined Sandbox

Description

Development

Used by game developers who are actively building features for a game.

Staging

Used by QA for testing purposes.

Production

Reserved for shipping a game to end-users.

The Production Sandbox is accessible by any member of the Product's owning Organization. Users who require Staging and Development access must be granted access specifically. Although these are the default predefined Sandboxes available for new Products, additional Sandboxes can be requested.

You can edit information for Deployments that belong to a Sandbox by clicking on the Deployments button on the right-hand side of its entry in the Sandboxes section. See the Deployments section below for more details.

Clicking the Identity Providers button within your Sandbox's entry will open a sidebar menu showing all of the Identity Providers you have available in your Product. You can use this menu to enable or disable whichever Identity Providers you want within this Sandbox.

Sandbox Identity Providers

To learn more about adding Identity Providers to a Product, refer to the Identity Providers page.

Deployments

A Deployment represents a specific distribution of a game and stores game progression, achievements, statistics, matchmaking, and other gameplay-related player information. Deployments may be configured by clicking on the Deployments button for a given sandbox. This will open a sidebar menu for configuring Sandbox Deployments.

Click image for full size.

You may add new deployments to a given Sandbox by clicking the New Deployment button, which will prompt you to provide its name. To edit a deployment's name, click the dropdown on the right side of its entry in the Sandbox Deployments list, then click Edit.

Click image for full size.

Each Deployment may be attached to only a single Sandbox at a time. If you want parallel deployments in two different Sandboxes, you must create one for each of them.

Each Deployment is automatically assigned a unique identifier. This Deployment ID is required for initializing the SDK, and configures it to access game session data for that Deployment. Information stored at the Sandbox level is also obtained using Deployment ID.