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
- Click on the bottom-left Start button to open the Windows Start Menu.
- Type
EngageCX Drivein the search box and select EngageCX Drive in the results.
From Taskbar
- Click on the
Show hidden iconsunder the Notification area of the Windows Taskbar. - Select the
EngageCX Driveicon.
From EngageCX Studio Tools
- Open any of the EngageCX Studio main components: Publisher, Modeler or Analyst.
- Select the
EngageCX Drivebutton under the Repository tab in the Ribbon.
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.
- Access the EngageCX Drive tool, then select the
Connectbutton. - You will be prompted to enter the Host Name of the EngageCX Enterprise Website. For example, https://eos4.ecrion.com. Enter the URL, then click
Continue. - Next, enter your EngageCX credentials and click
Sign in. - If the credentials provided are used for multiple environments it might be necessary to select the environment you want to connect with. If not, skip to the next step.
- Optionally, you can set up a local folder, or choose a synchronization type. Once you're ready, select
Finish. - Congratulations! You are now connected to the EngageCX Platform and all your workspace folders and files will be visible and accessible through the EngageCX Drive interface.
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
- Starting from the Drive Interface, select the
Options( ) button, from the top-right corner. - Choose
Accountsfrom the contextual menu.
From Taskbar
- Click on the
Show hidden iconsunder the Notifications area of the Windows Taskbar. - Right-click on EngageCX Drive icon.
- Choose
Accountsfrom the contextual menu.
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:
- Starting from the Configure Accounts dialog, select
+ Add Accountfrom the upper left side. - You will be prompted to enter the Host Name and the new credentials used to log in to the Enterprise Website. For more information, go to Signing in.
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:
- Starting from the Configure Accounts dialog, select the account you want to configure as active, then click on the
Options( ) button, on the right side. - Select
Set Activefrom the contextual menu. - Notice that the files and folders related to the active account are displayed in Drive.
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:
- Starting from the Configure Accounts dialog, select the account you want to configure as active, then click on the
Options( ) button, on the right side. - Select
Configurefrom the contextual menu. - Make the edits you need, then click
Finishto save the changes. The available options here are to change the location of the local folder where all the repository files are stored or to enable/disable the automatic synchronization.
Removing Accounts
At any time, you can stop accessing the EngageCX Platform from your local machine by removing your account. Here's how:
- Starting from the Configure Accounts dialog, select the account you want to configure as active, then click on the
Options( ) button, on the right side. - Select
Deletefrom the contextual menu and confirm the deletion. - The assets can't be accessed via EngageCX Drive, however they can still be found in the EngageCX Platform.
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:
- Starting from the Drive Interface, select the
Options( ) button, from the top-right corner. - Choose
Accountsfrom the contextual menu. - In the Configure Accounts dialog, hover over the account you want to change its default location, then select the
Options( ) button. - Choose
Configurefrom the contextual menu. - Under Edit Account dialog, select
Change Location. - Use Windows Explorer to configure your hard drive folder as a location for EngageCX Drive.
- Once you're ready, select
Finish, thenClose.
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
- Starting from the EngageCX Drive Interface, expand the folder(s) containing the file you want to access.
- Click on the file you want to open, then select the
Options( ) button. - Choose
Openfrom the contextual menu.
By Double-click
- Starting from the EngageCX Drive Interface, expand the folder(s) containing the file you want to access.
- Double-click on the file you want to open. Your file will open in the appropriate tool.
Opening Folders
By Using the Open Option
- Starting from the EngageCX Drive Interface, select the folder you want to open, then click on the
Options( ) button next to its name. - Choose
Openfrom the contextual menu.
From the Default Location
- Starting from the EngageCX Drive Interface, select the
Folder( ) button, at the top-right corner. - You will be redirected to the default location where you can select and open any of the folders presented and synchronized through EngageCX Drive.
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
- Starting from the EngageCX Drive interface, select the
Options( ) button, at the top-right corner. - Choose
New Folderfrom the contextual menu. - Provide a unique name for your folder, then select
Create. - Your new folder appears now on the EngageCX Drive list. If the automatic sync is disabled, the folder will be marked with a green plus icon ().
Within Other Folders
- Starting from the EngageCX Drive interface, select the root-folder in which you want to add a new folder.
- Select the
Options( ) button from the right. - Choose
New Folderfrom the contextual menu. - Provide a unique name for your folder, then select
Create. - Your new folder appears now on the EngageCX Drive list. If the automatic sync is disabled, the folder will be marked with a green plus icon ().
Uploading Folders
By using the EngageCX Drive tool, you can upload local folders together with data within, to the EngageCX Platform.
- Starting from the EngageCX Drive interface, select the root-folder in which you want to add a new folder.
- Select the
Options( ) button from the right. - Choose
Add Folderfrom the contextual menu. - Next, use Windows Explorer to browse and add your local folder to EngageCX.
- Your folder and its content appear now on the EngageCX Drive list. If the automatic sync is disabled, the folder will be marked with a green plus icon ().
Adding Files to Folders
You can add files to your folder through EngageCX Drive and then get to them from anywhere.
- Starting from the EngageCX Drive interface, select the folder in which you want to include a new file.
- Select the
Options( ) button from the right. - Choose
Add Filesfrom the contextual menu. - Next, use Windows Explorer to browse and add your local files to EngageCX.
- Your files appear now in the EngageCX folder. If the automatic sync is disabled, the file will be marked with a green plus icon ().
Editing Assets
Removing Assets
You can remove files within your EngageCX projects directly from the EngageCX Drive tool.
- Starting from the EngageCX Drive interface, select the folder/file you want to remove.
- Select the
Options( ) button from the right. - Choose
Deletefrom the contextual menu and confirm your selection by clickingYes. - Your file/folder will be permanently removed from both the local folder and the EngageCX Platform.
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.
- Starting from the EngageCX Drive interface, select the folder/file you want to rename.
- Select the
Options( ) button from the right. - Choose
Renamefrom the contextual menu. - Enter a new name for your file or folder, then select
Apply. - Your file/folder will be renamed on both the local folder and the EngageCX Platform.
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
- Starting from the EngageCX Drive interface, select the file you want to restore.
- Select the
Options( ) button from the right. - Choose
Versionsfrom the contextual menu. - In the Versions dialog, there will be listed all the versions available for your current file alongside the details of versions to better decide upon your choice.
- Once decided, select the
Restore( ) button, next to the chosen version. - A new version will be added in the list with the description of the new current version of the file.
Download a Version
- Starting from the EngageCX Drive interface, select the file you want to restore.
- Select the
Options( ) button from the right. - Choose
Versionsfrom the contextual menu. - In the Versions dialog, there will be listed all the versions available for your current file alongside the details of versions to better decide upon your choice.
- Once decided, select the
Downloadbutton, next to the chosen version. - Choose the destination of the file version where to be downloaded on your local machine and select
Save.
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:
- Starting from the EngageCX Drive Interface, select the
Options( ) button, at the top-right corner. - Choose
Accountsfrom the contextual menu. - In the Configure Accounts dialog, hover over the account on which you want to enable synchronization and click on the
Options( ) button from the left. - Choose
Configurefrom the contextual menu. - In the Edit Account dialog, check the
Synchronize files automaticallyoption, then clickFinish. - Go back to the EngageCX Drive interface, click on the
Options( ) button, then chooseSynchronize Nowto make sure all your files are up to date. Note that each change you make on your files will be automatically uploaded to the EngageCX Platform.
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:
- Starting from the EngageCX Drive Interface, select the
Options( ) button, at the top-right corner. - Choose
Accountsfrom the contextual menu. - In the Configure Accounts dialog, hover over the account on which you want to enable synchronization and click on the
Options( ) button from the left. - Choose
Configurefrom the contextual menu. - In the Edit Account dialog, make sure that the
Synchronize files automaticallyoption is not checked. - Click
Finishwhen you're ready.
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.
- Starting from the EngageCX Drive interface, select the file/folder you want to edit.
- Click on the
Options( ) button to the right. - Choose
Check Out for Editfrom the contextual menu. - Your file/folder is now checked out and you can start editing it. Notice that your file has been marked with a red check mark ( ).
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.
- Starting from the EngageCX Drive interface, select the file/folder you want to edit.
- Click on the
Options( ) button to the right. - Choose
Check In Pending Changesfrom the contextual menu. - Optionally, in the Commit Changes dialog, add a comment to describe the changes you made.
- If you want to do a temporary check-in so you can continue working on the file, check the
Keep the file checked outoption. Otherwise, leave the option unchecked. - Once you're ready, click on the
Check Inbutton. The red check mark disappears from the file/folder when it is checked back in.
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.
- Starting from the EngageCX Drive interface, select the file/folder you want to edit.
- Click on the
Options( ) button to the right. - Choose
Undo Pending Changesfrom the contextual menu. - Select
Yesin the prompt dialog to discard the checkout. The red check mark disappears from the file/folder.
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.
- Starting from the EngageCX Drive interface, select the file/folder you want to edit.
- Click on the
Options( ) button to the right. - Choose
Get Latest Versionfrom the contextual menu. - To download the latest file versions from the entire workspace, select the
Options( ) from the top-right corner of the Drive interface, then chooseGet Latest Version.
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.
- Click on the
Show hidden iconsunder the Notifications area of Windows Taskbar. - Right-click on the EngageCX Drive icon.
- Check/Uncheck the
Start with Windowsoption from the contextual menu.
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.
- Click on the
Show hidden iconsunder the Notifications area of Windows Taskbar. - Right-click on the EngageCX Drive icon.
- Check/Uncheck the
Show Hidden Foldersoption from the contextual menu.
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:
- Starting from the EngageCX Drive interface, click on the
Select Workspace( ) button, at the top-left side. - From the contextual menu, select the workspace you want to explore.
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. |