Overview
The Document Composition editor is the desktop application where you design and build your document templates in CX Platform. Unlike the rest of CX Platform, which runs in your browser, the editor sits locally on your machine — which is what gives it the design power and performance needed for complex template work.
Because it's a local install, the setup process isn't quite as one-click as the rest of the platform. Some teams can get it running in a few minutes, while others will need to go through their IT or security team's standard software approval process. Either way, it's a one-time setup, and once it's installed you're good to go.
Every organisation handles software installation a little differently, so the steps below describe the general flow rather than a fixed click-by-click path. Your IT team can tell you exactly how the process works for your environment.
Heads up
If your organisation has managed devices or strict software approval policies, loop in your IT or security team before you request the installer. It's much smoother to get sign-off up front than to chase approvals once you've already got the file sitting in your downloads folder.
Before you start
A bit of prep makes the install go faster. Here's what to gather:
- Your CX Platform contact — they're the one who'll provide the installer and any organisation-specific configuration details.
- Your IT or security contact — even if you have admin rights, it's worth checking whether the installer needs to go through a managed deployment process.
- Your CX Platform sign-in credentials — you'll need these the first time you open the editor.
- A supported machine — your CX Platform contact can confirm the current system requirements (operating system, memory, disk space) for the version you're installing.
Request the installer
The editor isn't a public download. Your CX Platform contact will provide the installer that matches your organisation's environment and licensing, along with any details your IT team needs to review it.
- Reach out to your CX Platform contact and let them know you need the Document Composition editor installer.
- Confirm which version is right for you — your contact will check this against your platform setup and any organisation-specific requirements.
- Pass the installer and any supporting documentation (release notes, system requirements, code signing details) to your IT or security team if they need to review it first.
Coordinate with your IT team
This is the step that varies most from one organisation to another. Depending on how software is managed at your workplace, your install might look like any of the following:
- Self-install — if you have local admin rights and your organisation allows trusted vendor software, you can run the installer yourself.
- Managed deployment — your IT team pushes the editor out via their software distribution tool (such as SCCM, Intune, or Jamf), and it appears on your machine without you needing to run anything manually.
- Approval and assisted install — your IT team reviews and approves the installer, then schedules a time to install it on your machine with you.
If you're not sure which applies to you, your IT team will. A quick message describing what the editor is and who provided the installer is usually all they need to get the ball rolling.
Run the installer
Once your IT team has given the green light (or handled the install themselves), the editor will be available on your machine. If you're running it yourself:
- Double-click the installer file to launch it.
- Follow the on-screen prompts, accepting the default install location unless your IT team has asked you to use a specific path.
- When the installer finishes, you'll see the Document Composition editor in your applications list or on your desktop.
Sign in and verify
The first time you open the editor, you'll be asked to sign in. This connects the editor to your CX Platform account so your templates, fields, and Applications are all available.
- Open the Document Composition editor.
- Enter your CX Platform credentials when prompted.
- Once you're signed in, check that you can see your Applications and templates listed. That confirms the editor is connecting to your platform correctly.
Tip
If the editor opens but you can't see any of your templates, it's usually a permissions issue rather than a problem with the install. Check with your CX Platform administrator that your account has access to the right Applications.
If something goes wrong
Most installation hiccups come down to one of three things: a security setting blocking the installer, a missing prerequisite on the machine, or a network restriction stopping the editor from reaching CX Platform after install. Your IT team can usually clear these quickly once they know what to look for.
If you're stuck, get in touch with your CX Platform contact. Let them know what step you got to and what message you saw, and they'll help you work through it. That's it — once the editor is installed and signed in, you're ready to start building and editing document templates. Head to the Document Composition guides next to learn your way around the editor itself.