› Communications Manager Installation Guide › Scaling out composition › Scaling out tools

Scaling out tools

To scale out your composition, you need the following tools:

CreateProject.exe

Creates a new DOCX project in the repository database with a CLI.

The project is created in the same way as in Designer > New Project. Unlike Communication Manager Designer, this tool works without a repository user and does not require logging in. It requires the Services!Password instead.

Location

<DeployRoot>\CommunicationsManager\Programs\2025.3\Management\Instance

Scope and restrictions

  • Cannot be used in secondary instances.

  • Cannot create snapshots.

Parameters

Parameter Required/Optional Description
Instance!Number Required The number of the instance.
Services!Password Required The password for the Communications Manager service account.
Project!Name Required Project name.
Project!Group Optional Project group.

DeleteProject.exe

Deletes a project from the repository database with a CLI.

Unlike Communication Manager Designer, this tool works without a repository user and does not require logging in. It requires the Services!Password instead.

Location

<DeployRoot>\CommunicationsManager\Programs\2025.3\Management\Instance

Scope and restrictions

  • Cannot be used in secondary instances.

  • Cannot delete snapshots.

Parameters

Parameter Required/Optional Description
Instance!Number Required The number of the instance.
Services!Password Required The password for the Communications Manager service account.
Project!Name Required Project name.

CreateSnapshot.exe

Creates a new snapshot of the published state of an existing project.

The snapshot is added to the repository. The snapshot is attached to the project and given a name, description (optional), and creation time.

Location

<DeployRoot>\CommunicationsManager\Programs\2025.3\Management\Instance

Scope and restrictions

  • Cannot be used in secondary instances.

  • Can only create snapshots of projects, but not snapshots of other snapshots.

Parameters

Parameter Required/Optional Description
Instance!Number Required The number of the instance.
Services!Password Required The password for the Communications Manager service account.
Project!Name Required Project name.
Snapshot!Name Required Snapshot name.
Snapshot!Description Optional Snapshot description.

ImportSnapshot.exe

Imports an exported snapshot into the repository database.

The snapshot can optionally be renamed and connected to a different project upon import. The description, timestamp, and content of the snapshot can never be modified.

Location

<DeployRoot>\CommunicationsManager\Programs\2025.3\Management\Instance

Scope and restrictions

  • Cannot be used in secondary instances.

  • Cannot import projects.

  • Can import snapshots of projects that do not exist in the same repository.

Parameters

Parameter Required/Optional Description
Instance!Number Required The number of the instance.
Services!Password Required The password for the Communications Manager service account.
Project!Name Required when Snapshot!Rename=True, not permitted otherwise. Project name. Overrides the project name stored in the snapshot export file.
Project!Group Optional when Snapshot!Rename=True, not permitted otherwise. Project group where the snapshot is placed.
Snapshot!Rename Optional. Defaults to false when omitted. Boolean flag. Indicates whether the snapshot is renamed upon import.
Snapshot!Name Required when Snapshot!Rename=True, not permitted otherwise. Snapshot name. Overrides the snapshot name stored in the snapshot export file.
Snapshot!File Required Snapshot export file to load.

ExportSnapshot.exe

Exports an existing snapshot to disk.

The snapshot export file stores the project that the snapshot is created from, as well as the snapshot name, description (optional), and creation time.

Location

<DeployRoot>\CommunicationsManager\Programs\2025.3\Management\Instance

Scope and restrictions

  • Cannot be used in secondary instances.

  • Cannot export projects.

Parameters

Parameter Required/Optional Description
Instance!Number Required The number of the instance.
Services!Password Required The password for the Communications Manager service account.
Project!Name Required Project name.
Snapshot!Name Required Snapshot name.
Snapshot!File Required Snapshot export file to create.

ExportContentAsSnapshot.exe

Creates a snapshot of the published state of an existing project and exports it.

The snapshot is saved to disk, but not added to the repository. The snapshot export file stores the project that the snapshot is created from, as well as the snapshot name, description (optional), and creation time.

Location

<DeployRoot>\CommunicationsManager\Programs\2025.3\Management\Instance

Scope and restrictions

  • Cannot be used in secondary instances.

  • Cannot create snapshots of snapshots.

Parameters

Parameter Required/Optional Description
Instance!Number Required The number of the instance.
Services!Password Required The password for the Communications Manager service account.
Project!Name Required Project name.
Snapshot!Name Required Snapshot name.
Snapshot!Description Optional Snapshot description.
Snapshot!File Required Snapshot export file to create.

DeleteSnapshot.exe

Deletes a snapshot of a project.

Location

<DeployRoot>\CommunicationsManager\Programs\2025.3\Management\Instance

Scope and restrictions

  • Cannot be used in secondary instances.

  • Cannot delete active snapshots.

Parameters

Parameter Required/Optional Description
Instance!Number Required The number of the instance.
Services!Password Required The password for the Communications Manager service account.
Project!Name Required Project name.
Snapshot!Name Required Snapshot name.

ActivateSnapshot.exe

Marks the given snapshot as active.

At most one snapshot can be active per project. If another snapshot of the project is already active, it will automatically be deactivated.

Location

<DeployRoot>\CommunicationsManager\Programs\2025.3\Management\Instance

Scope and restrictions

  • Cannot be used in secondary instances.

Parameters

Parameter Required/Optional Description
Instance!Number Required The number of the instance.
Services!Password Required The password for the Communications Manager service account.
Project!Name Required Project name.
Snapshot!Name Required Snapshot name.

DeactivateSnapshot.exe

Removes the active mark from the given snapshot.

After you run this tool, the project remains without any active snapshots.

Location

<DeployRoot>\CommunicationsManager\Programs\2025.3\Management\Instance

Scope and restrictions

  • Cannot be used in secondary instances.

Parameters

Parameter Required/Optional Description
Instance!Number Required The number of the instance.
Services!Password Required The password for the Communications Manager service account.
Project!Name Required Project name.
Snapshot!Name Required Snapshot name.

ListSnapshots.exe

Displays an overview of the given project's snapshots.

Location

<DeployRoot>\CommunicationsManager\Programs\2025.3\Management\Instance

Scope and restrictions

None.

Parameters

Parameter Required/Optional Description
Instance!Number Required The number of the instance.
Services!Password Required The password for the Communications Manager service account.
Project!Name Optional. Mutually exclusive with Report!OverviewFile When specified, displays all snapshots of the given project. When not specified, shows active snapshots of all projects.
Snapshot!Name Optional. Mutually exclusive with Project!Name When specified, writes a detailed overview of all projects and all snapshots to the given file instead of displaying a report in the console.