EngageCX 12.0 (Nido) User Guide

Getting Started

EngageCX provides a complete, end-to-end customer communication management solution that integrates every process involved in the creation of professional documents into a smart unified and easy-to-use platform.

It consists of three websites, addressed to different stakeholders:

Skimming over this guide, you will be provided with guidelines on how to become from a novice to an advanced end-user of the Enterprise Website.


Logging In

Once you received credentials on e-mail or directly from your administrator, you can access the website from your browser and start designing and building documents.


Here's how to log in for the first time:


Personalizing your Experience

After logging in, at any time, you can change your password for a better security or update your personal account information with just a few clicks.

Changing your Password

Follow the steps below to change the current password:


Notes

  • If you forgot your old password, return to the login page and select Forgot Password hyperlink to receive a reset link via the email address associated with your account. If multiple environments are available for the provided email address, you will have to select the environment for which you want the password to be reset.
  • A reliable email connection needs to be configured to receive the reset mail with the new password. For more details, please access the Domain Emails chapter from the System Administrator website.

Updating Personal Information

Follow the steps below to edit your personal information as an EngageCX Platform user:

People

The People category allows you to record and manage information about the persons involved in your organization.

Accounts

The Accounts module allows you to view and manage all the organizations or persons involved with your enterprise.

Accessing Accounts

Follow the steps below to access the Accounts module:

  1. Select the System ( ) button at the leftmost corner toolbar of the EngageCX Enterprise Website.
  2. Select the Accounts option under the People module.

Creating a New Account

Creating a new account requires having at least one Account Type defined in your workspace. If none exists, visit the Manage Account Types section to read how to create one.

To stay organized, it is a best practice to provide a relevant account name that represents a Company Group, a Branch or an Individual business. In the EngageCX Platform, there are no restrictions in using special characters or spaces within the names of accounts. For example, Christ Paul, BlueSky Properties Inc., Lincoln Estate, National Invest, etc.


Follow the steps below to create a new account in the Enterprise Website:

  1. In the Accounts page, select the +New Account button from the toolbar.
  2. Fill out the form with the appropriate values:
    • Account Type: indicates the account purpose. Expand the drop-down list and select the needed type. To configure account types, read the instructions from here.
    • Parent: helps you to create a hierarchy of accounts by allowing you to specify a parent account for those accounts created on behalf of customers' partners.
    • Account Information: enter specific information for the current account. When creating a new account it is necessary to enter an organization name, a phone number and a website URL. Additionally, you can add address information and set up other account preferences.
  3. Once you're ready, select OK to save the changes.

The account will appear on your Accounts list. Now you can start adding contacts to it.


Managing Account Types

By default, all the accounts within the EngageCX Platform can be defined according to three categories: CompanyBranch, CompanyGroup or Individual. The Accounts page allows an administrator to define also custom types.

  1. In the Accounts page, select the More ( ) button from the toolbar.
  2. Select Manage Account Types from the contextual menu.
  3. Select +Add Account Type from the bottom of the dialog to create a new account type. Choose an appropriate name for the type of your account and select OK to save the changes.

The new account type will be displayed in the Manage Account Types dialog and can be further edited or deleted by accessing its corresponding More ( ) button.

Updating Accounts

In this section, users can learn how to view the Account Details screen that displays the details linked to an account, how to edit the data inside and how to remove an account from the list.


Viewing Account Details

Follow the steps below to open the Account Details page:

  1. Access the Accounts page and select the account for which you want to examine its content or select the More ( ) button, corresponding to your account, to choose Open from the contextual menu.
  2. On the left side, there are specific Account Details, that can be easily modified directly in the form fields provided. Do not forget, after the editing operation, to select the Save ( ) button from the toolbar to update the changes.


Editing Account Details

Follow the steps below to edit the Account Details:

  1. Access the Accounts page and select the account that requires updates.
  2. Select the More ( ) button from the toolbar and then choose Edit in the contextual menu or simply double-click on the form field you want to edit.
  3. Update the account's information by revising the form fields.
  4. Once you're ready, select the Save ( ) button located in the middle of the toolbar.


Deleting an Account

Follow the steps below to remove an account:

  1. Access the Accounts page and select the account you wish to delete.
  2. Select the More ( ) button at the right of the toolbar.
  3. Select Delete from the contextual menu and confirm the deletion.

The account will be removed from the Accounts list. The deleted account cannot be recovered, but you can start adding new entries.

Generating Documents for an Account

A common scenario for document generation involves producing a document in the same time for a certain account that includes many contacts. Follow the steps below to produce a document or a set of documents (batch) for an account:

  1. Access the Accounts page and select the account for which you want to create documents.
  2. Select the Compose button from the toolbar.
  3. Choose a Project from the opened dialog. Additionally, you can use the Search bar from the top-right corner to look up for a specific project or navigate to a specific destination folder through the sidebar on the left.
  4. Once you're ready, select Run.
  5. The Communication Run page will open in a new window, where you need to fill out the form with the required fields. Once you're ready customizing your form fields in the left side of the page, select the Save ( ) button from the toolbar.

On the Communication Run page, you will see a preview of the output document on the right side. For more details about Communications, please visit the Communications section.

More Accounts Options

In the Accounts Page, you can select the More ( ) button, next to an account name and access the following options displayed in a drop-down menu:


Contacts

The Contacts module enables you to manage contact information and communicate with individuals connected to an account.

Accessing Contacts

Follow the steps below to access the Contacts module:

  1. Access the EngageCX Enterprise Welcome page.
  2. Select the Contacts button under the Modules Menu.

Or

  1. Select the System ( ) button at the leftmost corner toolbar of the EngageCX Enterprise Website.
  2. Select the Contacts option under the People module.

A good and easy way of finding and navigating through Contacts is using the Sidebar that provides two views, Contacts and Leads. Accessing the All tab in the Sidebar will offer you a general view of all the contacts that have been created within the environment.

Creating Contacts

From Contacts, you can store both existing customers, by creating a new contact, or persons that are interested in your products, by creating a new lead.

As a naming convention for Contacts, we recommend that it should consist of the given name, surname or first name of the individual. Other additional information regarding the Contact should be avoided in order to reduce confusion or misunderstanding. There are no restrictions in using special characters or spaces within the names of contacts. For example, John Doe is a valid name.


Creating a New Contact

Follow the steps below to create a contact:

  1. In the Contacts page, select the Contacts Menu from the Sidebar to filter the results.
  2. Click on the +New button from the toolbar, then choose the Contact option from the drop-down menu.
  3. Fill out the form with the appropriate values. By default, the fields will be automatically completed with values taken from the Contact.efd file.
    • Account - indicates the parent account in which the current contact is included, if any. Use this option if you want to create a hierarchical relationship between your contacts and an account.
    • Contact Details - enter specific information for the current contact. When creating a new contact, it is necessary to enter the last name and the email of the person you want to add.
    • Is Primary Contact - make the current contact the main contact person, for example, the representative of your organization. This option enables to the primary contact more privileges than a basic one.
  4. Once you're ready, select Save to update the changes.

The contact will appear now on your Contacts list.


Creating a New Lead

Follow the steps below to create a lead:

  1. In the Contacts page, select the Leads Menu from the Sidebar to filter the results.
  2. Click on the +New button from the toolbar, then choose the Lead option from the drop-down menu.
  3. Fill out the form with the appropriate values. By default, the fields will be automatically completed with values taken from the Contact.efd file.
    • Lead Details - enter specific information for the current lead. When creating a new lead, it is necessary to enter the last name and the email of the person you want to add.
  4. Once you're ready, select Save to update the changes.

The lead will appear now on your Leads list.

Note

In the Contacts and Leads page, respectively, if a contact/lead has a bounce email, this will be marked by a yellow warning triangle, next to the corresponding email address. This means that the email message was not able to be delivered to the specified email address.

Updating Contacts

In this section, users can learn how to view the Contact Details screen that displays the details linked to a contact, how to edit the data inside and how to remove a contact from the list.


Viewing Contact Details

Follow the steps below to open the Contact Details page:

  1. Access the Contacts page and select the contact for which you wish to revise its details.
  2. The Activity section on the right of the page lists all the individual activities of the current contact.
  3. Select Activity Filter and decide what assets you want to consider. In case you want to clear the whole contact activity, meaning the Engagement and Tracking activities for the current contact, you should search for the Clear option in the drop-down list, then confirm the deletion.


Configuring Portal Users

If a contact was added in the Contacts list, the user will not be able to login to the customer portal before an environment administrator will give him permissions. This type of permissions needs to be provided for each contact.

  1. Access the Contacts button from the People module and select the contact from the list.
  2. Enable the Portal Access option to provide permissions to the Customer Portal or select the More ( ) button from the toolbar and click Configure Portal User.
  3. Complete the form with the required fields.

    • Username: the username used to login in the Customer Portal is filled in automatically based on your initial configurations.
    • Enabled: check this option to activate the Customer Portal for the current contact.
    • Reset Password: select this button if you want to reset your password for the Customer Portal account. You can click Generate password automatically to receive by email the new password or provide it by yourself.
  4. Once you're ready, select OK to save the changes.

Now you can access the Customer Portal and log in using the previously created credentials.

Note

Before accessing the Customer Portal, in case you have used the option from the More ( ) Menu, do NOT forget to check if the Portal Access option from the left side of the Contact's page is enabled.


Importing Contacts

EngageCX provides the ability to load Contact records from a CSV file. Follow the steps below to import contacts:

  1. Access the Contacts page and then select the More ( ) button from the toolbar to choose Import from the contextual menu.
  2. Select the Choose File button to browse for the .csv file in your local machine.
  3. Next, the dialog displays the contacts count. Map the .csv file headers to the Contacts fields available in the Contact Field drop-downs.
  4. Enable the Don't import duplicates option to exclude duplication of contacts rows.
  5. Once you're ready, select Import to save the changes.

The contact(s) has been added to the Contacts list according to your settings. Now you can select and start configuring each one of them as you need.

Note

The first row in the .csv file is reserved for headings and it is used to map contact fields. Excluding the first row, each row in the .csv file will create a new contact in the EngageCX Platform.


Editing Contact Details

Follow the steps below to edit the Contact Details:

  1. Access the Contacts page and select the All Menu from the Sidebar to view all the Contacts or Leads that might require updates. Choose one of the available Contacts/Leads for editing its properties.
  2. Select the Edit ( ) button from the toolbar.
  3. Update the contact's information by revising the form fields on the left side of the page.
  4. Once ready, select the Save ( ) button in the middle of the toolbar to update the changes.


Configuring List Subscription

A list's configuration controls who can subscribe and send to the list, how messages are distributed and sent to subscribers.

Note

Before proceeding with the following steps, a Subscription needs first to be configured.

  1. Access the Contacts page and select the contact you wish to configure a list subscription for.
  2. Navigate to the Preferences tab in the left side of the page under the Contacts Details.
  3. Under the Subscriptions section, there are all the available lists for the current contact that can be selected.
  4. Once you're ready, select the Save ( ) button from the toolbar to update the changes.


Deleting a Contact

Follow the steps below to remove a contact:

  1. Access the Contacts page and select the contact you wish to delete.
  2. Select the More ( ) button from the toolbar.
  3. Select Delete from the contextual menu and confirm the deletion.

The contact/lead will be removed from the Contacts list. The deleted contact/lead cannot be recovered, but you can start adding new entries.

Generating Documents for a Contact

A common scenario for document generation involves producing a document for a certain contact. Follow the steps below to produce a document for a contact:

  1. Access the Contacts page and select the contact for which you want to create documents.
  2. Next, select +New Communication from the toolbar.
  3. Choose a Project from the Compose dialog. Additionally, you can use the Search bar from the top-right corner to look up for a specific project or navigate to a specific destination folder through the sidebar on the left.
  4. Once you're ready, select Run.
  5. The Communication Run page will open in a new window. In case the communication project contains a form, you will need to fill out the the required fields. Once you're ready customizing your form fields in the left side of the page, select the Save ( ) button from the toolbar.

More Contact Options

In the Contacts Page, you can select the More ( ) button, next to a contact name and access the following options displayed in a drop-down menu:


Lists

Lists are used to organize a set of contacts and group them together for a specific purpose (e.g. receiving mass emails). There are two different types of lists supported by EngageCX: static and dynamic lists.

Accessing Lists

Follow the steps below to access the Lists module:

  1. Access the EngageCX Welcome page and select the System ( ) button from the top-left corner.
  2. Select the Lists option under the People module.

A good and easy way of finding and navigating through Lists is by using the Sidebar that provides two views, Static and Dynamic. Accessing the All Menu from the Sidebar will offer you a general view of all the lists that have been created within the environment.

Also, you can sort all the lists displayed in the Lists page by type criteria. If multiple sorting criteria are applied, such as Name, Type, or Number of Contacts, the high-priority is received by the last criteria set.

Creating a Static List

Lists are useful to classify a community of users that share common interests, so when creating a new list, generic and pointful names are unavoidable. There are no restrictions in using special characters or spaces within the names of lists. For example, Customers, Suppliers, Last Month Leads, etc. Static lists consist only of contacts added when you created the list. You can use static lists in your organization for emails sent infrequently or only one time.

  1. In the Lists page, select the +New List button from the toolbar and choose the Static option.
  2. Fill out the form with the appropriate values:
    • Name: provide a friendly list name.
    • Description: provide a description where to state the purpose of the list.
    • Opt-Out: select from which subscription list(s) you want the contacts in this list to be excluded.
  3. Once you're ready, select Create to save the changes.


Adding Contacts to a Static List

You can add contacts to a static list individually from a drop-down or based on a rule (e.g. Add all contacts with Last Name Equal "A" ). Follow the steps below to insert contacts into a static list:

  1. In the Lists page, select the Static Menu from the Sidebar to filter the lists results. Choose the list that you want to populate.
  2. Select +Add Contacts or choose the Add Contacts option from the More ( ) button in the toolbar.
  3. Select +More\Add by Criteria and then +Add to create a rule for quickly adding contacts to the list. The rules can be created based on the contact's fields, events of a communication project, engagement elements or list memberships.
  4. Additionally, you can select as many contacts as you want for the Additional Contacts drop-down to explicitly include them into the static list.
  5. Once ready, select Save to update the changes.

All the contacts that met the criteria specified will appear on the list. Also, the rule previously configured will not add automatically the contacts to the static list.

Note

To automatically add contacts based on a defined rule you should use Dynamic Lists.


Importing Contacts from CSV

EngageCX provides the ability to import contacts from a CSV file to a static list. Follow the steps below to import contacts into a static list:

  1. In the Lists page, select a static list.
  2. Select the +Add From CSV button, if the list is empty, or choose the Import option from the More ( ) Menu in the toolbar.
  3. Select Choose File to browse for the .csv file in your local machine. The dialog will display the contacts count. Map the .csv file headers to the Contact fields available in the Contact Field drop-downs.
  4. Enable the Don't import duplicates to exclude duplications of contact rows.
  5. Once ready, select Import to save the changes.

The contact(s) will be added to the list and are available for further configurations.

Note

The first row in the .csv file is reserved for headings and it is used to map contact fields. Excluding the first row will determine that each row in the .csv file to create a new contact in the EngageCX Platform.

Creating a Dynamic List

Dynamic lists consist of contacts added automatically when a set of rules are satisfied. You can use a dynamic list when you want to send emails more than once to a certain group of contacts that changes and get updated frequently. The Dynamic List's principle is: Contacts who match the criteria rules are added to the dynamic list.

  1. In the Lists page, select the +New List button from the toolbar and choose the Dynamic option.
  2. Fill out the form with the appropriate values:
    • Name: provide a friendly list name.
    • Description: provide a description where to state the purpose of the list.
    • Opt-Out: select from which subscription list(s) you want the contacts in this list to be excluded.
  3. Once you're ready, select Create to save the changes.


Adding Contacts to a Dynamic List

The rules configured in dynamic lists go against static lists principle. When a rule is configured for a dynamic list, the contacts that match will be automatically added into the list and constantly verified. In EngageCX, you can manually include or exclude contacts to dynamic lists.

Follow the steps below to insert contacts into a dynamic list:

  1. In the Lists page, select the Dynamic tab from the Sidebar to filter the list results. Choose the dynamic list that you want to populate.
  2. Select the Edit Rules ( ) button or choose the Properties option from the More ( ) Menu in the toolbar.
  3. Fill in the form with the required fields:
    • Rules: select +Add and use contact's parameters to create dynamic rules based on what your contacts will be added to the list. Besides defining single conditions, you can also group multiple rules connected through logical operators. When editing rules, you can choose any Contact or Parent Account field, as well as Engagement properties (such as Persona, Journey, Stage or current Touchpoint) and Events.
    • +More > Include Additional Contacts: to manually add contacts to the dynamic list, even if they do not meet the criteria rule.
    • +More > Manually Exclude Contacts to manually remove contacts from the dynamic list, even if they meet the criteria rule.
  4. Once ready, select Save to update the changes.

All the contact(s) that met the criteria specified will appear on the dynamic list and it will be automatically updated.

Note

A Contact can be assigned to only one Persona, but it can be part of many Lists.


Importing Contacts from CSV

EngageCX provides the ability to import contacts from a CSV file to a dynamic list. Follow the steps below to import contacts into a dynamic list:

  1. In the Lists page, select a dynamic list.
  2. Select the +Add From CSV button.
  3. Select the Choose File button to browse for the .csv file in your local machine. The dialog will display the contacts count. Map the .csv file headers to the Contact fields available in the Contact Field drop-downs.
  4. Enable the Don't import duplicates option to exclude duplications of contact rows.
  5. Once ready, select Import to save the changes.

The contact(s) will be added to the list and are available for further configurations.

Note

The first row in the .csv file is reserved for headings and it is used to map contact fields. Excluding the first row will determine that each row in the .csv file to create a new contact in the EngageCX Platform.

Sending Documents to the List Contacts

Follow the steps below to learn how to send one document to multiple recipients, all contacts included in a list:

  1. Access the Lists page and select the list for which you want to send documents.
  2. Select the +New Communication button from the toolbar.
  3. Choose a Project from the Compose dialog. Additionally, you can use the Search bar from the top-right corner to look up for a specific project or navigate to a specific destination folder through the sidebar on the left.
  4. Once you're ready, select Run.

The Communication Run page will open in a new page, where you are able to see the Summary of the output document. In addition, you can also view the communication documents, emails and SMS, besides the Log files during the communication jobs execution.

More Lists Options

In the Lists Page, you can select the More ( ) button, next to the list name and access the following options displayed in a drop-down menu:

Design

The Design category allows you to manage both projects and workspaces as well as their assets within.

Projects

Projects represent a central part of the EngageCX solutions. These allow you to manage and organize your particular files, together with their dependencies. In a nutshell, it can be seen as a Project Manager, as it is the place where you will plan and draw the map of each project individually. Project files are the ones used when running communications through EngageCX. For example, if you are responsible for running a communication project in EngageCX Platform, this is the right place to create and add the required project's assets.

Accessing Projects

Follow the steps below to access the Projects module:

  1. Access the EngageCX Enterprise Welcome page.
  2. Select Projects from the Modules Menu.

or

  1. Select the System ( ) menu at the top-left corner of the Welcome page.
  2. Choose Projects under the Design group.

Once the Projects page opens, you can easily navigate through your documents by selecting from the default views from the Sidebar, such as Shared publicly, to filter only the projects that have been shared across the environment, or Published to Portal, to see only the projects files that have been published to the Customer Portal. To view all the existing projects, select the All tab in the Sidebar. In case you know the destination folder of your project you can navigate through the By Folder view tree and narrow the results.

Creating Projects

Projects must be consistent and specific to an area of your work. When creating new Projects try to avoid internal codenames that have less to do with what the project is about. Keep in mind that most of the Projects are shared with others and they do not have to struggle in understanding the scope of them.

There are some restrictions on using special characters within the names of the projects, therefore project names cannot contain any of the following: '|' (vertical bar), '/' (slash), '\' (backslash), ':' (colon), '*' (asterisk), '"' (double quote), '<' (less than), '>' (grater than), '.' (full stop) and '?' (question mark). For example, some relevant names could be Retail, Financial, Insurance, Telecom, etc.


Creating Projects from Scratch

Follow the steps below to create your new project:

  1. In the Projects page, select + New Project from the toolbar.
  2. You will be prompted to select a default template as a starting point. Select Next to proceed with the Project configurations.
  3. Fill out the form with the following required fields:
    • Name: enter a friendly name for your project.
    • Description: optionally, provide more information about the project you want to create.
    • Folder: select Browse to navigate through the environment and choose a destination for the project to be stored.
    • Options: depending on the template you have selected, you might have the ability to enable/disable the options below:
      • Users must fill out a form: when this option is selected, users have the ability to enter input data manually before running a communication project.
      • Produce multiple documents at a time in batch: when this option is enabled, multiple documents are automatically produced from one single input data.
  4. Once you're ready, select Finish to save the changes.


Creating Projects from Word Documents

Using a Word document as the basis for a Project is an easy way to automatically create a template and a form for correspondence produced communications.

Before importing a Word Document, highlight the sections with yellow to automatically generate fields for the communication form. After importing the Word Document, EngageCX Platform will create a template (.epr file), a communication form (.efd file) containing the highlighted fields, an email body (.epr file) and a workflow (.wk4 file) to produce documents.

Follow the steps below to create a project from a Word document:

  1. Starting from the Enterprise Home screen, access the Projects module.
  2. In the Projects page, select the More ( ) button from the toolbar, then choose the Import Word Document option from the contextual menu.
  3. Under the Import Word Document dialog:
    • Select the Choose File button and browse for a .docx file to upload.
    • Choose the workspace in which this Word document should be stored.
  4. Once you're ready, select Import to successfully upload the file.

You will be redirected to the Project Details page, where you can start customizing the project assets to your needs.


Creating Projects from Workflow

Workflows can be created from both Projects and Workspaces. In case you have already created a workflow within Workspaces, you can simply create your Project in a plain manner. Follow the steps below to create a project from a workflow:

  1. Starting from the Enterprise Home screen, access the Projects module.
  2. In the Projects page, select the More ( ) button from the toolbar, then choose the Create from Workflow option from the contextual menu.
  3. Next, fill out the project form by providing the information below:
    • Type: use the drop-down list to select a project type. It can be Interactive, where users can manually enter the input, Batch, that uses a single input to generate multiple documents automatically, On-Demand, in case you need to generate documents in real-time, or Analytics Dashboard, for projects containing dashboard widgets.
    • Name: provide a friendly and unique name for your project.
    • Description: optionally, add additional project details into the rich text box.
    • Workflow: select Browse and choose the workflow you want to use.
  4. Once you're ready, click OK.

You will be redirected to the Project Details page, where you can start customizing the project assets to your needs.

Importing Existing Projects

The website allows you to import projects' archives created and exported from older versions or within other environments, without losing configurations. Follow the steps below to learn how to import a project:

  1. Starting from the Enterprise Home screen, access the Projects module.
  2. In the Projects page, select the More ( ) button from the toolbar, then choose the Import Project option from the contextual menu.
  3. Under the Import Project dialog:
    • Select the Choose File button and browse for a .zip archive to upload.
    • Choose the workspace in which this project should be stored.
  4. Once you're ready, select Import to successfully upload the archive.

You will be redirected to the Project Details page, where you can start customizing the project assets to your needs.

Publishing Projects to other Environments

Sometimes, due to the fact that EngageCX Platform is running on multiple servers, you may need to share assets between instances and for that, the Publishing feature comes in handy. This option offers an improvement of efficiency and consistency across environment processes.

Follow the steps below to publish your projects to other environments:

  1. Starting from the Enterprise Home screen, access the Projects module.
  2. In the Projects page, select the More ( ) button from the toolbar, then choose the Publish option from the contextual menu.
  3. Next, select the Project(s) you want to publish. Optionally, check the Include Tags option if you want to publish also the tags included in the selected projects. Select Next to continue.
  4. Fill in the form fields with destination credentials:
    • Select destination: enter the URL that the engine can use to publish the project(s). It should use the following format: http://HostName:PortName, where HostName is the EngageCX server that contains the Enterprise component, and PortName is the configured port number. For example, http://ecrionserver:8094
    • Username: enter a username that has sufficient authority to perform a publishing procedure on the destination server.
    • Password: type the corresponding password.
    • Environment: optionally, if the user belongs to multiple EngageCX environments, enter the environment name.
      Select Next to continue to the next step.
  5. Finally, select from the drop down list a Target Workspace to publish your project. Optionally, you can add some comments that will be applied to all existing versions already created for each individual project. This is valid only for the first version published of your project. Once you're ready, select Publish to finalize the process.
  6. Wait until the publishing process is finished for all the selected projects.

A green status bar in the Publish dialog will inform you when the status of the communication project(s) is Published successfully. Then sign-in to the Publish Destination Server to ensure the publishing process is successfully finished. The project(s) will be deployed in a folder structure that mirrors the folder structure of the source.

Working with Project Files

At any time, you can select a project from your projects list to customize it as needed. Once selected, you will be redirected to the Project Details page, where you can add new files or you can explore and edit the existing ones or their dependencies.


Adding New Files

Follow the steps below to insert files into a project:


Customizing Existing Files

A project contains all the assets required for building a communication, that will produce the outputs your organization demand. Since editing assets is popular, the platform provides you with a group of editors for each of the file type. All you need to do is to select the file you want to update, then choose the Edit button, and you will be redirected to the correlated page. Read through this section to learn more on each file type you can edit.


      Document Templates

Document Templates are .epr files created within the EngageCX Publisher, a stand-alone EngageCX solution, or by using the Online Template Editor, integrated in the EngageCX Platform. They describe the visual look & feel as well as the business rules that apply when producing a document dynamically from data.


      Content Fragments

Content Fragments are .epb files created either through the EngageCX Publisher, or by using the Online Template Editor. Fragments are a powerful way to improve efficiency and consistency across your document templates. For any of your designed content, you can preserve your work in a content fragment. By doing so, you can insert it into other templates. This means that you do not have to recreate the section of content that you had already created, but perhaps more importantly, when you need to change something within that section of content you will only need to change in one location and consequentially all of your templates using this content fragment are updated.


      Email Templates

To send your correspondence as an attachment to an email, you will need to create an email template. EngageCX provides an easy way to create email templates and multiple options that allow you to customize and format your emails' content. Email Templates are the .ehtml files and can be edited through the Email Editor .


      Workflows

Workflows are the .wk4 files, which define a series of processing steps or transformations that your data will go through, ultimately resulting in a document or set of documents being published along one or more output channels, like print, email or SMS. To build or customize a workflow, you will need to access the Workflow Editor .


      Forms

EngageCX allows you to create forms that capture data or enables users to create documents interactively. A form is a window or a screen that contains numerous fields or spaces to enter data. Each field holds a field label so that any user who views the form gets an idea of its contents. Forms are the .efd files, which can be build or customized through the Form Editor.

Working with Various Projects Options

After a Project is created, it will appear on the Projects list and can be easily accessed from the Sidebar. For accessing options related to the whole project folder, you have to select the More ( ) button and choose from the available options within the contextual menu:


Project Versions

Versions allow you to save the state of a project and its content as a backup that you can restore later or publish to a different EngageCX Platform, for example from your development system to your production system. Versions can be created only for Projects. It is suggested, as best practice, to create a version before any major edits or updates made to a project folder in case the changes fail acceptance testing and you need to roll back to a stable state. When restoring a version, this will be used as the latest version when running a communication.

Versions are seen in EngageCX as immutable entities. This means that once a version is created, you cannot add, edit or remove individual files within. You can only export, restore, publish, edit or delete a version as a whole.

When you add or modify files through versions, the versioning mechanism continues to behave as expected, creating a new version with each addition or change.


Versions Options

This section will describe each option related to versions of a project.

Creating a New Version

Follow the steps below to create a version:

Exporting a Project Version

Follow the steps below to export a version:

Restoring a Project Version

Follow the steps below to restore a version:

Deleting a Project Version

Follow the steps below to remove a version:

Editing a Project Version

Follow the steps below to modify a version:

Publishing a Project Version

Follow the steps below to publish a version:

Note

If the Review and Approval process is enabled on the workspace, the Publish option will be available only for the approved versions. Read the Review and Approval chapter for more information.

A notification dialog will display the successful status of the publish process. You can sign-in to the Publish Destination Server to ensure that everything is functioning properly. The version will be deployed in a folder structure that mirrors the folder structure of the source.


Versions vs Import/Export

While there are some similarities between versions and import/export, their purposes are different. Imports exist so you can upload multiple files easily into EngageCX and exports exist so that you can download multiple files easily from the Enterprise Website, but the data has to go through the local hard-drive. So use import/export whenever you need to upload or download files from the Enterprise Website.

For backup, restoring and publishing to a different EngageCX instance or environment, the recommendation is to use versions. They are designed with this purpose in mind, so they will always be more suitable for this task than manually importing and exporting files. Additionally, EngageCX Enterprise keeps track of versions so you can switch between them at any time, an important feature which is not possible if you just use import/export.


Clone Project

Once you click on the Clone option from the contextual menu, provide the required fields in the dialog:

Note

In case the project is shared, the clone of the project will inherit this property.


Share Project

To share a project, you need first to generate a public or a portal link. Public links are view-only and anyone with the link can view or download its content.

Note

Share options are not available for Batch Project types.

You can send to other enterprise users a public link to your project so anyone with the link can view or download its content.

You can send to other enterprise users a portal link to your project so any customer of the portal with the link can view or download its content.


Lock-Unlock Project

When a project is locked, it can be viewed by other users, but its content cannot be edited. In general, an environment administrator can lock a project completely when it passes Review and Approval. It will then unlock it when change requests come in; however, locking a project is not mandatory.

Note

The option is available only for the EngageCX users that have manage environment permissions.


Cleanup Project Jobs

Selecting this option you can:


View Project Properties

Once selected the option, you can choose to edit the following:

Basic Properties

Starting from the Properties dialog, select the Basic ( ) option, from the top-right corner.

Advanced Properties

Starting from the Properties dialog, select the Advanced ( ) option, from the top-right corner.


Workspaces

Workspaces enable collaboration and storage of all assets involved in your customer communication management processes. These are logical divisions of environments, usually associated with departments within a company. All the files needed for document production have to be stored in workspaces.

Workspace is the place where all projects are stored, but a user cannot make the precise difference between communications or folders until opening them.

Workspace Management

The purpose of a workspace is to allow you to better organize your assets into meaningful categories and can also provide restricted access, so that certain users or groups will only see the workspaces you allow them to see.


Accessing Workspaces

Follow the steps below to access the Workspaces module:

  1. Access the EngageCX Enterprise Welcome page.
  2. Select Workspaces from the Modules Menu.

or

  1. Select the System ( ) menu at the top-left corner of the Welcome page.
  2. Choose Workspaces under the Design group.


Creating a new Workspace

During the software installation, a Default workspace is added to the system. It is used to store the Project Ideas content that you can freely rename or delete.

Workspace names should be meaningful and scoped to a specific group of users. If you are working on exclusive independent scopes of projects, multiple workspaces could make sense. The name must not contain special characters, but can include spaces. For example, Front Office, Operations, Bank Office, QA, Development, Production Projects, etc.

Note

A user must belong to a Group that has Manage Environment Permission in order to create a new Workspace.

Follow the steps below to create a workspace:

  1. In the Workspaces page, select the +New Workspace button from the top-right corner of the toolbar.
  2. Fill out the form with the appropriate values:
    • Workspace Name: enter a friendly name for your workspace.
    • Description: optionally, provide information about the workspace you want to create.
  3. Once ready, select Create and the new workspace is added to the list.


Managing Workspaces

Managing a workspace involves setting up multiple configurations at workspace level and its tasks users are authorized to work with (Review and Approval, Publish, etc.).

Follow the steps below to configure a workspace:

  1. In the Workspaces page, decide upon the workspace you want to edit.
  2. Select the More ( ) button, next to the workspace's name.
  3. Choose Manage from the contextual menu.
  4. In the Manage Workspace dialog :
  5. Once ready, select OK to save the changes.


Deleting Workspaces

Follow the steps below to remove a workspace:

  1. In the Workspaces page, decide upon the workspace you want to delete.
  2. Select the More ( ) button, next to the workspace name.
  3. Choose Delete from the contextual menu.
  4. Confirm and select the OK to update the changes.

Note

It is important to know that deleting a Workspace is an irreversible operation. Make sure you have created a backup copy of any files you may need before deleting the workspace.


Viewing User Permissions

User permissions allow you to see and manage which users have which permissions at workspace level. Follow the steps below to see privileges that authorize a user:

  1. In the Workspaces page, decide upon the workspace you want to monitor.
  2. Select the More ( ) button, next to the workspace name.
  3. Choose View User Permissions from the contextual menu.
  4. The View Users Permissions dialog provides a list with all the users that have permissions to access or manage the selected workspace. For example, users with Access permissions can view the content of the current workspace, while users with Manage permissions can view and manage the content of the current workspace.


Note

Users Permissions can be enabled from the Users/Settings chapter.

By selecting any workspace in the list, you can explore all the files and project folders within that workspace.

Workspace Files

You can select a workspace from the workspaces list, at any time, to access the Workspace Details page. The Workspace Details page allows you to view and organize all the files and folders stored within. The view provides a hierarchical structure that allows you to keep your documents organized.


Adding New Files to your Workspace

Follow the steps below to insert an asset to your workspace:

Note

Prior of adding a new file to your workspace, make sure you to select a root folder first. If there are no existing folder, select the +New Folder button in the toolbar to create one.


Folders

Folders provide containers that help you organize and store your production documents. Within a workspace, you can add as many folders as you want.

The top-level folder created in a workspace, is usually called a root folder or a project folder and it is used to hold all the files for a custom project you are working on. For example, it could be the name of the document you are producing. Each workspace can contain multiple root folders, but at least one is necessary in order to add your files. It can contain multiple different files, including templates, content fragments, business rules, workflows or other folders.

It would be desirable to achieve consensus on folder naming within a team or a department. You should keep the folder names short, but meaningful. The names must not contain special characters, but can include spaces. For example, Contract, Credit Order Letter, Loan Agreement, On-Boarding Package, Portfolio Analysis, Monthly Statement, etc.

Creating a new Folder

Follow the steps below to create a folder to your workspace:


Importing Folders

EngageCX provides the ability to import external folder archives to the Workspace and use their assets. Only zip archives can be imported. Follow the steps below to import a folder to your workspace:

The folder will be added to the workspace location where you currently are.


Exporting Folders

Follow the steps below to export a folder from your workspace:

A zip file containing all the assets within the project folder will be downloaded on your local machine.


Sharing Folders across Multiple Workspaces

Shared folders are useful to improve efficiency and consistency of your documents and also these are great for organizations that want to preserve disk space. For example, you can create a shared folder called Branding, containing the company logo and some common stylesheets. Then, these files can be used by a large number of users, from different workspaces, without having to add a version of your file each time is needed.

Note

Only root folders can become shared; if you are not able to see this option within the contextual menu, use the upper menu bar to return to the main folder.

Your root-folder, together with all its assets, is now shared across all the workspaces created in the current environment. To verify, access other workspace and notice that the folder you just shared is visible from other workspaces.

You can identify if a folder is shared or not through its tags. Once a folder is shared, the Shared ( ) tag will be visible after access, next to its name.

To stop sharing a folder, right-click on it within Sidebar and select the Share\Unshare option from the contextual menu.


Creating Hidden Folders

In the EngageCX Platform, you can tag a folder as hidden folder. Once a folder is hidden, it will not be shown to users unless a user has specifically chosen to view hidden folders in their user profiles. Hidden folders are useful when you want to add content that you or any other user should not modify or for old folders with whom you don't want to clutter the interface by default. However, hidden folders will still be indexed by EngageCX.

Follow the steps below to create a hidden folder:


Displaying Hidden Folders

Follow the steps below to display a hidden folder:


Business Rules

Business behavior is governed by business rules that dictate how flows should be initiated and directed. They typically describe requirements or policies that transcend the software project they are required in the domain or business and the workflows may need to conform to them. The main utility of business rules is that these can be used when there is a set of common rules shared within workflows or in case of the conditional translation. An example of such a rule could be conditional translation.

Creating New Business Rules

Follow the steps below to add a business rule to your workspace:

Business Rules names should define the purpose they achieve, enabling you to establish instructions and definitions for project assets reconciliation. The names should express the new behavior of business processes. For example, Promoting specific products, Promoting categories, Exclude specific items, Message Routing Rule, Email Restriction, etc.

Notes

To add a business rule to a workflow, please access this link.


Accessing the Business Rule Editor

The Business Rules Editor opens online and all related configurations can be performed from here allowing you to easily create and edit rules and decisions.

  1. Starting from the Workspace Details page, select the business rule you want to edit.
  2. You will be redirected to the Business Rule preview page.

Business Rules can be edited within the Business Rule Editor:


Business Rules and Properties

EngageCX Solutions improve efficiency and eliminate errors by supporting business rules, integration with existing business processes. Properties have the aim to make a well-written business rule, helping users to understand the logic behind that govern the business requirements and stay clear about what the rule is required to do.

Adding a Rule

Follow the steps below to add a rule:

Note

If there is no Data Source to build your expression with, please check the input.


Adding a Property

Follow the steps below to add a property:


Editing Rule Content

Follow the steps below to modify a rule:


Business Rules Settings

The Settings section is intended for managing the default language and the data source that could be used in a business rule.

Configuring Languages

Follow the steps below to set up a language:


Configuring the Data Source

Follow the steps below to assign a data source to your business rule:


Business Rules Display Options

How the business rules are displayed in the page can be selected from the Display section. These can be combined into groups by a specified category or filtered according to rule-based data.

Adding a Category

Follow the steps below to insert a category:


Grouping

Follow the steps below to group business rules:


Filtering

Follow the steps below to filter business rules:


Other Business Rule Options

At the editing business rule time, it might be necessary to consider the following options:

Folders and Files Options

At workspace level, you can manage files and folders existing in a workspace through various options.


Folders

In the table below, you can see all the available actions that can be taken at folder level.

View Upload Export Synchronize Folder Permissions
Tags Copy Rename Move Delete


Files

In the table below, you can see all the available actions that can be taken at file level.

Open Upload Download Add/Remove favorite Versions Dependencies
Tags Copy Rename Move Delete


Open Folders

The EngageCX Platform provides several ways to display the contents of your folders.


By selecting the folder:

Follow the steps below to open a folder:


From Contextual Menu:

Follow the steps below to open a folder:


From Sidebar:

Follow the steps below to open a folder:


Open Files

Follow the steps below to open a file:


Rename

Both files and folders within a workspace can be renamed.

Rename Files

Follow the steps below to rename a file:


Rename Folders

Follow the steps below to rename a folder:


Delete

Both files and folders within a workspace can be deleted.

Delete Files

Follow the steps below to delete a file:


Delete Folders

Follow the steps below to delete a folder:


Export Folders

At workspace level, folders can be exported by two methods:

From Workspaces Details

Follow the steps below to export a folder:


Within the Project Folder

Follow the steps below to export a folder:


Download Files

Follow the steps below to download a file:


Move

Follow the steps below to move a file or a folder:


Copy

Follow the steps below to copy a file or a folder:


Add or Remove Favorite

As you start to work with many different files or folders across many different Projects in EngageCX Platform, you may want to customize your experience by marking specific files as recently visited documents. We call these Favorites in EngageCX, and you can access such files directly from your Welcome Page whenever initially logging into the system.


Uploading Content

In order to add a file or a folder to any project or another ordinary folder in EngageCX Platform, you will need to understand how to use the Upload feature. This is often the first step in getting started with setting up your document production projects, but this task will also prove to be necessary as you continue to add modifications to templates, add new data sources and much more.


Single Files

Follow the steps below to upload a single file:


Zip Folders

Follow the steps below to upload a ZIP folder:


From the EngageCX Studio product

When working with any of the EngageCX Products, you will have the ability to connect directly to EngageCX to upload, edit or remove files.


Synchronize Folder

In the EngageCX Platform, you can configure a folder to synchronize with the Amazon Web Service.

Note

A reachable Amazon S3 connection is required in order to set up a synchronized folder in EngageCX Platform. To create a new connection, please visit the Amazon S3 connections.

Follow the steps below to synchronize a folder:

Notes

The amazon full synchronization can be done in three ways:

  • If the user changes the synchronization details.
  • When the EngageCX Service (EOS4Service) is restarted.
  • Every day at midnight.

A full synchronization can take from several seconds to some minutes depending on the synchronized data size.

Notes

If you want a real-time synchronization, you will need to configure Amazon to push bucket events to EngageCX platform using SNS service.

To view the Synchronization Folder Log, please visit the Synchronization Log chapter to read more information about it.

Each folder that synchronizes with Amazon contains, by default, an Amazon synchronized tag visible, at the top-left side of the page. To read more information on how to edit the current tag, please visit the Tag section of this chapter.


Configuring Amazon S3 bucket to push notifications to EngageCX Platform

Note

The logged-in user must have permissions to administrate the Simple Storage Service (S3).

Notes

If you do some changes in the bucket, in the period that Amazon notifications weren’t set, you will need to do a manual synchronization, to be sure that all data are at the latest version.


Version Control

As you work in any of the Projects you create in EngageCX, you may modify files and upload newer versions. The EngageCX Software will use a repository to store the file in its previous state and use the new file as the latest version. This process is called versioning and will prove useful to you for tracking and accessing the history of any file within the project.

This functionality gives you some benefits such as:

Accessing the File Versions

Follow the steps below to access the versions of a file:


Along with each version, you can find useful information regarding the following:

Version Number The unique identifier for the current version.
Date created The date when the version was created.
Size The size of the current version.
Author The author that created the version
Comments Comments associated with the version.
Status The status of the current version.


New versions of a file are created as a result of any action that creates or overwrites that file, for example:


Dependencies

Whenever you set up a project within EngageCX Platform, you will need many different types of files to be able to generate the needed documents. EngageCX Projects rarely work in isolations. Each Project relies on multiple individual and reusable components.

The Dependencies dialog can be accessed by selecting the More ( ) button of any file you choose and display all the directly-connected files and also the files where it is used, in a separate tab.


Sharing Files

Besides folders, EngageCX also allows you to share each file, separately. To share a file within a workspace, follow the steps from below.


Folder Permissions

To apply permissions for an individual folder, you need to:

Note

If you do not agree with some permissions that are already set, you can reset all of them in Folder Permissions dialog.


Tags

Tags are keywords associated with a folder or file from a workspace. These can be added manually and are useful when you want to find the needed content in a quick manner. To add a new tag to a file/folder:

Engagement

Customer Engagement is a business communication connection between an external stakeholder (consumer) and an organization (company or brand) through various channels of correspondence. The purpose of this is aimed to build a long-term engagement strategy that increases the number of repetitive buyers. Typical use cases could be exchanging information with the customer based on behavior, transforming one-time customers to repeat customers to brand advocates, customer activity stream log of all interactions etc.

The Engagement group is divided into three categories: Communications, that allows you to send documents to the persons you want to trail, Journeys, where you can design your users' adventure from prospect to customer, and Persona, that help you to set down the target audience.

Communications

The Communications module allows you to generate and deliver documents to any output type using the Projects you have created.

Accessing the Communications Module

Follow the steps below to open the Communications module:

  1. Access the EngageCX Welcome Page.
  2. Select Communications from the Modules Menu.

or

  1. Select the System ( ) menu at the top-left corner of the Welcome page.
  2. Choose Communications under the Engagement group.

Running a New Communication Project

Follow the steps below to run a communication:

  1. On the Communications module, select +New Communication from the toolbar.
  2. A new page is opened where you will need to select a Project you want to run. Scroll up and down through the Projects list or use the Search bar at the top-right to quickly find a specific project. Additionally, you can either use the Sidebar in the left side to find a specific destination folder of your project or make use of the Search By Folder for a more precise result. Once selected, click Run.
  3. You will be redirected into an Overview page of your communication project. Depending on your Project Options, it may be necessary to fill in some form fields, then submit the project.

Monitoring a Communication

Once a project is submitted, its associated communication will appear on a list within the Communications page. The communications list quickly summaries important communication details, such as the communication names that are being run within the environment, their status, the user who initializes it and the start date. The number of documents that are being produced according to their types are displayed in the right-columns, like: Forms, Documents, Sent Emails and Clicked Emails.

If multiple communications are present on the list, you can use the Sidebar to focus on them. You can use it to look up for communications filtered By Project or By Folder. Additionally, you can find a communication by simply selecting from the default views, to check up on communications that are Succeeded, finished with Errors, or still In Progress.

Furthermore, EngageCX provides other two custom views, from where users have the ability to inspect and run communications in an automated fashion: Scheduled and Triggered.

To create your custom communication views, please visit the Views section of this guide.


Communication Overview

For a more detailed view of the generated outputs, select a communication you are interested in from the list. You will be redirected to an Overview page summing-up the documents that are being produced, delivered or read by the recipients. You can select Documents from the Sidebar to view all the documents, emails or print streams that are being generated for the selected project.

Select the Emails tab from the Sidebar to view all the delivered correspondence. Use the down-arrow from the top-left side to filter your emails, by displaying only the one clicked, delivered, failed, opt-out, pending, read, sent or suspended.

Select the SMS tab from the Sidebar to display all the SMS tickets sent through the EngageCX Platform associated with the project selected. Use the down-arrow from the top-left to filter your tickets by displaying only the one who failed, running or sent.

In case your project run has failed, go to the Log tab from the Sidebar to view a job log corresponding to the current communication alongside the message and timestamp of each of them.


Embedding a Communication

Due to embedded communications in the EngageCX Platform, one user can easily find a project by certain tags specified in a dedicated URL, and then run the communication and see the generated documents.

The format of the URL should be something like this:

http://ecrionserver:portnumber/EOS/Communications?embed=true#communications/NewCommunication!tag=tagName

where the key parameters needed to be used are highlighted below:

Note

Any kind of parameter (e.g. contactId, communicationId, or any other parameter found in the communication workflow) can be added within the URL, if there is a need to be passed as a job parameter. For example, to specify the contactId, the URL should be as follows:

http://ecrionserver:portnumber/EOS/Communications?embed=true#communications/NewCommunication!tag=tagName&contactId=EOS_Contact


Scheduled Communications

By selecting the Scheduled tab in the Sidebar, EngageCX will provide a filtered view of all the communications that have been scheduled earlier. On this page, you can either view information about existing scheduled communications, including the project name, the last time the communication was run and the author that scheduled the communication, or you can create new schedules.

Scheduling a Communication:

The EngageCX Platform provides you the ability to automatically schedule your communications based on the availability of the project resources, to start at a specific time. You can schedule projects to run hourly, daily, weekly, monthly, or even number of minutes, on certain days of the week, several times a month, etc.

Follow the steps below to schedule a communication:

  1. Access the Communications module and select the Scheduled view from the Sidebar.
  2. Select +Add Schedule from the toolbar.
  3. Next, choose the communication project you may want to set a schedule for and click OK.
  4. In the Configure Schedules dialog, select New Schedule.
  5. Within the Schedule dialog, select the options you want to apply.
    • Choose the time frame you would like to schedule the Project for, by selecting the Hourly, Daily, Weekly or Monthly tabs.
    • Configure the timing of the Schedule.
    • Toggle on or off the Enabled option to activate/deactivate the Schedule.
    • Select Configure Parameters button to modify the already defined parameters(if exist) from the Workflow that need to be set before the Project runs.
  6. When you're ready, select Save.

The scheduled communication will appear now on your Scheduled list and will run the project accordingly.


Triggered Communications

Triggers allow you to configure EngageCX to start specific projects as an automatic response to an action. In the Triggered page, you can inspect all the projects that have been triggered and/or create new triggers. The supported methods for triggering projects are Hot Folders and Microsoft Message Queues (MSMQ).

Configuring a Hot Folder Trigger

Follow the steps below to set up a hot folder trigger:

  1. Access the Communication module and select the Triggered view from the Sidebar.
  2. Select +Add Trigger from the toolbar.
  3. Next, choose the communication you may want to configure and select OK.
  4. In the Configure Triggers dialog, select the New\Hot Folder button.
  5. Within the Hot Folder dialog, fill in the form with the mandatory fields:
    • Path: provide the path of the folder containing the external resources.
    • Hot Folder Type: Select the type of the Hot Folder: Machine Physical Folder or SFTP Folder.
      • If you choose SFTP Folder, you will need to select an SFTP Connection to use. If none is available, you will have to configure an SFTP Connection.
    • File Pattern: Provide the file pattern of the data source that EngageCX should be monitoring the folder for. You can use wildcards like '*' to make the pattern more generic.
    • Pooling Interval: The number of seconds between 2 consecutive attempts to check for new files.
    • Enabled: On or off Enabled option to activate or deactivate the Hot Folder Trigger
    • Configure Parameters: Configure the parameters (if any) from the Workflow that need to be set before the Project runs.
  6. Once you're ready, click OK.

The triggered communication will appear now on your Triggered list and will run the project accordingly.


Configuring a Microsoft Message Queues Trigger

An MSMQ trigger monitors the Microsoft Message Queue. Each time an entry is added, EngageCX will parse it using either a binary or XML formatter and use the result as the input. The formatter to use is specified by the user when creating or editing the trigger.

Follow the steps below to set up a MSMQ trigger:

  1. Access the Communication module and select the Triggered view from the Sidebar.
  2. Select the +Add Trigger button, from the toolbar.
  3. Next, choose the communication you may want to configure and select OK.
  4. In the Configure Triggers dialog, select the New\Microsoft Message Queue button.
  5. Within the MSMQ dialog, fill in the form with the mandatory fields:
    • Path: Provide the path of the MSMQ.
    • Formatter Type: Choose the Formatter Type to be used: BinaryFormatter or XmlFormatter.
    • Polling Interval: The number of seconds between 2 consecutive attempts to check for new files
    • Enabled: On or off Enabled option to activate or deactivate the MSMQ Trigger.
    • Configure Parameters: Configure the parameters (if any) from the Workflow that need to be set before the Project runs.
  6. Once you're ready, click OK.

The triggered communication will appear now on your Triggered list and will run the project accordingly.


Workflow Settings for Triggers

One of the common scenario to user triggers is when you want to use input data in your Projects from external sources. Setting up an EngageCX Trigger process does not necessary mean that the project workflow will use the external data to generate documents.

When building your project workflow, you will need to reference the trigger file in your dynamic expressions. This can be accomplished by setting the Source parameter value in the Get Data step to the Trigger File Standard parameter. Or simply enter the following flag {PARAM:TriggerFile} inside the complex expression. This will resolve the path of the trigger file.


Communication Filtering

With Communication projects, you can filter your view so that you will see information that is most important to you within the page.

  1. In the Communications page, enable the Filters button on top-right of the page to be able to apply a filter for the available communication entries.
  2. Select the communication's operator based on which the filter will test for from the available drop-down list.
  3. Choose an operand to execute the filter from the second drop-down list.
  4. Select the second operator to test the communication data when executing the filtering expression.

Once you have finished to configure a filter, you can add another one by clicking Add new next to the filter's drop-downs and so on, as long as you get only the communications you want in the view.


Communication Filters

Filters can be very useful for viewing a specific range of communication information, allowing you to display only the data you are interested in and hide the rest.

Name Description
Status Verifies the current status of the communication project that has been running.
Type Verifies the communication type.
Author Verifies the author that has run the communication.
Not Older Than Verifies the date when the communication has finished running by setting a lower limit.
Name Verifies the communication name.
Project Name Verifies the project name of the communication being stored.
Start Date Verifies when the communication has started.
End Date Verifies when the communication has finished.

More Communication Options

At any time, you can select the More ( ) button, next to a communication name and select from the actions below under the contextual menu:


Share Communication

To share a communication, you need first to generate a public or a portal link. Public links are view-only and anyone with the link can view or download its content. This feature has the same behavior as the Share Project property.

In case you do not want the communication to be public anymore, you can manually do the reverse operation which is Unshare. Only if the communication job URL is already public, the Unshare option will appear to your contextual menu.


Journeys

Customer Journeys reveal the experiences that your customers go through when interacting with your company and brand. The EngageCX software creates a narrative starting from the journey purpose and automatically enrolls a customer to a journey based on a persona or a list. In this way, different customer stages are allowed to be defined inside a journey. Using a journey map to track the entire customer experience, in real-time, will help you pro-actively monitor your customers and manage them appropriately.

Within the EngageCX Platform, you can create two types of customer journeys: a Journey or an Episode.

Accessing the Journeys Module

Follow the steps below to open the Journeys module:

  1. Access the EngageCX Enterprise Welcome Page.
  2. Select Journeys from the Modules Menu.

Or

  1. Select the System ( ) menu at the top-left corner of the Welcome page.
  2. Choose Journeys under the Engagement group.

Creating a new Customer Journey

Follow the steps below to create a customer journey:

  1. Starting from the Customer Journeys page, select the + New button from the toolbar.
  2. Choose the customer journey type from the contextual menu: journey or episode.
  3. You will be prompted to select a template as a starting point. Choose between an Blank template, to configure a customer journey from scratch, or other predefined templates, Episodes like (Webinar - to create a web-based seminar for your customers, or Newsletter - to set up a journey that delivers newsletters to your customers) or Journeys like (Customer Nurture - to support the process of developing customer relationships at every stage of their interaction with the sales funnel).
  4. Fill out the form with the needed values:
    • Name: Enter a friendly and unique name for your journey.
    • Description: Optionally, provide more information about the Journey you want to create. The description will be applied in the Journey Map of the corresponding Journey below the Prospect stage.
    • Projects Folder: Choose the destination folder for your journey to be stored. This field is required only for predefined templates selection, not for the blank ones.
  5. Once you're ready, select Finish.

After the successful creation of the journey, you will be redirected to the Online Editor, where you can perform further edits.

Importing an Existing Customer Journey

Follow the steps below to import a customer journey:

  1. Starting from the Customer Journeys page, select the More ( ) button from the toolbar.
  2. Select Import from the contextual menu.
  3. Click Choose File to select an existing journey/episode from your local machine. The file that you are allowed to import is a ZIP archive, which contains all the dependencies used in the journey configurations in order to properly function.
  4. You can choose another Workspace besides the Default one, which is, by default, selected.
  5. Once you're ready, select Import.

After the successful import operation of the journey, you will be redirected to the Online Editor, where you can perform further edits.

Enabling/Disabling Customer Journeys

By default, when a new Journey\Episode is created, it would be Disabled. When a journey\episode is disabled, the contacts enrolled will not receive any communication. It is best practice that while editing a journey\episode to keep it disabled.

To enable\disable customer journeys:

Assigning a Target Audience

After a Journey\Episode has been created, locate the Target Audience column in the Journeys module. A Target Audience represents a group of contacts within a Persona or a List that will be enrolled in the Journey or Episode. To assign one, simply select the corresponding Edit Target Audience ( ) button and choose from the available drop-down list.

More Customer Journey's Options

At any time, you can select the More ( ) button, next to a journey name and select from the actions below under the drop-down menu:


Journey Details Page

Selecting a journey\episode in the Customer Journeys module will redirect you to the Journey Details page. On the left side of the page, you can view the Sidebar showing all the touchpoints defined and the journey\episode dependencies. If there any any errors within these dependencies, you should access the Dependencies tab and select View journey errors on top of the page. You will have a more detailed The Contacts Pane can be found on the right side, offering easy access and details on every customer assigned to the current journey. The centered area of the Journey Details is reserved for the Journey Map, that provides a smooth and clear eyesight interface to track your entire customer engagement evolution within your company.


Journey Map

The Journey Map can be found in the middle of the Journey Details page, providing an interactive path for your customers within the journey they are enrolled with. It maps out all the different checkpoints you expect customers to pass through along their journey goals.

To start editing a journey map, select the Edit ( ) button in the toolbar. The Map Editor will open and you can start adding elements to your journeys.


Journey Stages

A journey is structured in a sequence of stages, which usually happens over time. The EngageCX Contacts pass through stages, over time, activating certain touchpoints based on some predefined event rules. During a time period, a Contact connects touchpoints together and expresses a Contact Journey. This is depicted using a dotted line that unites the touchpoint bullets. The solid lines are drawn by the user and represent his customer journey route prediction. This way, unexpected routes can be detected and analyzed. The horizontal center area represents the main route a user is expected to follow, and the touchpoints positioned outside can lead to alternate routes.

Adding New Stages

Follow the steps below to create a stage:

  1. Select the + Add Stage button from the bottom bar of the Journey Map.
  2. Provide a relevant name for the stage.

When naming the stages of your Customer Journey think about what customers are trying to achieve as a result of their interaction with your company. At the end of each stage, you might have answers to the questions below:

Contextual Stages Options

Follow the steps below to explore the options from the contextual menu of a stage:

  1. Right click on a stage in the Journey Map Editor.
  2. From the contextual menu that is displayed, you can select the following options, according to your needs:
    • Rename: Use the Rename button to edit the name of the current journey stage.
    • Color: Use the Color button to change the color of the stage according to your preferences.
    • Delete: Use the Delete button to remove the current stage from your journey.


Touchpoints

Touchpoints can be added to the board and are contained within stages. Each touchpoint can be edited, on a separate page. The touchpoint editor allows the user to define the event rules that activate the current touchpoint and the interactions that will happen after the activation occurs.

Keep in mind that the event has a Contact context, meaning that it is triggered by/for a specific Contact and carries some additional data. By using the event types and data filters, the user can target specific key moments, like when a Contact first joins EngageCX, or when an address is changed, or when a specific document is received by the Contact, or a form is sent from a Contact.

When an event is emitted from the underlying EngageCX system, it passes through each touchpoint and matches against the rules defined. When a match is found, the Contact is moved in the touchpoint and executes the interactions, which basically runs an EngageCX Solutions workflow. Touchpoints should have rules that are all exclusive, meaning that an event should match only one touchpoint.

A touchpoint is referring to any interaction that may alter your customer's experience in the time they use your products.

Adding New Touchpoints

Follow the steps below to create a touchpoint:

  1. Double-click on the stage area where you want to add the touchpoint.
  2. Provide a name for your touchpoint.

Editing a Touchpoint

Follow the steps below to edit a touchpoint:

By using the right-click:

  1. Starting from the Map Editor,right-click on a touchpoint at your choice.
  2. From the contextual menu, you can select to:
    • Change the touchpoint color.
    • Make milestone if it a starting on an ending touchpoint.
    • Provide a new name to the touchpoint.
    • Delete the touchpoint.
    • For more options, select Edit touchpoint. Go to the Properties tab in the Sidebar and configure the touchpoint according to your needs.

By using the Sidebar:

  1. Starting from the Map Editor, access the Components tab.
  2. Hover the mouse over the touchpoint you want to edit, then select the Edit ( ) button that appears next to its name.
  3. The Properties tab will open in the Sidebar for the touchpoint selected, from where you can:

    • Enter a new name for your touchpoint;
    • Edit the touchpoint description; The description will be shown on top of the page, while previewing the touchpoint, before accessing the Edit mode.

    • Add a new trigger for the touchpoint;

    • Create new steps for the touchpoint.

When editing a touchpoint, you can either define the event rules that activates the current touchpoint, or the interactions that will happen after the activation occurs.


Touchpoints Events

An event represents a trigger factor for activating a touchpoint. Each touchpoint can have multiple events that can trigger a Contact transition (e.g. when a form is submitted: Pricing Info Form Submission).

Adding a new event

Follow the steps below to insert an event:

  1. On the Touchpoint Editor, select + Add trigger to add an event from the contextual menu.
  2. Choose an event from the menu:

    • Account Updated - activate the touchpoint when the Account criteria is met.
    • Contact Updated - activate the touchpoint when the Contact criteria is met.
    • Correspondence Submitted - activate the touchpoint when the Correspondence Document is submitted.
    • Document Created - activate the touchpoint when the Document is created.
    • Email Read - activate the touchpoint when the email is read.
    • Email Link Clicked - activate the touchpoint when the email link is accessed.
    • Email Opted-Out - activate the touchpoint when a Contact opts out from an email.
    • Touchpoint Completed - activate the touchpoint when another touchpoint is completed.
    • Tracked Event - activate the touchpoint when an event that is tracked occurs.
    • Task Completed - activate the touchpoint when a task is successfully completed.
  3. When all configurations are finished, select Apply to save the changes.


If the name of the trigger is changed in the Properties Pane, the update will be reflected under the Journey Map Editor and its name will be automatically renamed.


Touchpoints Interactions

When an event is triggered, the Engagement Engine analysis all touchpoint events and finds a match for the Contact that triggered it. After the Contact transitions in the current touchpoint (e.g. Requested a quote), the interactions start to run.

When you try to make a connection between two touchpoints, a dialog will be displayed on the screen, where you can add triggers based on the steps of the connection start-node. This is an automatic way of making connections. Same happens when a trigger or event is inserted in the Touchpoint Editor, a connection line will be automatically designed based on the previously added trigger/event. In the dialog, triggers of type Correspondence Submitted will be detected also, so that an option .

Adding a new interaction

Follow the steps below to insert an interaction:

  1. On the Touchpoint Editor, select + Add step to add a new interaction from the contextual menu.
  2. Choose an interaction from the menu:

    • Communications - run a specific communication, after the touchpoint is activated.
    • Wait - wait a specific time until to process the next iteration (if it has one). This time can be relative (x days/minutes/seconds from now) or absolute (e.g. a specific date: Oct 10 2018 13:00 AM).
    • Advanced workflow - runs a custom workflow by selecting it from the project files or uploading from your local machine.
    • Task - assign a Review Journey task to an engaged customer.
  3. When all configurations are finished, select Save to apply the changes.

When editing the Journey Map, please note the following toolbar options:


If the name of the step is changed in the Properties Pane, the update will be reflected under the Journey Map Editor and its name will be automatically renamed.


Journey Analytics

To access the Engagement view of Episodes and Journeys within your environment, select the Analytics button in the toolbar. Engagement module will open in a new page and it enables to you two views that can be easily accessed from the toolbar:


Contacts Pane

On each Journey/Episode Preview, that has assigned a target audience, you can view a list with all the contacts enrolled under the Contacts Pane, located in the right-side of the Journey Details page. It allows you to monitor your customers and manage them appropriately. The touchpoint reached by each contact is also displayed here.

More Contacts Pane Options

At any time, you can select the More ( ) button next to a contact name in the Contacts Pane and perform the following actions under the drop-down menu:


Personas

Under the Persona section, you are able to create and manage the target audience for a Journey. A target audience is the demographic of people most likely to be interested in your products or services. It consists of a particular segment at which a product is aimed. For example, if you own a toy store, your target audience is parents, grandparents and anyone else with children in their lives.

Target Audience works with Persona. One persona consists of a group of contacts that shares the same interests.

Accessing the Personas Module

Follow the steps below to open the Personas module:

  1. Select the System ( ) menu at the top-left corner of the Welcome page.
  2. Choose Personas under the Engagement group.

Creating New Persona

Follow the steps below to add a persona:

  1. On the Personas page, select + New Persona from the toolbar.
  2. Fill out the form with the needed values:
    • Name: Enter a friendly name for your Persona.
    • Description: Optionally, provide more information about the Persona you want to create.
    • Rules: Add a filter from the drop-down list and create a statement such that a contact must satisfy a condition before being assigned to this Persona. You can add rules based on the List membership of contacts, by choosing the Lists field from the drop-down list. Additionally, select the Group ( ) button at the left side of conditions to indent certain statements of your rules.
  3. Once ready, select Create to save the changes. A confirmation dialog is displayed to inform you that there are changes related to contacts' state or not. Confirm if you want to apply those changes.

To see the actual contacts assigned for a specific Persona, you should select it from the list and you will have access to every contact included.

More Persona Options

After a Persona entity is created, it will appear in the Persona's list. At any time, you can select the More ( ) button next to a persona's name and perform the following actions under the drop-down menu:

Note

Deleting a Persona will not delete the journey. Instead, it will unroll all Contacts in that Persona from that journey.

Organization

Analytics

Using the Analytics Module, users can create interactive documents based on their own custom dashboards. A dashboard is a collection of widgets that provide a visualization of your enterprise data. This is useful to track metrics and other key data points relevant to a business, department, or a specific process, and it is also intended to simplify complex data flows to let users casting a glance over their current performance.

Accessing the Analytics Module

Follow the steps below to open the Analytics module:

  1. Access the EngageCX Welcome Page.
  2. Select the Analytics button from the Modules Menu.

or

  1. Select the Systems ( ) button from the top-left corner.
  2. Choose the Analytics option under the Organization module.

Dashboards

Dashboards often provide at-a-glance views of key performance indicators relevant to a particular objective or business process. These help you to make intelligent business decisions based on meaningful patterns in transactional data. Dashboards are .bid files created using the Analyst tool. To learn more about how to create a Dashboard using the Analyst tool please visit the EngageCX Analyst Help Manual.

Accessing the Analytics page you can either navigate through existing dashboards or create new ones. A good and easy way of finding and navigating through EngageCX Dashboards is using the Sidebar. By default, there will be two views in the Sidebar: Custom and System. To view all the existing dashboards, select the All Menu and to create new views, please visit the Views chapter of this guide.

The System Dashboards provide business users with an intuitive and easy-to-use tool for monitoring their issues. If a dashboard is created properly then users are treated to a highly visual panorama of their own business.


Creating New Dashboards

Follow the steps below to create a dashboard:

  1. From the Analytics page select New Dashboard from the toolbar.
  2. Choose the Project that should be executed from the available templates. Additionally, you have the possibility to use the search bar for a specific project name or access the sidebar for a specific folder.
  3. Next, click Run and you will be redirected to the Dashboard Preview page.


Reviewing Dashboards Output

When you are designing your dashboard, you may frequently want to check the output behavior of your widgets. EngageCX provides the ability to review the output documents of the created dashboards. In Analytics page, simply select your dashboard and you will be redirected to the Dashboard Preview. The user can review and test all the widgets included in the dashboard. For this, right click on a widget in the Dashboard Preview and select one of the following options from the contextual menu:

Download CSV Export To Show/Hide Legend
Toggle column Show/Hide Scrollbar


Download CSV

Follow the steps below to download a CSV from a widget's data:

  1. Right click on a widget in the Preview Mode.
  2. Select the Download CSV option.
  3. The data in the widget will be exported as a CSV file on your local machine.

Note

This option is valid only for Visualization Widget types.


Export to

Follow the steps below to export a widget:

  1. Right click on a widget in the Preview Mode.
  2. Select the Export to option.
  3. Choose the file format in which you want your widget to be exported.
  4. The data in the widget will be exported as the selected file format on your local machine.


Show Hide Legend

The legend will be shown in your widget by default. However, you will have the option to hide it. Follow the steps below to show/hide the legend:

  1. Right click on a widget in the Preview Mode.
  2. Select the Show/Hide Legend option depending on the legend state.


Toggle column

This option allows you to restrict the number of columns in a table to emphasize only some of them. Follow the steps below to toggle a column:

  1. Right click on a table widget type in the Preview Mode.
  2. Select the Toggle column option.
  3. Choose the column option that you want to be toggled.

Note

This option is valid only for Table Widget types.


Show Hide Scrollbar

Follow the steps below to show/hide the scrollbar:

  1. Right click on a graphical widget in the Preview Mode.
  2. Select the Show/Hide scrollbar option depending on the scrollbar state.

Note

This option is valid only for Graphical Widget types, excepting the Pie Chart because it does not have axes.

Every time a dashboard is created, a corresponding Analytics Job will run. For more details regarding Analytics Jobs, please visit Jobs chapter.

Generating Reports

Because the EngageCX Platform includes document automation technology, users can generate reports that integrate their dashboard information within an external document. Follow the steps below to generate a report:

  1. Within Dashboard Output Preview, select the Reports ( ) button from the toolbar.
  2. Select the available Report template from the drop-down list.
  3. Select the Format for the output file.
  4. Select the necessary options for the Dashboard state:
    • Include filters option suppose that the downloaded document will contain data filtered by you previously.
    • Include marks option suppose that the marks done by you under Dashboard Preview be retained when downloading the report.
  5. Once ready, click Generate report.

The output file will be downloaded on your local machine.

Configure Schedules

EngageCX provides users to schedule dashboards to refresh on a certain period that you set (daily, weekly, or monthly), and then receive refreshed dashboards results by email. Follow the steps below to set up a schedule for your dashboard:

  1. In the Analytics page, select Schedules from the toolbar.
  2. Select None from the Schedules column next to the dashboard for which you want to configure one.
  3. Click New Schedule from the Configure Schedules dialog in case there is no schedule display in the list.
  4. Configure your schedule for the selected dashboard as you usually do for any other schedule.
  5. Once you're ready, click Save.

You can repeat the process as many times as you consider to be necessary for your dashboard.


More Dashboard Options

After a Dashboard is created, it will appear on the Dashboard list and can be easily accessed from the Sidebar. For accessing options related to a certain dashboard, you have to select the More ( ) button and choose from the available options within the contextual menu:

Note

System Dashboards cannot be deleted.


Developer

Developer module is intended to bring a strong starting point of EngageCX platform users. Accessing Developer module will lead users to various samples and documentation links, latest versions of both, desktop design software and software development kits, and this will also allow developers to generate API Keys to authenticate custom applications.

Accessing the Developer Module

Follow the steps below to open the Developer module:

  1. Access the EngageCX Welcome Page.
  2. Select the Developer button from the Modules Menu.

or

  1. Select the Systems ( ) button from the top-left corner.
  2. Choose the Developer option under Organization Module.

From the Developer module you can access the following features:

API Keys Code Samples Project Ideas
Documentation Software

API Keys

An API Key represents a safer way to authenticate your applications that authorizes on the client side (e.g. a browser) or a mobile application. EngageCX allows you to generate numerous API Keys, to allow access to your account of custom applications without using a username:password combination.


Managing API Keys

All users can generate API Keys for themselves, at any time, by following these instructions:

  1. Access the Developer Module from EngageCX Welcome page.
  2. Select the Manage API Keys button from the API Keys tile. From the Manage API Keys dialog, select the Add API Key option
  3. Provide a short description for the API Key under the Reason box, then select Create.

The API Key will appear on the My API Keys list, where you can view additional information such as the creation date or the description applied.


Adding API Key for Users

The feature is available only for users that belong to groups that have the Manage Environment option enabled(e.g. environment admins).

Generating API keys on behalf of others users allows admins to have a full view and manage all the API keys of the current environment, and also helps administrators to provide custom permissions to API keys by associating them with a user. When an admin will use a key on behalf of another user to authenticate, he will have the same permissions as the user of which the API Key belongs, and not full permissions.

When an API Key is created for an end-user, it will work exactly the same as if the user has created it. The administrators can view the API Key once, then it will become obfuscated and will be visible only when the user logs in to the EngageCX Platform. Administrators can only manage(edit/delete/add) the keys. Also, if the administrator that created the API Key is updated/deleted, the API Key will still exist and work, as the end-user is the owner of the Key.

Below you can view step by step instructions on how to add an API Key for other users.

  1. Access the Developer Module from EngageCX Welcome page.
  2. Select the Manage API Keys button from API Keys tile. From the Manage API Keys dialog, select the Add API Key For User option.
  3. Add the user(s) for which you want to generate API Keys. You can use the navigation bar to select or deselect users, or simply click in the Users box and a drop-down list with the existing users will become visible. Optionally, type in a simple description in the Reason box to justify the scope of the API Key.
  4. Check the Send Notification option if you want your users to be notified through the email.
  5. Once you're ready, select Create to save the changes.

Next, you will be prompted with a notification telling you that the API Key(s) has been generated and you are allowed to view the entire key string. Selecting OK will lead you to the Users API Keys list, where you can view additional information such as the creation date, the descriptions applied or the username for which the key has been generated.

Note

If many users are selected, EngageCX will generate a new API Key for each user.

By default, EngageCX will use the SMTP Connection created in Settings\Email. If there is no connection created, EngageCX will use the connection created under Domain Settings\Email from System Administrator website.

Note

Note that the API Keys created are now obfuscated and can be seen only by the user for which these have been created.


More API Keys Options

At any time, you can click on the More ( ) button button next to the API Key to perform the following actions:


Delete

You can entirely delete an API Key by selecting Delete button and confirming the deletion. An API Key is not tied to a specific administrator. Any EngageCX administrator can remove any API Key that was issued on behalf of any user.

It is important to know that deleting an API Key is an irreversible operation. The option is more useful for API keys generated on behalf of other users; for example, if you want to grant access to your application in case somebody unauthorized access it, you can simply delete the key.


Edit

This option allows you to edit the initial description provided for your API Key.


Checking User Keys

At any time, admins can see the keys associated with a specific user from the environment.

  1. Access the Users tab from the Admin Settings page.
  2. In the Users page, identify the “#Product Keys” tab, where you can view the keys assigned to each account. Selecting a key from the column will open the Manage API Keys dialog from where you can manage the existing keys or generate others.

Code Samples

By accessing the Code Samples page you can explore a large range of code application which demonstrates various EngageCX features.

Note

At first glance, you will need to generate an Application Key to be able to view and run the code samples. Simply, select the Generate API Key button and EngageCX Platform will generate an API Key for you.


Accessing the Code Samples Page

The code samples are divided into two categories:

Document Production Code Samples

Code samples related to document production represent a collection of code snippets that examine different ways of producing documents with EngageCX Platform. The examples vary depending on the available EngageCX Platform you are using.
By selecting on each of the examples displayed, you will be offered a short piece of code, with the possibility to execute and for some of them to actually download the output result.


Design Tools Code Samples

In this section, you will find a code snippet that shows you how to embed the EngageCX template editor in your solution. For example, by running the Online editing document using embedded Template Editor code snippet will create an authorized URL to the embedded Template Editor for a template stored on EngageCX server.


Running the Code Samples

After selecting a code sample, the Preview page is divided into two parts. The left region is an Online Code Editor, from where you can modify the code according to your needs. In the right side, you can view console that displays the generated output.

Follow the steps below to run a code sample:

  1. In the Code Samples Page, select the model you want to test.
  2. The Code Preview will open in a new page. You will have to select the Run button, from the toolbar to run the snippet code and instantly view the output.
    • Additionally, next to the Run button in the toolbar, you can access a drop down menu to choose any other code sample that you want to explore.
    • To read more information about API Reference, select the Documentation button from the toolbar.

Note

The code samples that enable local running are those written in JavaScript, only.

Project Ideas

Likewise code samples, EngageCX Platform comes with several project ideas covering a wide range of complexity, marking a strong key point for users that want to get acquainted with EngageCX Projects. The samples are divided into four categories and show how to accomplish different goals and address particular scenarios for Financial, Insurance, Retail or Telecom business.


Accessing Project Ideas

Follow the steps below to open the Project Ideas page:

  1. Access the EngageCX Welcome Page.
  2. Select the Developer button from the Modules Menu.
  3. Choose Project Ideas tile to view the available templates.


Installing/Uninstalling Project Ideas

EngageCX Platform has multiple Project Ideas for you that demonstrates simple and complex features. To explore these, you will have to install them first, by following the steps described below.

Note

Project Ideas can be installed only on the Default workspace.

  1. Access the Project Ideas page.
  2. Select the category project you would like to install, then select the Install button, beneath its name. For full installation, select the More ( ) button from the toolbar, and select the Install All from the drop down menu.

The samples will appear now on your EngageCX Default workspace.


Exploring Project Ideas

There are several projects that EngageCX shall make available from different domains of expertise for you to play with each of them and get ideas for projects of your own.

Financial

Find out below projects from the Financial area.

Contract for a New Loan Basic financial contract template for a new loan.
Contract for Opening a Bank Account Basic contract template showcasing forms features like conditional pages, signatures and sends an email with the generated contract as PDF attachment.
Fact Sheet The Fact Sheet is an on-demand communication that demonstrates how EngageCX can be used to generate outputs based on user input values.
Financial Planning Workshop Letter The samples demonstrates how you can use account information with an interactive communication.
Loan Automation Loan processing automation solution that allows banks to automate document-intensive loan applications.
Monthly Statement Bank statement showcasing more complex features like barcodes.
On-Boarding Package The samples demonstrates how you can include conditional documents and build on-boarding package deliverable to the customer.
Portfolio Analysis The Portfolio Analysis is an on-demand communication that demonstrates how EngageCX can be used to generate outputs based on user input values.
Purchase Order Letter Basic letter template for showcasing authoring editor capabilities.


Property and Casualty Insurance

Find out below projects from the Property and Casualty Insurance area.

Insurance Policy The Insurance Policy sample demonstrates how forms can retrieve directly the data from EngageCX contacts.
Quote Automation Receives quote requests into back-office system, accelerates sales process and closes deals faster.


Health Insurance

Find out below projects from the Health Insurance area.

Smart Explanation of Benefits Smart Document sample with interactive charts and tables that generates multiple statements from data.


Retail

Find out below projects from the Retail area. Retailing consists of all activities involved in selling goods and services to customers.

Adventure Works Collection of dashboards that describes performance metrics for AdventureWorks, a fictional company.
Bookstore Invoice Basic example with fields and dynamic tables that generates a single invoice from data. Uses XML data as input, where the data source contains transactions for a single invoice.
Bookstore Newsletter Basic newsletter for showcasing forms structured data feature.
Summer Sale Summer is traditionally a slow time for retailers. This promotion takes advantage of the end of summer to unload unsold stock in preparation for next summer. The offers are enticing, and there is sense of urgency created by saying the summer clothes will be gone after the sale.
Webinar A typical web seminar workflow.


Telecom

Find out below projects from the Telecom area. Telecom consists of billing, collecting usage, aggregating it, applying required charges and finally generating invoices for the customers.

Analytics Telephone Invoice Analyses usage accounts using interactive charts and visualizations.
Loyalty Programs This journey map describes the end-to-end cellular telecom customer experience, including all the steps involved in becoming a brand advocate, such as regular customer, insider subscription, special deals alerts, upgrades and merchandise purchases.
Smart Monthly Telephone Invoice Smart Document example with interactive charts and tables. The sample generates one or more invoices from data with a Transpromo placeholder and subdocuments. Uses CSV data as input, where the data contains transactions for multiple invoices. This sample has 2 workflows, each with its own data model (.edx): one will produce all invoices and another one for a single invoice. The workflow for the single invoice will receive a parameter, the invoice ID.
Special Offers A circular customer journey map presenting the experience satellite customers are having, focusing on a single aspect, such as monthly statements special offers.

Documentation

Accessing this module will take you to the Developers Guide documentation, where you can learn how to build applications that use API Keys, in order to produce documents requested by your company.

Software

Software tile leads you to the latest version of both, desktop design software and software development kits. In this section, you will find useful tools, to help you actually develop professional document templates, data models and interactive visualization, under EngageCX Studio or create applications that use EngageCX API to generate documents.

The EngageCX Studio provides the advanced functionality to create both traditional and modern documents, fully interactive communications. EngageCX Studio consists of three visual applications with comprehensive design models, from raw data to presentation.


For Visual Layout Templates: Publisher tool


For Data Models: Modeler tool


For Advanced Data Visualization Dashboard: Analyst tool

EOS SDKs and EOS Portal SDKs: references that users can download to add it to their applications to be able to run EngageCX APIs. Software programmers are able to produce documents in high volumes and manage customer communications, according to the different EngageCX layers. EngageCX provides the following APIs available to download:

REST API Inspector: users can access the REST API page to validate APIs without any kind of setup or desktop downloads and to start testing immediately right in their browser. For more details regarding this, go to EngageCX Developers Guide.


Accessing Software Tools

Follow the steps below to open the Software page:

  1. Access the EngageCX Welcome Page.
  2. Select the Developer button from the Modules Menu.
  3. Choose Software tile to download EngageCX tools and software products.

or

  1. Select the Systems ( ) button from the top-left corner of the EngageCX Welcome Page.
  2. Choose the Developer option under the Organization module.
  3. Choose Software tile to download EngageCX tools and software products.

Admin

The Settings page allows you to configure access control for users or groups, integration with other external systems or handling environment settings.


Note

This section covers features and functions that are available only to environmental administrators. Review the Users and Groups sections to find out more information about environmental administrators.


The Admin module allows you to access the following sections:

Home Users and Groups People
Licensing Domains Channels
Integrations Sysinternals

Home

If you just signing in as an environment administrator, this page is for you. Within Home menu, you can manage environment settings such as environment timezone, import, export or uncover internal configurations.


Accessing the Home Menu

To access the Home Settings Menu, use one of the following methods described below:

  1. Select the Admin menu from the Organization Module.
  2. Access the Home tab from the Sidebar.

or

  1. Select the Admin gear button from the Modules Menu of the Enterprise Website Welcome page.
  2. Access the Home tab from the Sidebar.


Managing Time Zone

Follow the steps below to configure the time zone:

  1. Access the Home tab within the Settings page.
  2. Click on the UTC(Coordinated Universal Time) link next to Timezone, under the General section.
  3. Set up the time zone for the current environment by selecting an option from the drop-down menu.
  4. Enable the Lock the time zone for all users option if you want to use the same time zone for all users so that individuals to not be able to modify the time zone for their accounts.
  5. Select OK to save the changes.


Exporting Environments

Follow the steps below to export an environment:

  1. Access the Home tab within the Settings page.
  2. Select Export from the right of the toolbar.
  3. In the Export Environment dialog, you can picture how many assets will be included in the archive. If you agree with the content, select Export.

The zip archive will be downloaded to your personal computer and will contain all files and folder stored within your environment such as Projects, Dashboards, Journeys and Task Types.


Importing Environments

Follow the steps below to import an environment:

  1. Access the Home tab within the Settings page.
  2. Select Import from the right of the toolbar.
  3. Select the Choose File button from the Import Zip dialog to navigate the file system. Optionally, add Comments about the content that you want to upload.
  4. Enable the Reset option in case you want all the files from the current environment to be deleted.
  5. Once ready, select Import to save the changes and proceed with the import procedure.


Note

Only zip files that match the environment structure will be available for import.


Reset Environments

Follow the steps below to reset an environment:

  1. Access the Home tab within the Settings page.
  2. Select the More ( ) button from the right of the toolbar.
  3. Select Reset Environment from the contextual menu.
  4. Choose the files from the current environment that you want to delete.
  5. Once ready, select Reset to save the changes and proceed with the reset procedure.

Users and Groups

As an environment administrators, you can control who has access to the EngageCX modules, functionalities and assets. To learn more, please select one of the options from the table below:

Create, Edit and Delete Users Create, Edit and Delete Groups
Managing Permissions Synchronization with Active Directory

Create, edit and delete Users

The Users page allows you to create and maintain all the users within Enterprise Website, and also here you can assign them permissions that determine user's access to projects data and other administrative functions.


Access the Users Tab

Follow the steps below to open the Users tab:

  1. Access the Administrator Settings page within the EngageCX Platform.
  2. Select the Users tab from the Sidebar.


Create New Users

Follow the steps below to add a user:

  1. Access the Users tab within the Admin settings page and select +New User from the toolbar.
  2. Provide a valid Email address for the user, then click Next. This email address will be used for system notifications and password resets.
  3. Fill in the form fields, as follows:
    • Select the Authentication method. You can choose between EngageCX Authentication and Windows Authentication (only when the necessary settings are configured by the System Administrator.).
      Depending on the authentication method, you will have to enter some information, such as:
    • Username\Password: enter a username, then choose a password for your user or check the Generate password automatically, in which case Ecrio will send a password through email to the user you want to create.
    • First Name\LastName\JobTitle: optionally, you can enter some essential information for your user.
    • Enabled: when enabled, users can sign in and use EngageCX Platform.
    • Groups: assign the user to a group. See Include User to a Group chapter for more details.
    • Permissions: set up the user's permissions. See User Permissions chapter for more details.
    • Manage Portal: when enabled, the user will be authorized to access the Customer Portal page and manage customer portal users.
  4. Once you're ready, select OK to save the changes.

The user created will be listed in the Users page and it will be available for further configurations.

Note

If using EngageCX Authentication, by default, the Generate password automatically option will be selected. Leaving this selected, EngageCX will send an email to the user, using the email provided, with their username and a randomly generated password. They will have the option to change their password when they log in.

Note

Ensure that you have selected the Enabled option. If it is not selected, the user will not be able to log in with the provided credentials. Disabling a user is a way of shutting down their user account without deleting any information or associated assets. This is an option to consider in case you might want to re-enable the account at a later time.


Edit User

Follow the steps below to modify a user:


Delete User

Follow the steps below to remove a user:

Create, edit and delete Groups

By accessing the Groups page, you can control the access rights for multiple users in one location and easily assign a user to these groups. This allows you to easily re-configure a user's rights if their responsibilities change, create consistency for levels of users, and enhance security across your team to ensure you know which users have access to which EngageCX Platform rights.


Access the Groups Tab

Follow the steps below to open the Groups tab:

  1. Access the Administrator Settings page within the EngageCX Platform.
  2. Select the Groups tab from the Sidebar.

Create New Groups

Follow the steps below to add a group:

  1. Access the Groups tab within Admin Settings page and select +New Group from the toolbar.
  2. Fill in the form fields, as follows:
    • Group Name: provide a unique name for your group.
    • Active Directory Groups: if using Active Directory for authentication, add the group(s) you may want to synchronize. If many groups are added, separate them by ;.
    • Select the Add button to choose the user(s) you want to make member(s) of this group.
    • Environment Permissions: enable the permissions granted to your group by selecting from the available options:
      • Manage Environment: see the Environment Group Permissions chapter for more details.
      • Manage Portal: check this option to grant rights to all the users in the group to be able to view the Customer Portal module and authorize the users to add, edit and remove customer portal contacts.
    • Workspace Permissions: set up the group workspace permissions or see the Workspace Group Permissions chapter for more details.
    • User Interface Profile: assign a profile for every user within the group. For more details, access the Profiles chapter.
  3. Once you're ready, select Save to update the changes.

The group will be added to the Groups page and it will be available for further configurations.


Edit Group

Follow the steps below to modify a group:


Delete Group

Follow the steps below to remove a group:

Managing Permissions

EngageCX Platform gives you the ability to make your resources or EngageCX features accessible or limited, to users and groups, as you want to.

From Users or Groups, you can set up Environment or Workspace permissions depending on the access rights that you would like to give. For more granular control, you can set permissions for each individual folder. By default, all folders in a workspace are accessible for users who have access to that workspace. However, if you deny a user access to a specific folder, then all its subfolders will be restricted to that user.

For each user, you can set up the following:

For each group, you can set up the following:

In this section, you can learn how to grant or deny different permissions on users or groups.


To include a user to a group

When a user is added to a group, it will inherit all the group's permissions.

  1. Access the Admin Module and navigate to the Users tab.
  2. Add a new user or select Edit to open properties of one of the existing users.
  3. Within User Dialog, scroll down to the Groups section and check the group(s) in which you want to add the user. By default, you will be able to see the Administrators and Everyone groups.

Or

  1. Access the Admin Module and navigate to the Groups tab.
  2. Add a new group or select Edit to open properties of one of the existing groups.
  3. Within Group dialog, select the +Add button from the Users section and choose the user(s) you want to add to the group from the drop-down list.


To set up workspace permissions for a user

  1. Access the Admin Module and navigate to the Users tab.
  2. Add a new user or select Edit to open properties of one of the existing users.
  3. Within User Dialog, scroll down to the Permissions section and enable from the following options:
    • Manage Portal: when enabled, the user will be authorized to access the Customer Portal page and manage customer portal users.
    • Explicit Rights: here you can select Access or Manage for the individual workspace(s) this user has access to.
      • If you give a user Access rights to a workspace, then that user will be allowed to see all folders in the workspace except the ones which have been explicitly denied.
      • If you give a user Manage rights to a workspace, then that user will be given full permissions to that workspace and all the folders, files and other assets contained in it, and will ignore any explicitly denied paths.
    • Effective Rights: here you can see all the rights of the selected user. Note that for users, explicit rights will be combined with the rights of the group(s) they are in if any.


To configure folder permissions

  1. Access the workspace that contains the needed folder.
  2. Select the More ( ) button, next to the folder name.
  3. Choose Permissions from the contextual menu.
  4. In the Folder Permissions dialog, click the +Add button.
  5. Add a user from the drop-down list, then check all the permissions you want to allow for the corresponding user.


To set up environment permissions for a group

  1. Access the Admin Module and navigate to the Groups tab.
  2. Add a new group or select Edit to open properties of one of the existing group.
  3. Within Group Dialog, scroll down to the Environment Permissions section that allows you to:
    • Manage Environment: check this option to grant rights to all the users in the group to be able to make modifications to the Environment itself and give them access to all workspaces, folders, files and other assets in that environment. This option is typically saved for the Administrators group, as it will also allow users to add, edit and remove users, groups, views, task types, and account types. Environmental Administrators can also create, edit and delete workspaces.
    • Manage Portal: check this option to grant rights to all the users in the group to be able to view the Customer Portal module and authorize the users to add, edit and remove customer portal contacts.
  4. Once ready, select Save to update the changes.


To set up workspace permissions for a group

  1. Access the Admin Module and navigate to the Groups tab.
  2. Add a new group or select Edit to open properties of one of the existing group.
  3. Within Group Dialog, scroll down to the Workspace Permissions section that allows you to configure workspace access by configuring:
    • Access Rights: the users included in the group will be allowed to see all folders in the workspace except the ones which have been explicitly denied.
    • Manage Rights: the users included in the group will be given full permissions to that workspace and all the folders, files and other assets contained in it, and will ignore any explicitly denied paths.
  4. Once ready, select Save to update the changes.


To configure User Interface Profiles

  1. Access the Admin Module and navigate to the Groups tab.
  2. Add a new group or select Edit to open properties of one of the existing group.
  3. Within Group Dialog, scroll down to the User Interface Profile.
  4. Select the user profile from the drop-down list or click Edit Profiles to update the selected profile.
  5. In the Manage Profiles dialog, click on the profile you want to edit. Notice that a profile needs to be set as default, to see the changes.
  6. Set up different permissions for the selected profile, then click Save.

To read more information regarding User Profile, access this link.

Synchronizing Active Directory Users

In addition to adding users as described in the above sections, EngageCX allows you to synchronize Active Directory users with environment users. During synchronization, user information such as user names and email addresses are read from the Active Directory and recorded in the EngageCX database.

Before integrating EngageCX authentication with AD, it might be necessary that:

Note

When mapping users to EngageCX Platform, you need to make sure that the AD group is a Security Group. If you use Distribution Groups, users cannot be synchronized across EngageCX environments.

Below you can see the steps you need to follow to check the group type of the Active Directory:

  1. Access the server that contains the Domain Controller.
  2. Open the Active Directory Users and Computers tool.
  3. Go to Users.
  4. Right-click on the group domain and select Properties.
  5. Under the General section, check the Group Type.


Enable access from the Sysadmin Website

Using Active Directory users with EngageCX requires you to enable the Use Active Directory to authenticate users option available in the Authentication page of the EngageCX Sysadmin website.

Once the property is enabled, AD users will automatically be granted access to the EngageCX Platform when they login. Upon logging into the EngageCX Platform with an AD user, the system will automatically synchronize with the Active Directory by creating an associated user inside the EngageCX System. Note that only the required information about the user (such as the Name and Email address) will be stored in the EngageCX Platform. Sensitive information, such as the password, will not be stored.


Logging-in

Logging in using an AD user requires the following structure:

Domain\UserSyntax


Authorization in AD

By default, after logging into the EngageCX Platform, the AD User will not have any permission. Permissions can be provided by mapping EngageCX Groups to AD Groups. To map the two groups you need to follow the instructions below:

  1. Sign in to the Enterprise Website and access the Admin settings button from the Welcome page.
  2. Select the Groups tab from the Sidebar.
  3. Select the needed group from the list. Additionally, you can click on the New Group button in the toolbar to include new groups.
  4. In the Group dialog, enter the AD group(s) you may want to synchronize under the Active Directory Groups field. If you want to synchronize multiple groups, these should be separated by ;. The permissions set up on the group you edit will be inherited to the AD group(s) of users. To find out more about permission managements in EngageCX solutions, please access the Permissions section.

Note

The AD Groups prerequisites described above apply here, therefore, the access must be enabled from the Active Directory Authentication section of the Sysadmin Guide.

Admin People

The EngageCX Platform allows users to engage in various subscription lists, sent by your organization, from the User Preference Center form. Subscriptions must be added onto the Subscriptions page, in order to be available in the form. When subscriptions are enabled, emails sent to customers will contain a footer containing a link to unsubscribe from the list, like this: This email was sent to customer@email.com. If you no longer wish to receive these emails, please unsubscribe here.

Selecting the unsubscribed link will open the User Preference Center form. It will contain additional public lists which your customers can select to subscribe. The User Preference Center is stored in EngageCX Projects.


Field Customizations

From the People page, you have some customization links, that redirects you towards the customization of each one of the forms corresponding with Account, Contact or Lead .efd files in the Form Editor.

  1. Select Edit Fields for each form you want to configure.
  2. Customize the form fields according to your needs.
  3. Once you're ready, do not forget to select the Save ( ) button to persist the changes into further utilization of the current form.


Creating a Subscription

Follow the steps below to add a subscription:

  1. Access the Admin Settings page within EngageCX Platform.
  2. Select the People tab from the Sidebar.
  3. In Subscriptions page, select the More ( ) button from the toolbar and choose the Create subscription option.
  4. Fill in the form with the required parameters:
    • Name: provide a name for your subscription that will be visible in the User Preference Center.
    • Description: optionally, add a description where to highlight the purpose of the subscription.
  5. Once you're ready, click Save to update the changes.

The Subscription name will appear in the User Preference Center communication, when a customer select to subscribe to an associated list.


More Subscription Options

In the Subscriptions page, you can select the More ( ) button, next to the subscription name and access the following options under the drop-down list:

Licensing

In order to use EngageCX, as a client, you need to have an EngageCX Account synchronized (accounts.ecrion.com), from where you can retrieve and keep track of your product keys. EngageCX manages automatic integration with EngageCX Account, in order to provide keys for EngageCX products. Each product key dictates what features or components are available and how long can it be used.

EngageCX offers two types of licenses:

Server-side licenses can be installed and managed from the Sysadmin Website, under the Licensing page. To learn how to install and manage server licenses, please visit the Licensing chapter of the Sysadmin Guide.

Environment licenses can be installed and managed from the Enterprise Website, under Admin settings. Note that this feature is available only for the users that have manage-environment rights(e.g. environmental administrators). An environment key can be added to an existing EngageCX user account and it is a 1:1 relationship between them. As a consequence, deleting an environment will also uninstall the attached environment product keys.

Once assigned to a customer account, each license has an expiration date that is given by the user's request. For example, if a user is willing to purchase a license only for a month, the expiration date will expire exactly in a month from now on.


Accessing the Licensing Menu

Follow the steps below to open the Licensing page:

  1. Access the Admin Settings page within EngageCX Platform.
  2. Select the Licensing Menu from the Sidebar.


Online Installation

If your server has an Internet connection, we recommend using Online Activation for your product keys. Below you can find step by step instructions on how to install a product key online.

  1. Access the Licensing tab within Admin page.
  2. When the Product Keys option is toggled off, select Sign-In.
  3. Enter the username and password of your EngageCX Account, then click Sign-in.
  4. Next, select the +Add License button from the toolbar.
  5. Choose the Product Key(s) you need and select Install.


Offline Installation

If your server is offline or cannot otherwise communicate with our licensing server, we recommend using Offline Activation. Below you can find step by step instructions on how to install a product key offline.

  1. Access the Licensing tab within Admin page.
  2. Next, select the +Add License button from the toolbar.
  3. Copy the request key from the Add Key form.
  4. In the Add Key dialog, copy the string generated in the Step 1 box.
  5. Next, in a web browser, access your EngageCX account, then select the corresponding Key Id from the Product Keys tab.
  6. In the license dialog, select the Install Product Key dialog, paste the string into the Activation Key box, then click Install.
  7. Next, copy the activation string, then go to your EngageCX domain page and paste the string into the Step 2 box. Once you're ready, select Finish.

All Product Keys that are installed will be displayed on the Licensing page, together with meaningful information such as the expiration and maintenance dates and the user to whom this license is assigned.


More Licenses Options

At any time, you can click on the More ( ) button next to the Key to perform the following actions:

Assign License to a User

The licenses can be assigned to clients that have EngageCX Accounts.

  1. In Licenses page, select the More ( ) button, next to the Product Key for which you want to assign a user and choose Assign option.
  2. Select a user from the available list found in your environment and press OK to save the changes.

Once assigned, the user can benefit from the full EngageCX Studio features. The user must log into the EngageCX Studio tools (Publisher, Modeler or Analytics) and provide the same credentials used in the assignation of the product key. Otherwise, they will not be able to integrate with EngageCX Account.

The environment license assigned to the user can be easily revoked, too. Select Revoke from the contextual menu of the Product Key and confirm the selection.


Uninstall Licenses

The uninstall process is very similar to the install process, providing both an online and offline methods.

When you have an internet connection, a product key can be uninstalled as follows:

  1. In the Licenses page, select the More ( ) button, next to the Product Key that you want to remove and choose Uninstall option.
  2. Confirm the deletion and select OK to update the changes.

If you do not have an internet connection, a product key can be uninstalled as follows:

  1. In Licenses page, select the More ( ) button, next to the Product Key that you want to remove and choose Uninstall option.
  2. Confirm the Offline Mode to release your license and select OK to update the changes.
  3. Copy the string from the box and go to EngageCX Account Website to paste it.
  4. Select the corresponding Key ID for your license and select Uninstall Product Key, where you paste the string you have previously copied. Then, select Uninstall to update the changes.

The product key will be released and it will be no longer available for you to use.


Domains

Within Domains, you can enable an analytic tracking system that will help you monitor who is visiting your website and create a portrait view of your website audience. Using a tracking system allows you to find out information such as how many users interact with your website, how engaged they are, the location of your users or what device do they used to visit your website.

Accessing the Domains Page

Follow the steps below to open the Domains page:

  1. Access the Administrator Settings page within EngageCX Platform.
  2. Select the Domains tab options from the Sidebar.


Adding a New Domain

Follow the steps below to add a domain:

  1. Access the Domain page and select +New Tracker from the toolbar.
  2. In the Create Tracker dialog, fill in the mandatory form fields:
    • Enter a unique and relevant name for the Tracker.
    • Include the domain(s) according to your needs. Note that at least one domain is required. Only traffic that originates from these domains (including all subdomains) are allowed.
    • Select which tracking data you want to store:
      • Auto Detect Geographical Data - extracts data automatically from IP Address.
      • Auto Detect Device - extracts data automatically from the User Agent parameter.
      • Auto Detect Web Campaigns - extracts web campaign's parameters from data location.
      • Track First Web Visit - extracts the timestamp and the address of the first visited web page.
  3. You can create a mapping between EngageCX and Track Fields. Select the Lead Fields tab menu for configuring this option.
  4. Access the Advanced tab to set the utm_* flags as Blacklist URLs. These parameters are used to exclude from the accessed URLs that are being tracked within the domain. The data extracted from the accessed links will be found in the Customer Activity.
  5. Once you're ready, select Create.

The domain will appear now on your Tracking list.


Mapping Lead Custom Fields to EngageCX Track Fields

EngageCX provides a way to convert a qualified lead based on information extracted from the track fields.

  1. Starting from the Create Tracker/Edit Tracker dialog, access the Lead Fields tab menu.
  2. Click Add to configure a mapping. Before you begin, make sure you have the corresponding custom fields added under EngageCX fields.
  3. Configure the mapping and select which EngageCX field you want to map to which Track field from the drop-down menus.
  4. Once you're ready, select Save and then click Update.


Adding Tracker Code to your Website

For each domain added, EngageCX Platform will generate a Tracker Code, whereon you will have to add to your website. The steps below provide information on how to add the code to your website.

  1. Access the Domain page.
  2. Identify the Domain Tracker you want to integrate with your website, then select Get Tracker Code.
  3. Select Copy To Clipboard. Note that every time you create a new tracker, you have to do this copy-paste operation in the pages on which you are interested to monitor users because the code generates a unique id, which you have to specify in the < > HTML tag.
  4. Access the code of your site's templates that you want to start the tracking and paste the script code as the first item into each page that you want to track.

Note

  • The code should be added near the top of the HEAD tag and before any other script or CSS Tag.
  • The string T-Y-XXXXX represents the tracking ID and it should be replaced with the tracking ID of the website you wish to track. By default, EngageCX generates the correct tracking ID for each domain added in Enterprise Website.
  • More Tracking Options

    Once a Tracker is created, you can access some options by selecting the More ( ) menu next to it under the drop-down menu:


    Channels

    EngageCX Channels are used to deliver communications directly to the final recipients. EngageCX provides a multi channel messaging for distributing documents, such as Email, Print or SMS. Before creating a channel, users need to configure a corresponding queue, then run a communication that has a channel defined. After running the communication, job tickets will be generated showing the status, the time and the name of the job that has been running in the workflow.


    Accessing the Channels Module

    EngageCX provides two methods of accessing Channels. One is to configure a channel from the Admin Settings page or another one is to access the channels module from the EngageCX welcome page.


    Configuring Channels

    Configuring a channel in EngageCX implies setting up a channel queue. This can be achieved either by creating a corresponding queue (Email, SMS or Print) from the Channels view in the Admin settings or through the Channels module.


    From the Admin Settings

    Follow the steps below to open the Channels page:

    1. Select the Admin module from the Welcome page.
    2. Access the Channels tab from the Sidebar.


    Creating an Email Queue

    Follow the steps below to create an email queue:

    1. In the Channels page, select the +New Channel button from the toolbar. Choose Email option from the contextual menu.
    2. Fill in the Email Queue form with the appropriate values:
      • Name: provide a unique and relevant name for the email channel you want to create.
      • Description: optionally, add a description related to the channel.
      • Email Connection: select the connection from the drop-down list. If there are none available, you will need to create a new email connection from internals settings.
      • Track Email Read: if enabled, this option will embed in all HTML email messages delivered through this queue a one-pixel transparent image that resides on the EngageCX server. When the recipient of the email loads the images for that, it will inform the EngageCX Server that the email has been read. This Read status will be reflected in the Status column.
      • Track Web Campaigns: if enabled, this option will embed in the links sent by email information about the active web campaigns.
      • Track Engagement: if enabled, this option will keep the evidence of the customers accessing the links delivered through email.
      • Suspend tickets with bounced recipients: if enabled, this option will suspend the email ticket that has the TO recipient as a bounce list item.
      • Select Send test email if you want to check if the email connection is successfully configured.
    3. Once ready, select Save to update the changes.

    Your Email Channel will appear on the Channels page and it will be available for further configurations.


    Creating a Print Queue

    Follow the steps below to create a print queue:

    1. In the Channels page, select the +New Channel button from the toolbar. Choose the Print option from the contextual menu.
    2. Fill in the Print Queue form with the appropriate values:
      • Name: provide a unique and relevant name for the print channel you want to create.
      • Description: optionally, add a description for your print queue.
      • Select the + Add Printer button to choose the device(s) to be used for printing jobs in this queue.
    3. Once ready, select Save to update the changes.

    Your Print Channel will appear on the Channels page and it will be available for further configurations.


    Creating an SMS Queue

    Follow the steps below to create an SMS queue:

    1. In the Channels page, select the +New Channel button from the toolbar. Choose the SMS option from the contextual menu.
    2. Fill in the SMS Queue form with the appropriate values:
      • Name: provide a unique and relevant name for the SMS channel you want to create.
      • Description: optionally, add a description for your SMS channel.
      • SMS: select the SMS connection to use for jobs in this queue. If there are none available you will need to create a new SMS connection.
    3. Once ready, select Save to update the changes.

    Your SMS Channel will appear on the Channels page and it will be available for further configurations.

    Note

    Track Reads tab from Channels page is valid only for Email Channels types. For SMS and Print Channels, the option will remain unchecked.


    From the Channels Module

    In order to access this module on your EngageCX Platform, you should have environment administrator privileges that allow users to enable this feature. This option can be set up from Modules section when configuring User Profiles.

    1. In the Welcome page, select the Channels module.
    2. The old Channels functionality is brought back into this view.


    Configuring Channel Queues

    The Channels page offers the three options of creating a queue for the required channel (Email, SMS or Print).


    Configuring an Email Queue

    Follow the steps below to configure an email queue:

    1. In the Channels page, select the Email tile to create an email channel.
    2. Select the +New Queue button from the toolbar.
    3. Fill in the Email Queue form with the appropriate values:
      • Name: provide a unique and relevant name for the email channel you want to create.
      • Description: optionally, add a description related to the channel.
      • Email Connection: select the connection from the drop-down list. If there are none available, you will need to create a new email connection from internals settings.
      • Track Email Read: if enabled, this option will embed in all HTML email messages delivered through this queue a one-pixel transparent image that resides on the EngageCX server. When the recipient of the email loads the images for that, it will inform the EngageCX Server that the email has been read. This Read status will be reflected in the Status column.
      • Track Web Campaigns: if enabled, this option will embed in the links sent by email information about the active web campaigns.
      • Track Engagement: if enabled, this option will keep the evidence of the customers accessing the links delivered through email.
      • Suspend tickets with bounced recipients: if enabled, this option will suspend the email ticket that has the TO recipient as a bounce list item.
      • Select Send test email if you want to check if the email connection is successfully configured.
    4. Once ready, select Save to update the changes.

    Your Email Channel will appear on the Channels page and it will be available for further configurations.


    Configuring an SMS Queue

    Follow the steps below to configure an SMS queue:

    1. In the Channels page, select the SMS tile to create an SMS channel.
    2. Select the +New Queue button from the toolbar.
    3. Fill in the SMS Queue form with the appropriate values:
      • Name: provide a unique and relevant name for the SMS channel you want to create.
      • Description: optionally, add a description for your SMS channel.
      • SMS: select the SMS connection to use for jobs in this queue. If there are none available you will need to create a new SMS connection.
    4. Once ready, select Save to update the changes.

    Your SMS Channel will appear on the Channels page and it will be available for further configurations.

    Note

    Track Reads tab from Channels page is valid only for Email Channels types. For SMS and Print Channels, the option will remain unchecked.


    Configuring a Print Queue

    Follow the steps below to configure a print queue:

    1. In the Channels page, select the Print tile to create a Print channel.
    2. Select the +New Queue button from the toolbar.
    3. Fill in the Print Queue form with the appropriate values:
      • Name: provide a unique and relevant name for the print channel you want to create.
      • Description: optionally, add a description for your print queue.
      • Select the + Add Printer button to choose the device(s) to be used for printing jobs in this queue.
    4. Once ready, select Save to update the changes.

    Your Print Channel will appear on the Channels page and it will be available for further configurations.


    More Channels Options

    In the Channels page, at any time, you can select the More ( ) button, next to the channel name and execute the following actions under the drop-down menu:


    Viewing Channel Tickets

    When a workflow is executed with a channel step (Email, Print or SMS) configured, a corresponding job is generated. These jobs are also called "tickets" and can be accessed through Channel Tickets from the Sysinternal page.

    Integrations

    The Integrations module allows you to manage the integration of EngageCX accounts and contracts with other external systems, such as Customer Management Systems(CRM).


    Accessing the Integrations Menu

    Follow the steps below to open the Integrations page:

    1. Select the Admin button from the Organization section.
    2. Access the Integrations tab from the Sidebar.

    or

    1. Select the Admin gear button from the Modules Menu in the Enterprise Welcome page.
    2. Access the Integrations tab from the Sidebar.


    CRM Synchronization

    Having all customer data synchronized into a single view will enhance the business productivity of your organization.

    Creating CRM Synchronization

    Follow the steps below to configure a CRM synchronization:

    1. In the Integrations page, select the + New Integration button from the toolbar. Choose the CRM Synchronization option from the contextual menu.
    2. Select a CRM connection from the drop-down list under the Manage People Integration dialog. If there are not any connections, you have to configure an external system integration from Connections chapter.
    3. Check the Enable synchronization option, such that EngageCX will be able to synchronize CRM entities, such as Accounts, Contacts and Leads, according to some rules.
    4. Switch between tabs to configure the mapping between EngageCX custom fields and CRM fields, as follows:
      • CRM Accounts mapped with EngageCX Accounts, under Account Fields tab.
      • CRM Contacts mapped with EngageCX Contacts, under Contact Fields tab.
      • CRM Leads mapped with EngageCX Leads, under Lead fields tab.
    5. You have the possibility to erase a mapping from any lists of Fields, by clicking on the Delete symbol button. The created mapping can also be edited, by clicking on Edit symbol button, specifying the mapping property in EngageCX Platform or/and the CRM field for the EngageCX field to be mapped to. The entities deleted in CRM, are also deleted in EngageCX Platform and vice versa. If any conflict occurs, while updating mapping properties, the CRM value is kept.
    6. Select the Add button, to create a new EngageCX - CRM field mapping, if needed. The newly created entities in EngageCX Platform, are created also in CRM and vice versa. For example, if you map a 'Last_Name' field from CRM with 'Name' field in EngageCX, any change in CRM at the level of 'Last_Name' will be applied also in field 'Name'.
    7. Click on Save button, to successfully apply all changes to your mapping.
    8. Select the Enable & Sync Now button to start the synchronization process. You can click on View Synchronization Log option from the Integrations Menu and see the progress of the synchronization process in the Sync Log View.

    Search


    One useful feature that you may wish to utilize is the Search Box located in the toolbar and it can be easily accessed from the EngageCX Welcome Page. For every search that you intend to do, we recommend to:


    Note

    For each environment, you may enable or disable the Search feature. In a new environment, the search will be off, by default. You can enable it from the Environment Settings within EngageCX Sysadmin Website.

    Quick Search can be used when you want to search for specific files within EngageCX and is used for keywords searching or particular phrases. Using this feature will help you find files faster and navigate directly to the content you want to see.

    Follow the steps below to perform quick search:

    1. In the EngageCX Welcome page, select the Search button from the toolbar.
    2. Type the name of the file you want to find or keywords, then hit Enter.
    3. You will be redirected to the Search Center with all the results found.


    Notes

    • The results are displayed based on accuracy, meaning the first files will be those containing the word in their names, then the path and afterwards inside their content.
    • If there are multiple of a file, the latest version will be displayed in the Search Center.
    • Permissions determined by the environment administrators determine the search results, meaning that you'll only see the assets you have permissions.

    Search Tips

    Below you can find some tooltips for a more efficient search of your files to use under the Search Box:

    The Sidebar from the Search Center is an effective improvement in the search process as it helps users to filter their results. So, if you are retrieving too many results after a Quick Search, you may wish to try narrowing your search by specifying the subject index field that might contain your asset or the date estimation when this file was created.


    Users can narrow down search results for more complex searches by using the Advanced Search feature. The Search Engine uses a set of very useful crawl tools by a series of different filters and clauses.


    Follow the steps below to open the Advanced Search page:

    1. Access the EngageCX Welcome Page and select the Search button from the toolbar.
    2. Type in the keyword associated to your file and hit Enter. Search Center page will open in a new window tab.
    3. Select the Advanced Search button from the toolbar. Proceed to the search configurations.

    Configuring Filters & Clauses

    Follow the steps below to configure a search filter:

    1. After selecting the Advanced Search button, a new dialog will open.
    2. Configure the filter parameters for better results and fill in the form with the appropriate values:
      • Select the match type from the drop down menu. You can choose from three available options:
        • Any Words: search engine matches not only the whole phrase but also words individually.
        • All Words: search engine matches just results containing all words in a phrase, not necessarily typed in the same order.
        • Exact Phrase: search engine matches the whole phrase only.
      • Type in the Search Box your word(s).
      • Result type: select your result type of your searches from the dropdown menu. For example, if you want to look for the Fact Sheet project folder, you should select the Folders option.
    3. Configure the search clause by setting up a criterion. Select Add new clause button.
      • Field: select the field of the previously selected result type to base your criteria on.
      • Operator: choose the operator to use for testing the condition.
      • Value: provide the value for which the condition must test true. You can add as many clauses as you need.
    4. Once ready, select Search to update the changes.

    Tasks

    Tasks were created to help you split your work with other team members, allowing you to improve the way you plan and track the life-cycle of an EngageCX project. Using tasks, you can stay constantly connected with your team's work, have a good view and clear idea of the project's onset, enhancing your organization to a successful management and completion of your document production.

    Review and Approval

    The EngageCX Platform provides many ways to review your project assets, by allowing you to:

    Enabling Review and Approval

    In EngageCX, you will be able to set a Review and Approval for all the files within a workspace or for a version of the project.

    Notes

    This section covers features and functions that are available only to environment administrators. Review the Users and Groups sections to find out more information about environment administrators.

    Follow the steps below to enable Review and Approval:

    1. Access the Workspaces Module and identify the workspace on which you want to enable the process.
    2. Select the More ( ) button, next to the Workspace name.
    3. Choose Manage from the contextual menu.
    4. In the opened dialog, under the Review and Approval section you can choose from the following options:
      • Run only approved files: when selected, you will be able to generate documents only from the latest approved version of a project snapshot. If there are no approved assets, you will see a notification informing you that there are no approved versions available.
      • Approve communication projects before publish: when selected, you will not be able to publish versions that are not approved.
      • If both options are selected, you can run and publish only approved assets.
    5. Once ready, select OK to update the changes.


    Note

    You cannot publish a project directly, you need to create a version of it first.


    Requesting Review and Approval

    The next step after enabling the Review and Approval process is to request a review for your work to be able to run the approved files. Below you can find step by step instructions in order to request a review and approval.


    1. When the Run only approved files is enabled, you will not be able to run any communication project containing files that are not approved.

    There are two ways to request a review for workspace's files:


    2. When the Approve communication projects before publish is enabled, you will not able to publish any project version that is not approved. There are two ways to request a review for a snapshot project:


    Requesting Review from Workspaces

    Follow the steps below to request Review and Approval:

    1. Access the workspace that contains the needed files.
    2. Select the More ( ) button, next to the file/folder name.
    3. Choose Request Review and Approval.
    4. Within Request Review and Approval dialog
      • Select the files you want to send for review.
      • Choose a convenient date to receive feedback.
      • Optionally, add some comments or attach additional assets.
    5. Once ready, select OK. Notice that your file has been submitted for review. Select Execution Details to track the review workflow. If using the default workflow, a review document task will be assigned to all users included in the Administrator Group.


    Requesting Review from Projects Snapshot

    Follow the steps below to request Review and Approval:

    1. Access the project that contains the needed snapshot.
    2. Select the Versions button, at the right of the toolbar.
    3. In the Versions dialog, select the More ( ) button, next to the snapshot name you want to submit.
    4. Choose Request Review and Approval option.
    5. Within Request Review and Approval dialog
      • Select the files you want to send for review.
      • Select the files you want to send for review.
      • Choose a convenient date to receive feedback.
      • Optionally, add some comments or attach additional assets.
    6. Once ready, select OK. Notice that your file has been submitted for review. Select the Execution Details to track the review workflow. If using the default workflow, a review snapshot task will be assigned to all users included in the Administrator Group.


    Review and Approval Default Workflows

    For each Review and Approval configuration, you will have the option to use the default workflow or update a review and approval workflow manually.


    Review Workflow

    The default Review Workflow will go through the following steps:


    Review and Publish Workflow

    The default Review and Publish workflow will go through the following steps:


    Edit Workflow

    By selecting the Edit Approval Workflow option, you have the ability to update the default workflow to suit your needs. When updating the Review and Approval workflow it must be necessary to include the following steps:

    1. Create Snapshot, which will create a snapshot of the project as it currently is.
    2. Tag, which will set Approved to true or false on snapshot, so that the assets will be able to be used in the production runs.

    Working with Tasks

    In the Tasks page, you are allowed to create new tasks and issues for other users, review files and approve or add new document versions.

    Note

    This section covers features and functions that are available only to environment administrators. Review the Users and Groups sections to find out more information about environment administrators.

    Accessing the Tasks Module

    Follow the steps below to open the Tasks page:

    1. Sign-in to the EngageCX Website.
    2. Select the Tasks button from the right of the toolbar, next to Search.

    Creating a New Task

    Follow the steps below to create a task:

    1. In the Tasks page, select the +New Task button from the toolbar.
    2. Choose the task type you want to create from the contextual menu. Depending on the context, you can either select to:
      • Issue
      • Review Document
      • Review Journey
      • Review Snapshot
      • Task
    3. Fill in the new task form with the appropriate values:
      • Name: provide a relevant name for the task you want to create.
      • Assign To: select from the drop down list to assign the task to a user or a group within the current environment.
      • Description: optionally, provide a description to highlight the purpose of this task.
      • Within Notification Recipients box, you can add email addresses of other users that you want to collaborate to the current task.
      • More: select this option to include other essentials assets to the current task. Select the + to add attachments and browse within your local machine the file that you want to insert. Then, select the Upload to save the changes.
    4. Once ready, select the OK.

    All the users specified will be notified through the email, and the task will be available within their Tasks list.

    A good and easy way of finding and navigating through EngageCX Tasks is using the Sidebar. By default, the Sidebar provides two views:

    At any time, you can create new Views to simplify your tasks perspective. For more details, please visit the Views chapter.


    Working with Tasks

    Even if you need to review and approve project content or you just want to create a task or issue for another member of your team, in both ways, you can monitor the overall progress of each task.

    To open the Task monitor page, simply access the Tasks page and then select the one you want to analyze. Within the task monitoring page, you can view:

    After a new task has been added to the list, it will appear to the assigned user as a New Task.

    Starting a Task

    Follow the steps below to start working on a task:

    1. Access the task on which you want to start working.
    2. Select the Start Work button from the Task Board.
    3. Within Start Work dialog, you can choose a snapshot to work on from the drop-down menu, to add new attachments or comments, or simply select the OK to start working with any further afterthoughts.
    4. In the Timeline Board that the Task has changed its status from New to Active.

    The next step after completing the task is either to Approve or Reject the current task.

    Approving a Task

    Follow the steps below to approve a task:

    1. Access the task whereon you want to approve.
    2. Select the Approve button from the Task Board.
    3. Within Approve dialog, you can choose to add new assets or comments, or simply select the OK to approve the task.
    4. In the Timeline Board that the Task has changed its status from Active to Approved.

    Rejecting a Task

    Follow the steps below to reject a task:

    1. Access the task whereon you want to reject.
    2. Select the Reject button from the Task Board.
    3. Within Approve dialog, you can choose to add new assets or comments, or simply select the OK to reject the task.
    4. In the Timeline Board that the Task has changed its status from Active to Rejected.

    Notes

    For each update of the task status, users assigned to the project task will receive a notification through email.


    Enforcing four-eyes principle

    When requesting a review for a document or snapshot, you can enable the four-eyes principle for tasks. If this configuration is enabled, a user who requested the Review will not be able to Approve any changes.

    1. Access the Workspaces Module and identify the workspace on which you want to enable the process.
    2. Select the More ( ) button, next to the workspace name and choose Manage from the contextual menu.
    3. In the opened dialog, under the Tasks section, enable the Enforce four-eyes principle for tasks option.
    4. Once ready, select the OK to update the changes.


    Editing a Task

    To assign an existing task to a new team member or just update the task description, use one of the two methods described below:

    1. Access the Tasks page and locate the task you want to edit.
    2. Select the More ( ) button, next to the task name and choose Edit from the contextual menu.
    3. Edit the task form and select the OK to update the changes.

    Or

    1. Access the Tasks page and open the task you want to edit.
    2. Select the Edit button from the toolbar.
    3. Edit the task form and select the OK to update the changes.


    Deleting a Task

    Follow the steps below to remove a task:

    1. Access the Tasks page and locate the task you want to remove.
    2. Select the More ( ) button, next to the task name and choose Delete from the contextual menu.
    3. Confirm the deletion and the task is removed from the list.

    SysInternals


    Enabling System Internals

    Follow the steps below to enable Sysinternals:

    1. Access the Admin Settings page and navigate to the Home tab.
    2. Check the Show Internals option under Advanced section.
    3. Select the Sysinternals Menu for further system configuration at the bottom of the Sidebar.


    Notes

    • Use only when instructed by EngageCX Technical Support. Using Sysinternals incorrectly may result in serious problems and data loss.
    • Please make sure that the user, used to log into the Enterprise Website, has manage environment rights.

    Configurations

    From Configuration, administrators can access and set up from a variety of different modules. Select the feature you want to explore from the table below.

    Views Tasks Profiles Environment Variables Custom Paths Tags SSO
    Forms Portal Audit Emails Bounce List OAuth2 Microservices

    Views

    A View is a custom perspective for all the modules and options present in EngageCX Platform. Throughout EngageCX, there are different default views depending on which section you are in. However, you are able to create new views to customize your user experience and find the needed files in a quick and easy way. For example, if you have tagged files in a project as important as you are able to create a view which will allow you to easily see all the files with that tag.

    The built-in views that come with EngageCX are not intended to be modified, because they are monitored and their definitions will be reverted to the initial state if modified. This is so that in case we need to alter them in subsequent updates, there won't be any conflicts with potential user changes.


    Accessing the Views page

    Follow the steps below to open the Views page:

    1. Under the Admin Settings page, go to Sysinternals Menu from the Side Bar.
    2. Select the Views button from the Configuration section.


    Creating a New View

    Follow the steps below to configure a view:

    1. Start by selecting the +New View button from the toolbar to create a new view.
    2. From the dropdown menu, choose the type of view you want to define. The View Type indicates where the view will be able to be seen. Currently, you can create a view for Files, Jobs, Tasks, Communications, Email, Print, SMS or Marketing.
    3. Next, enter a unique and relevant Name and a Description for the View, then select Create.
    4. Within Edit View dialog fill in all the mandatory fields
      • Choose how this view will be presented, either list, grid, or collapsed, using the buttons at the top-right corner.
      • Enable the Daily report option, add the email address of the recipients and set the Report time for sending reports at a certain time every day.
      • Select Filters for this View by selecting the Add button. Define a condition for the filter operation. For more details, please read the Filters chapter.
      • Select the Columns on which you are interested in to see in the view. For more details, please read Columns chapter.
      • Additionally, you can select Delete View to remove the current view.
      • Selecting the Duplicate View option allows you to create a duplicate of your view and configure new specification for it.
    5. Once ready, select Save to update changes and successfully create the view.


    Filters

    Filters allow you to specify the rules to select the files you want.

    The required parameters to define a filter are:

    Field Define the name of the field that you wish to filter by.
    Operator Define the relationship between the field and the value, e.g. Equals, In, etc.
    Value Define the value that the field should compare itself to.

    If the field and the value satisfy the relationship defined by the operator for a certain item, then that item is a match and will be shown in the view.


    Columns

    Columns allow you to specify which properties (columns) you wish to see in the View. You can specify a display name for each property (the column heading) and whether or not the contents of the column will be expanded. If you have defined multiple columns, you can also reorder them by clicking on the up/down arrows. The required parameters to define a column within a custom view are:

    Field Define the name of the field that you wish to filter by.
    Display Name Define the value that the field should compare itself to.
    Value Define the expanded area that the field is able to interface with.


    Editing a View

    Follow the steps below to modify a view:

    1. Access the Views page under Configuration section from Sysinternals.
    2. Select the view you want to configure from the list or right-click on it and choose Edit option from the contextual menu.
    3. Modify the view parameters under Edit View dialog, according to your needs.
    4. Select Save to update the changes.


    Deleting a View

    Follow the steps below to remove a view:

    1. Access the Views page under Configuration section from Sysinternals.
    2. Right-click on the view you want to remove from the list and select the Delete option from the contextual menu.
    3. Select OK and confirm the deletion.


    Note

    The built-in views cannot be deleted and a warning dialog will inform you of it. Just custom views can be successfully deleted.


    Task Types

    From Task page, you can manage the different type of tasks that can be accomplished by users. By default, EngageCX comes with 4 types of tasks: Issue, Review Document, Review Snapshot or Task. In this section, you can view how to create new task types for your users. To learn how to create new tasks and assign them to users.


    Accessing the Task Types page

    Follow the steps below to open Task Types page:

    1. Under the Admin Settings page, go to Sysinternals Menu from the Side Bar.
    2. Select the Tasks button from the Configuration section.


    Creating a New Task Type

    Follow the steps below to configure a task type:

    1. In the Task Types page, start by selecting the +New Task Type from the toolbar.
    2. Fill in the New Task Type form with the required fields:
      • Name: provide a unique and relevant name for your task.
      • Description: optionally, add some description about the new task type.
    3. For each new task you create, you need to set up States and Transitions. Task states define how your task progresses upon its creation to closure. To add a new State, you have to select the +Add State button and fill in the New State form with the appropriate values:
      • Name: provide an appropriate name for the state of your task.
      • Requires work item of type: select the types of assets this state will apply to: Documents, Snapshots or None.
      • Is starting state: optionally, enable this option if the state will be a starting state.
      • Remind Frequency: set up a reminder for this state in hours.
    4. Once ready, select OK to save the changes. You can repeat the third step as many times as you need to create multiple states.
    5. If multiple states were added, you will have to define rules that tells how a task passes from one state to another, a process known as transitioning the task. To add a task transition you have to select the + button next to the state name and fill in the New Transition form with the appropriate values:
      • Name: provide a name for the task transition you want to create.
      • Transition to state: select the state to go, from the drop down list.
      • Notifications Disabled: optionally, you can enable/disable email notifications option.
      • Request User Input: optionally, you can enable/disable this option to create a form for collecting information from the user.
    6. Once ready, select Save to update the changes and successfully create the task.


    Recreate Standard Task Types

    This procedure will restore the default task types to their initial configurations.

    1. Access the Task Types page.
    2. Select the More ( ) button from the toolbar and choose Recreate standard task types.
    3. Confirm the reset task configuration by selecting Reset.
    4. All the default task type data (Review Document, Review Snapshot, Review Journey, Issue and Task) will be overridden and the configurations done to these task types will be lost.

    Editing a Task Type

    Follow the steps below to modify a task type:

    1. Access the Task Types page and click on the More ( ) button, next to the task you want to edit.
    2. Select Edit from the contextual menu. The Task Types dialog will open from where you can edit the task name, description or add different states that this task can go through.

    Note

    When you select to edit a task, you will be able t see three email notification samples: Send an email when a new task is created, Send an email when a task transition occurs, or Send an email when a task is idle. These are created by default, but can be modified at any time. To change them, simply select the notification hyperlink, then start editing the HTML Code.


    Deleting a Task Type

    Follow the steps below to remove a task type:

    1. Access the Task Types and click on the More ( ) button, next to the task you want to edit.
    2. Select Delete from the contextual menu. Note that it will be permanently removed from EngageCX Platform, and you will not be able to assign tasks using this type.


    Profiles

    User groups can have different profiles depending on their role in the EngageCX Platform. Profiles allow you to specify custom rights for users of a given group. This includes the ability to allow and deny access to files or EngageCX modules.

    For example, a group with Projects and View Files rights set on its profile will have access to all the projects created within EngageCX Platform, but will not be able to run and generate documents using them.


    Accessing Profiles

    Follow the steps below to open the Manage Profiles dialog:

    1. Within SysInternals page, select the Profiles button under the Configuration section.
    2. The Manage Profile dialog allows you to manage or create new user profiles.


    Creating a New Profile

    By default, EngageCX Platform comes with three user profiles: Front-Desk Agent, Operations Manager and Developer, which is the default profile. To add a new profile, use the steps described below.

    1. In the Manage Profiles dialog, select the + Add User Profile button.
    2. Fill in the Add User Profile form with the required fields:

      • Name: provide an appropriate name for your profile.
      • Set as Default User Profile: set the customized profile as default user profile.
      • Select from the available features which you want to provide this type of profile access to:
        • Actions: enable the actions that this profile is allowed to perform.
        • Dashboards: enable the dashboard elements that this user profile can have access to.
        • Views: enable the views that are available to this user profile.
        • Modules: enable the modules available to this user profile.
    3. Once ready, select Add to save the changes.


    Updating a Profile

    Follow the steps below to update a profile:

    1. Within Manage Profiles dialog, select the profile you want to edit.
    2. In the Customize Profile dialog, check/uncheck the operations and/or modules you wish to enable. Optionally, check the Set as Default User Profile option to make the profile selected as default.
    3. Once ready, select Save to update the changes.

    Note

    To set up a user profile to a group, visit the Groups chapter of this guide.


    Environment Variables

    Environment Variables are key-value pair parameters which are used in a communication workflow, that can be set up only by administrator users only. These define static values for some parameters across the whole environment, for example, Printer Name.


    Accessing Environment Variables

    Follow the steps below to open the Manage environment variables dialog:

    1. Within SysInternals page, select the Environment Variables button under the Configuration section.
    2. The Manage Environment Variables dialog allows you to manage or create new environment variables.


    Adding New Environment Variable

    Follow the steps below to add an environment variable:

    1. Within Manage Environment Variables dialog, select the +Add Variable button.
    2. Enter a relevant Name and a Value for the variable you want to add.
    3. Once ready, select Save to update the changes.


    Updating Environment Variables

    Follow the steps below to update an environment variable:

    1. Within Manage Environment Variables dialog, select the More ( ) button, next to the variable name you want to edit.
    2. Select Edit from the contextual menu.
    3. Enter a new name or value for your variable, then select Save to update the changes.


    Deleting Environment Variables

    Follow the steps below to remove an environment variable:

    1. Within Manage Environment Variables dialog, select the More ( ) button, next to the variable name you want to edit.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select the OK button.


    Using Environment Variables within Workflows

    Follow the steps below to learn how to use an environment variable in a workflow:

    1. Access Environment Variables and add the variables you need.
    2. Go to your Project and open the Workflow to edit.
    3. Select the workflow step for which you want to add the variable created, then go to the Complex Expression dialog.
    4. The Environment Variables menu will be available in the Parameters section, from where you can select and add the variables you have just created.


    Custom Paths

    Within EngageCX, you can add your custom code using the Custom step in a workflow. To use an executable file within a Custom step, you have to define first the windows full path, \.exe, that will be used in Command Line box in the Workflow Editor. This parameter can be considered as a whitelist for .exe files, being developed to prevent any malicious behavior.


    Accessing Custom Paths

    Follow the steps below to open the Custom Path dialog:

    1. Within SysInternals page, select the Custom Path button under the Configuration section.
    2. The Custom Path dialog allows updating your custom paths used for workflow 'Custom step' or download EDS software.


    Configuring a Custom Path

    Follow the steps below to set up a custom path:

    1. Within Custom Path dialog, select the +Add custom path button.
    2. Enter the full path of the executable you want to use within EngageCX Platform.
    3. Optionally, you can choose or edit the path used for downloading the EngageCX Studio bundle tools.
    4. Once ready, select the Save button to update the changes.


    Tags

    From Tags, you can manage and add custom paths that you can use further with the Tag step within an EngageCX workflow.


    Accessing Tags

    Follow the steps below to open the Manage custom tags dialog:

    1. Within SysInternals page, select the Tags button under the Configuration section.
    2. The Manage Custom Tags dialog allows to manage or create new custom tags.


    Creating Custom Tags

    Follow the steps below to set up a custom tag:

    1. Within the Manage Custom Tags dialog, select the +Add Tag button.
    2. Enter a Name for your tag, and optionally, a Default Value. When the Default Value is specified, it will be used in the workflow; however, you can choose to edit it later. It can take static values or workflow placeholders such as XPaths, Dates or GUID. For example, you can add a tag having the Name - CorrelationId, and the Default Value - {GUID} placeholder.
    3. Once ready, select Save to update the changes. The new tag will appear in the custom tags list.


    Updating Custom Tags

    Follow the steps below to update a custom tag:

    1. Within Manage Custom Tags dialog, select the down arrow, next to the tag name you want to edit.
    2. Select Edit from the contextual menu.
    3. Enter a new value for your tag, then select Save to update the changes.


    Deleting Custom Tags

    Follow the steps below to remove a custom tag:

    1. Within Manage Custom Tags dialog, select the down arrow, next to the tag name you want to remove.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select OK button.


    Using Custom Tags within Workflows

    Follow the steps below to learn how to use a custom tag in a workflow:

    1. Access Custom Tags and add the tags you need.
    2. Go to your Project and open the Workflow to edit.
    3. If your workflow contains a Tag step, select it and go to the Sidebar\Properties to edit it. Otherwise, add a new Tag step from Sidebar\Components.
    4. Next, from the Sidebar\Properties, select +Add Parameter and then, select the Tag option to insert a new key-value pair parameter.
    5. Select the down arrow, next to the Tag parameter to reveal all the custom tags available, then select the tag created at point 1. In our example, you should select the CorrelationId tag. The inputs will be populated with the tag name and the default value defined in Custom Tag dialog.


    SSO

    Single Sign-On (SSO) is an authentication process that allows users to enter one set of credentials and access multiple applications. The process authenticates the user for all the applications they have been given rights to and eliminates further prompts when they switch applications during a session

    Setting up the Single Sign-On(SSO) solution in EngageCX Platform provides authorized access to users through a simple and easy process, using only one set of credentials.

    When comes of configuring SSO with SAML or WS-Fed protocols, EngageCX comes with a friendly setup assistant and a series of well-defined steps for SSO configurations. The Single Sign-On process can be enabled on the Enterprise or Customer Portal websites.

    In this section, you can find step-by-step instructions on how to configure and use Single Sign-On within EngageCX Platform.


    Accessing the Single Sign-On Page

    Follow the steps below to open the Single Sign-On page:

    1. Within SysInternals page, select the SSO button under the Configuration section.
    2. The Single Sign-on page allows to manage or create new SSO connections.


    Configuring Single Sign-on

    The Single Sign-On process consists of creating a trusted relationship between the Identity Provider and the EngageCX Platform. Once the relationship is available, the user(s) can easily authenticate to the Identity Provider website and access the Service Provider application in a secure way.

    EngageCX offers two ways to use SSO:

    Notes

    Creating a Single Sign-on connection requires the following:

    • Setup an Application or a Relying Party Trust on the Identity Provider side.
    • Configure the web.config file on the EngageCX Website on which you want to enable Single Sign-On. This configuration is necessary only for SSO WS-Federation configurations. Please contact your implementation manager or engagecxsupport@mhcautomation.com for more details.
    • Setup a Single Sign-on connection within Enterprise Website using the SSO Wizard.
    • Create Mapping Rules and synchronize EngageCX Fields with Identity Provider attributes
    • Verify the Single Sign-on configuration.



    Step 1: Provide Information to your Identity Provider

    Start by configuring the Application or the Party Trust on the Identity Provider side. While setting up SSO on the IdP side, you will need to provide the EngageCX ACS URL to your IdP. This provides the location to which the SSO Token will be sent, and it can be copied from the first step of the EngageCX SSO Wizard.

    For more information, please refer to the Identity Provider documentation for the correct syntax or contact your EngageCX Implementation Manager for assistance.



    Step 2: Set up Single Sign-on

    Once the Identity Provider has finished configuration of the Single Sign-On process, to create the setup within EngageCX Website, you will need to follow the SSO wizard provided by EngageCX. Below you can see a reference on how to fill out the SSO form wizard.

    1. Start by accessing the Single Sign-On page and selecting the EngageCX Website on which you want to enable SSO:
      • Setup Enterprise SSO: to configure SSO on the Enterprise Website.
      • Setup Portal SSO: to configure SSO on the Customer Portal Website.
    2. The first step in the dialog wizard asks you to select the Identity Provider you may want to use for the connection. You can choose between:
      • Security Assertion Markup Language (SAML 2.0).
      • Web Services Federation Language (WS-Federation).
    3. Next, to establish a single sign-on connection through the protocol chosen before, fill out the form with the mandatory information received from your Identity Provider.
      • ACS URL: This provides the location to which the SSO tokens will be sent. In our case, is the location to the EngageCX Website. Select Copy to Clipboard from the right side and paste the URL link to the required Identity Provider configuration box.
      • IdP Login URL: Enter the URL associated with logging in to the Identity Provider address. Login URL is used when a user attempts to log in with SSO. EngageCX triggers a redirect to the URL and expects a POST request. In response, the EngageCX Platform produces an EngageCX access token for the assertion subject and redirects the now authenticated user to the EngageCX Homepage.
        The URL needs to be provided by your Identity Provider. Please note that each IdP setup is unique and it is important to add the correct URL generated by the IdP application, to ensure availability and integrity of your configuration.
      • IdP Logout URL: Optionally, you can provide a logout URL from your Identity Provider. This will validate the request to the IdP.
        Please make sure the URL entered is the correct link generated by the application set up for EngageCX Platform.
      • Signing Certificate: this field is available only for the SAML 2.0 protocol.
        Select Choose File to navigate the file system and upload the Signing Certificate issued by your identity provider. This will establish a trusted relationship between the Service Provider and the Identity Provider.
        If your Identity Provider has generated multiple certificates, you will need to use the same certificate as the one used when configuring the IdP application. Otherwise, you will be prompted with an invalid SAML error.

    Once ready, select Next to go to the Mapping step.


    Step 3: Create Mapping Rules

    The next step allows you to set up mappings connections that allows you to synchronize the EngageCX Platform with the Identity Provider. Note that the mappings need to be done on both, EngageCX Platform and IdP application/relying trust.

    To map fields within EngageCX SSO Wizard, use the following steps: * Select the +Add new mapping link. * Select the available user profile fields from the drop down list, then enter in the related empty field, the correspondent Identity Provider attribute issued for mapping. * For Enterprise Websites, by default, the user will not have any rights. To provide any rights for the users, you need to include them in Groups. To do this, map the correspondent group field from the IdP to the Groups field. By default, EngageCX provides two groups for which you can create synchronization: Administrators and Everyone.

    Once ready, select Save and continue.


    Step 4: Verify the Single Sign-on configuration

    In the end, if the setup was correct, you will be able to view a notification such as:

    Enterprise SSO has been successfully configured with {IdP Name}

    To ensure that the Single Sign-On is set correctly, select the Login now using SSO. You will be redirected to the Identity Provider Sign In page. Log in to the IdP website.

    http://{hostname|IPAddress|:{Port Number}/Security/Login?environment={EnvironmentName}&RelayState={returnEOSURLEncoded}

    where:


    Forms

    Here you can access and manage settings that apply to all the forms in your environment. Once ready with all configurations, you have to select the Update Settings button to save the changes.


    Google API Key

    When working with either the Google Address or Google Map widget you will need to make sure to add a Google API Key in order for them to function properly.


    Email Blacklist

    Under this section, you have the possibility to impact deliverability for your emails. This option allows you to provide your selected domains against sending, meaning some emails you send may not be delivered, being blacklisted. EngageCX users can take advantage of this feature by restricting some domains (ex. yahoo.com, gmail.com, etc.) for sending emails, in order to allow communication only to a selected target of users (ex. corporate clients).


    Portal

    This section allows you to configure dynamic fields for the Portal Users. Portal Settings allows you to manage Customer Portal configurations.

    1. In the Sysinternals page, access Portal hyperlink within the Configuration section.
    2. Select from the drop down list the dynamic field for Email parameter.
    3. Select from the drop down list the dynamic field for DisplayName parameter.
    4. Once ready, select Save to update the changes.


    After configurations are set, all the Portal users will use the same format as specified in the Portal Settings parameters.


    Audit

    Audit logs allow administrators to look back at changes that have been made in the EngageCX Platform. This is useful when you need to keep a record of events such as user logins, files administration or system clean-ups.


    Accessing the Audit page

    Follow the steps below to open the Audit page:

    1. Within SysInternals page, select the Audit button under the Configuration section.
    2. The Audits page allows monitoring EngageCX events.


    Configuring Audit Options

    This feature is used to configure what information to appear in the Audit logs.

    1. Within Audit page, select the More ( ) button from the toolbar.
    2. Select Configure Audit Options from the drop down menu.
    3. Within Customize Audit Options dialog, check\uncheck the operations you want to be stored in the log file, regarding Files, Users and/or System.
    4. Once ready, select Save to update the changes.


    Viewing Audit Logs

    Follow the steps below to view the audit logs:

    1. Within Audit log page, select the down arrow next to the Audit Category name (e.g. next to Files).
    2. Choose what types of audit logs to be displayed from Files, System or Users logs dropdown menu.


    Clean Up

    Follow the steps below to clean up the audit logs:

    1. Within Audit page, select the More ( ) button from the toolbar.
    2. Choose the Clean up option from the contextual menu.
    3. Check what assets you want to remove (Files and/or Users), then select the Clean Up button.
    4. Confirm the deletion and select OK.

    OAuth

    OAuth is a login procedure through which EngageCX allows users to configure another identity provider for taking advantage of the EngageCX features. OAuth2 enables application to obtain limited access to user accounts on an HTTP service. It works by delegating user authentication to the service that hosts the user account and authorizing application to access the user account.


    Accessing OAuth Page

    Follow the steps below to open the OAuth2 page:

    1. Within SysInternals page, select the OAuth2 button under the Configurations section.
    2. The page allows you to configure an OAuth setup.


    Configure OAuth

    Follow the steps below to configure an open authentication:

    1. In the OAuth2 page, select Configure from the toolbar.
    2. To establish an OAuth2 connection, you must specify some information that you can get from the Authorization and Resource Server. Before configuring the third party application, you must have the same user account configured in EngageCX Platform as well.
    3. Next, log in to the third party application. Access an existing application or create a new one for your organization. Then navigate to the Sandbox Account section and there you will find all the required parameters that you have to provide within the OAuth setup page from the EngageCX Portal.
    4. Provide the required parameters in the Setup OAuth2 dialog.
      • Client Id - Client Id provided from the Authorization Server.
      • Client Secret - Client Secret provided from the Authorization Server.
      • Log-in Page - Authorization Server OAuth log-in page.
      • Scope - One or more scope values indicating which parts of the user\s account you wish to access.
      • State - A random string generated by the EngageCX Platform, which will be verified later.
      • Get access token URL - Endpoint from the Resource Server, where the Authorization Code is exchanged for an Access Token.
      • Get user info URL - Endpoint from the Resource Server, where user information is gathered.
      • Authorization Type - The token sent using the authorization type.
      • Create users if not exist - Enable this option to allow the EngageCX Platform to automatically create the user if it does not exist. Otherwise, the user mappings will be updated.
      • Revoke access token URL - The token sent when the authentication request is revoked.
      • Enabled - Check this option to enable the OAuth as a new identity provider.
    5. Once you're ready, click Save.

    6. If everything works as expected, you will be provided with all the OAuth configurations page. For testing, you should select Log-in now using oauth.

    The log-in URL should look like below:

    http(s)://{Hostname|IPAddress:PortNumber}/security/oauth2/login?environment={EnvironmentName}&relayState={returnEOSURLEncoded},

    where:

    Notes

    - If the user is already logged in the OAuth login page, it will automatically redirect the user to the Return URL.

    - If you are going to use OAuth or Single Sign-On to authenticate the user, then the accessToken is not required in the URL, since it will be generated automatically when calling the OAuth Login Page.

    Example: Below is an example of the OAuth Login page with Return URL to Online Editor embedded:

    https://companyABC.ecrion.com/security/oauth2/login?environment=Development&relayState=https%3A%2F%2FcompanyABC.ecrion.com%2FEOS%2FEprEditor%3Fembed%3Dtrue%23workspace%2FDefault%2FRetail%2FInvoice.epr
    


    Emails Bounce List

    A hard bounce is an email that cannot be delivered for some reasons such as email recipient's server does not accept emails, the email's address or the email's domain is not a real one. These reasons generates a permanent failure, until all of them are being removed from the list.


    Accessing Emails Bounce List

    Follow the steps below to open the Emails Bounce List page:

    1. Within SysInternals page, select the Emails Bounce List button under the Configuration section.
    2. The page allows you to manage existing emails bounce list or remove all of them.

    The page will display a list in which there will be recorded all email addresses that were named by Amazon SES as hard bounce.


    Removing Bounce Emails

    Follow the steps below to delete bounce emails in a list:

    1. Under the Emails Bounce List page, select the Remove all button from the toolbar.
    2. Confirm the deletion and select OK to empty the list.

    or

    1. Access the Emails Bounce List page and select the Remove button corresponding to an hard bounce that you want to delete from the list.
    2. Confirm the deletion and select OK to remove the email address.


    Connections

    Connections allow you to integrate the EngageCX Platform with other external entities. Select from the table below the connection you want to configure within EngageCX.

    Database SharePoint Document DB Docusign Email Facebook FTP/FTPS REST API
    SFTP Amazon S3 Azure Salesforce Microsoft Dynamics CRM SMS BPMOnline


    Database

    Third party systems, such as database connections can be created and managed in the Enterprise Website.

    Accessing Database Connections

    Follow the steps below to open the Database page:

    1. Within SysInternals page, select the Database button under the Connections section.
    2. The Database page allows you to manage existing database connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up a database connection:

    1. Under the Database connections page, select the + New Connection button from the toolbar.
    2. To create a connection to your database, fill in all the mandatory fields:

      • Connection Name - A name for your Database Connection.
      • Provider Name - The database provider such as Microsoft SQL Server, Oracle, MYSQL, etc.
      • Connection String - Refer to your database documentation for the correct syntax. You can also use The Connection Strings Reference to build a connection string for the .NET framework.
      • Test Connection - Verify if the Database connection can be done using the specified fields.
      • Once ready, click on the Save button to successfully create the connection.

    The connection will appear on your Database Connections page.


    Updating Database Connections

    To update a database connection, access the Database Connections page and follow the steps described below.

    1. Under the Database connection page, go to the connection you would like to update and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select Save to update the changes.


    Deleting a Database Connection

    If you want to remove an unused connection, access the Database connection page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the Database connection page, go to the connection you would like to delete and select the More ( ) button.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.

    REST API

    Third party systems, such as REST API connections can also be created and managed in the Enterprise Website.

    Accessing REST API Connections

    Follow the steps below to open the REST API page:

    1. Within SysInternals page, select the REST API button under the Connections section.
    2. The REST API page allows you to manage existing API connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up a REST API connection:

    1. Under the Database connections page, select the + New Connection button from the toolbar.
    2. To create a connection to your database, fill in all the mandatory fields:

      • Connection Name - A name for your Database Connection.
      • Provider Name - The database provider such as Microsoft SQL Server, Oracle, MYSQL, etc.
      • Connection String - Refer to your database documentation for the correct syntax. You can also use The Connection Strings Reference to build a connection string for the .NET framework.
      • Test Connection - Verify if the Database connection can be done using the specified fields.
      • Once ready, click on the Save button to successfully create the connection.

    The connection will appear on your Database Connections page.

    SharePoint

    Third party systems, such as Sharepoint connections can also be created and managed in the Enterprise Website.

    Accessing Sharepoint Connections

    Follow the steps below to open the Sharepoint page:

    1. Within SysInternals page, select the Sharepoint button under the Connections section.
    2. The SharePoint page allows you to manage existing sharepoint connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up a Sharepoint connection:

    1. Under the SharePoint connections page, select the +New Connection button from the toolbar.
    2. To create a connection to the SharePoint, fill in all the mandatory fields:

      • Connection Name - A unique name for your SharePoint connection.
      • SharePoint URL - The URL to the SharePoint site (e.g. http://testserver/sites/test).
      • Domain - The SharePoint Domain (e.g. company@onmicrosoft.com).
      • Username - Your SharePoint username
      • Password - Your SharePoint password.
      • Verify if the SharePoint connection can be done using the specified fields by selecting Test Connection.
      • Once ready, click on the Save button to successfully create the connection.

    The connection will appear on your SharePoint Connections page.


    Updating a Connection

    To update a connection (change credentials, update password or change connection name), access the SharePoint Connection page and follow the steps described below.

    1. Under the SharePoint connection page, go to the connection you would like to update and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select Save to update the changes.


    Deleting a SharePoint Connection

    If you want to remove an unused connection, access the SharePoint Connection page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the SharePoint connection page, go to the connection you would like to delete and select the More ( ) button.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.

    Document DB

    DocumentDB allows the connectivity of the EngageCX server with an Amazon DocumentDB endpoint.


    Accessing Document DB Connections

    Follow the steps below to open the Document DB page:

    1. Within SysInternals page, select the DocumentDB button under the Connections section.
    2. The Document DB page allows you to manage existing document db connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up a document DB connection:

    1. Under the Document DB Connection page, select the +New Connection button from the toolbar.
    2. To create a connection to Document DB, fill in all the mandatory fields:

      • Connection Name - A unique name for your Document Connection.
      • URL - The URL of the Document DB server that hosts the DB solution that you want to connect to (e.g. https://abccompany.documents.azure.com:443/)
      • Key - The primary key of the Document DB server.
      • Database Id - The Id configured when creating a database within Document DB server (e.g. FamilyDB).
      • Collection Id - The unique identifier configured when creating a database collection (e.g. FamilyCollection).
      • Verify if the Document DB connection can be done using the specified fields by selecting Test Connection.
      • Once ready, click on the Save button to successfully create the connection.

    The connection will appear on your Document DB Connections page.


    Updating a Document DB Connection

    To edit a connection, access the Document DB Connection page and follow the steps described below.

    1. Under the Document DB connection page, go to the connection you would like to update and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select Save to update the changes.


    Deleting a Connection

    If you want to remove an unused connection, access the Document DB Connection page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the Document DB connection page, go to the connection you would like to delete and select the More ( ) button on the right-hand side.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.

    DocuSign

    Third party systems, such as Electronic Signature Providers can also be created and managed in the Enterprise Website.


    Accessing Electronic Signature Connections

    Follow the steps below to open the Electronic Signature page:

    1. Within SysInternals page, select the DocuSign button under the Connections section.
    2. The Electronic Signature page allows you to manage existing connections or create new ones.


    Adding a New DocuSign Connection

    Follow the steps below to set up a DocuSign connection:

    1. Under the Electronic Signature connection page, select the +New Connection button from the toolbar.
    2. To create a connection to Electronic Signature, fill in all the mandatory fields:

      • Connection Name - A unique name for your Electronic Signature Connection.
      • Provider Name - The provider name determines the type of connection to create. Currently, only DocuSign provider is available.
      • URL - The URL of the Electronic Signature site.
      • Email - The Email used to login to the Electronic Signature provider.
      • Password - The Password used to login to the Electronic Signature provider.
      • API Key - The Integrator Key generated in your Electronic Signature account.
      • Verify if the Electronic Signature connection can be done using the specified fields by selecting Test Connection.
      • Once ready, select Save to successfully create the connection.

    The connection will appear on your Electronic Signature page.

    Generating Docusign API Key

    An Integrator Key (API Key) is a GUID that is used to identify your integration and is needed to authenticate your API calls.

    To generate your key follow the steps below:

    1. Log into your DocuSign account.
    2. From the drop down next to your User, select Go to admin.
    3. Once in the Admin Console select API and Keys.
    4. Select the Add Integrator Key button.
    5. Enter a description for your key and select Add. A GUID will be generated, which is your Integrator Key (API Key).
    6. Copy the Key and add in the EngageCX Platform to API Key field mentioned in DocuSign Connections.

    Configuring Callbacks

    Setting up callbacks is mandatory if you are going to configure the workflow to wait the produced documents from DocuSign. DocuSign will notify EngageCX about the status of sent to sign documents from the workflow.

    1. Log into your DocuSign account.
    2. From the drop down next to your User select Go To Admin.
    3. Once in the admin console select Connect under the Integrations section on the left.
    4. Select Add Configuration from the contextual menu, then select Custom.
    5. In Custom Configuration Settings configure the necessary settings.

    When creating or editing a custom connection for EngageCX Platform you will need to provide the following:

    1. A unique name for the connection.
    2. The URL to Publish. This URL should be an EngageCX link in following format: http://{ecrionURL}/api/v2/interop/callback?callbackType=esignature&signatureType=docusign
    3. Make sure the following options are checked:
      • Enable Log (maximum 100)
      • Require Acknowledgment
      • Document PDFs
      • Certificate of Completion
      • Time Zone Information
      • Document Voided Reason
      • Sender Account as Custom Field
      • Document Fields
      • All Users (included new users)
      • Document Signed/Completed
      • Document Declined
      • Document Voided
      • Recipient Signed/Completed
      • Recipient Declined

    For more information about configuring the Workflow Step visit Electronic Signature.


    Updating a connection

    To update a connection (change credentials, update password or change connection name), access the Electronic Signature Connection page and follow the steps described below.

    1. Under the Electronic Signature connection page, go to the connection you would like to update and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select Save to update the changes.


    Deleting a connection

    If you want to remove an unused connection, access the Electronic Signature Connection page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the Electronic Signature connection page, go to the connection you would like to delete and select the More ( ) button.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.

    Email Connections

    Third party systems, such as email connections can be created and managed in the Enterprise Website.


    Accessing Email Connections

    Follow the steps below to open the Email Connections page:

    1. Within SysInternals page, select the Email button under the Connections section.
    2. The Email page allows you to manage existing email connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up an email connection:

    1. Under the Email connections page, select the +New Connection button from the toolbar.
    2. To create an Email connection, fill in all the mandatory fields:

      • Connection Name - A name for your Database Connection.
      • Email Type - Select between SMTP or Amazon SES connections.
      • Select Continue to proceed with Email connection configuration.

    SMTP Connections

    When creating/editing an SMTP (Simple Mail Transfer Protocol) Email connection you will need to fill in the following fields:

    Amazon SES Connections

    When creating/editing an Amazon SES (Simple Email Service) connection you will need to fill in the following fields:

    The domain name has to be verified in order to be usable through EngageCX Software. The verification must occur in the Amazon SES instance that is used to send emails. If you are managing your own instance contact your System Administrator to set up this domain in Amazon SES. However, if you are using the hosted version of EngageCX contact engagecxsupport@mhcautomation.com to request a new domain setup in Amazon SES.


    Updating Email Connections

    To update a connection (change credentials, update password or change connection name), access the Email Connections page and follow the steps described below.

    1. Under the Email connections page, go to the connection you would like to update and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select the Save button to update the changes.


    Deleting a Connection

    If you want to remove an unused connection, access the Email Connections page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the Email connections page, go to the connection you would like to delete and select the More ( ) button.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.


    Facebook

    Third party systems, such as Social Media (Facebook, Twitter, etc.) connections can be created and managed in the Enterprise Website.


    Accessing Facebook Connections

    Follow the steps below to open the Social Media page:

    1. Within SysInternals page, select the Facebook button under the Connections section.
    2. The Facebook page allows you to manage existing connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up a social media connection:

    1. Under the Social Media connections page, select the +New Connection button from the toolbar.
    2. To create a connection, fill in all the mandatory fields:

      • Connection Name - A unique name for your connection.
      • Channel - The social media channel you want to create a connection for. Currently, the only channel available is Facebook.
      • PageId - the PageId of your Facebook account.
      • Access Token - the access token generated in Facebook for Developers.
      • Verify if the Social Media connection can be done using the specified fields by selecting Test Connection.
      • Once ready, click on the Save button successfully create the connection.

    The connection will appear on your Social Media page.


    Updating a Facebook Connection

    To update a connection, access the Social Media Connection page and follow the steps described below.

    1. Under the Social Media connection page, go to the connection you would like to edit and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select Save to update the changes.


    Deleting a Connection

    If you want to remove an unused connection, access the Social Media Connection page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the Social Media connection page, go to the connection you would like to delete and select the More ( ) button.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.


    FTP FTPS

    Third party systems, such as File Transfer Protocol/File Transfer Protocol over SSL connections can be created and managed in the Enterprise Website.


    Accessing FTP-FTPS Connections

    Follow the steps below to open the FTP-FTPS page:

    1. Within SysInternals page, select the FTP/FTPS button under the Connections section.
    2. The FTP/FTPS page allows you to manage existing connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up a FTP/FTPS connection:

    1. Under the FTP/FTPS connections page, select the +New Connection button from the toolbar.
    2. To create a connection, fill in all the mandatory fields:

      • Connection Name - A unique name for your connection.
      • URL - The URL or IP Address for the FTP/FTPS location.
      • Username - The FTP/FTPS username
      • Password - The FTP/FTPS password.
      • Verify if the FTP/FTPS connection can be done using the specified fields by selecting Test Connection.
      • Once ready, click on the Save button to successfully create the connection.

    The connection will appear on your FTP/FTPS Connection page.


    Updating a FTP/FTPS Connection

    To update a connection (change credentials, update password or change connection name), access the FTP/FTPS Connections page and follow the steps described below.

    1. Under the connections page, go to the connection you would like to update and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select Save to update the changes.


    Deleting a Connection

    If you want to remove an unused connection, access the FTP/FTPS Connections page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the connections page, go to the connection you would like to delete and select the More ( ) button.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.


    SFTP

    Third party systems, such as SSH File Transfer Protocol connections can be created and managed in the Enterprise Website.


    Accessing SFTP Connections

    Follow the steps below to open the SFTP page:

    1. Within SysInternals page, select the SFTP button under the Connections section.
    2. The SFTP page allows you to manage existing SFTP connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up a SFTP connection:

    1. Under the SFTP connections page, select the +New Connection button from the toolbar.
    2. To create a connection to SFTP, fill in all the mandatory fields:

      • Connection Name - A name for your SFTP connection.
      • Server Name - The Host name or IP Address of the SFTP server.
      • Port - The port number that the server listens to. By default, is 22.
      • Username - The SFTP username
      • Password - The SFTP password.
      • Verify if the SFTP connection can be done using the specified fields by selecting Test Connection.
      • Once ready, select Save to successfully create the connection.

    The connection will appear on your SFTP Connections page.


    Updating an SFTP Connection

    To update a connection (change credentials, update password or change connection name), access the SFTP Connections page and follow the steps described below.

    1. Under the SFTP connection page, go to the connection you would like to update and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select Save to update the changes.


    Deleting a Connection

    If you want to remove an unused connection, access the SFTP Connections page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the SFTP connection page, go to the connection you would like to update and select the More ( ) button.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.


    Amazon S3

    Third party systems, such as Amazon Web Service connections can be created and managed in the Enterprise Website.

    Accessing Amazon Web Service Connections

    Follow the steps below to open the Amazon Web Services page:

    1. Within SysInternals page, select the Amazon S3 button under the Connections section.
    2. The Amazon S3 page allows you to manage existing amazon s3 connections or create new ones.


    Adding a New Amazon S3 Connection

    Follow the steps below to set up an Amazon web service connection:

    1. Under the Amazon Web Service connections page, select the +New Connection button from the toolbar.
    2. To create a connection to Amazon, fill in all the mandatory fields:

      • Connection Name: A unique name for your Amazon connection.
      • Service Type: Select the Amazon Simple Storage Service.
      • Region: The AWS region you are using (e.g.: us-east-1)
      • Access Key: The Amazon Access Key Id.
      • Secret Key: The Amazon Secret Access Key Id.
      • Bucket: The AWS bucket created in the AWS region.
      • Server Side Encryption: This field determines which Amazon server-side encryption are you using to protect your data.
      • Verify if the Amazon Web Services connection can be done using the specified fields by selecting Test Connection.
      • Once ready, click on the Save button to successfully create the connection.

    The connection will appear on your Amazon Web Service Connections page.

    Notes

    Amazon key and Secret Key must be obtained from Identity and Access Management (IAM) module in the AWS console. These keys should be associated with permissions that allow to list bucket objects and read a specific object from the bucket.

    To create an Amazon Synchronized Folder, please visit the Synchronized Folders chapter of this guide. To view the synchronization folder log, please visit the Synchronization Folder Log chapter of this guide.


    Updating Amazon Connections

    To update a connection (change credentials, update password or change connection name), access the Amazon Web Services Connection page and follow the steps described below.

    1. Under the Amazon Web Services connection page, go to the connection you would like to update and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select Save to update the changes.


    Deleting a Connection

    If you want to remove an unused connection, access the Amazon Web Services Connection page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the Amazon Web Services connection page, go to the connection you would like to delete and select the More ( ) button.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.


    Azure

    Third party systems, such as Azure Web Service connections can be created and managed in the Enterprise Website.


    Accessing Azure Connections

    Follow the steps below to open the Azure Web Services page:

    1. Within SysInternals page, select the Azure button under the Connections section.
    2. The Azure Web Services page allows you to manage existing Azure storage connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up an Azure web service connection:

    1. Under the Azure connections page, select the + New Connection button from the toolbar.
    2. To create a connection, fill in all the mandatory fields:

      • Connection Name - A name for your Azure Connection.
      • Account Name - The Azure account name (e.g. eostestazurestorage).
      • Account Key - The Azure account key is obtained through the Azure portal.
      • Test Connection - Verify if the Azure connection can be done using the specified fields.
      • Once ready, click on the Save button to successfully create the connection.

    The connection will appear on your Azure Storage Connections page.


    Updating Azure Connections

    To update a connection (change credentials, update password or change connection name), access the Azure Connections page page and follow the steps described below.

    1. Under the Azure Storage Connections page, go to the connection you would like to update and select the More Options button.
    2. Select the Edit from the contextual menu and make the necessary changes.
    3. Once ready, select the Save to update the changes.


    Deleting a Connection

    If you want to remove an unused connection, access the Azure Connections page page and follow the steps described below.

    1. Under the Azure Storage Connections page, go to the connection you would like to delete and select the More Options button.
    2. Select the Delete from the contextual menu.
    3. Confirm the deletion and select Delete.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all the affected data.


    BPM Online

    EngageCX allows users to integrate the Business Process Management (BPM) that helps controlling business processes for your company.


    Accessing BPM Online Connections

    Follow the steps below to open the BPM Online page:

    1. Within SysInternals page, select the BPMOnline button under the Connections section.
    2. The BPMOnline page allows you to manage existing BPMOnline connections or create new ones.
    3. Enter the BPM Server URL that hosts the BPM solution that you want to connect to.
    4. Specify a REST authentication service that manages user authentication


    Adding a New Connection

    Follow the steps below to set up a BPMOnline connection:

    1. Under the BPMOnline connections page, select the +New Connection button from the toolbar.
    2. To create a connection to BPM, fill in all the mandatory fields:

      • Connection Name - A unique name for your BPMOnline Connection.
      • Username - The BPM username.
      • Password - The BPM password.
      • URL - The login URL of your BPM org.
      • Authentification URL - Specify a REST authentication service that manages user authentication.(the BPM is based on basic and cookie authentication, e.g. https:///ServiceModel/AuthService.svc/Login;authtype=basic|cookie)
      • Verify if the BPM connection can be done using the specified fields by selecting Test Connection.
      • Once ready, click on the Save button to successfully create the connection.

    The connection will appear on your BPMOnline Connections page.

    For more information regarding the BPM Connection usage in Modeler, access the following link.

    Salesforce

    Third party systems, such as Salesforce connections can be created and managed in the Enterprise Website.


    Accessing Salesforce Connections

    Follow the steps below to open the Salesforce page:

    1. Within SysInternals page, select the Salesforce button under the Connections section.
    2. The Salesforce page allows you to manage existing salesforce connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up a Salesforce connection:

    1. Under the Salesforce connections page, select the +New Connection button from the toolbar.
    2. To create a connection to Salesforce, fill in all the mandatory fields:

      • Connection Name - A unique name for your Salesforce Connection
      • Salesforce URL - The login URL of your Salesforce org. (e.g. https://login.salesforce.com/services/Soap/c/32.0 )
      • Username - The Salesforce username.
      • Password - The Salesforce password.
      • Token - The security token generated by Salesforce.
      • Verify if the Salesforce connection can be done using the specified fields by selecting Test Connection.
      • Once ready, click on the Save button to successfully create the connection.

    The connection will appear on your Salesforce Connections page.

    Requesting Salesforce Security Token

    Follow the steps below to request a Salesforce security token:

    1. Login to your Salesforce account.
    2. From your personal settings, type Reset in the Quick Find box, then select Reset My Security Token.
    3. Select the Reset Security Token button and check your inbox to retrieve the Access Token from the mail received.


    Updating Salesforce Connections

    To update a connection (change credentials, update password or change connection name), access the Salesforce Connections page and follow the steps described below.

    1. Under the Salesforce connection page, go to the connection you would like to update and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select Save to update the changes.


    Deleting a Connection

    If you want to remove an unused connection, access the Salesforce Connections page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the Salesforce connection page, go to the connection you would like to delete and select the More ( ) button.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.

    Microsoft Dynamics CRM

    Third party systems, such as Microsoft Dynamics CRM connections can be created and managed in the Enterprise Website.


    Accessing Microsoft Dynamics Connections

    Follow the steps below to open the Microsoft Dynamics CRM page:

    1. Within SysInternals page, select the Microsoft Dynamics CRM button under the Connections section.
    2. The Microsoft Dynamics CRM page allows you to manage existing connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up a Microsoft Dynamics CRM connection:

    1. Under the Microsoft Dynamics CRM connection page, select +New Connection from the toolbar.
    2. To create a connection to Microsoft Dynamics, fill in all the mandatory fields:

      • Connection Name - A unique name for your Microsoft Dynamics Connection.
      • Microsoft Dynamics URL - The URL of the Microsoft Dynamics CRM server that hosts the CRM solution that you want to connect to. (e.g.: https://abccompany.crm4.dynamics.com, where abccompany is the organization's name and crm4.dynamics.com, is the domain's name)
      • Username - The Microsoft Dynamics username.
      • Password - The Microsoft Dynamics password.
      • Verify if the Microsoft Dynamics connection can be done using the specified fields by selecting Test Connection.
      • Once ready, select Save to successfully create the connection.

    The connection will appear on your Database Connections list. In addition, you will notice that all your Microsoft Dynamics accounts and contacts are available within the People module.


    Updating Microsoft Connections

    To update a connection (change credentials, update password or change connection name), access the Microsoft Dynamics CRM Connection page and follow the steps described below.

    1. Under the Microsoft Dynamic connection page, go to the connection you would like to update and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select Save to update the changes.


    Deleting a Connection

    If you want to remove an unused connection, access the Microsoft Dynamics CRM Connection page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the Microsoft Dynamic connection page, go to the connection you would like to delete and select the More ( ) button.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.

    SMS Connections

    Third party systems, such as SMS connections can be created and managed in the Enterprise Website.


    Accessing SMS Connections

    Follow the steps below to open the SMS page:

    1. Within SysInternals page, select the SMS button under the Connections section.
    2. The SMS page allows you to manage existing SMS connections or create new ones.


    Adding a New Connection

    Follow the steps below to set up an SMS connection:

    1. Under the SMS connections page, select the +New Connection button from the toolbar.
    2. To create a connection to SMS, fill in all the mandatory fields:

      • Connection Name - A unique name for your connection.
      • Once ready, click on the Save button to successfully create the connection.

    The connection will appear on your SMS Connections page.


    Updating SMS Connections

    To update a connection (change credentials, update password or change connection name), access the SMS Connection page and follow the steps described below.

    1. Under the SMS connection page, go to the connection you would like to update and select the More ( ) button.
    2. Select Edit from the contextual menu and make the necessary changes.
    3. Once ready, select Save to update the changes.


    Deleting a Connection

    If you want to remove an unused connection, access the SMS Connection page and follow the steps described below.

    Note

    Once you delete a connection, all active assets using that connection will be broken. You will have to manually configure all affected data.

    1. Under the SMS connection page, go to the connection you would like to delete and select the More ( ) button.
    2. Select Delete from the contextual menu.
    3. Confirm the deletion and select Delete.

    Channels Tickets

    Access Tickets under Channels section to view the current state of execution of jobs within the chosen Channel Queue.

    You can manage queues for a specific Channel from the toolbar of this view:

    Delete Channel Queue

    Follow the steps below to remove a channel queue:

    1. In the Email Queues page, select the More ( ) button under the toolbar.
    2. Choose the Delete option from the dropdown menu.
    3. Confirm the deletion of the queue and select OK.

    View Channel Queue Properties

    Follow the steps below to edit a channel queue:

    1. In the Email Queues page, select the More ( ) button under the toolbar.
    2. Choose the Properties option from the dropdown menu.
    3. Perform modifications for the selected Channel Queue and select Save to update the changes.

    Workspaces Settings

    The Workspace section from Internal Settings provides administrators the ability to monitor and manage custom features presented. By default, two workspaces will be displayed : the Default workspace, visible in the Workspaces module, usually used to install and test Project Samples, and the System workspace, hidden from the Workspaces module, having the role to store all the files necessary for proper function of EngageCX Platform.

    Next to the Workspaces section, there is a Show Activities checkbox that enables various elements, such as Triggers, Schedules, Jobs and Files, associated with the environment, to be displayed or not. If the Show Activities option is enabled, under the Workspaces module you will be able to navigate to Jobs, Schedules and Triggers by clicking on the corresponding links. In the Workspaces page, once an activity is accessed, a drop-down menu in the toolbar will allow users to switch among Files, Jobs, Scheduler or Triggers.

    The table below provides the features you can edit within Workspace settings.

    Jobs Schedules Triggers
    Execution Log Sync Log Files

    Jobs

    In EngageCX, we use the term job to refer to a workflow that is executing or has finished executing. There are some key distinctions between a workflow at design time and a workflow at runtime (i.e. a job).


    Running a Job

    First, because you can run the same workflow multiple times, each job will be assigned its own unique identifier called the Job ID. You can see information about existing jobs (running or finished) in the Jobs page. Also, a job will have a status: it can be running (in the process of executing the steps), successful(if it has executed all the steps defined in the workflow without any errors), or failed (if it hasn't).

    Each job creates a corresponding folder for its outputs within the Jobs page. Within that folder, each step also creates its own subfolder to store its outputs, if any. Each step, as it executes, will use the outputs from the previous step as its input. There is one exception to this rule: if the previous step is of a type which does not by its nature produce any output within Enterprise Website (e.g. Copy to FTP), then it will simply be ignored and the step before it will be used instead.


    Monitoring a Job

    To view the current state of execution simply select the Jobs button within Workspace section of the SysInternal page.


    Job Detailed View

    To access the Job's detailed view, simply select a Job from one of the predefined views (Failed Jobs, Recent Jobs, All Jobs, etc.)

    1. The top section displays the execution flow. You can select a step to drill down and view the generated work items.
    2. The bottom section displays the execution log. Note that when you drill down, the execution log is filtered to show only the records for that step.


    Job Commands

    At any time the follow commands are available for a selected job:


    From Toolbar


    From More Options Menu

    You can access the More ( ) button to see the Job options available in the contextual menu:

    Schedules

    As well as for communications, environment administrators have the ability to configure EngageCX to start specific jobs at a certain time. Jobs can be scheduled to run hourly, daily, weekly, monthly, or every number of minutes, on certain days of the week, several times a month, etc.


    Configuring a Schedule

    Follow the steps below to configure a schedule:

    1. In the Schedulers page, select the +New Schedule button from the toolbar.
    2. Fill in the Schedule form with the appropriate values:
      • Choose the time frame you would like to schedule the Job for, by selecting from the Hourly, Daily, Weekly or Monthly tabs.
      • Choose File: upload the workflow to be used for this Schedule.
      • Configure the timing of the Schedule (in minutes).
      • After completing the previous fields, you will be able to select the Configure parameters button to modify already defined parameters (if exist) from the workflow that need to be set before the Job runs.
      • Toggle on or off Enabled option to activate or deactivate the Schedule.
    3. Once ready, select the Save button to update the changes.

    The new schedules will appear on your Schedules list. Select the View Log option to see log messages.


    Editing a Schedule

    Follow the steps below to edit a schedule:

    1. In the Schedulers page, select the schedule you want to edit.
    2. Within the Schedule dialog, you can edit the time frame where your job will be runned or update parameters.
    3. To delete a schedule, click on the Delete Schedule button, at the bottom of the dialog.

    Triggers

    From Triggers, you can configure EngageCX to start specific jobs as an automatic response to an action. Currently, the supported methods for triggering jobs are Hot Folders and Microsoft Message Queues (MSMQ).

    Configuring a Hot Folder Trigger

    A hot folder trigger monitors a specific folder looking for a user configured file pattern, e.g. all files matching "*.XML". Each time a file matching the pattern is dropped into the folder, EngageCX picks it up, removes it from the folder and runs a job using it as input.

    The following parameters need to be configured:

    Path Provide the path of the folder.
    Hotfolder Type Select the Hot Folder type; Machine Physical Folder, SFTP Folder.
    SFTP Connection If the Hot Folder type will be an SFTP Folder, select the connection to use. To learn how to create a new connection visit SFTP.
    File Pattern Provide the file pattern of the data source file that EngageCX should be monitoring the folder for. You can use wild cards like ' * ' to make the pattern more generic.
    Workflow Select the Choose File button and navigate for the workflow that should be run when a file is found
    Pooling Interval The number of seconds between 2 consecutive attempts to check for new files.
    Configure Parameters Configure the parameters (if any) from the Workflow that need to be set before the Job runs.


    Configuring a Microsoft Message Queue (MSMQ) Trigger

    An MSMQ Trigger monitors the Microsoft Message Queue. Each time an entry is added, EOS will parse it using either a binary or XML formatter and use the result as the input. The formatter to use is specified by the user when creating or editing the trigger, using the Add Trigger or Edit Trigger dialogs, respectively.

    The following parameters need to be configured:

    Path Provide the path of the MSMQ.
    Formatter Type Choose the Formatter Type to be used; BinaryFormatter, XmlFormatter.
    Workflow Select the Choose File button and navigate for the workflow that should be run a file is found.
    Pooling Interval The number of seconds between 2 consecutive attempts to check for new files.
    Configure Parameters Configure the parameters (if any) from the workflow that need to be set before the Job runs.

    Execution Log

    Execution Logs section have the purpose to store everything that was run. Besides Jobs, there will be also Direct Render execution logs. The information will not be too detailed, but it consists of data when the execution was started, when it was finished and error messages, if exist. In this case, the flow will not continue with intermediary steps (for example, Render).

    When you execute a Job stream, a log file will show progress information when you access the Execution Log for a chosen Workspace.


    Accessing the Execution Log Page

    Follow the steps below to open the Execution Log page:

    1. Choose the preferred workspace.
    2. Select the Execution Log button to view all logs for all Jobs and Direct Renders presented in the selected workspace.

    There will be displayed logs, according to Severity status (Errors, Warnings, Information, Diagnostics), Timestamp and a Message related to the state of the log.

    The data from Execution Log view can be filtered according to severity status, by the filter symbol on the left side of the Severity parameter.

    Synchronization Log

    When you synchronize folders with Amazon S3, a log file will show progress information when you access the Sync Log page for a chosen workspace.

    If the synchronization has been finished you can see its activity log by inspecting the flow of operations in performing synchronization until completion. You can also check for errors or warnings. Note that if you have done a manual synchronization, you should restart the EngageCX Service (e.g. using Windows Services).

    In case of errors, during the preview of the folder log, check in EngageCX configuration file (located at C:\ProgramData\EngageCX\EOS4.config) the Folder Log parameter to be set to true. The log folder is the folder in which the log files related to Amazon synchronization are to be created and saved: LogServerEnabled=true.

    Files

    The Files menu is available only for the System workspace. Accessing Files, you can explore and manage all folders and files used by EngageCX Platform to function properly. Note that it is not recommended to add/edit/delete anything from the System Files, unless indicated by the EngageCX Technical Support.


    Domains

    All the Domains Trackers added in Domains Settings are visible and can be managed from Internal Settings.

    Visitors

    From the Visitors page you can manage and keep evidence of how many users interact with your website before they register. We called a visitor a user that access your website without logging in.

    Visitors are tightly bound to the user's domain tracking feature available in Domain Settings. This feature implies storing visitors in a database, where you can save meaningful information about them. When a Visitor is completing a Lead Generation form as a Communication Project, the data will be stored within Contact information.

    Working with this type of users is limiting in some ways, because there are not many things you know for sure about them, but there are certain data you can store, such as:

    All the data you want to store can be configured from the Domains Settings page.

    If tracking is enabled on your domain, all visitors that are not registered will be recorded by EngageCX Platform. EngageCX allows environment administrators to track the actions of your anonymous users by selecting the Visitors page within Internal Settings.


    Note

    Extra high volume of Page View entries can lead to delays under EngageCX functionalities.


    Viewing Visitors

    To view all the visitors that access your website, follow the steps below:

    1. Go to the Domains section within the SysInternals page.
    2. Select the Visitors option, next to the domain name you have configured to monitor.
    3. A list with all the anonymous users that have been visiting the website will be displayed.
    4. For further details, simply select the anonymous user id and a page with custom information will be displayed.

    After you interact with one of the Visitors, you should consider the following:

    EngageCX provides conversion of the anonymous users that visit portal and complete the Lead Generation form, to tracked-users (leads) that can be considered potential clients. Further they can be monitored and managed under the Customer Journey module. Therefore, any data collected on that user persisted in the account of the newly-registered user.


    More Visitors Options

    In the Visitors Page, you can select the More ( ) button, next to the user and select from the following options under the drop-down menu:


    Cleanup Tracking History

    Cleanup Tracking History is intend to clean-up of old visitor records that have been registered until a certain date. This functionality can be performed manually or automatically.


    Automatic Clean Up

    Follow the steps below to perform an automatic clean up:

    1. Go to the Domains section within the SysInternals page.
    2. Select the Cleanup Tracking History option, next to the domain name you have configured to monitor.
    3. In the dialog, under the Automatic section, select the number of days after which the anonymous users will be deleted from the system. In the drop-down list there are only some available options, up to one year of inactivity.
    4. Once you're ready, click Save.


    Manual Clean Up

    Follow the steps below to perform a manual clean up:

    1. Go to the Domains section within the SysInternals page.
    2. Select the Cleanup Tracking History option, next to the domain name you have configured to monitor.
    3. In the dialog, under the Manual section, select the date until which the anonymous users will be deleted from the system. You can choose from the date-picker or directly type in the date you want to take into consideration as being the last day of activity.
    4. Below the date field, there will be computed some statistics related to the number of active and inactive anonymous users. You can click Delete Users to directly remove those users.
    5. Once you're ready, click Save.

    Appendix

    Best Practices

    Set up your environments

    Before you start adding and editing the files in your projects, think about how will you set up the Environments within EngageCX Platform. You may want to create an Environment for each of your customers, or perhaps you need to make an Environment for testing, production, and development.

    It is a good idea to write down your Environments and list what types of actions will take place in each. This process will begin to give structure to the organization of your document's production cycle, and then you can proceed with creating Environments for your users to work in.

    Group your users

    Within EngageCX Platform, you can group your users by their responsibility. By grouping your users, you can manage the rights that each group of users possesses in one location and can eliminate the headaches associated with the administration of many users. In addition, for each user or group, you can set up Environment or Workspace permissions depending on the access rights that you would like to give. Once you've decided about EngageCX users, go to the Permissions section and start configuring users, groups and permissions.

    Keep your document production and customers in sync

    Having all customers data synchronized into a single view will allow you to take immediate actions in order to grow your business productivity. Using EngageCX Platform, you can integrate your CRM contacts, accounts and leads, and use them to produce dynamic documents. To find out more information on how to setup integration, read the Integrations sections of this guide.

    Learn about Review and Approval

    The Review and Approval feature allow you to structure the steps any project must follow and which users need to review in order for that project to be approved and published in the production environment. Think about a simple modification like changing a template font. Then think about the parties that will need to be involved to review, test, and approve on all levels. From there, you can learn more information about configuration in the review and approval section of the documentation.


    Terminology

    EngageCX Software is designed to be an easy-to-use environment to manage every aspect of your document production needs. Before you get started with designing and managing your projects for document production, we recommend you become familiar with some of the common terminology.

    The latest EngageCX release comes with an intuitive interface equipped with all the features and options used to enhance your customer experience. Once you have logged in to the Enterprise Website, you will be presented with the homepage displaying a warm welcome for the user who is currently logged in.

    The start page gives you quick access to the main modules menu. The Modules Menu is where you will find all the functionalities needed for documents creation, design and configuration that are available for the user you are logged into.

    Beneath, you will be able to see your recent files, communications, tasks or channels tickets. The number of items displayed for each category can be configured from the drop down list, at the bottom of every category. If you have administrator privileges, you can go to User Profiles and choose what categories to display. From Profiles, you can also pin shortcuts to the Welcome Page, to easily create or run documents. The Install Software button from the right, will open the Software Download page, that provides access to the Visual Design software and other Programming tools and API's resources.

    At the very top of each EngageCX page, you will be able to spot the Navigation Bar, providing access to a couple of essential features, such as:


    In the left of the Navigation Bar you can select the System ( ) Menu, that display a floating window providing quick access to all available modules, from each EngageCX page.

    Beneath the Navigation bar, the Toolbar will be visible on each module page. It provides access to the essential tasks you can perform in the current area. When navigating through complex projects, on the right side, you can view the current path and/or select the down arrow to easily swap to another EngageCX location to explore.

    In the right side is displayed the Sidebar, exhibiting tabs to custom features and/or a tree view of all the assets included in the selected module. You can collapse the Sidebar to focus on your tasks and expand it whenever you're ready to move around. Simply, select the double-arrow icon, at the top right side to bring out or hide it.

    In the sections below you will find helpful information highlighting some of the important terms used when discussing EngageCX.


    Workspaces

    A Workspace is an area where users that have access, can store their work and share it with other team members. Workspaces contain all of the modules required to, upload files, create tasks, run workflows, or trigger actions based on different events.

    A Workspace can be created for each department in your company that will have access to EngageCX Platform, with only the users from the department having access to the Workspace, for example Accounting, Marketing, Human Resources, etc. Workspaces can also be created for large projects that your company needs to produce that many users from different groups will have access to.


    Templates

    Templates become a crucial part of high-volume document production. They describe how to paginate, stylize and lay out documents generated dynamically from data. Templates can contain various dynamic elements such as Fields, Conditions, Repetitions (such as repeated table rows or repeated paragraphs), Conditional Formatting, etc.

    A template file has the .epr or .xfd extension and can be edited either directly online in Enterprise Website or offline in Publisher tool. A reusable sub-document that can be inserted in multiple templates has the .epb or .xfc extension.


    Note

    The process of creating documents dynamically from data is called “document composition”. This is why, throughout this documentation, Publisher is in some cases referred to as a “visual document composition tool”.


    Workflows

    A workflow describes what should happen in a high-volume document production job. Typical workflow steps are Get, Render, Email, etc.

    A workflow file has the .wk4 extension and can be edited directly in Enterprise Website.


    Jobs

    Document production workflows can be executed in the Jobs module under Admin Settings. Here you can start, stop and otherwise control high-volume document production jobs.

    For each job, the system stores the inputs, outputs and the full execution log.


    Modules

    Modules are large groups of functionality within EngageCX Enterprise.

    People Record and manage information about the persons involved in your organization.
    Engagement Business communication connection between an external stakeholder (consumer) and an organization (company or brand) through various channels of correspondence.
    Design Manage both, projects and workspaces, as well as their assets.
    Organization Build interactive documents and help developers to design or configure environment settings.

    Tiles

    An EngageCX Module's functionality is organized in Tiles. When you select a Module, you will see all of the Tiles that are available, subject to access rights:

    People Module
    Accounts Allows you to view and manage all the organizations or persons involved with your enterprise.
    Contacts Enables you to manage contact information and communicate with individuals connected to an account.
    Lists Used to organize a set of contacts and group them together, for a specific purpose (for example, receiving mass emails).
    Engagement Module
    Communications Allows you to generate and deliver documents to any output type using the Projects you have created.
    Journeys Uses a customer journey map to track the entire customer experience, in real-time and manage them appropriately.
    Personas Manage the target audience that consists in a group of contacts that shares the same interests.
    Design Module
    Projects Project Manager that allows you to manage and organize your particular files, together with their dependencies.
    Workspaces Logical devisions of environments that enable collaboration and storage of all assets involved in your customer communication management processes.
    Organization Module
    Analytics Create interactive documents based on their own custom dashboards.
    Developer Lead users to various samples and documentation links, latest versions of both, desktop design software and software development kits.
    Admin Configure access control for users or groups, integration with other external systems or handling environment settings.


    Output Parameters

    PDF Output

    EngageCX Software can generate PDF (Portable Document Format) in several flavors including PDF/X, PDF/A, Section 508 Compatible PDF, and more.

    Advanced Parameters

    Notes

    When working with the Publisher to create templates, you will have the ability to set the Owner Password, User Password and Encryption Strength. These options will be overwritten by any parameter configurations made in an EngageCX workflow.

    In order for the PDF output to be protected you will need to set both an Owner Password and User Password. This will cause a password request dialog to appear whenever the PDF is opened.

    Word Output

    EngageCX can generate .docx files. These are Microsoft Word files that can be opened using Microsoft Office 2007 and newer.

    There are no parameters to configure. Any configurations to the template in the Publisher will be used, for example document protection.

    PowerPoint Output

    EngageCX can generate Microsoft PowerPoint files.

    Plain Text Output

    EngageCX can generate plain text output. The following parameters will help you customize this output.

    Advanced Parameters

    ASCII This option can be used when your input contains only ASCII characters.
    UTF 8 UTF-8 can support many languages and can accommodate pages and forms in any mixture of those languages.

    TIFF

    TIFF (computer file format) output is very useful when the output must be sent to a FAX Machine.

    Advanced Parameters

    CA CCITT3 This encoding option can be used for black and white image data telecommunications. All modern FAX machines and FAX modems support this compression type.
    CA CCITT4 Black and white encoding for Fax machine, also very popular.
    CA LZW Use this type of compression when you need to generate color TIFF.
    CA None No compression.
    CA RLE Run-length-encoding compression.

    Email Body

    When using the Email step, you will need to render the email body using a render step.

    Advanced Parameters

    CID (Content ID Any images in the email template will be added to the body as separate parts of the email, with a unique CID assigned to all.
    Embedded (64-bit) The images will be written inline directly inside the email body itself.
    External The reference used in the template will be carried over for each image.

    HTML

    EngageCX has the ability to produce HTML (Hypertext Markup Language) output. The following options will help you customize this output.

    Advanced Parameters

    PS

    EngageCX can generate Post Script files.

    AFP

    EngageCX can generate AFP (Advanced Function Presentation) output.

    Advanced Parameters

    Custom EngageCX will automatically create code pages on-the-fly, based on characters that are used in your documents.
    AFP T1000808 Personal Computer: Cyrillic, Russian with euro
    AFP T1000892 OCR-A.
    AFP T1001250 Windows Latin2: ANSI Central and Eastern European.
    AFP T1001252 Windows Latin1: ANSI Western European. This is the default code page for ASCII.
    AFP T1V10500 Country Extended: IBM EBCDIC (Extended Binary Coded Decimal Interchange Code) International.
    Raster This option will convert the fonts to AFP Raster Fonts. These fonts will be embedded in the AFP output and the document can be printed on all AFP printers. When the convert to AFP Raster Fonts is selected, then True Type and Type 1 fonts are automatically converted to FOCA native Raster fonts in the AFP output rendered with EngageCX.
    Outline This option will convert all fonts used to AFP Outline Fonts. Outline Fonts can scale without any quality loss but require more processing by the printer.

    HTML5 Smart Document

    EngageCX will allow you to generate an EngageCX Smart Document. A Smart Document will allow end customers to interact with their own data.

    Your Smart Document template should include widgets or responsive design options.

    PNG

    EngageCX can generate PNG (Portable Network Graphics) output. PNG output is very useful when you need to render a low-resolution document that loads quickly and looks great.

    Advanced Parameters

    **JPEG **

    EngageCX can generate JPEG (Joint Photographic Experts Group) output. JPEG output supports a large variety of colors, which allows for crisp images without a large file size.

    Advanced Parameters