Publishing and displaying immersive projects

Publishing an immersive project is a three-part process: create a project record, upload a version's .zip file to it, and link a CMS page to the project so it has somewhere to be served from.

Create an immersive project

An Immersive Project record is a container that tracks a project's uploads and provides a stable identifier a CI/CD pipeline can reference across deploys.

To create an immersive project:

1. In the header, click .

2. From the Create list, select Immersive Project.

3. In the Internal Identifier field, type a unique identifier for the project.

   note

   If a CI/CD pipeline also uploads to this project, its identifier must match the id parameter sent by the pipeline.

4. (Optional) In the Internal Name field, type a display name. If left blank, the name is populated automatically from the first upload's manifest, if it has one.

5. (Optional) From the Asset Serving Mode list, select an option to override the site-wide default (see Configuring immersive projects) for every version of this project.

6. Complete your site's workflow to publish the asset.

Upload a version

Each upload to a project is tracked as an Immersive Project Version record.

To upload a version:

1. In the header, click .
2. From the Create list, select Immersive Project Version.
3. (Optional) In the Internal Name field, type a name to identify this version in dropdown lists.
4. From the Immersive Project list, select the project this version belongs to.
5. In the Interactive Project Archive field, upload a .zip file containing the project. See Technical reference for the required .zip structure.
6. Complete your site's workflow to publish the asset.

Publishing the record automatically queues a background job that extracts the .zip and uploads its contents to cloud storage. The record's read-only Job field shows the job's current status.

note

If the .zip includes an immersive-manifest.json file at its root, its name value sets the project's Internal Name (only if the project has no name yet), and its version value sets this version's Internal Name, replacing the default upload-timestamp label. See Technical reference for the full manifest format.

Monitor upload jobs

Every upload—whether started from the CMS or from a CI/CD pipeline—creates an Immersive Project Job asset that can be reviewed independently of the version record that triggered it. Immersive Project Job assets extend the platform's Job type, so they appear on the CMS's search page for that asset type, with the completion-status and last-activity-date filters described in Searching and monitoring jobs.

To review upload history: Go to the search page for Immersive Project Job assets. Each job shows its status: Pending while the upload is being processed, Success once the files are in cloud storage, or Failed if the upload could not be completed.

Link a page to a project

Any CMS content type that has been set up to host immersive projects (see Technical reference) exposes an Immersive Project tab.

To link a page to an immersive project:

1. Open the page, and click the Immersive Project tab.

2. From the Project list, select Set.

   The Immersive Project, Immersive Project Version, and Sub Page fields appear.

3. From the Immersive Project list, select the project to display.

   The page serves that project's latest published version by default.

4. (Optional) From the Immersive Project Version list, select a specific version to lock the page to that release instead of always serving the latest one.

5. (Optional) From the Sub Page list, select an HTML file within the project. The page then resolves to that specific file instead of serving the project as a whole. When this field is empty, the page serves the whole project starting from its root HTML file.

6. Complete your site's workflow to publish the asset.

note

Some page types also include a Sub Page Metas cluster for overriding SEO and social-share metadata (title, description, share image) per sub-page. Whether this is available depends on how the page type was implemented—check with your development team if you don't see it.