EngageCX Drive Guide

Getting Started

Overview

EngageCX Drive is a synchronization tool that helps you stay organized with your local files, access important server assets and share file changes with your team. Either you intend to edit your assets locally or within the EngageCX Platform directly, all the changes will be kept in sync.

Accessing EngageCX Drive

The EngageCX Drive is a subcomponent of the EngageCX Studio software. Either you install all of the three main components (Publisher, Modeler and Analyst), or each one separately, EngageCX Drive will be automatically installed on your local machine, allowing you to connect with your EngageCX Platform account.

There are a number of ways you can use to access the EngageCX Drive tool:

From Windows Start Menu

From Taskbar

From EngageCX Studio Tools

Accounts

Signing in

If you're new to EngageCX Drive, this section will walk you through the steps to get started synchronizing your EngageCX files.

EngageCX Drive displays data hierarchically, including the Content Library, and permits files to be opened directly with the corresponding tool. For example, if you want to open the Invoice.epr template, double-click on it and it will automatically open in Publisher.

Accounts Management

Even if you are already connected to your EngageCX account, you can make edits to it. Additionally, connecting to multiple EngageCX accounts is available. All accounts settings can be performed within the Configure Accounts dialog.

There are two ways to access the Configure Accounts dialog. Here's how:

From Drive Interface

From Taskbar


The Configure Accounts dialog allows you to connect to new accounts or edit existing accounts as needed. To learn more about existing options, select one from the table below:

Add Account Set Active Accounts Edit Account Remove Account

Adding New Accounts

In case you want to access files from different EngageCX environments, you can set up a new connection to the EngageCX Platform by using the new account credentials, rather than editing the existing account. Here's how:

Set Active Accounts

When you are connected to multiple accounts, only one can be active, and the others are seen as passive. When an account is active, all the assets included are displayed into the EngageCX Drive interface, and you can make changes to them. To set up an account as active, follow the steps below:

Editing Accounts

Within an existing account, you can change the local folder which stores locally all the assets included, or you can choose between manual or automatic synchronization. To access the Edit Account dialog, follow the steps below:

Removing Accounts

At any time, you can stop accessing the EngageCX Platform from your local machine by removing your account. Here's how:

Project Assets Management

Repository Location

EngageCX Drive creates a local folder on your hard drive to store your project assets you synchronize. By default, it will be created at C:\Users\Username\Documents\EngageCX\Eos\\{Workspace}.

The easiest way to access it is by selecting the Folder ( ) icon from the upper right side of the EngageCX Drive interface.

To change the default folder location, please follow the steps below:

Opening Assets

There are a number of ways to open EngageCX files. As best practice, the latest version of your documents must be downloaded to ensure that the correct changes are applied to your files.

Opening Files

By Using the Open Option


By Double-click

Opening Folders

By Using the Open Option


From the Default Location

Adding New Assets

Creating New Folders

At any time, you can create new folders within your workspace or other folders, directly from the EngageCX Drive tool.


Within the Workspace


Within Other Folders

Uploading Folders

By using the EngageCX Drive tool, you can upload local folders together with data within, to the EngageCX Platform.

Adding Files to Folders

You can add files to your folder through EngageCX Drive and then get to them from anywhere.

Editing Assets

Removing Assets

You can remove files within your EngageCX projects directly from the EngageCX Drive tool.

Renaming Assets

In case you want to provide a new name for a folder or file, you can do this directly from the EngageCX Drive.

Assets Versions

Versions allow you to save the state of a file and its content as a backup that you can restore later. When you modify files through versions, the versioning mechanism continues to behave as expected, creating a new version with each change.

Restore a Version

Download a Version

Syncing

The EngageCX Platform allows you to synchronize your local files with the server in two ways, either automatically or manually, after each change you make.

Automatic Synchronization

The automatic synchronization method simplifies the authoring process by eliminating the synchronization steps. When automatic synchronization is enabled, your documents are in sync all the time, no matter how often you make edits to your documents.

Automatic synchronization can be enabled within your account. Here's how:

Manual Synchronization

If you do not want the changes you make on your files to be seen by other people right away, EngageCX Drive allows you to manually synchronize your files.

To disable automatic synchronization and manually synchronize your files, follow these steps:


When you synchronize your files manually, it must be necessary to understand the following options available on EngageCX Drive:

Check Out for Edit Check In Pending Changes Undo Pending Changes Get Latest Version

Check Out for Edit

To make sure that no other person can edit a document while you make changes on it, it might be necessary to check out the file or folder. When your file/folder is checked out, you can edit it locally or on the server.

Check In Pending Changes

When the synchronization is performed manually, the changes you make on the documents will not be available to your colleagues until you check the files back into the EngageCX Platform.

Undo Pending Changes

If you check out a file/folder and don't make changes to it, or you make changes that you don't want to keep, you can simply discard the checkout, rather than saving the file. When you discard a checkout, you can avoid making a new version of your file.

Get Latest Version

It is best practice to stay up to date and download the latest documents from the EngageCX Platform on a regular basis so that the files you design can be compatible with the one created by your organization.

Settings and Personalization

Startup App

The EngageCX Drive is configured to automatically start whenever Windows boots. Although it also has a built-in setting that allows you to configure whether you want to start the tool with Windows or not.

Display Hidden Files

The EngageCX Platform allows you to create and add hidden folders into your workspaces. Within the EngageCX Drive you can choose to display or not the hidden folders. When the option is enabled, all hidden folders will be displayed as grayed out in the interface.

Viewing Shared Folders

Just like in the Enterprise Website, shared folders are visible across multiple workspaces within the EngageCX Drive tool as well. To view the shared folders, it might be necessary to switch between the workspaces. Here's how:

EngageCX Drive Icons

When working with EngageCX Drive, there are some icons you will need to familiarize yourself with in order to fully take advantage of this functionality.

Name Symbol Meaning
Latest Version The file/folder is downloaded and the latest version is available on the local folder.
Not Latest Version The current version of the file downloaded is not the latest version available in the EngageCX Platform. Synchronize Now your file/folder or use the Get Latest Version option to obtain access to the latest version presented in the EngageCX Platform.
Not Downloaded The folder is not downloaded on the local folder and the files within cannot be accessed at the moment.
Checked Out for Edit The file/folder has been checked out for edit. You can use the Check In Pending Changes to check in the changes made, or Undo Pending Changes to revert the file to the latest version available on the EngageCX Platform and lose all local changes.
Deleted File The file/folder has been selected to be deleted. Note that you must also use the Check In Pending Changes option to commit the changes into the EngageCX Repository, or Undo Pending Changes to ensure that the file/folder is not deleted.
Added Folder/File The file/folder is newly created into the EngageCX Drive and it has not been checked in to the EngageCX Platform. To add it to the EngageCX Platform, you might use the Check In Pending Changes option to upload the file/folder, or Undo Pending Changes to lose all the local changes.
Shared Folder The folder is tagged as shared into the EngageCX Platform.
Hidden Folder The folder is tagged as hidden into the EngageCX Platform.