EngageCX 11.5 (Mantine) Users Guide

Getting Started

Logging Into EngageCX Platform

Once you received credentials on email or from your administrator, you can access the EngageCX Enterprise Website from your browser and start designing and building documents.

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

• Open a web browser and enter the EngageCX URL, consisting of Host Name or IP Address, along with the Port Number of the Enterprise Website server. As an example, the link in your browser should look as follows: http://ecrionserver:8094

• Next, you must fill in the following mandatory fields, then click Sign In.

  • Username: Enter the username from your email or received from your system administrator.
  • Password: Enter the password associated with your account.

• If multiple environments are available for the presented credentials, you will have to select the environment you would like to access and click Continue.

Personalizing Your Experience

After logging in to the Enterprise Website, at any time, you can change your password for a better security or update personal account information.

Changing Your Password

Follow the steps below to change the current password:

• Click on your account name in the upper right-hand corner, then select the Edit Account from the drop down menu.
• Select the Change Password button in the bottom of the opened dialog.
• Enter your existing password, then the new one, and then enter the new one again.
• Once you're ready, select the Save.

Updating Personal Information

Follow the steps below to edit your personal information inside EngageCX Platform:

• Click on your account name in the upper right-hand corner, then select the Edit Account from the drop down menu.
• In the Edit Account dialog, modify your personal information on the Account tab, or manage system features on the Preferences tab, as needed. When edit, note that:
  • If you change your email address, a confirmation email will be sent to the new address.
  • Your account time zone servers as the default time zone for all documents and automatic processes enhanced in your environment.
  • By default, all hidden folders are concealed in your environment, but you can opt to show them whenever you need.
  • Alerts allow you to stay updated with all the changes encountered in your environment. You can opt to turn on or off alerts for emails, jobs triggers or print processes. To receive alerts emails, a functional email connection is required.

People

The People module allows you to record and manage information about the persons involved in your organization.
These options are available in EngageCX, but if you do not see these options in your environment reach out to your account manager for an upgrade.

Accounts

EngageCX

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

Accessing Accounts

1. Select the System menu at the upper left 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 relevant account name that represents a Company Group, Branch or an Individual business. In 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 EngageCX Enterprise:

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 your customer's 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 website URL. Additionally, you can address information and set up other account preferences.
3. Once you're ready, select the OK to save the changes.

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

Manage Account Types

By default, all accounts within 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 Accounts page, select the More Options button from the toolbar.
2. Select the Manage Account Types from the contextual menu.
3. Select the Add Account Type button from the bottom of the dialog to create a new account type. Choose an appropriate name for the type of your account and select the 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 Options Menu.

Updating Account Information

1. Access the Accounts page and select the account that requires updates.
2. Select the More Options button from the toolbar and then choose Edit in the contextual menu.
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

1. Access the Accounts page and select the account you wish to delete.
2. Select the More Options menu at the right of the toolbar.
3. Select the 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.

Creating Documents

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, then select the Run. Additionally, you can use the Search bar from the top-right corner to look up for a specific project.
4. Communication Run Page will open in a new window, where you need to fill out the form with the required fields. On the Communication page, you will see a preview of the output document on the right side. For more details about Communications, please visit the Communication section.

More Accounts Options

In the Accounts Page, you can select the More Options button, next to the account name and access the following options:

• Open - to open the account page, that allows you view and update personal account details.
• Compose - to submit an interactive project.
• Delete - to permanently delete the selected account from the list.
• Properties - to open a dialog that allows you to edit current account information.

Contacts

EngageCX

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

Accessing Contacts

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

Or

1. Select the System menu at the upper left 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 customer, 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.

Creating a New 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:
   • 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 accounts.
   • Contact Details - enter specific information for the current contact. When creating a new contact, it is necessary to enter the last name and email of the person you want to add.
   • Is Primary Contact - make the current contact the main contact person.
4. Once you're ready, select the Save to update the changes.

The contact will appear now on your Contacts list.

Creating a New 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:
   • Lead Details - enter specific information for the current lead. When creating a new lead, it is necessary to enter the last name and email of the person you want to add.
4. Once ready, select the Save to update the changes.

The lead will appear now on your Contacts list.

Updating Contact Information

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 More Options button from the toolbar and choose the Edit option from the contextual menu.
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.

About Contact Id

For every Contact created, a corresponding unique Contact Id is generated. It can be further used in Workflow steps parameters, when you want to reference a specific contact. In order to find the Contact Id for a contact, please follow the steps below:

1. Access the Contacts page from the People Module.
2. Select the More Options button corresponding to a contact and choose Properties option from the dropdown menu.

or

1. Access the Lists page from the People Module.
2. Navigate to the list that contains your contact.
3. Select the More Options button and choose Properties option from the dropdown menu.

Deleting a Contact/Lead

1. Access the Contacts page and select the contact you wish to delete.
2. Select the More Options button from the toolbar.
3. Select the 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.

Enabling Portal Access

If a contact was added in the Contacts list, the user will not be able to login to customer portal before an environment admin will give him permissions and this needs 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 Customer Portal.
3. Complete the form with the required fields from User dialog:
   • Username: choose a username to login in Customer Portal.
   • Generate password automatically: enable this option to receive by email the password. If you keep the option disabled, you should continue with the following fields:
     • Password: choose a password to login in Customer Portal.
     • Confirm Password: provide the same password for confirmation.
4. Once ready, select the OK to save the changes.

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

Configuring Portal User

1. Access the Contacts button from People Module.
2. Select the contact from the Contacts page list. From the toolbar, select the More Options button and choose Configure Portal User option in the dropdown menu.
3. Fill in the Portal settings form with the required fields:
   • Username: choose the username for logging in Customer Portal.
   • Enabled: check the option to have permissions in Customer Portal. *Reset Password: select this button if you forget your old password. You will receive a notification with the new password by email.
4. Once ready, select the OK to save the changes.

Now you have permissions to access the Customer Portal and login using the new credentials.

Importing Contacts

EngageCX provides the ability to load Contacts from a CSV file.

1. Access the Contacts page. Then, select the More Options button from the toolbar to choose Import from the contextual menu.
2. Select the Choose File button to browse for the .csv file.
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 duplicate contacts rows and add only unique contacts.
5. Once you're ready, select the 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, if needed.

Creating Documents

1. Access the Contacts page and select the contact for which you want to create documents.
2. Next, select the Compose button from the toolbar.
3. Choose a Communication Project from the New Document dialog, then select the Run. Additionally, you can use the Search bar from the top-right corner to look up for a specific project.
4. The Communication Run Page will open in a new page, where you have to fill out the form with the needed values. Here you are also able to see a preview of the output document on the right side. For more details about Communications, please visit the Communication section.

Viewing Contacts Activity

1. Access the Contacts page and select the contact for which you wish to revise its activity.
2. The Activity section on the right of the page lists all the individual activities of the current contact.
3. Select the Activity Filter and decide what assets you want to consider.

More Contacts Options

In the Contacts Page, you can select the More Options button, next to the contact name and access the following options:

• Open - to open the Contact page, that allows you view and update personal contact details or contact activity.
• Compose - to submit an interactive project.
• Delete - to permanently delete the selected contact from the list.
• Properties - to open a dialog that allows you to edit current contact information.

Multiple Contacts and Accounts

There are times when you may need to use the same contact for more than one company or one of your contacts might work on behalf of multiple companies. To be able to handle your opportunities in an easy manner, EngageCX allows you to create a complex business relationship between your accounts and contacts. The relationship is many-to-many, users are allowed to do both: set up a contact for more than one account, and set up an account for multiple contacts.

Adding more Contacts to an Account

1. Access the Accounts page and select the More Options button for an account.
2. Choose Properties from the contextual menu and select the Manage contacts hyperlink at the bottom of the dialog.
3. Select the Create new contact and fill out the form with new contacts details. Additionally, configure which is the primary contact in the selected account.
4. Once ready, select the Save to update the changes.

Adding more Accounts to a Contact

1. Access the Contacts page and select the More Options button for a contact.
2. Select the Properties from the contextual menu.
3. Tap the Account box and a drop-down list with all existing accounts become visible. Choose the account(s) in which you want to include the selected contact.
4. Once you're ready, select the Save to update the changes.

Lists

EngageCX

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

Accessing Lists

1. Access the EngageCX Enterprise Welcome Page and select the System button from the top-left corner.
2. Select the Lists option under 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.

Creating a New 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.

1. In the Lists page, select the +New List button from the toolbar.
2. Fill out the form with the appropriate values:
   • Name: provide a friendly list name.
   • Dynamic: enable the option only if you want the list to be dynamic.
   • Use Subscription: enable the option if you want your contacts to receive regular emails. Additionally, you can choose a Subscription Name and it will be visible in the Email Preference Center.
   • Subscription Name: choose a name for the subscription that will be visible in the Email Preference Center.
   • Public List: enable this option if you want to allow contacts to add themselves to this list.
   • +Add: select this button to set up other optional configurations:
     • Description: optionally, provide a description related to the purpose of the list.
     • Registration Forms: optionally, you can select to create a form that allows new contacts to register by email, to add themselves to the current list. In the registration form box, you will need to specify a project name and EngageCX will generate a project containing the customer form.
3. Once you're ready, select the Create to save the changes.

The List will appear on your Lists page. Now you can start adding contacts to it.

Static and Dynamic Lists

Using EngageCX, you can group your contacts into static or dynamic lists. 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. 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 Rule Principle is that: Contacts who match the criteria rules, are added to the dynamic list. Because of this, the same Contact can be present in multiple lists. These lists can be used as audience for Engagement automation.

There are two ways of filling in a static or a dynamic list: by creating a static or dynamic rule or by importing contacts from a CSV file. In this section you can learn how to do both, add contacts to a list or update a list with CSV contacts.

In the left side of the page, there is a Sidebar from where you can filter Lists by their type. For example, if you want to see only the group of Dynamic Lists, you should select the Dynamic Menu from the Sidebar.

Also, you can sort all the lists displayed in the Lists page by type criteria. If multiple sorting criteria are applied, the high-priority is received by the last criteria set.

Adding Contacts to 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 the Add Contacts button or choose the Add Contacts option from the More Options menu from the toolbar.
3. Select the +Add\Add by Criteria to create a rule for quickly adding contacts. Additionally, you can select the Additional Contacts field and all the contacts available will be displayed in a drop-down list from where you can choose.
4. Once ready, select the 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.

Adding Contacts to a Dynamic List

To create a Dynamic List, make sure to check the Dynamic option when creating the list.

1. In the Lists page, select the Dynamic Menu from the Sidebar to filter the lists results. Choose the list that you want to populate.
2. Select the Edit rules button or choose the Edit Rules option from the More Options button from the contextual menu.
3. Fill in the form with the required fields:
   • Rules: using contacts' parameters, create a dynamic rule after which your contacts will be added to the list. 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).
   • +Add: select this button for more additional configurations:
     • Include Additional Contacts and
     • Manually Exclude Contacts to manually add/remove contacts in/from the dynamic list, even if they meet the criteria rule.
4. Once ready, select the 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 kept updated.

Adding Contacts from CSV

EngageCX provides the ability to import contacts from a CSV file.

1. In the Lists page, select the static/dynamic list created.
2. Select the Add From CSV button or choose the Add From CSV option from the More Options menu from the toolbar.
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 Contacts fields available in the Contact Field drop-downs.
4. Check the Don't import duplicates to exclude duplicate contact rows and add only unique contacts.
5. Once ready, select the Import to save the changes.

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

Sending Mass Emails using Bulk Communication

1. Access the Lists page and select the list for which you want to send documents.
2. Select the Compose button from the toolbar.
3. Choose the Communication Project from the dialog, then select the Run. Optionally, you can use the Search bar to look up for a specific project.

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.

Subscriptions

Lists can also be used to manage users that subscribe to various updates, sent by your organization. In the EngageCX Platform, you can enable your contacts to opt in or out for the Lists they want to subscribe.

To enable the Subscriptions:

1. On the Lists module, select the list you want to edit.
2. Click on the More Options menu from the toolbar and choose Properties.
3. Check the Use Subscriptions button, then provide a unique subscription name for your list. The Subscription name will appear in the Email Preference Center, when a customer select to un\subscribe from your list.
4. Additionally, check Public List to make the list visible to all people, providing them the ability to auto subscribe to this list.
5. Once you're ready, select Save to update the changes.

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 Email Preference Center form. It will contain additional public lists which your customers can select to subscribe. The Email Preference Center is stored in EngageCX Projects.

More Lists Options

In the Lists Page, you can select the More Options button, next to the list name and access the following options:

View Contacts	Add Contacts	Edit Rules	Add from CSV
Send Bulk Communication	Delete	Properties	Clear List

View Contacts

Access this option to open the selected list and view all the contents included within.

Add Contacts

By accessing this option, you can add contacts in the selected static list.

Edit Rules

This option manages the current rule configured on the selected dynamic list.

Add from CSV

This option allows you to import contacts from a CSV file.

Send Bulk Communication

If this option is selected, mass emails are sent to all contacts included in the list.

Clear List

This option will remove all the contacts assigned to the current list.

Delete List

Select this if you want to permanently remove the selected list.

View List Properties

This option will open a dialog that allows you to edit the current list information.

Design

The Design module allows you to manage both, projects and workspaces, as well as the assets within.

Projects

EngageCX

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 you want to run communications through EngageCX. For example, if you are responsible for running a communication project with EngageCX Platform, this is the right place to create and add the required project's assets.

Accessing the Projects Module

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

or

1. Select the System button from the top-left corner.
2. Choose the Projects option under the Design module.

Once the Project page opens, you can easily navigate through your documents by using the default views hierarchically displayed within your workspaces from the Sidebar. To view all existing projects, select the All tab in the Sidebar.

Creating a New Project

Project names must be consistent and specific to a domain of your work, but 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 no restrictions in using special characters or spaces within the names of the projects. For example, Retail, Financial, Insurance, Telecom, etc.

1. In the Projects page, select the + New Project button from the toolbar.
2. Select the Blank template or a built-in template that best suits your needs. Select the Next to proceed with Project configuration.
3. Fill out the form with the appropriate values:
   • Name: enter a friendly name for your project.
   • Description: optionally, provide more information about the project you want to create.
   • Folder: select the Browse to navigate through EngageCX Platform and choose a destination for the project to be stored.
   • Options: if the Blank template is selected, you can have the ability to enable/disable the following options:
     • Users must fill out a form: this option provides a way to enter data manually before running a communication project.
     • Produce multiple documents at a time in batch: select this option if you want to produce documents for multiple customers from only one input data file.
4. Once ready, select the Finish to save the changes.

You will be redirected to the project content folder and you can start adding assets to it.

Project Assets

After a Project has been added to the EngageCX Platform, you can start editing its assets or adding new ones to meet your needs. A project can contains the following assets:

Document Templates	Email Template	Content Fragments
Form	Workflow

Publishing Multiple Projects

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 Publish feature comes in handy. This option offers an improvement of efficiency and consistency across environment processes.

Publishing a Communication Project to another Environment

1. Access the Projects Module from Enterprise Website.
2. In the Projects page, select the More Options button from the toolbar and choose the Publish option in the contextual menu.
3. Select the Communication Project(s) you want to publish from the list and optionally, you can also opt in to publish tags as well, by enabling Include Tags option. Select the Next button under Publish Wizard.
4. Fill in the Publish form with the required fields:
   • Select destination: provide the URL that EngageCX can use to publish the communication. The expected format is something like http://HostName:PortNumber.com(for example, http://ecrionserver:8094).
   • Username: provide the username for being able to log in and see the published communication.
   • Password: provide the password for being able to log in.
   • Environment: optionally, provide the environment's name, if the same username is used in multiple environments.
     Once all fields become completed, select the Next to fill in the last part of the Publish Wizard:
   • Target workspace: select from the available options in the dropdown list the workspace location where you want to publish your communication project.
   • Comments: optionally, you can add comments for the selected communication. These comments will be applied to all snapshots created for each individual communication.
5. Once ready, select the Publish button to save the changes and proceed with the operation.

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

Importing a Word Document

Using a Word document as the base for a Project Communication 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 fields highlighted, an email body (.epr file) and a workflow (.wk4 file) to produce documents.

Follow the steps below, to import a DOCX file as a template in your Communication Project:

1. In the Projects page, select the More options from the toolbar.
2. Choose the Import Word Document option from the drop down 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 ready, select the Import to successfully upload the file.

You will be redirected to the project content of the communication with all its assets that have been created based on the import operation.

Importing a Project

1. In the Projects page, select the More Options button from the toolbar.
2. Choose the Import Project option from the drop down 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 ready, select the Import to successfully upload the archive.

You will be notified if an error occurs and the communication project has not been imported. Otherwise, you will be redirected to the project content of the communication.

Creating from Workflow

EngageCX Platform allows you to add all the project assets and create the workflow before creating the projects themselves. If this is the approach that has been taken you will need to create the communication from a workflow.

1. In the Projects page, select the More Options button from the toolbar.
2. Choose the Create from Workflow option from the drop down menu.
3. Under the New Project dialog:
   • Select the type of communication that you want to use: Interactive, Batch, On-Demand or Analytics Dashboard.
   • Name: provide a friendly name for the communication project.
   • Description: optionally, provide additional information in the description box.
   • Workflow: select the Browse and choose a workflow to use in the current project folder.
4. Once ready, select the OK to save the changes.

The new communication project will be listed in the Projects list.

More Projects Options

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

Open	Test	Export	Versions
Lock-Unlock	Delete	Properties	Share

Open Project

This option allows you to open the Project page and view or edit all the assets included. To open a Project:

1. Select the More Options button next to the Project Name.
2. Choose Open from the contextual menu.
3. You will be redirected to the Project content.

Or

1. Access the Project page.
2. Select the Project you want to open from the Project list or Sidebar.

Test Project

This option will redirect you to the Communication Run page, from where you can configure and generate test documents. To test a Project:

1. Select the More Options button next to the Project Name.
2. Choose Test from the contextual menu.
3. You will be redirected to the Communication Run page.

Export Project

By selecting this option, a new zip archive will be downloaded on your local machine and it will contain all the communication assets. The ZIP file can be added therefore to other EngageCX environments, using the Import option. To export a Project:

1. Select the More Options button next to the Project Name.
2. Choose Export from the contextual menu.
3. A new Zip archive will be downloaded to your local machine.

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, e.g. from your development system to your production system. Versions can be created only for Projects. It is suggested, as a best practice, to create a version before any major edits or updates are 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 or delete 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.

To create a Version for a Project:

1. Select the More Options next to the Project Name.
2. Choose Versions from the contextual menu.
3. Select the +New Version from the Versions dialog.
4. Next, give the version a name and add some comments, if needed. The name of the Version will be the name of the folder created if Published to a new Environment.
5. Notice that the version created will be visible in the Versions list.

To export a Version:

1. Open the Project folder that contains the Version you want to export.
2. Select the Versions button from the toolbar.
3. In the Versions page, look after the version you want to export and select the More Options button, next to its name.
4. Choose Export from the contextual menu.
5. A Zip archive will be downloaded to your local machine.

To restore a Version:

1. Open the Project folder that contains the Version you want to restore.
2. Select the Versions button from the toolbar.
3. In the Versions page, look after the version you want to restore and select the More Options button, next to its name.
4. Choose Restore from the contextual menu.
5. Next, enter some comments and select the Restore button.

The snapshot version has been restored to the project.

To delete a Version:

1. Open the Project folder that contains the Version you want to remove.
2. Select the Versions button from the toolbar.
3. In the Versions page, look after the version you want to delete and select the More Options button, next to its name.
4. Choose Delete from the contextual menu, then confirm your selection.

The version will be removed from the Versions list.

To publish a Version:

1. Open the Project folder that contains the Version you want to publish.
2. Select the Versions button from the toolbar.
3. In the Versions page, look after the version you want to publish and select the More Options button, next to its name.
4. Choose Publish from the contextual menu.
5. Next, provide destination details:
   • In the Destination Server field, enter the URL that EngageCX can use to publish the version. It should use the following format: http://HostName:PortNumber.com (for example, http://ecrionserver:8094)
   • In the Username and Password fields, enter the credentials for an account that has sufficient authority to perform a publish procedure on the destination location.
   • Optionally, if the username is used for multiple environments, enter the Environment name.
6. The next step allows you to select the target workspace and a folder location to publish the version. If the Version's name is the same as a folder already in the destination Workspace, you have the following options:
   • Delete existing files: deletes the files included in the Version prior to writing them in the destination folder. This means the versions are lost in the target environment. If there are extra files in the destination folder they will remain untouched.
   • Delete only the files included in folder: deletes the destination folder, and all files within, prior to publishing the Version.
   • Create subdirectory with version name: add the Version content to a subdirectory that contains the Version name.
   • Include Tags - additionally, you can opt-in to publish tags as well. Tags are the keywords used to describe the content of a project.
7. Once ready, select the Next.

A notification dialog will display the succeeded status of the version 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 Enterprise Website.

For backup, restore and publishing to a different EngageCX instance or an 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, Enterprise Website 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.

Share Project

This option allows you to share the project content publicly or with your portal users. 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.

To share a project with other enterprise users:

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

1. Select the More Options button next to the Project Name.
2. Choose Share from the contextual menu.
3. Select the Get Public Link button. A new link has been generated.
4. Select the Copy to Clipboard and then send the link to the persons with whom you want to share the asset.
5. Once ready, select the Share to save the changes.

To share a project with portal users:

1. Select the More Options button next to the Project Name.
2. Choose Share from the contextual menu.
3. Select the Get Portal Link button. A new link has been generated.
   • Select the Copy to Clipboard and then send the link to the portal users with whom you want to share the asset.
   • Optionally, update the Title box to easily recognize the asset in the Portal User website.
   • The Portal Users box allows you to select from the existing portal users. If you want to distribute the resource to all portal users, check Everyone. Here, you can also edit the name of the template available and select the portal user for each you want to share the file. Check Everyone option and the project will be available for all portal users.
4. Once ready, select the Share to save the changes.

Lock-Unlock Project

This option allows you to restrict the way other users can use your project. When a project is locked, it can be viewed by other users, but its content cannot be edited. In general, an environmental administrators 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.

To lock a project:

1. Select the More Options button next to the Project Name.
2. Choose Lock\Unlock from the contextual menu.
3. Next, you can either lock all existing project files or check only those you want to prevent from editing.
4. Once ready, select the Apply to save the changes.

The project will be marked by the locked icon.

Delete Project

This option will delete the selected communication project and all the files included.

1. Select the More Options button next to the Project Name.
2. Choose Delete from the contextual menu.
3. Select the OK to confirm your selection and update the changes.

View Project Properties

Selecting this option will open a dialog that allows you to configure the Project's properties.

1. Select the More Options button next to the Project Name.
2. Choose Properties from the contextual menu.
3. A new dialog will be opened from where you can edit the project name, update the description or configure the way you want to view your produced documents.

Configure Run Mode

1. Access the Properties dialog of a project you want to configure.
2. Select from the Run Mode available options how would you like to display the communication project after its submission in Customer Portal. Based on the type of your project, you can select from different options of the Communication Run Preview, as follows:
   • Show Output: Select this option to display all documents generated once the communication is finished.
   • Show a Message: Select this option to display a custom message after the communication has finished generating the output.
   • Show a Summary: Select this option to display a summary overview of all documents produced.
   • Download Output: Select this option to automatically download the generated documents once the communication is run.
   • Preview Documents: Select this option to display a preview of all documents produced once the communication is finished.
   • Continue Editing: Select this option to display an editable version of all documents produced once the communication is finished.
3. Once ready, select the OK to save the changes.

Advanced Options

Advanced Options for a communication project help you configure the behavior of the output documents under the Customer Portal.

1. Access the Properties dialog of a project you want to configure.
2. Select the Advanced settings gear button, at the top-right corner of the dialog.
3. Here, you have the ability to configure template parameters or enable/disable different features for those projects that contains a form file, such as:
   • Show live preview: Preview while you work allows you to preview changes to your document before you commit to finalizing those changes.
   • Give documents a name: Provide a name for the documents generated after the communication is run.
   • Enable discussions: Customers can use discussions as a forum-like communication tool only if this feature is enabled.
   • Show versions button: View all the previously created versions for the communication project.
   • Show advanced menu: Enable the Advanced Menu in the Preview Mode.
4. Once ready, select the OK to save the changes.

Templates

Templates are .epr files created using either the EngageCX Publisher tool or using the Online Editor in EngageCX Platform. They describe the visual look & feel as well as the business rules that apply when producing a document dynamically from data.

To learn more about how to create a basic template using the Publisher tool, please visit the EngageCX Studio Publisher documentation. For Online Editor, please access the Online Editor chapter of this guide.

Within the templates created there may be content fragments, translation files, images and more. It is important to think about the best way to store these additional files in EngageCX, because they should be accessible when running a workflow, and should also be easy to find if they need to be modified.

Online Template Editor

Online Template Editor describes the layout of the final output of your documents that are being produced.

Accessing the Online Editor

There are a few ways to get to the Online Editor in EngageCX Platform.

From Projects

1. Within the Projects module, access the project folder containing the template you want to edit, then select the template to open it. (the .epr file format).
2. The template preview will open in a new page. Select the down arrow from the toolbar, then click the Edit Online option. You will be redirected to the online editor page.

By creating a new Template

1. Go to the Project module and access the project folder to which you want to add a new template.
2. Select the +New button from the toolbar, then choose the Document Template option.
3. Next, enter a friendly name for your template, and click Ok.
4. The document template will be added to the project folder and you will be redirected to the Template Editor.

Embedding Online Editor

EngageCX Solutions allows you to easily access the online editor through certain tags specified in a dedicated URL.

Here is an example of how the URL should look like:

http(s)://{Hostname|IPAddress:PortNumber}/EOS/EprEditor?embed=true&accessToken=XXXXXXXX&path=#workspace/{WorkspaceName}/{TemplatePath}

where the key parameters to be used are highlighted below:

• Hostname|IP Address - is the EngageCX Server Hostname/IP Address (e.g. companyABC.ecrion.com)
• Embed=true - is required for embedding the online editor within the URL
• AccessToken - is not required if it has been already used in Single Sign-On or OAuth
• WorkspaceName - is the workspace name where the template you want to access through the online editor resides. (e.g. Default)
• TemplatePath - is the template path in the given workspace. (e.g Retail/Bookstore Invoice/Invoice.epr)

For example, a complete URL should look as follows:

https://companyABC.ecrion.com/EOS/EprEditor?embed=true&accessToken=XXXXXXXX&path=#workspace/Default/Retail/Bookstore Invoice/Invoice.epr

Online Editor Components

EngageCX Platform provides various components that can help you create and design your templates to meet your organization's needs. There are two ways of adding new components to the Online Editor template: using the Sidebar, by drag and drop, or directly from the Editor design surface, by selecting the + sign. For particular instructions for each component, select the one you want to add from the table below:

Paragraph	Table	Image	List	Condition
Repeat	Page Break	Fragment	Field	Hyperlink

Paragraphs

A paragraph defines a section in a template. EngageCX templates are usually created by one or multiple paragraphs. All other elements used to create a template, such as static text, tables, images, etc., are included in paragraphs.

To add a new paragraph:

1. Access the Components tab from the Sidebar.
2. Select the Paragraph button, then drag and drop the element into the Design Surface.

Or

1. Select an area within the Editor design surface, then select the + button that appears on the left side.
2. Select the Paragraph option from the contextual menu.

The paragraph will now appear on your template.

To edit an existing paragraph:

1. Select the paragraph you want to edit in the Editor design surface.
2. Notice in the Sidebar that the Styles tab has been opened. Here you can access more advanced options, such as font options, remove option, borders edits or breaks.
3. When the modifications are finished, the updates are done automatically, and also they can be easily observed in your template.

Tables

Tables can be helpful when designing your templates for either positioning information on the page or placing content in rows for display information in individual cells.

To add a new table:

1. Access the Components tab from the Sidebar.
2. Select the Table button, then drag and drop the element into the Design Surface.
3. Within the Insert Table dialog, you will need to:
   • Add the number of rows and columns that you want your table to have.
   • Optionally, check the options to add a header or a footer to your table.
   • Click the Dynamic Table option to create a repeating dynamic table. You will be prompted to select the element(s) from the Data Source Tree, that will repeat in your table.
4. Once you're ready, select OK.

Or

1. Select an area within the Editor design surface, then select the + button that appears on the left side.
2. Select the Table option from the contextual menu.
3. Within the Insert Table dialog, you will need to:
   • Add the number of rows and columns that you want your table to have.
   • Optionally, check the options to add a header or a footer to your table.
   • Click the Dynamic Table option to create a repeating dynamic table. You will be prompted to select the element(s) from the Data Source Tree, that will repeat in your table.
4. Once you're ready, select OK.

The table will now appear on your template.

To edit an existing table:

1. Select the table you want to edit in the Editor design surface.
2. Notice in the Sidebar that the Styles tab has been opened. Here you can access more advanced options, such as borders, visibility or removing columns/rows/table.
3. When the modifications are finished, the updates are done automatically, and also they can be easily observed in your template.

Images

Using images for your business templates is worth a thousand words. One of the key components to designing a powerful piece of communication is having the capability to integrate images into your documents.

To add a new image:

1. Access the Components tab from the Sidebar.
2. Select the Image button, then drag and drop the element into the Design Surface.
3. Next, browse within the project's files or upload a new image from your local machine.

Or

1. Select an area within the Editor design surface, then select the + button that appears on the left side.
2. Select the Image option from the contextual menu.
3. Next, browse within the project's files or upload a new image from your local machine.

The image will now appear on your template.

To edit an existing image:

1. Select the image you want to edit in the Editor design surface.
2. Notice in the Sidebar that the Styles tab has been opened. Here you can access more advanced options, such as width, height, aspect ratio or changing the selected image.
3. When the modifications are finished, the updates are done automatically, and also they can be easily observed in your template.

Lists

Lists are useful when you create business documents as this help you structure your data in a concise and well-organized way.

To add a new list:

1. Access the Components tab from the Sidebar.
2. Select the List button, then drag and drop the element into the Design Surface.

Or

1. Select an area within the Editor design surface, then select the + button that appears on the left side.
2. Select the List option from the contextual menu.

The list will now appear on your template.

To edit an existing list:

1. Select the list you want to edit in the Editor design surface.
2. Notice in the Sidebar that the Styles tab has been opened. Here you can access more advanced options, such as alignment, list types, borders, removing lists or other custom list options.
3. When the modifications are finished, the updates are done automatically, and also they can be easily observed in your template.

Conditional Paragraphs

Conditional Paragraphs allow you to include entire paragraphs of content, both static and dynamic, into your output, entirely dependent upon your data source.

To add a new conditional paragraph:

1. Access the Components tab from the Sidebar.
2. Select the Condition button, then drag and drop the element into the Design Surface.
3. Within the Insert Conditional Paragraph dialog, you will have to set your initial condition by:
   • Selecting the field from your data source which you want to base your condition on.
   • Selecting an operator.
   • Based on the operator selected, you might need to add a value for your expression.
   • To create more advanced expressions, select the Advanced button. The new dialog provides you various functions, operators or parameters you can use in order to develop your complex expressions as you need.
4. Once you're ready, select the OK button to save the changes.

You can create also inline conditional paragraph, by selecting the Insert Element ( ) button from the Styles pane. If this is the case, you are able to configure the condition that you want to evaluate. The drop-down menu provides two options: the actual condition to be tested or the Otherwise statement.

Or

1. Select an area within the Editor design surface, then select the + button that appears on the left side.
2. Select the Condition option from the contextual menu.
3. Within the Insert Conditional Paragraph dialog, you will have to set your initial condition by:
   • Selecting the field from your data source which you want to base your condition on.
   • Selecting an operator.
   • Based on the operator selected, you might need to add a value for your expression.
   • To create more advanced expressions, select the Advanced button. The new dialog we provide you various functions, operators or parameters you can use within your complex expressions.
4. Once you're ready, select the OK button to save the changes.

The conditional paragraph will appear on your template. The content added to this paragraph will be visible in the preview only when the condition applied is met.

To edit a conditional paragraph:

1. Select the conditional paragraph you want to edit in the Editor design surface.
2. Notice in the Sidebar that the Styles tab has been opened. Here you can access more advanced options, such as formatting the conditional paragraph or adding additional conditions (by selecting the fx button from the bottom-left bar). Use the bottom-left bar to navigate through the Styles options for different components within the template.
3. When the modifications are finished, the updates are done automatically, and also they can be easily observed in your template.

Repeating Paragraphs

Repeating Paragraphs are an excellent way to display repeating content from your data source when you do not want this presented in a table format.

To add a new repeating paragraph:

1. Access the Components tab from the Sidebar.
2. Select the Repeat button, then drag and drop the element into the Design Surface.
3. Next, in the Data Source Tree, select the element after which you want to repeat your paragraph. To create an advanced repeating condition, select the Advanced button.
4. Once you're ready, select the OK button.

You can create also inline repeating paragraph, by selecting the Insert Element ( ) button from the Styles pane. If this is the case, you are able to configure the condition that you want to evaluate. The drop-down menu provides two options: the actual condition to be tested or the Otherwise statement.

Or

1. Select an area within the Editor design surface, then select the + button that appears on the left side.
2. Select the Repeating option from the contextual menu.
3. Next, in the Data Source Tree, select the element after which you want to repeat your paragraph. To create an advanced repeating condition, select the Advanced button.
4. Once you're ready, select the OK button.

The repeating paragraph will appear on your template. The content added to this paragraph will repeat in the preview based on the condition applied.

To edit a repeating paragraph:

1. Select the repeating paragraph you want to edit in the Editor design surface.
2. Notice in the Sidebar that the Styles tab has been opened. Here you can access more advanced options, such as formatting the repeating paragraph, editing the repeating condition or deleting the paragraph.
3. When the modifications are finished, the updates are done automatically, and also they can be easily observed in your template.

Page Break

A page break helps users to split the content in a document template.

To add a new page break:

1. Access the Components tab from the Sidebar.
2. Select the Page Break button, then drag and drop the element into the Design Surface.

Or

1. Select an area within the Editor design surface, then select the + button that appears on the left side.
2. Select the Page Break option from the contextual menu.

The page break will split your template content to the next page.

Fragments

Content Fragments or Fragments help you split large documents into smaller and more manageable pieces. Once you've created a content fragment, you can use it on multiple document templates, and more importantly, when you need to change something within that section, you will only need to change the content fragment and automatically all the templates that contain it, will be updated.

To add a new content fragment to a template:

1. Access the Components tab from the Sidebar.
2. Select the Fragment button, then drag and drop the element into the Design Surface.
3. Next, you can either browse for a fragment within your project's files or upload from your local machine.
4. When a new fragment is inserted, you need to select how the fragments should be displayed in the template (as a paragraph or inline, included in an existing paragraph), or specify the context in which the content fragments to be displayed.

Or

1. Select an area within the Editor design surface, then select the + button that appears on the left side.
2. Select the Content Fragment option from the contextual menu.
3. Next, you can either browse for a fragment within your project's files or upload from your local machine.
4. When a new fragment is inserted, you need to select how the fragments should be displayed in the template (as a paragraph or inline, included in an existing paragraph), or specify the context in which the content fragments to be displayed.

The content fragment will appear on your template.

To edit an existing content fragment:

1. Select the fragment you want to edit in the Editor design surface.
2. Notice in the Sidebar that the Styles tab has been opened. Here you can access more advanced options, such as formatting the content fragment, editing the fragment or deleting the fragment.
3. When the modifications are finished, the updates are done automatically, and also they can be easily observed in your template.

Fields

A Field is a placeholder in your template that is used at runtime to retrieve the information from your data source and insert into the document when rendered. Fields will show up in the Editor Design Surface by default, with a gray background and an XPath expression (the location of the information in your data source).

To add a new field:

1. Access the Components tab from the Sidebar.
2. Select the Field button, then drag and drop the element into the Design Surface.
3. Next, you will be prompted to select the field you want to add from your Data Source Tree. The Other tab provides you with built-in fields, such as Current Date/Time, Page Number, Page Count or the ability to create advanced expression. From the Format drop-down you can select from predefined formats for your fields.

The field will appear now on your template. At any time, you can change its value by clicking on it and selecting a new field from the Value field in the Sidebar properties.

To apply a format to your field:

EngageCX provides predefined formatting options to help you easily change the structure of your data source field to be presented the way you intend in the output.

1. Select the field you want to edit in the Editor design surface.
2. Click the Value field from the Styles pane in the Sidebar to edit.
3. On the bottom of the Edit Field dialog, you can find Format drop-down menu. Select one from the available options provided.
4. To create a custom formatting, select the More Formatting option from the drop-down and then choose Custom. Add the formatting type you want in the empty box. A new formatting type is created by using the # symbol to extract characters from the input string. For example, to format a Social Security Number (SSN), use ###-##-####. 123456789 will become 123-45-6789.
5. Once you're ready, click OK.

Hyperlinks

Within EngageCX templates, you can add hyperlinks to easily reference external contents.

To add a new hyperlink:

1. Access the Components tab from the Sidebar.
2. Select the Hyperlink button, then drag and drop the element into the Design Surface.
3. Next, enter the text you want to display in your output, and the URL address to the external resource, then select Ok.
4. In case you want to create an advanced expression as the URL of the link, you should select the Dynamic Value (fx) button.
5. From the Edit Expression dialog, click Advanced, next to the Address field, to create your expression based on the elements in the data source.
6. Once you're ready, select OK.

Data Source

Since EngageCX Platform allows you to use both, static and dynamic document templates, assigning and working with a data source is essential to your design process. The Data Tab from the Sidebar allows you to add different types of input useful in template creation. The data source file types supported are : XML Data and Schema Files (.xml, .xsd), Modeler Diagram Files (.edx), Form Files (.efd) or Spreadsheet Files (.csv, .xlsx).

To add a data source file:

1. From the Sidebar, select the Data tab.
2. Select the Browse (the three dots) button inside the Source field.
3. Choose the data source file for the template which you are going to design. You can also select the Upload File and import files from your local machine if needed

Your data source will be added on the Sidebar and you can start adding fields into your template.

Languages

For EngageCX templates you can set up multiple language translations, meaning that during the rendering process, a specific translation can be applied and all of the static text in your document will be replaced using the translation you set up.

To add a new language:

1. From the Sidebar, select the Languages tab.
2. Select the + button to add a new language to your template.
3. Select the language from the drop-down list.
4. The new language will be displayed in Languages list and available for further formatting.

To update a language translation:

Once a new language is added to your document template, you need to manually create the translation file, by following the steps below.

1. From the Languages tab, select the language you want to update.
2. In the Language Properties dialog, you can view all the existing document translations.
   • To add a translation, simply add the corresponding text inside the Translation box.
   • Optionally, you can set a language as default. By setting a language as default, you are changing the original language for your document template and all the defined translations for this language will be removed.
   • To delete a language, select the Delete Language. Note that the default language cannot be deleted.
3. Once ready, select the OK to update the changes.

Settings

Pages

To add a new page:

1. From the bottom of the Sidebar, select the Settings tab and then access Pages.
2. Select the + button to add a new page to your template.
3. Choose the desired format for the page: Letter, A3, A4 or A5.

You will notice that the page is added in the Pages list.

To update a page:

1. From the Sidebar, select the Settings tab and then access Pages.
2. Select the Page to be edited and then, the Settings gear button, next to it.
3. Choose the Edit option from the contextual menu.
4. The edit option that appears allows you to change the size, orientation or margins of the selected page.

To delete a page:

1. From the Sidebar, select the Settings tab and then access Pages.
2. Select the Settings gear button next to the page name you want to delete.
3. Choose the Remove option.

Sections

When designing your templates, it is extremely important to know how you want to build your document. Within EngageCX platform, you can choose how the content on a page is arranged through the Section option.

To add a new section:

1. From the bottom of the Sidebar, select the Settings tab.
2. Select the Sections option and then, select the + button to add a new section to your template.

To edit a section:

1. From the Sections tab, select the Settings gear button for the section you want to edit.
2. Choose Edit from the contextual menu.
3. Next, you will be able to adjust different section option such as
   • Select the Edit button next to the section to rename it.
   • Adjust printing options.
   • Make the section dynamic by selecting the fx next to the Static section field, and adding Conditions or repeating expressions for the section.

Fonts

When creating a template for EngageCX Platform, besides usual font files, you can also have the ability to insert external fonts to personalize your document.

To add a new font:

1. From the Sidebar, select the Settings tab and then access Fonts.
2. Select the + button to select an external font file. You can also upload a font file from your computer by selecting Upload File.
3. In the Add Font dialog, provide a name for the font and the path where you want to store the file, then select the OK to save the changes.

To edit a font file:

1. From the Sidebar, select the Settings tab and then access Fonts.
2. Select the font file you want to edit.
3. Provide a new name and a new path for the selected font file, then click OK to update the changes.

To edit a font file:

1. From the Sidebar, select the Settings tab and then access Fonts.
2. Select the Settings gear button next to the font name you want to remove.
3. Choose the Remove option.

Navigation Bar

The Navigation Bar is a component of the Online Template Editor that allows you to select a specific element in order to modify its attributes accordingly. When an element is selected in the Design Surface, you can notice the Navigation Bar displayed at the bottom of the page.

Saving your work

Whenever you add a new component to your document template or set up a customized element, it is important to save your work so the edits to be seen or changed later.
To save your template changes, simply select the Save button in the toolbar.

Previewing your template

At any time, you can preview the document template, like PDF, Word or HTML5 Smart Document. To preview your template, first make sure you have saved your edits, then select the Preview button in the toolbar, and choose the needed output.

Preview Settings

1. In Template Editor, select the Preview button from the toolbar.
2. Choose the Settings option from the contextual menu.
3. Select the Language for the preview format and set up your parameters, if any.
4. Once ready, select the Save to update the changes.

Content Fragments

Content 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.

To create a new content fragment:

1. Go to the Projects module and access the project you want to edit.
2. Select the +New button from the toolbar and choose the Content Fragment option.
3. Enter a friendly name for your content fragment, then select Ok.
4. The content fragment will be added to your project and you will be redirected to the online template editor.

To edit a content fragment:

1. Go to the Projects module and access the project containing the content fragment you want to edit.
2. From the project assets list, select the content fragment to edit (the .epb file format).
3. The Content Fragment preview will open in a new page. From the toolbar, select the Edit button to open the online editor for the selected fragment.

Content Library

The Content Library (Library) houses all of the content fragments found within a given workspace. The content library will be visible within template online editor, below the Components, under the Sidebar. If there are no Content Fragments listed you can create new fragments directly from Library, by following the steps below:

To create a new fragment:

1. In the Sidebar, under the Components tab, select the + sign, next to Library.
2. The Add Content Fragment window will open in which you need to:
   • Enter a name for your Content Fragment;
   • Set up the folder in which the fragment will be saved. By default, EngageCX will set up the location of the opened template.
   • Select an existing category or create a new one. Categories help you to easily find fragments within Library.
   • In the Content box, add the content you want for the fragment. You can use the options available to format and structure the content.
3. Once you're ready, select Ok.

Notice that the content fragment has been added to the Library.

To edit an existing content fragment:

1. In the Sidebar, under the Components tab, select the gear button next to the fragment name you want to edit.
2. Within the Edit Content Fragment dialog, you can edit the name of your fragment, the location, add it to other category or modify the content. For advanced edits, click the Open button. The content fragment will open in a new window from where you can select to edit it in Publisher or using Online Editor.

Email Template

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' template content.

To create a new email template:

1. Go to the Projects module and access the project you want to edit.
2. Select the +New button from the toolbar and choose the Email Template option.
3. Enter a friendly name for your email template, then select Ok.
4. The email template will be added to your project and you will be redirected to the Email Editor.

To edit an email template:

1. Go to the Projects module and access the project containing the email template you want to edit.
2. From the project assets list, select the email template to edit (the .ehtml file format).
3. The Email Preview will open in a new page. From the toolbar, select the Edit button to open the online editor for the selected email template.

Email Template Components

A default email template is very similar with a typical project template but requires you to enter some additional information, such as:

• The email address of the recipient, under the To area;
• The email address of the user filling out the form, under the From area;
• A subject for your email;
• Customized content.

Additionally, select the Components tab in the Sidebar to have access to more advanced options that allow you to build and particularize your email template according to your needs.

To add a new component:

1. In the Email Editor, access the Components tab from the Sidebar.
2. Choose one of the available components to insert into the email template and drag and drop each item into the Design Surface.
   • Text: insert a text field into the template.
   • Button: insert a button into the template. (for example, Submit button)
   • Image: insert an image into the template. (for example, the Company's Logo)
   • Left: split the row into two text fields as shown in the picture.
   • Right: split the row into two text fields as shown in the picture.
   • 2 Columns: insert by default, text fields in 2 equidistant columns.
   • 3 Columns: insert by default, text fields in 3 equidistant columns.
3. Once ready, you can proceed with configuring each one of the elements within the template.

To delete a component:

1. In the Email Editor, select the component that you want to remove from the Design Surface.
2. On the right side of the component, select the Delete button or go to Style Menu from the Sidebar and select the Delete.

Email Template Styles

For configuring components' properties within Email body, Style Menu from the Sidebar is the first choice. There you will find properties related to the selected component, to the row it belongs or styles of headings, body or paragraph of the email body template. The tables below list the available properties, grouped by components.

Text Properties

Paragraph	Background	Padding
Layout	Link	Heading

Button Properties

Action	Content	Padding

Image Properties

Action	Content	Background	Padding

Paragraph

The content inside a text element can be edited by setting up paragraph attributes such as Font Family, Font Size, Alignment, Line Height and Text Color.

Background

Both background properties are optional and they can be set under the Style tab after selecting a component in the Design Surface.

• The background-color property is used to specify the component's background color.
• The background-image property is used to specify the component's background image by using an URL and it is available only for the text element.

Padding

The component's padding is the space between its content and its border. Using the Padding property you can create extra space within the element.

By default, the Padding property has one value, but you can select the Expand button if you want to set four different values referred to as Top, Bottom, Right and Left.

Layout

For a faster mobile-friendly environment, you can use responsive display by enabling/disabling Hide on mobile option for showing or hiding elements on mobile devices.

Link

The Link property let you edit the content of a link within a text element, by configuring attributes such as Font Family, Font Size, Line Height and Text Color.

Heading

This property defines four levels of headings (h1, h2, h3, and h4). Attributes such as Font Family, Font Size, Line Height and Text Color can be set for any of the four levels individually.

Action

In case of Button element, the Action property let you specify the URL to where to send the form data after you submit it.

In case of an Image element, the Action attribute specifies the URL to where the user might be redirected when the image is clicked.

Content

The Content property for an Image element is used to insert a content for your component from the current workspace or upload a local file.

The content inside a Button element can be edited by configuring attributes such as Font Family, Text Color, Background Color, Font Size, and Alignment.

Row Properties

The Stack on mobile property ensures the elements on a row are positioned properly on mobile devices. If enabled, components will stretch to fill the entire height of the row and wrap when necessary.

Styles Properties

The following properties can be set as a general style for an entire couple of same elements. For example, if you have 2 headings set on 2 text components, one heading with red text color and the other one blue-colored respectively, you can set the Heading attribute within Styles properties to one color only, that will be inherited from both headings.

Body	Paragraph	Link	Heading

Body Style

The Body property defines the style to be used for all bodies within the same components. The attributes that can be configured for the component-box are Max Width, Background Color, and Shadow.

Paragraph Style

The Paragraph property defines the style to be used for all paragraphs within the same components. The attributes that can be set for the components' contents are Font Family, Font Size, Alignment, Line Height, and Text Color.

Link Style

The Link property defines the style to be used for all links within the same components. The attributes that can be set for the components' links are Font Family, Font Size, Line Height, and Text Color.

Heading Style

The Heading property defines the style to be used for all headings within the same components. The attributes that can be set for the components' headings are Font Family, Font Size, Line Height, and Text Color.

Quick Access Properties

You can have access to a contextual toolbar that contains some properties for Button and Text component if you double-click on the content within the element that you want to edit.

Bold	Italic	Link	Heading	Bullet

Bold Font

Select this property from the toolbar if you want to set the font style to Bold.

Italic Font

Select this property from the toolbar if you want to set the font style to Italic.

Add Link

Enable this option to add a hyperlink to the selected text.

Add Heading

Enable this option to set a heading level for the selected text within the component.

Add Bullet

Enable this option to add a bullet for the selected text within the component.

Email Template Data Source

The Data tree in the Email Editor should mimic the one in the Template Editor. Therefore, you can set a data source for your email template, by following the steps below:

1. Access the Data tab from the Sidebar.
2. Select the Browse button to choose a file for the data source.
3. You have two options to choose the data source file. You can either select from the files within the current workspace or select the Upload File and import a file from your local machine.
4. Once ready, select the OK to save the changes.

Once the data source is assigned, you can drag and drop any field from the data tree displayed on the Sidebar into the Design Surface. Text elements are treated as normal fields in the data tree, but one user cannot type in a field.

On the left bottom section of the Design Surface, you can select the View Source Code button, where you have access to the entire source code of the body of the email.

Workflows

Workflows 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, SMS, or web.

Accessing the Workflow Editor

There are a few ways to get to the workflow editor.

From Projects

1. Go to the Projects module and access the Project Folder containing the workflow you want to edit.
2. From the project assets list, select the workflow to edit (the .wk4 file format).
3. The Workflow Preview will open in a new page. From the toolbar, select the Edit to open the editor for the selected workflow.

By creating a new Workflow

1. Go to the Workspaces module and access a folder where you want to add a workflow file.
2. Select the +New button from the toolbar and choose the Workflow option.
3. Provide a friendly name for your workflow and optionally a description, then select the Create.
4. The workflow has been added to the workspace folder and you will be redirected to the Workflow Preview page.
5. From the toolbar, select the Edit and the editor will open in a new page.

Workflow Components

When building a workflow you will need to add different steps and stages to generate the output you desire.

Workflow Steps help you to define clear rules to meet your business processes; its allow you to create the life cycle that your document goes through from simple data to the required business goal. For this, you have to access the Side tab from the Sidebar, where you can add any of the components displayed, according to your needs by using drag and drop into the workflow design surface.

To add a new step:

1. Select the Steps tab from the Sidebar.
2. Within Components section, select the step you want to add, then drag and drop it into the workflow design surface. Additionally, select the More to view all the steps you can use within a workflow. The Steps section picture all the steps that are currently included in your workflow.

The step will now appear on your workflow.

To find out more information on each step, in particular, select the step you need from the table below:

	Get Data	Render	Email	Tag
	Archive	Copy to EOS Folder	Overlay	Custom
	Post to Social Media	Copy to Amazon S3	Decompress	Create Snapshot
	Create Correspondence	Publish Snapshot	Maintenance	Append
	Run Project	Create-Update People	If	Split
	Assembly	SMS	Index	Copy to Folder
	Copy to FTP	Print	Validation	Copy to SharePoint
	Electronic Signature	Render DITA	Delete Snapshot	Web Request
	Create Project	Group	Run Workflow	Extract Sub-Form Data
	Wait	Issue	Review Document	Task
	Review Snapshot	Get Files	Copy To Azure	Data Ingestion

To edit an existing step

1. In the workflow design surface, select the step you want to edit.
2. Next, navigate to the Properties tab in the Sidebar.
3. Here, you can view a series of basic and/or advanced properties specific to the selected step. In a nutshell :
   • To rename, click on the step name, then enter a new name.
   • To delete, select the Delete button, at the top-right of the Sidebar.
   • To add a description, select the +Add Step Description hyperlink. Adding a description to a step is helpful to ensure that any user fully understands what the step is configured to do.
   • For more advanced options, select the Switch to Advanced button.
4. Once ready, you need to connect the steps.

Connecting Workflow Steps

The workflow editor in EngageCX Platform does not provide an automatically connection between steps. So that, you have to connect them manually and try to create in the order they should appear.

If you find that you need to modify the order of your workflow steps after they are inserted or you are creating them out of order you can reconnect the steps in the Design Surface. To remove a connection, right click on the connection line and select the Delete connection. Also, from the drop down menu displayed after right-clicking on the connection line, you can set the status of Succeeded or Failed. If you decide what step should flow into another step, hover the mouse over the first component and drag the circle appeared on the edge of it, and drop into the second one.

Workflow Stages consists of one or more steps enclosed in a phase of more workflow scenarios.

To add a new stage:

1. In the workflow editor page, select the + Add stage button from the bottom.
2. Provide a representative Name for your phase, then press Enter.

To edit an existing stage:

1. In the workflow editor page, right-click on the stage you want to edit.
2. The contextual menu will provide you with basic options, such as:
   • Delete stage: to remove the stage from your workflow.
   • Rename stage: to enter a new name for your stage.
   • Color: to highlight the stage.

Workflow Parameters

Workflow Parameters will allow users to modify the name of the Job that the Workflow will create, as well as add custom input parameters that can be used throughout the workflow. Use workflow parameters when you need to pass as input: a customer ID, output format, language identifiers and more.

1. Access a workflow and select the Edit from the toolbar to access the Workflow Editor.
2. In the Sidebar, navigate to the Properties tab. Make sure that no step is selected.
3. Select the + Add Parameter button.
4. Enter a Name and a Default Value in the corresponding boxes.
5. Once ready, select the Save from the toolbar to update the changes.

Job Name Pattern

By default, the Job name will be a combination of the Communication name and date/time when the Job was run. If needed, you can change the default pattern by following the steps described below.

1. Access a workflow and select the Edit from the toolbar to access the Workflow Editor.
2. In the Sidebar, navigate to the Settings tab.
3. Click the Job Name Pattern field and update, as needed. Additionally, select the Dynamic Value(fx) button to create complex expressions, if needed.

Complex Expressions

The Complex Expression Dialog allows you to build dynamic values whenever a Dynamic Value (fx) button is present. You can select values from the Data Representation Tree or choose one or more predefined parameters.

The following predefined parameters groups are present:

Date
Year	Current year.
Short Year	Current year.
Month	Current month.
Short Month	Current month.
Day	Current day.
Hour in Day (24 hours)	Current hour, {HH} format. (Ex. 22)
Hour in half-day (12 hours)	Current hour, {hh} format. (Ex. 10 PM)
Minutes	Current minutes, {mm} format. (Ex. 12)
Seconds	Current seconds, {ss} format. (Ex. 20)
Milliseconds	Current milliseconds, {fff} format. (Ex. 126)

Standard
Guid	A uniquely generated value.
Job ID	The ID of the Job that is currently being run.
Position	The ordinal number in an enumeration. For example, a render step can receive multiple work items as input. You can use the position parameter to create an expression for each one of the work items.
Copy Position	The ordinal number in an enumeration that stores a copy.
Trigger File	If the executing workflow is started by a trigger this is the file that was retrieved by the trigger.
Trigger File Name Without Extension	If the executing workflow is started by a trigger this is the file that was retrieved by the trigger. The file name will be the same as the input file, without the extension.
Public Link	A uniquely generated URL for a file that is published either through the Customer Portal or as a public file. Note that the file still has to be tagged to become public.
Interactive Document URL	The URL path for the Interactive Communication Document type.
Input File Path	The path to the XML file that is the source work item for this step. Note that usually, this is the result of the Split step.
Communication Name	The name provided for the new Communication.
Enterprise URL	The URL path for the EngageCX Environment.
Portal URL	The URL path for the Customer Portal platform.
Running User - Username	The username of the person that started the workflow.
Running User - Email	The email of the person that started the workflow.

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. In EngageCX Software, the business rules are directly connected with the workflow and must be attached to one of the steps within. Otherwise, they become useless.

Creating a Business Rule

1. Access a folder within a workspace and select the +New button from the toolbar.
2. Select the Business Rules option from the contextual menu.
3. Provide a name and optionally a description for the rule. Once ready, select the Create to save the changes.

Business Rules Editor will open in a new page that allows you to manage rules and properties.

Adding a Business Rule to a Workflow

1. Access a project folder within Projects and open a workflow on which you need to add a business rule.
2. Select the Edit from the toolbar to access the workflow editor.
3. In the Workflow Editor, access the Settings tab from the Sidebar.
4. Select the Add Business Rules button to add an existing rule (.rules file format) to the current workflow. You can also upload a file from your personal computer by selecting Upload File button.
5. Once ready, select the OK to save the changes. You can add as many files as you want according to your needs. Notice that the path files are listed in the Business Rules section on the left.

Accessing the Business Rules 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. Choose the folder within the workspace where you have previously defined the business rule(s).
2. Select the business rule file (.rules file format) and select the Edit from the toolbar to open the Business Rule Editor.
3. Notice that you will be redirected to the Business Rules Editor where you can proceed with various configurations.

Working in the Business Rules Editor

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 to stay clear about what the rule is required to do.

Adding a Rule

1. In Business Rules Editor page, select the New Rule button from the toolbar.
2. Provide a representative description of your business rule and configure a condition for your rule by selecting the Dynamic Value button (fx).
3. Build your complex expression using the available fields of the Data Representation.
4. Once ready, select the OK to save the changes and successfully add the business rule to the list.

Adding a Property

1. In Business Rules Editor page, select the New Property button from the toolbar.
2. Provide a name and choose the Category from the drop-down list. If you need to add more Category types, please go to the Add a Category section.

Business Rules Settings

Configuring Languages

1. In Business Rules Editor page, select the Languages button from the toolbar.
2. The default language set for the rules is English, but you can easily change this property from Edit Language dialog, enabling Is Default option.
3. Configure another default language in the Edit Language dialog, too if needed.
4. To remove or edit a language you have to simply select it:
   • Select the Delete Language button in Edit Language dialog for removal.
   • Reconfigure the language in the Edit Language dialog.
   • Select the Add button (+) to create a new language entity.

Configuring the Data Source

1. In Business Rules Editor page, select the Data Source button from the toolbar.
2. Browse for a data source, either within EngageCX or on your local machine, that you need to add instead of the old one.
3. Once ready, select the OK to save the changes and successfully insert the data source file.

Display Settings

Adding a Category

1. In Business Rules Editor page, select the Categories button from the toolbar.
2. Select the Add button (+) from the Categories dialog.
3. Define a term that is establishing a category of the business rule and select the OK to save the changes.

Grouping

1. In Business Rules Editor page, select the Rules Grouped button from the toolbar.
2. Choose one of the two options in the drop-down menu, based on which business rules in the list will be grouped.
3. Notice in the Rules list a reordering of elements according to your preferences.

Filtering

1. In Business Rules Editor page, select the Filter button from the toolbar.
2. Choose the element(s) based on which you want to filter your business rules entities to be displayed in the list.
3. Notice in the Rules list a filtering of elements according to your preferences.

Editing a Value

1. Select the value from the Content column that corresponds to your business rule.
2. Provide a value for the content in the Edit Value dialog. You can also use a complex expression by selecting the Dynamic Value button (fx).
3. Once ready, select the OK to update the changes. You can remove the value associated with the business rule by accessing again the Edit Value dialog and select the Delete Value.

Save and Check in Changes

After you finished with all your business rules configurations, you have to select the Save button, then Check in to save and update the changes.

Revert

Revert option from the toolbar redirects you to the project folder that contains your analyzed business rule in the Editor.

Add Tag

Tags are keywords associated with a business rule from a workflow. These can be added manually and are useful when you want to find the needed content in a quick manner. For more details about adding a new tag to a business rule, please visit the Tags section.

Add to Favorites

As you start to work with many different business rules across many different Workflows in EngageCX Platform, you may want to customize your experience by marking specific rules as recently visited files. We call these Favorites in EngageCX, and you can access such business rules files directly from your Welcome Page whenever initially logging into the system. For more details about adding to favorites, please visit Add or Remove Favorite section.

Other Workflow Options

At any time you can use the toolbar or select the More Options button within the Workflow Editor to perform the following actions:

Save	Test Run	Run	Save as	Go to Folder	Share	Download
Versions	Dependencies	Copy	Move	Delete	Rename

Save Workflow

Select the Save button, located at the middle of the toolbar each time you make an edit operation to the workflow to update the changes.

Workflow Test Run

The Test Run option allows you to run the workflow while you develop it, without the need of being approved first if you have a workspace review and approval process set.

The test run will also limit the number of documents produced or sent, as follows:

• Produces maximum 10 files for a Render step;
• Produces maximum 10 files for a Split step;
• Sends maximum 10 emails;
• Produces maximum 10 prints;
• Produces maximum 10 files tagged;
• Produces maximum 10 files when using the Index output;
• Produces maximum 10 files when using the Merge step;
• Produces maximum 10 files when using the Group step;
• API cannot be used in test mode;
• The following steps are not available and will be skipped within test mode: Wait, Web Request, Electronic Signature, SMS, Copy to FTP, Copy to Amazon, Delete snapshot, Publish snapshot, Custom, Maintenance, Copy to Folder, Post to Social Media, Copy to Sharepoint, Create Project, Create snapshot, Copy to EOS, Create Interactive.

Save As Workflow

Select the Save As option from the More Options menu to save the workflow into another location within the workspace.

Run Workflow

This option allows you to run the workflow as it would be in a production environment. If you have a workspace review and approval set and do not have an approved workflow version you will receive an error. If you do have an approved version but have made edits to it, EngageCX will run the last approved workflow.

Go to Folder

Select this option to go back to the folder where this workflow is located.

Share Workflow

This option allows you to make the workflow public. Select the Share to generate a public link, then Copy to clipboard and send the link to the users wherewith you want to share the workflow.

Download Workflow

Select this option to download the workflow on your local computer.

Workflow Versions

This option allows you to view all the different Versions of the workflow. You will also be able to view and modify comments for each version or upload a new one.

Workflow Dependencies

Select this option to view all the directly-connected files with the workflow and also the files where it is used, in a separate tab.

Copy Workflow

Select this option to copy the workflow to a different folder within the workspace.

Move Workflow

Select this option to move the workflow to a different folder within the workspace.

Delete Workflow

Select this option to delete the workflow all together, but not until your confirmation of deletion.

Rename Workflow

Select this option to provide a new name for your workflow.

Workflow Steps

Automated Workflow steps are programmatic steps that do not require user intervention. When editing workflow steps within Sidebar, use the Switch to Advanced and Switch to Basic buttons to access more workflow step options.

Get Data

Getting your data is usually the first step in a workflow. In EngageCX, you can use XML files that are already uploaded into the repository, EngageCX forms (.efd files) created within Form Editor or data models (.edx files) created using the Modeler tool, which is part of EngageCX Studio. Data models created in Modeler can retrieve data from any data source including SQL databases, Web Services, spreadsheets and more.

• Source

  Select the Choose File button to navigate the file system and select the data source file you would like to use.

• Output file name

  Select the Add parameter button to change the name of the output data source file that is created. This step by default, will be set to rendering PDF. Additionally, select the Dynamic Value (fx) button to define a more complex expression for this field.

• Diagram Connection

  To view the Diagram connections inside your service model, you have to select the Switch to Advanced Menu, after you have selected an .edx file as a source of the data source. Then you should choose from the drop-down list the connection from where you want the diagram to be imported, after a valid connection is set up.

Render

The Render step produces the output documents. You can configure what type of output you would like to produce, what template to use, and other variables that will drive this production. In this section, you will have access to the different configuration options for each output type.

• Output format

  EngageCX allows you to render your documents in many different types of outputs. By default, the render step will be set to render PDF files.

  Notes

  Depending on the Output format you have selected, when switching to advanced, you will see different advanced parameters to modify. For more information on each of these visit Output Parameters]. However, there are a few standard parameters that are available for each output type.

• Template

  Use the Choose File button to search the EngageCX Repository, and select the data source you would like to use. If a template does not exist in EngageCX you have the option to upload one to the repository directly from the step.
  For example, let's assume you want to generate an output from the Loan Agreement template. Therefore you should use the Financial\Loan Agreement\Template.epr. If not available, visit the Project Ideas chapter to see how to install sample projects.

• Output file name

  By default, EngageCX will automatically assign the output file name as a combination of the input data source and its position. However, you can use the Output file name parameter to create a file name that works best for you. Please note that these names will need to be unique for each file, select the Dynamic Value (fx) button to the right of the field and add Date and or Standard Parameters to make the file name unique.

• Language Id

  When creating templates either using the EngageCXCX Studio Publisher or Online Editor, you are able to create multiple translation files to use with your template. This parameter allows you to indicate the translation id, so the parser to know what language to use when rendering documents. Note that this is only available for templates that have at least one translation file included.
  This can be a static value that you enter, or the value can be driven dynamically from the data source by selecting the Dynamic Value (fx) button to the right of the field.

• Retry count

  By default, if Render step fails within the workflow, a message error will be displayed. Retry Count parameter can be used in case of a failure at Render step level, by specifying the number of times this step must retry execution.
  For example, let's assume an error in rendering document is noticed. Therefore, you can set the parameter to 3 times of retrial process.

• XSLT Engine

  Select the transformation engine that you want to use in the workflow. You can select between MSXML, DotNet20, Internal or Saxon.

• Reference Resolver

  Reference Resolver Type is a collection of values that can be set to specify options for resolving references for elements such as page-number-citation, page-number, etc.. You can choose from: Disabled, Parallel, Serial and Optimized.
  When the Reference Resolver is set to Parallel, it is enabled as a separate thread. Setting it to Serial means that the Reference Resolver is enabled, but works on the same thread as the actual rendering process. A separate thread for the Reference Resolver is used for rendering time optimization. It runs parallel with the main rendering thread

• Run condition

  You are able to set a specific condition that when met will trigger the Render step to run and produce the necessary documents. You are able to type the expression directly into the field, or you can select the dynamic value button to the right of the field, to create a dynamic expression, using the assigned data source or the available dynamic parameters. For example, let's assume you want to restrict the render process to the condition statement where the "City" parameter finds "Annapolis" value in the data source. Therefore, you can use {XPATH:/ns:Accounts/ns:Account/@City = 'Annapolis'} as a parameter.

• Associate with Account(s)

  In EngageCX you are able to associate emails with different company accounts. This will allow you to select an account and view all rendered documents that were generated to them.

• Associate with Contacts(s)

  In EngageCX you are able to associate emails with different contacts. This will allow you to select a contact and view all rendered documents that were generated to them.

• Filter analytics data by Contact

  In EngageCX you can select certain pieces of data from the documents that are produced, according to Contact Criteria.

• IMDB Name

  Choose the XPath for database's name that stores in the computer’s main memory the produced documents.

• Image Errors

  Introduce images to fix issues that cause errors when rendering or exporting.

• Additional Copy Count

  This parameter setup will store the number of times that each document produced in Render step will be copied. For example, if Copy Count is set to 3, the workflow will duplicate the output document three times. In the end, you will be able to see 4 documents.

• Additional Copies Output Name

  You can use this parameter, in order to customize the name of the document copies. If no specified, the files generated will have the name of the original file duplicated, for example OutputName(number). For example, you can set this parameter to Guid to uniquely identify the outputs generated.

• Encoding

  Help you select the Encoding Type for Plain Text outputs. The encoding types you can select are ASCII, UTF 8 or UTF 16.

• Line Height

  Set up a value for the line height to increase or decrease the space above and below lines for Plain Text outputs.

• Trim Pages

  When the Trim Page parameter is set to true, from the plain text output will be removed the extra whitespace and tab spaces.
  When the Trim Page parameter is set to false, the extra whitespaces will be kept in the output.

• Ignore CSS Box Attributes

  When this parameter is set to true, all the box model elements(margins, borders, paddings) will be ignored in the output.

• Encode Compression

  EngageCX provides various options for compression, when generating TIFF outputs. You can choose from CA CCITT3, CA CCITT4, CA LZW, CA None or CA RLE.

• Include Images

  Use this parameter to include or not images into Email Body content. You can either embed the image or use a Content ID (CID).

• Fixed body width

  Use this parameter to specify whether to use a fixed width to approximate a paginated document layout or a fluid layout based on the window size.

• Fixed body align

  Use this parameter to align the email body to left, right or center.

• Code Page

  Use this parameter to select the Code Page type you want to use for IBM:MODCA outputs. You can choose between ACP Custom, ACP NotSet, ACP T1000808, ACP T1000892, ACP T1001250, ACP T1001252 or ACP T1V10500.

• Convert Fonts

  Use this parameter to convert fonts to Outline or Raster.

• Resolution

  Use this parameter to specify the default resolution(DPI). The value 0 means automatic. Available for JPEG, PNG and TIFF Outputs.

• Hide Static Content

  When this parameter is set to true, the parser will skip rendering the static content elements(headers, footers, etc.) in HTML output.

Data Ingestion

In EngageCX, you can use Data Ingestion to import data from an .edo diagram (Data Operations Diagrams) for immediate executions of data operations. The data processed by this step can be streamed in real-time or ingested in batches. This step returns XML files with the log of operations' statuses performed after the successful execution of the workflow.

• Source

  Select the Choose File button to navigate the file system and select the data source file you would like to use.

• Output file name

  Select the Add parameter button to change the name of the output data source file that is created. This step by default, will be set to rendering PDF. Additionally, select the Dynamic Value (fx) button to define a more complex expression for this generated file.

• Diagram Connection

  To view the Diagram connections inside your service model, you have to select the Switch to Advanced Menu, after you have selected an .edx file as a source of the data source. Then you should choose from the drop-down list the connection from where you want the diagram to be imported, after a valid connection is set up.

Email

Use Email to send all input work items via email to recipients that are either statically or dynamically (retrieved from input data) defined.

To send emails to multiple recipients use the Group step to create groups for each recipient. Each group can contain a single Plain Text or Email Body work item and 0 or more attachments.

• Queue

  Select an Email Queue to be used for delivery from the drop down menu.

• From

  In the basic parameters section, you are able to add a from email address statically.

• To

  In the basic parameters section, you are able to add a to email address statically.

• Email Fields

  Configure all remaining fields including 'From', 'To', Cc and Bcc addresses, and the 'Subject' for the email. Each aspect can be a static value or you can set them dynamically from the data source that is being used in the workflow by selecting the fx button.

• Subject

  In the basic parameters section, you are able to add an email subject line statically.

• Attachment Name

  You are able to specify the name for the attachment that will be sent with this email.

• Inherit attachments tags

  If your email content has tags, EngageCX allows them to be automatically inherited from the attachment.

• Send Attachments as Link

  Selecting this option will send any attachments as html links for the recipient to open.

• Send Condition

  You are able to set a specific condition that when met will trigger the email step to send the necessary email(s). You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.

• Associate with Account(s)

  In EngageCX you are able to associate emails with different company accounts. This will allow you to select an account and view all emails that were sent to them.

• Associate with Contacts(s)

  In EngageCX you are able to associate emails with different contacts. This will allow you to select a customer and view all emails that were sent to them.

• Email Body Validation

  To ensure that all emails are sent with an email body you can select to add validation to the emails. You have the option to either suspend any email ticket that does not have a body or fail the entire job and any email does not have a body.

• Attachment Validation

  To ensure all email attachments are sent properly you can select to add validation for the attachments. You can choose to allow emails to be processed without attachments, suspend any email ticket that does not have an attachment, or fail the entire job if an email does not have an attachment.

• Priority

  Use the Priority option to select the level of priority once the email is sent.

Tag

EngageCX allows you to add tags (metadata) to documents at the time they are rendered. Some of the tags you can can add have a predefined meaning in EngageCX, for example, when a document is tagged with a Contact ID, it will show up in the list of documents for that customer, in the Customer Module.

• Tag

  Select the tag you would like to be applied to the rendered document. Below is a list of the predefined tags in EngageCX:

	Name	Value	Description
	Public	{Guid}	This will create a unique ID to be used to create the public URL. The document will be accessible online without authentication, through an URL similar to the following:https://EngageCX4.ecrion.com:8097/EngageCX/PublicLink?publicId={GUID}&embed=true
	Contact ID	Contact ID	Associated this document with the specified contact. The contact ID can be statically added or pulled in for your data source.
	Account ID	Account ID	Associated this document with the specified account. The account ID can be statically added or pulled in for your data source.
	Portal Available	True/False	This will allow the document to be visible in the customer portal. Users have to be authenticated before accessing the document.
	Portal Category	Documents/Forms/Analytics	Choose where this document will be stored in the customer portal.
	Portal Title	Anything	Give the document a title that will be shown in the customer portal.
	Status	Anything	Stores the current status of its associated workflow.

• Run Condition

  You are able to set a specific condition that when met will trigger the Tag step to run and tag the necessary documents. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to apply tags only if the "Street" parameter from the data source is having a certain value. Therefore, you can use {XPATH:/ns:Accounts/ns:Account/@Street = 'Street1'} as a testing condition.

• Update tags

  You can perform later editing of tags content, that have already been associated with some rendered documents.

Archive

Use the Archive step to create a ZIP archive.

• Run condition

  You are able to set a specific condition that when met will trigger the Archive step to add the necessary documents to a zip file. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to deliver some Bookstore Invoice document to a certain client by email. Therefore, you should use
  {XPATH:/root/Invoices/Invoice/CustomerInformation/email = 'username@ecrion.com'} as a condition for add the specified data into an archive.

• Output File Name

  By default, EngageCX will automatically assign the output file name. However, you can use the Output file name parameter to create a file name that works best for you. Note that these names will need to be unique for each file, select the fx button to the right of the field and add Date and or Standard Parameters to make the file name unique.

Copy to EOS Folder

The copy-to-EOS-folder step allows you to send any project files to a destination folder located in the EngageCX Environment.

• Workspace

  You will need to select the EngageCX Workspace where the files should be stored.

• Path

  You will need to specify a path to an EngageCX folder where the files should be sent.

• Send condition

  You are able to set a specific condition that when met will trigger the Copy to Folder step to send the rendered documents to the selected folder. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume that you want to copy the output files for a specific "Type" attribute of Holding node-set. Therefore, you should define a condition based on {XPATH:/ns:FactSheet/ns:Holdings/ns:Holding/@Type}.

• Output File Name

  By default, EngageCX will automatically assign the output file name. However, you can use the Output file name parameter to create a file name that works best for you. Note that these names will need to be unique for each file, select the fx button to the right of the field and add Date and or Standard Parameters to make the file name unique.

Overlay

The Overlay step will allow you to add a one-page template which is rendered over the selected pages. This is helpful when adding watermarks or barcodes to specific pages in the document.

• Template

  Select the Choose File button, to search the EngageCX repository and pick the overlay template that should be used. If the template to use is not currently in EngageCX you have the ability to upload a new one directly from the step.

• Include

  Use the drop down list to select which pages should have the overlay included on them.

• Exclude

  Use the drop down list to select which pages should be excluded from the having the overlay.

• Output File Name

  By default, EngageCX will automatically assign the output file name. However, you can use the Output file name parameter to create a file name that works best for you. Note that these names will need to be unique for each file, select the fx button to the right of the field and add Date and or Standard Parameters to make the file name unique.

• Placement

  Use the options in the drop down to choose if the overlay is placed above or below the parent template.

• Run condition

  You are able to set a specific condition that when met will trigger the Overlay step to add a one-page template. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to add watermarks only if the invoice "number" parameter from the data source is having a certain value. Therefore, you can use {XPATH:/root/Invoices/Invoice/InvoiceProperties/number = '02116'} as a testing condition.

Custom

The Custom step will allow you to add custom command line code. Use the fx button to pass authentication token, Job ID, and other useful parameters.

• Command Line

  The Custom step may use the REST API as described in the Developer's Guide

  As a recommendation, you should put the used parameters between quotes, like this:

  <InstallationPath>\LogStep.exe -accessToken "{Token}" -jobid "{JobId}" -stepid "{StepId}" -steppath "{StepPath}".

• Timeout (in seconds)

  You may choose to add a max time for the step to run before it times out. This will ensure that the step and job do not continuously run if there is an issue with the custom step.

A Custom step should be used when all the other built-in Workflow steps cannot offer a satisfactory solution to a particular use case. Due to this type of step, clients have the ability to configure a specific behavior according to their needs.

For example, a client wants to send faxes. At this moment, EngageCX Solutions does not cover the scenario of configuring fax channels. Therefore, one client can design the following workflow:

• Get Data
• Render
• Custom fax (the rendered documents from the previous step will be used as input and will be further distributed through a fax channel following business logic, customized by the client)

Let’s assume a particular scenario for rendering PDF outputs from inputs received from an executable file. Those inputs will be written as access tokens in a log.txt file within the specified folder.

Step 1: Create the Application

Firstly, you have to create the application and for that, you have a wide variety of possibilities because it can be written in any programming language and the only limitation of the application is to have an executable file format.

Create a folder on your local machine, where you will store the application assets and the outputs produced by the Custom step.

Step 2: Integrate with EngageCX

In order to be able to use a .exe in the Workflow Editor, you should first declare it in the Custom Paths section from the Admin Settings page. For more details, please view the Custom Paths chapter.

Step 3: 3. Configure the Workflow

Finally, navigate to the folder location in the workspace where your workflow file is located. For setting up the parameters for the Custom step, you should open the workflow in the Editor. Drag and drop the Custom step from the Sidebar into the Design Surface and access its properties.

For configuring Custom step parameters, select the step in the Design Surface, then select the “Properties” Menu from the Side Bar.

Now, you can proceed with creating a communication and run the project you have just created. Once the communication was executed you should check for the document that is being produced after the execution of the workflow.

Post to Social Media

EngageCX will allow you to post messages and or images directly to your Social Media pages.

• Channel

  Select the Social Media channel to post to, such as Facebook.

• Access Token

  Provide the Access Token to be used. You are able to type the Token directly into the field, or you can select the fx button to the right of the field, and select the dynamic parameter for the ID used when configuring the connection.

• Page ID

  Provide the Page ID of the page to post the message to. You are able to type the Page ID directly into the field, or you can select the fx button to the right of the field, and select the dynamic parameter for the ID used when configuring the connection.

• Message

  Add a message to be posted to the Social Media site.

• Picture

  You can choose to add an optional image to the post. You can browse for a file from the EngageCX repository or select the fx button to the right of the field, and select the dynamic parameter for the input file. Selecting the dynamic parameter "{Input-File}" will use the image file that was rendered in a previous Workflow step.

• Run condition

  You are able to set a specific condition that when met will trigger the Post to Social Media step to post messages and or images directly to your Social Media pages. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to post a message only if the invoice "number" parameter from the data source is having a certain value. Therefore, you can use {XPATH:/root/Invoices/Invoice/InvoiceProperties/number = '02116'} as a testing condition.

Copy to Amazon S3

• Connection

  You will need to select a connection for the drop down list. If there is no connection, visit the Connections page to create a new Amazon connection.

• Destination Folder

  Supply the destination folder where the file(s) should be copied to in Amazon s3.

• Bucket Name

  Provide the name of the bucket to be used for this step.

• Output File Name

  By default, EngageCX will automatically assign the output file name. However, you can use the Output file name parameter to create a file name that works best for you. Note that these names will need to be unique for each file, select the fx button to the right of the field and add Date and or Standard Parameters to make the file name unique.

• Run condition

  You are able to set a specific condition that when met will trigger the Copy to Amazon S3 step to copy all the files directly on Amazon. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to add some invoices in Amazon S3 only if the "number" parameter from the data source is having a certain value. Therefore, you can use {XPATH:/root/Invoices/Invoice/InvoiceProperties/number = '02116'} as a testing condition.

• Amazon Metadata

  You can configure some system metadata for an S3 object that should be copied in Amazon.

Decompress

This step will extract files from a Zip folder. You can use this step to extract files form; a previous Archive step, a Zip archive such as one placed in a hot folder Trigger.

Create Snapshot

Create Snapshot will create a Snapshot of a folder and all the files contained within that folder.

Create Snapshot is commonly used as one of the Workflow steps in the Deploy Workflow that will be generated by EngageCX when the Deploy Custom Action is added to a Communication.

To read more information about Snapshots, please visit the Snapshot chapter of this guide.

• Workspace

  The workspace containing the project folder to create the snapshot of.

• Folder Path

  Provide the path to the folder to create a snapshot of.

• Snapshot Name

  A unique name for the snapshot to be created. You can also select the fx button to add Date and Time values.

• Run condition

  You are able to set a specific condition that when met will trigger the Create Snapshot step to create a Snapshot of a folder and all the files contained within that folder. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to create a snapshot only if the "number" parameter from the data source of an invoice is having a certain value. Therefore, you can use {XPATH:/root/Invoices/Invoice/InvoiceProperties/number = '02116'} as a testing condition.

Create Correspondence

The Create Correspondence step is used to combined Correspondence documents and Batch Communications. A use case for this would be having a monthly survey form for your customer to fill out.

You would use this step to produce those Correspondence documents in batch and push them to their personal Customer Portal page.

• Communication

  Select the Batch Communication from the drop down to be used to create the Correspondence Documents. For example, you can select the Fact Sheet.

• Contact ID

  The Contact ID will be used to publish the Correspondence Document to the correct Customer Portal. This will most likely be a value that is stored in the Data Source; to learn how to connect to EngageCX through the Modeler visit the EngageCX Modeler help guide.

• Title

  Enter a Title for the Correspondence Document that will be visible on the Customer Portal. This value can be static or you can select the fx button to select a value from your data source.

• Run condition

  You are able to set a specific condition that when met will trigger the Create Correspondence step to construct Correspondence documents. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to create a monthly survey correspondence only if the "number" parameter from the data source of an invoice is having a certain value. Therefore, you can use
  {XPATH:/root/Invoices/Invoice/InvoiceProperties/number = '02116'} as a testing condition.

Publish Snapshot

The Publish Snapshot step will publish the Snapshot, that was created in the previous Create Snapshot step, to a destination Environment and Folder as indicated by the parameters.

Create Snapshot is commonly used as one of the Workflow steps in the Deploy Workflow that will be generated by EngageCX when the Deploy Custom Action is added to a Communication.

When the Review and Approval is enabled, the step will be on Pending until an approved version of the communication is available. To read more information about Snapshots, please visit the Snapshot chapter.

• EOS URL

  The URL path for the EngageCX destination Environment.

• Workspace

  The path for the destination Workspace of the Snapshot.

• Access Token

  Provide the EngageCX access token.

• Folder Name

  Name of the folder that will be created to house the snapshot files in the destination Workspace.

• Delete Existing Files

  Selecting this option deletes the files included in Snapshot prior to writing them in the destination folder. This means the versions are lost in the target environment. If there are extra files in the destination folder they will remain untouched.

• Delete Folder Files

  Selecting this option deletes the destination folder, and all files within, prior to publishing the Snapshot.

• Include Tags

  In the Snapshot folder of a specified Communication, include also tags, inherited from the initial project folder.

• Run condition

  You are able to set a specific condition that when met will trigger the Publish Snapshot step to create the necessary snapshots for a communication project. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to publish a snapshot only if the "number" parameter from the data source of an invoice is having a certain value. Therefore, you can use {XPATH:/root/Invoices/Invoice/InvoiceProperties/number = '02116'} as a testing condition.

• Communication Name

  Provide the name of the Communication project for which you have to do a Snapshot.

• Communication Description

  Provide the description of the Communication project for which you have to do a Snapshot.

Maintenance

The Maintenance step will delete old jobs, based on the values indicated by the parameters, to reclaim storage space.

Using this step alone will allow you to create a Maintenance Workflow, which can be used as a Custom Action in a Communication.

• Older Than

  Provide the time frame for the Jobs that you want to overlook at the time the Workflow is run. The values for this field should be numbers.
  For example, let's assume that you want to clear storage after 3 months. Therefore you can use 3 as the timeframe for the maintenance process.

• Unit Type

  Select the Unit Type for the Other Than value.
  Based on the same example above, you should set this parameter to Months.

• Stages

  Filter the Jobs that will be deleted based on Job outcome. Available values are Aborted, Succeeded, Failed or Waiting for Input.
  For example, let's assume you want just "Failed" jobs to be deleted, not all of them. Therefore, you should set the parameter to Failed only.

• Communication

  You are able to select a communication from the drop down list to run this step for. If a communication is selected only the jobs for the selected communication will be affected.
  For example, let's assume you want to clear failed jobs just for Bookstore Invoice template. Therefore, you should set "Bookstore Invoice" as communication to which to apply this step.

Append

The Append step will allow you to add additional files to the end of the rendered documents. This is helpful if you need to add a static terms and conditions page or some other document without having to modify the template being used.

• File

  Select the file(s) to append to the end of the documents. If you are selecting more than one file to append, they will be added to the document in the order they appear in the step.
  For example, let's assume you have a Contract template used in the current workflow and you need to add the Loan Agreement that makes the contract possible. Therefore, you can use \Default\Financial\Loan Agreement\Template.epr to add an additional file to the final output.

• Run condition

  You are able to set a specific condition that when met will trigger the Append step to add the necessary documents to the existing documents. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to check in order to add the additional file, if the "FirstPaymentDate" attribute is less or equal than the current month meaning the first payment has already be done. Therefore, you can use {XPATH:/ns:root/ns:Form-Current/ns:form-submission/ns:content/ns:LoanAgreement/ns:Loan/ns:FirstPaymentDate}{MM}<={MM} as a condition of the step execution.

Run Project

The Run Project step will allow you to select a separate communication project to run.

• Communication

  This parameter allows you to choose from a drop down list the Communication project that needs to be run.
  For example, let's assume that you want to run a communication based on a Contract between a customer and your company. Therefore, you can choose the Contract template as a communication.

• Test Mode

  By selecting this option you will be running the selected communication as a test. This means that the number of outputs will be limited.

• Run Asynchronous

  Selecting this option will allow the selected communication to run while still allowing the rest of the tasks in the current workflow to run.

• Run condition

  You are able to set a specific condition that when met will trigger the Run Project step to execute a certain type of communication. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to run the Contract communication for a specific customer. Therefore, you can use a condition to restrict the starting of the step in the workflow, by using
  {XPATH:/ns1:Accounts/ns1:Account/ns1:Contacts/ns1:Contact/ns1:PortalCredentials/@LoginName ='username1'}
  in order to validate the "username" attribute of your desired client.

If

The If step allows you to set up a condition statement for the execution of a process or another step within the workflow.

• Expression

  You can configure a complex expression as a condition to test for workflow steps that follow.

Split

If your input data is in XML that contains nodes for multiple documents, you can use the Split step to produce several sub-XMLs, one for each document.

Example: Let’s assume your input data file contains the monthly invoice content for thousands of customers:

Invoices.XML

<invoices>
    <invoice account="Joe Doe">
    …
    </invoice>
    <invoice account="Mary Jane">
    …
    </invoice>  
    …
</invoices>

After running Split, a separate XML file will be created for each node that is a direct child of the root element:

Invoice01.XML

<invoice account="Joe Doe">
    …
</invoice>

Invoice02.XML

<invoice account="Mary Jane">
    …
</invoice>

… and so on.

• XML Node

  This parameter will allow you to select the exact node that EngageCX will use to create the sub-XMLs. By default, EngageCX will use the first repeating node as the split point.
  For our example, to generate the Invoice01.XML and Invoice02.XML, the value you need to add is
  {XPATH:/invoices/invoice}.

• Keep Context

  The Keep context option will ensure that when the sub-XMLs are created they follow the same structure as the original.

• Output file name

  By default, EngageCX will automatically assign the output file name as a combination of the input data source and its position, as shown above. However, you can use the Output file name parameter to create a file name that works best for you. Please note that these names will need to be unique for each file, select the fx button to the right of the field and add Date and or Standard_ parameters to make the file name unique.

• In memory

  When performing the Split step, the output documents will be stored in memory, not on the disk, resulting in faster rendering.

Get Files

The Get Files step is used to copy files from the disk drive to the EngageCX Repository. The copied files will become output for this step, and used as input for the next steps (e.g. Assembly).

• File Paths

  It is a mandatory step and receives as input a node that describes the location of a file from a disk drive. It allows the use of XPATH, as it is evaluated as a node-set. Additionally, XPATH can be used to bring multiple files to the EngageCX Repository. For example, select {XPATH:/root/file/@src} from the Data Source tree, where the XML file looks like this:

  < root>

  < file src="C:\GetFilesStep\ *.pdf"/>

  < file src="C:\GetFilesStep\Input.docx"/>

  < file src="C:\GetFilesStep\testIgnore.pdf"/>

  < /root>

  Search patterns are also supported (Supported wildcards: * and ?). To take all the files with the same file pattern, you can use *.{extension}. For example, this takes all the PDF files from the GetFilesStep folder: C:\GetFilesStep\*.pdf.
  To take all the files from a specified location, you can use *.*. For example, this takes all the files included in GetFilesStep: C:\GetFilesStep\*.*

• Ignore if not found

  Optionally, check this parameter if you want to ignore absent files at rendering time. By default, it is false.
  When false, the process will be stopped and the step will fail when the files do not exist on the disk drive or cannot be accessed.
  If true, the files that do not exist or are not accessible will be skipped, and the process will be finished with success.

Assembly

The Assembly step enables the creation of document bundles. These are useful mostly for generating print streams.

The usual options for steps after an Assembly step are Render or Overlay.

• Sort by expression

  This parameter will allow you to create a specific expression to sort the files before merging them together. To add an expression, you need to :

  • Type in the field in the Sort by box or click on the fx button from the right and select the field you want to create the sorting from the Data Source Tree.
  • Select if you want to order ascending or descending.
  • Select which data type are you using : strings or numbers.

  For example, let's assume you want to sort your data by setting a filter criterion based on "Type" field of the Account. Therefore, you can use {XPATH:/ns:Accounts/ns:Account/@Type} as "Sort by" parameter and evaluate only the string values data types.

• Sort by page count

  This parameter will sort the documents by the number of pages that have been rendered before merging them into a single document. You can choose to either sort by ascending or descending page counts.

• Group by Expression

  This parameter will allow you to create a complex expression to group the files by before merging them together. This is useful, for example, when you need to perform house-holding (group multiple statements that must be sent to the same address). Therefore, you can use {XPATH:/ns:Accounts/ns:Account/@Street} as a filter criterion for grouping.

• Group by Page Count

  This parameter will group the documents by the number of pages that have been rendered before merging them into a single document.

• Split by Max Output Page Count

  Sometimes, when merging files together, the resulting file is too large to be used as is. Using the split by page count parameter will allow you to select how many pages should be merged together before creating a new merged file.

  Notes

  This feature will never split a rendered document. For example, if you set the split page count to be 100, if the next merged document takes the count from 97 to 103, EngageCX will not split that last document, having part with the first merged document and the rest the next. EngageCX will trim the first merged document at 97 and start fresh.

• Split by Max Output Size

  Sometimes, when merging files together, the resulting file is too large to be used as is. Using the split by max output size parameter will allow you to select the max size of the file before it is merged together.

  For example, let's assume you want to have a size restriction of 100 MB. Therefore, you can use 100 as the Maximum output size for evaluating your resulting file.

• Output File Name

  By default, EngageCX will automatically assign the output file name as a combination of the input rendered files and position. However, you can use the output file name parameter to create a file name that works best for you.

  Notes

  This name will need to be unique if you are using the split by page count parameter mentioned above. To do so, select the fx button to the right of the field and add Date and or Standard Parameters to make the file name unique.

• Force Page Count

  This parameter is used to impose constraints on the number of pages in an output document. If this constraint is not satisfied, an additional page/pages will be added at the end of the document. The following values are available:

  • auto
  • even: Forces an even number of pages in the output.
  • odd: Forces an odd number of pages in the output.
  • end-on-even: Forces the last page in the output to be an even-page.
  • end-on-odd: Forces the last page in the output to be an odd-page.
  • no-force: Does not force either an even or an odd number of pages in the output.
  • multiple-of(x): The behavior is similar to force-page-count="odd". The number of pages in the output will be a multiple of the "x" integer set as value.
  • end-on-multiple-of(x): The behavior is similar to force-page-count="even". It forces the last page in the output to be a multiple of the "x" integer set as value.

• Duplex

  This parameter specifies whether the final output should be printed in duplex mode. The default value is false.

• Media Color

  This parameter specifies the color to use for printing. The default value is none.

• Run Condition

  You are able to set a specific condition that when met will trigger the Assembly step to run and produce the necessary documents. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.

  For example, let's assume you want to assembly documents only if the "Street" parameter is having a certain value. Therefore, you can use {XPATH:/ns:Accounts/ns:Account/@Street = 'Street1'} as a testing condition.

SMS

• Queue

  Select an SMS Queue to be used for delivery from the drop down menu. If there is no SMS connection created, please visit the Connection chapter to find out how to create an SMS connection.

• To

  Provide the number for the recipient of the SMS message. This parameter can be a static value or you can set it dynamically from the data source that is being used in the workflow by selecting the fx button.

• SenderID

  Provide the value ID that appears on customer's phones to show from whom the SMS is.

Index

The Index step will allow you to create a custom CSV file. This will log the selected values from the rendered data source.

• Column

  You will need to provide a Column name and the data to be captured in that column. Select the fx button to choose a value from the corresponding data source or one of the predefined parameters.

• Run Condition

  You are able to set a specific condition that when met will trigger the Index step to run. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to log values only if the invoice "number" parameter from the data source is having a certain value. Therefore, you can use
  {XPATH:/root/Invoices/Invoice/InvoiceProperties/number = '02116'} as a testing condition.

Copy to Folder

The copy-to-folder step allows you to send any project files to a destination folder. If you are working with our hosted version, this step will send the files to a folder on our server. If you are working with our custom version, you can send the files to a folder on your server or locally on your machine.

• Path

  You will need to specify a path to either a local or network directory where the files should be sent.

• Send condition

  You are able to set a specific condition that when met will trigger the Copy to Folder step to send the rendered documents to the selected folder. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.

• Output File Name

  By default, EngageCX will automatically assign the output file name. However, you can use the Output file name parameter to create a file name that works best for you. Note that these names will need to be unique for each file, select the fx button to the right of the field and add Date and or Standard Parameters to make the file name unique.

Copy to FTP

EngageCX can also accommodate the need to push files to the host of your choosing using File Transfer Protocol (FTP). With this step, you can configure a few simple parameters for host URL and login credentials, and EngageCX will send the files of your choosing to the host specified.

• Connection Type

  You must specify the type of connection to be used, either FTP or SFTP.

• Connection

  You will need to select the connection to use from the list available.

• Destination Folder

  Supply the destination folder where the file(s) should be copied to.

• Send condition

  You are able to set a specific condition that when met will trigger the Copy to FTP step to send the rendered documents to the selected FTP folder. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a dynamic expression, using the assigned data source or the available dynamic parameters.

• Output File Name

  By default, EngageCX will automatically assign the output file name. However, you can use the Output file name parameter to create a file name that works best for you. Note that these names will need to be unique for each file, select the fx button to the right of the field and add Date and or Standard Parameters to make the file name unique.

Print

• Printer Name

  Provide the name of the printer to be used for this step. You are able to type the name directly into the field, or you can select the fx button to the right of the field, to pull the name from the assigned data source.

• Queue

  Select a Print Queue to be used from the drop down menu.

• Send condition

  You are able to set a specific condition that when met will trigger the Copy to FTP step to send the rendered documents to the selected FTP folder. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a dynamic expression, using the assigned data source or the available dynamic parameters.

• Input Tray

  Provide the name of the input tray to be used for this step. You are able to type the name directly into the field, or you can select the fx button to the right of the field, to pull the name from the assigned data source.

• Manual Tray

  Provide the name of the manual tray to be used for this step. You are able to type the name directly into the field, or you can select the fx button to the right of the field, to pull the name from the assigned data source.

• Printing Mode

  Use the drop down menu to select the printing mode to be used for this job. - Auto: Selecting this will use the default settings from the printer itself. - Simplex: This will print the document as single sided. - Duplex: This will print the document double sided.

• Color Mode

  Use the drop down menu to select the color mode to be used for this job. - Auto: Selecting this will use the default settings from the printer itself. - Color: This will print the document in color. - Monochrome: This will print the document in gray-scale.

• Orientation

  Use the drop down menu to select the orientation to be used for this job.

• Copy Count

  You are able to provide the number of copies you would like to make this job. If nothing is added to this parameter only 1 copy will print.

• Collate

  Use the drop down menu to select if you want this document to print collated or not.

• Associate with Account(s)

  In EngageCX you are able to associate print files with different company accounts. This will allow you to select an account and view all files that were created for them.

• Associate with Contact(s)

  In EngageCX you are able to associate print files with different contacts. This will allow you to select a customer and view all files that were created for them.

Validation

The Validation step will check the XML file introduced as a data source if corresponds to the format of a .xsd file. In this way, you can obtain a faster information if an error might be occurring, without having to perform all the steps in the Workflow.

• Source

  EngageCX allows you to compare the .xml file, where you, in a previous step (ex. Get Data) retrieve data from, with the format of an XML schema diagram that must be uploaded from your local machine.

Copy to SharePoint

EngageCX can also accommodate the need to push files directly to a SharePoint folder.

• Connection

  You will need to select a connection for the drop down list. If there is no connection created, please visit Connections to find out how to create a sharepoint connection.

• Destination Folder

  Supply the destination folder where the file(s) should be copied to in SharePoint.

• Run condition

  You are able to set a specific condition that when met will trigger the Copy to SharePoint step to push files directly to a SharePoint folder. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to add some invoices in a SharePoint folder only if the invoice "number" parameter from the data source is having a certain value. Therefore, you can use {XPATH:/root/Invoices/Invoice/InvoiceProperties/number = '02116'} as a testing condition.

• Output File Name

  By default, EngageCX will automatically assign the output file name. However, you can use the Output file name parameter to create a file name that works best for you. Note that these names will need to be unique for each file, select the fx button to the right of the field and add Date and or Standard Parameters to make the file name unique.

Copy To Azure

EngageCX can also accommodate the need to push files directly to an Azure Storage Blob container.

• Connection

  You will need to select a connection from the drop-down list. If there is no connection created, please visit Connections to find out how to create an Azure connection.

• Destination Container

  Supply the destination container where the file(s) should be copied into the Azure storage.

• Destination Folder

  Supply a pseudo-folder as a destination, inside the container, where the file(s) should be copied to. In this way, you can create a hierarchy through the file system storage and your files will be better organized.

• Output File Name

  By default, EngageCX will automatically assign the output file name. However, you can use the Output file name parameter to create a file name that works best for you. Note that these names will need to be unique for each file, select the fx button to the right of the field and add Date and/or Standard parameters to make the file name unique.

• Send condition

  You are able to set a specific condition that when met will trigger the Copy To Azure step to send the rendered documents to the selected folder. You are able to type the expression directly or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters. For example, let's assume that you want to copy the output files for a specific "Type" attribute of Holding node-set. Therefore, you should define a condition based on {XPATH:/ns:FactSheet/ns:Holdings/ns:Holding/@Type}.

• Azure Metadata

  EngageCX allows you to configure some system metadata that would be copied into Azure. When adding Azure metadata, you have to specify a Name, in the upper area, which should be simple and not contain special characters, and a Value, on the bottom area, which can be static or dynamic.

Electronic Signature

This workflow step can be used if you need to collect electronic signatures for your document. As a prerequisite, you will need to make sure that you have configured an Electronic Signature connection. The section below will highlight the steps to set up and work with an electronic signature provider (DocuSign, EcoSign, etc.) in EngageCX.

• Signature Provider

  You will need to select a provider from the list of configured Signature Providers.

• Subject

  Provide a subject for the notification sent to who needs to sign the document.

• Message

  Provide a Message for the notification sent to who needs to sign the document.

• Wait for signatures

  By checking this option and if you will check the checkbox Wait for signatures, you will need to configure the callbacks, otherwise, the workflow will never finish.

• Run condition

  You are able to set a specific condition that when met will trigger the Electronic Signature step to collect electronic signatures for your document. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to collect electronic signatures only if the "number" parameter from the data source is having a certain value. Therefore, you can use {XPATH:/root/Invoices/Invoice/InvoiceProperties/number = '02116'} as a testing condition.

Render DITA

• Source DITA Files

  Provide the source for the DITA files to render.

• Transform type

  From the drop down list provided select the output type to transform the DITA files to.

• DITA Parameters

  Use this section to add any DITA specific parameters that might be needed.

Delete Snapshot

The delete snapshot step will need to be after a create snapshot step in the workflow. This step will delete the snapshot that has been created by this workflow.

To read more information about Snapshots, please visit the Snapshot chapter.

• Workspace

  Provide the name of the workspace containing Snapshot to be deleted.

• Folder Path

  Provide the path to the folder where the snapshot is located.

• Snapshot Name

  Provide the name of the snapshot to be deleted by this step.

• Run condition

  You are able to set a specific condition that when met will trigger the Delete Snapshot step to remove a Snapshot of a folder and all the files contained within that folder. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to delete a snapshot only if the "number" parameter from the data source of an invoice is having a certain value. Therefore, you can use {XPATH:/root/Invoices/Invoice/InvoiceProperties/number = '02116'} as a testing condition.

Web Request

The Web Request step will output the files uploaded in the step folder, similar with the Custom step.

• Url

  Stores the URL Parameter from a Web Request.

• Method

  Choose from the predefined HTTP methods or create a complex expression as one.

• Content

  Specifies the format (ex. JSON) of the data gathered from a GET request, the way in which it might be structured.

• Header Parameter

  HTTP headers allow the clients and the server to pass additional information with the request or the response.

• Body Parameter

  There can be an unlimited number of key-value pair body parameters, that are parsed when the web request has been sent. These parameters are specific for each HTTP request.

• Custom Body

  The purpose of this parameter is to let the user, the freedom to choose the view of the HTTP request body. This cannot be used with Body Parameter.

• Run condition

  You are able to set a specific condition that when met will trigger the Web Request step to call the specified HTTP Request. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  
  For example, let's assume that you want to make an HTTP request only if the "number" parameter from the data source of an invoice is having a certain value. Therefore, you can use {XPATH:/root/Invoices/Invoice/InvoiceProperties/number = '02116'} as a testing condition.

Create Project

This step will create a new Communication Project in the destination Environment as indicated by the values in the parameters.

Create Project is commonly used as one of the Workflow steps in the Deploy Workflow that will be generated by EngageCX when the Deploy Custom Action is added to a Project.

• Communication Type

  Select the type of communication that will be created.
  For example, let's assume that you want to create an Invoice template as a result of this step. Therefore, you should select Batch as the type of communication.

• Communication Name

  Provide a name for the new Communication.

  Based on the example above, you should write the name of the selected communication, e.g. Bookstore Invoice.

• Communication Description

  Provide a description of the Communication.

• Override Communication

  Toggle this on to allow the newly created Communication to override a previously created Communication with the same name.

• EngageCX URL

  The URL path for the EngageCX Environment where the Communication Project will be created.

• Access Token

  Provide the EngageCX access token.

• Workspace

  The path for the Workspace where the Workflow used to run the Communication will be held.

• Workflow Path

  The path for the Workflow used to run the Communication will be held.

Group

The Group step will aggregate the input work items according to a given criterion.

• Expression

  Group criteria to use such as an account number, customer email address or Input File Path. For more details see the complex expression dialog.
  For example, let's assume that you want to group Fact Sheets according to their "Country" attribute. Therefore, you can use {XPATH:/ns:FactSheet/ns:Holdings/ns:Holding/@Country} as a criterion of grouping.

• Additional Includes Expression

  You have the ability to add an expression for any additional files that should be added to the group other than the ones specified in the main expression.

• Page Count

  This parameter will group the documents by the number of pages that have been rendered before grouping them together.

• Output Size (MB)

  Sometimes, when grouping files together, the resulting file is too large to be used as is. Using the output size parameter will allow you to select the size of the group.

• Group condition

  The conditional sequence that can be also configured as a complex expression to limit the performing of a certain Group criterion.
  For example, let's assume that you want to restrict the already existent grouping criterion to a specific "Country" attribute in the data source. Therefore, you can use {XPATH:/ns:FactSheet/ns:Holdings/ns:Holding/@Country}="Romania" as a condition.

Run Workflow

The Run Workflow step will allow you to select a separate workflow to run. This task is very helpful when creating a review and approval workflow. It will allow you to generate the output from a workflow and send it to a user or group for them to review without needing technical knowledge of how the system works.

• Workflow File

  EngageCX allows you to upload a new workflow file, under the current one.

  For example, let's assume that you want to create a "contact" after you have a contract with one of your clients. Therefore, you can use another workflow that gets Customer's data from a different data source and stores the information in the database.

• Workflow workspace

  Provide the name of the Workspace project that houses the workflow needed to be executed. By default, after selecting the Workflow file, the workspace will be automatically identified.

• Test Mode

  By selecting this option you will be running the selected workflow as a test. This means that the number of outputs will be limited.

• Run Asynchronous

  Selecting this option will allow the selected workflow to run while still allowing the rest of the tasks in the current workflow to run.

• Run condition

  You are able to set a specific condition that when met will trigger the Run Workflow step to execute another specified .wk4 file under the same workflow. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you have a workflow inside a workflow and for the inner one you want to set a condition based on the existence of a contact. Therefore, before you actually create the contact, you should use {XPATH:/ns1:Accounts/ns1:Account/ns1:Contacts/ns1:Contact != 'MyContact'} and verify if the contact is not already in the data source.

Extract Sub-Form Data

• Source

  Choose the sub-form from which you would like to extract data.

  For example, let's assume that you want to extract data from a Loan Agreement form, where the client input some values. Therefore, you can use \Default\Financial\Loan Agreement\Form.efd as a parameter.

Create-Update People

• Accounts

  Creates an Account record and uses the data source's dynamic values to pull the desired information from the parent into the Account record.

  For example, you can add an account representing the customer of a Fact Sheet template, from the parent node-set "Statements" and use
  {XPATH:/ns:Statements/ns:Statement/ns:Account/@AccountType}.

• Contacts

  Creates a Contact record and uses the data source's dynamic values to pull the desired information from the parent into the Contact record.

  For example, you can add a contact representing the client of a Loan Agreement template, from the parent node-set "Accounts" and use
  {XPATH:/ns1:Accounts/ns1:Account/ns1:Contacts/ns1:Contact}.

• Accounts Field

  Allows you to set Account's parameter values according to the parent record.

  For example, you can update the "Account" data field that is already introduced, with a "name" attribute. Therefore, you can use
  {XPATH:/ns1:Accounts/ns1:Account/ns1:Properties/ns1:Property/ns1:Name}.

• Contacts Field

  Allows you to set Contact's parameter values according to the parent record.

  For example, you can update the "Contact" data field that is already introduced, with a "name" attribute. Therefore, you can use
  {XPATH:/ns1:Accounts/ns1:Account/ns1:Contacts/ns1:Contact/ns1:Properties/ns1:Property/ns1:Name}.

Wait

• Duration in Seconds

  You may choose to add a certain period of time (in seconds) between steps, that run one after another. This will ensure that the previous step has finished its running period by the time the next step starts.

  For example, you can use this step to suspend the workflow until a defined event has occurred.

Issue

• Assign To

  Select from the drop down list to assign the step to a user or a group of users within the current environment.

• Title

  Provide a relevant title for your issue.

• Step description

  Provide a description of the step purpose in the current workflow.

• Comment

  Enter additional information about the Issue step.

• Comment Attachments

  Select the Dynamic Value button - fx to add attachments for your comments that you want to insert.

• Notification Recipients

  Within Notification Recipients box, you can add the email addresses of other users that you want to collaborate to the current step.

• Run Condition

  You are able to set a specific condition that when met will trigger the Issue step to run. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to run Issue step only if the "Street" parameter from the data source is having a certain value. Therefore, you can use
  {XPATH:/ns:Accounts/ns:Account/@Street = 'Street1'} as a testing condition.

Review Snapshot

• Assign To

  Select from the drop down list to assign the step to a user or a group of users within the current environment.

• Title

  Provide a relevant title for the current step.

• Step description

  Provide a description of the step purpose in the current workflow.

• Comment

  Enter additional information about the Review Snapshot step.

• Comment Attachments

  Select the Dynamic Value button - fx to add attachments for your comments that you want to insert.

• Notification Recipients

  Within Notification Recipients box, you can add the email addresses of other users that you want to collaborate to the current step.

• Run Condition

  You are able to set a specific condition that when met will trigger the Review Snapshot step to run. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to Review Snapshot only if the "Street" parameter from the data source is having a certain value. Therefore, you can use
  {XPATH:/ns:Accounts/ns:Account/@Street = 'Street1'} as a testing condition.

Review Document

• Assign To

  Select from the drop down list to assign the step to a user or a group of users within the current environment.

• Title

  Provide a relevant title for the current step.

• Step description

  Provide a description of the step purpose in the current workflow.

• Comment

  Enter additional information about the Review Document step.

• Comment Attachments

  Select the Dynamic Value button - fx to add attachments for your comments that you want to insert.

• Notification Recipients

  Within Notification Recipients box, you can add the email addresses of other users that you want to collaborate to the current step.

• Run Condition

  You are able to set a specific condition that when met will trigger the Review Document step to run. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to Review Document only if the "Street" parameter from the data source is having a certain value. Therefore, you can use
  {XPATH:/ns:Accounts/ns:Account/@Street = 'Street1'} as a testing condition.

Task

• Assign To

  Select from the drop down list to assign the step to a user or a group of users within the current environment.

• Title

  Provide a relevant title for your task.

• Step description

  Provide a description of the step purpose in the current workflow.

• Comment

  Enter additional information about the Task step.

• Comment Attachments

  Select the Dynamic Value button - fx to add attachments for your comments that you want to insert.

• Notification Recipients

  Within Notification Recipients box, you can add email address of other users that you want to collaborate to the current task.

• Run Condition

  You are able to set a specific condition that when met will trigger the Task step to run. You are able to type the expression directly into the field, or you can select the fx button to the right of the field, to create a complex expression, using the assigned data source or the available dynamic parameters.
  For example, let's assume you want to run the Task step only if the "Street" parameter from the data source is having a certain value. Therefore, you can use
  {XPATH:/ns:Accounts/ns:Account/@Street = 'Street1'} as a testing condition.

Forms

EngageCX allows you to create forms that capture data or allows users to create documents interactively. A form is a window or 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.

Accessing the Form Editor

There are a few ways to get to the Form Editor for editing a template within EngageCX Platform. There are a few ways to get to the Form Editor for editing a template within EngageCX Platform.

From the Projects Module

1. Go to the Projects module and access the Project Folder containing the form you want to edit.
2. From the project assets list, select the form to edit (the .efd file format).
3. The Form Preview will open in a new page. From the toolbar, select the Edit to open the editor for the selected form.

From the Project Folder

1. Go to the Workspaces module and access a folder where you want to add a form file.
2. Click the +New button from the toolbar and choose the Form option.
3. Provide a friendly name for your form, then click Create.
4. Notice that the form has been added to the workspace folder and you will be redirected to the Form Preview page.
5. From the toolbar, select the Edit. The editor will open in a new page.

Form Components

When building a form in EngageCX Platform, you will need to add different form fields to achieve the desired output.

Adding a Form Field

You can include a field to your form by following one of the following methods described below.

Form fields should be named for what they are as a type, not how they work. Otherwise, the names can become too confusing. The name must not contain special characters, except digits and underscores. You should choose a name that can be easy to read and understand. For example, fname, lname, job_type_dropdown, textarea1, male_radiobox etc.

From Components

1. Access a form within a Project and select the Edit from toolbar, to access the form editor.
2. Select the Components tab from Sidebar.
3. From the Components list, select the form field you want to add, then drag and drop it to the form design surface. Additionally, select the More button to view more form fields.

From Form

1. Access the form within a Project and select the Edit from toolbar, to access the form editor.
2. Select the Components tab from Sidebar.
3. From the Form list, click on the + button next to the field in which you want to include the new field.
4. Choose the type of field to be added from the contextual menu.

The form field will now appear on your form.

Editing a Form Field

The Sidebar can be used to modify the properties of any object present in your form. To edit a form field, you will need to:

1. Select the element you want to edit in your form.
2. Go to the Style tab from the Sidebar.
3. For each field, you can:
   • Customize the form input using the options available in selected form properties list.
   • Customize the form label using the options available in the Styles list.
   • Remove the form field, by selecting the Delete button , at the top-right corner of the sidebar.

Form Fields

Page

The starting point of any form is a Page. A Page is what contains different form fields, each new form will start off with one page. However, you can add multiple pages to your form to match what your layout template will look like.

Page Properties

Caption	Name

Text

The most generic data entry field type on an EngageCX form is the text field. The Text field allows you to capture text type data, such as letters, numbers or symbols.

Text Properties

Caption	Caption Position	Name	Validation	Visibility
Read-only	Required	Default Value	Description	Placeholder
Mask	Data Field Binding	Lookup Button Visibility	Permissions

Label

Adding a Label will help with organizing the form and breaking pages into sections.

Label Properties

Caption	Visibility

Contact Field

By default, adding a Contact Field will let you insert EngageCX contacts by their first names. The values are valid if there is an EngageCX Account Integration mapped in Administrator Settings.

Contact Field Properties

Caption	Caption Position	Contact Field	Visibility	Read-only
Required	Default Value	Description	Placeholder	Permissions

Dropdown

Adding a Dropdown Field will allow you to add multiple choices for the user to select from. Having options in a Dropdown list instead of the free-form textbox will ensure that the data that is coming in is exactly what you are looking for.

Items

Once you have configured the Dropdown field, you will need to add Items for the different options. By default, EngageCX will add 3 generic Items that you can select to edit. You can update the Caption and Value of the items.

The value of the Item will be what is translated to the XML generated by the form. This is the value that will be used in the Publisher template to configure things like conditional sections, also this value is what will be presented on the file output.

For example, the Caption might read "M" and the Value might be "Male".

To add a new Item:

1. In the Sidebar, navigate to the Components tab and scroll down to the Form list.
2. Select the Dropdown element you want to edit, and click the + button, next to its name.

Dropdown Properties

Caption	Caption Position	Name	Visibility	Multiple
Max Items	Read-only	Required	Default Value	Description
Data Field Binding	Permissions

Number

Adding a Number as a form field will restrict the input values only to numerical type and will provide also stepper arrows to allow users to sequentially increase or decrease the value. This type of field includes a built-in validation to reject non-numerical entries.

Number Properties

Caption	Caption Position	Name	Visibility	Read-only
Required	Default Value	Description	Placeholder	Permissions

Currency

This form field has a built-in validation that specifies the format for US currency.

Currency Properties

Caption	Caption Position	Name	Mask	Visibility
Read-only	Required	Default Value	Description	Placeholder
Permissions

Signature

Adding a Signature to a Form will allow the user to customize a digital signature to be added to the document.

Signature Properties

Caption	Caption Position	Name	Visibility	Read-only	Agreement
Recipient Name	Recipient Role	Underline	Description	Placeholder

Time

Adding a Time Field will allow the user the user to add a specific time to the Form. This could be the time it was filled out or the time a client should expect a fix completed.

Time Properties

Caption	Caption Position	Name	Visibility	Time Format
Read-only	Required	Default Value	Description	Placeholder
Permissions

Password

Adding a Password field will allow the end user to enter a password with security enabled.

Password Properties

Caption	Caption Position	Name	Visibility	Read-only
Required	Default Value	Description	Validation	Placeholder
Permissions

File Picker

Adding a File Picker to a Form will allow the user to select a file to be added to the email that is being set through the workflow. This file will be in addition to the file that is created from the form.

File Picker Properties

Caption	Caption Position	Name	Visibility	EngageCX Files
Local Files	Extensions	Read-only	Required	Description
Default Value	Permissions

Rating

The Rating field allows users to rate a statement out of 5 stars.

Rating Properties

Caption	Caption Position	Name	Visibility	Icon
Scale	Read-only	Required	Default Value	Description
Permissions

EngageCX Authentication

Adding an EngageCX Authentication Form widget will allow the user to provide their user information. This can be used as an extra authentication for forms.

EngageCX Authentication Properties

Name	EngageCX Url	Username	Environment	Read-only

Google Address

Adding a Google Address field will allow your users to start typing an address and have it offer suggestions using Google.

You will need to make sure to provide a Google Map API.

Goggle Address Properties

Caption	Caption Position	Name	Visibility	Read-only
Required	Default Value	Description	Permissions

XML Field

An XML Field is a field that displays the content located in the XML Data Source without the need to add XSLT code to match the specific tags.

XML Field Properties

Name	File

Group

Adding a group will help organize your data in the form considering different criteria.

Group Properties

Caption	Name	Data Field Binding

Text Area

A text area field can be used to provide extra space for the user to add content without providing additional formatting options such as with a Rich Text field.

Text Area Properties

Caption	Caption Position	Name	Visibility	Rows
Read-only	Required	Default Value	Description	Placeholder
Permissions

Separator

Adding a separator will help isolate elements within the form page.

Separator Properties

Visibility

Radio

Adding Radio buttons to a form will allow the user to see all of the options they have, and only allow them to select 1.

Items

Once you have configured the Radio field, you will need to add Items for the different options. By default, EngageCX will add 3 generic Items that you can select to edit. You can update the Caption and Value of the item.

The value of the Item will be what is translated to the XML generated by the form. This is the value that will be used in the Publisher template to configure things like conditional sections, also this value is what will be presented on the file output.

For example, the Caption might read "M" and the Value might be "Male".

To add a new Item:

1. In the Sidebar, navigate to the Components tab and scroll down to the Form list.
2. Select the Radio element you want to edit, and select the + button, next to its name.

Radio Properties

Caption	Caption Position	Name	Visibility	Read-only
Required	Default Value	Description	Permissions

Checkbox Group

Adding Checkboxes to a form will allow the user to select multiple options, unlike a Dropdown list or Radio Buttons.

Items

Once you have configured the Checkbox Group field, you will need to add Items for the different options. By default, EngageCX will add 3 generic Items that you can select to edit. You can update the Caption and Value of the item.

The value of the Item will be what is translated to the XML generated by the form. This is the value that will be used in the Publisher template to configure things like conditional sections, also this value is what will be presented on the file output.

For example, the Caption might read "M" and the Value might be "Male".

To add a new Item:

1. In the Sidebar, navigate to the Components tab and scroll down to the Form section.
2. Select the Checkbox element you want to edit, and select the + button, next to its name.

Checkbox

Adding a Checkbox to a form will allow the user to enable one single option.

Checkbox Properties

Caption	Caption Position	Name	Visibility	Read-only
Required	Default Value	Description	Permissions

Date

Adding a Date Field will allow a user to select a date from a calendar or manually type one in.

Date Properties

Caption	Caption Position	Name	Visibility	Date Format
Separator	Read-only	Required	Default Value	Description
Not Before Current Date	Limits	Placeholder	Permissions

Rich Text

A Rich Text Field will allow the user to format the content of the field, using paragraphs, lists and additional font choices.

Rich Text Properties

Caption	Caption Position	Name	Visibility	Read-only
Required	Permissions	Default Value	Description	Toolbar

Datetime

Adding a Datetime Field will allow a user to select a date and a time from a date & time picker or manually type the values in.

Datetime Properties

Caption	Caption Position	Name	Visibility	Date Format
Separator	Time Format	Read-only	Required	Default Value
Description	Not Before Current Date	Limits	Placeholder	Permissions

Repeating Section

Adding a Repeating Section to the Form will allow the user to fill out the information within the section multiple times.

For example, if the Form was for an order, the repeating section might have information pertaining to products, and the user would be able to fill this out multiple times depending on how many different products they wanted.

To add Field Types:

1. In the Sidebar, navigate to the Components tab and scroll down to the Form section.
2. Select the repeating section you want to edit, click the + button, next to its name and select the field type you want to insert.

Repeating Section Properties

Caption	Name	Visibility	Read-only	Required
Data Field Binding	Add Button Template

Image Picker

Adding an Image Picker to a Form will allow the user to select an image file to be added to the email that is being set through the workflow. This file will be in addition to the file that is created from the form.

Image Picker Properties

Caption	Caption Position	Name	Visibility	Required
Permissions

Structured Data

Adding a Structured Data set will allow you to set up a section of the form for the user to fill document content in a structured or restricted manner.

Structured Data Properties

Caption	Name	Visibility	Schema

Script

Adding a custom script will allow you inject a JScript snippet into the form to further customize the form to your needs. You can add a script to set advanced custom validations, field visibility options, restrictions on content and much more. A JavaScript file can be either uploaded by selecting Browse button or directly written down in the provided Script text box.

For more information about working with scripts please reach out to our support team (engagecxsupport@mhcautomation.com).

Google Map

EngageCX will allow you to insert a Google Map directly into your form. It is important to note that this field is a purely visual one for the form.

You will need to make sure to provide a Google Map API.

Google Map Properties

Caption	Caption Position	Visibility	Map Type	Default Value

Subform

In the form editor, you are able to add subforms to the form template. Subforms are similar to content fragments in a document template. These are able to be reused in multiple forms so that you do not need to re-create the same section multiple times. Also subforms will allow to easily update them in a single location which will be automatically updated across all the forms using this type of field.

Google Map Properties

Path	Name	Visibility

Form Field Properties

Caption

The caption for your form field will be shown in the Form editor as well as in the Communication Module when a user is filling it out. This caption should convey what the user should be typing in the field, for example, Employee Name.

Caption Position

Select where the Caption should be shown in relation to the drop down list, either to the left or on top of the list.

Name

The text in the Name field will be the default value for the field and will show both in the Form that is being filled out and the Layout Template preview. This information should be the default answer for this field.

Validation

A validation type can be selected to ensure that the user fills in the textbox with the correct information. The following validation options are available; Alphabetic, AlphaNumeric, Currency, Email, Name, Numeric, URL, Year.

Is Visible

If the Is Visible option is selected then by default, the field will be visible to the end user when filling out the form. Optionally, you can select the Hide If button to set a specific condition, using other form fields, that when met will hide the current form field.
If the Is Visible option is not selected then by default, the field will be invisible to the end user when filling out the form. Optionally, you can select the Show If button to set a specific condition, using other form fields, that when met will display the current form field.

Read-only

This option will make the selected field unable to be edited. This option is helpful if you have data that you need to have displayed in the form and the corresponding template but you do not want the person filling out the form to have the ability to edit it. For example, customer ID.

Required

Depending on the needs of your forms the form field that is added may not always need to be filled in. Toggling off the Required option will allow the user to successfully fill out the form without needing to fill in this field.

Default Value

The form editor allows you to apply a formula or add parameters that will be used as a value of the Field. You can choose from one of the predefined parameters or you can create your own formula using the fx button.

Description

Adding a description is helpful to ensure that the user fully understands what the field is looking for. It is important to note, that the description will not automatically be added to the Layout Template. If you wish to have this description visible on the final document it will need to be manually added to the Layout Template in the Publisher.

Agreement

Add a customized signature agreements and terms text.

Recipient Name

You can add name, email information or other data of the recipient to be displayed under the signature itself.

Recipient Role

Recipient roles are used to map to the automatic anchor tags in your output documents.

Underline

Insert an underline to suggest the place where the signature must be drown.

Placeholder

Provide a place holder for the field. A place holder can act as an example of what the user should enter in the text box without affecting the value stored in the XML file.

Mask

The form editor allows you to set a mask that will be used for the value of the Field. You can choose from one of the predefined options or you can create your own using the @ symbol to mask letters, # for numbers and * for both.

Permissions

This option allows you to manage permissions for filling the field. Here you can specify users or group of users that you want to write in the selected field. For example, to allow only users included in the Administrator group to complete the current textbox, select Administrators. To read more information about Users and Groups, please visit the Admin chapter.

Data Field Binding

This option defines how the values in a business object should be bound to the fields shown in the UI and allows you to select from the data source output in order to populate the current field with existing values by auto-completing.

Lookup Button Visibility

This option allows you to enable or disable the search icon that appears on the right side of a field and help you populate the current field with values from data source added before.

Contact Field

This option allows you to select the default Contact Field and will show in the Form that is being filled out and the Layout Template preview. This information should be the default answer for this field. New Contacts fields can be added from the Admin.

Multiple

If the Multiple option is enabled, the field allows you to make multiple selections from the same dropdown list of items. Otherwise, you can do only one selection when completing the form.

Max Items

Set the max number of items to pull from a data source if one is set up to populate the values for the Dropdown.

Time Format

You can select to either have the time in an AM/PM format or a 24-hour format.

Browse EngageCX files

Toggling on this option will allow the user to search through the files stored in EngageCX Workspaces.

Browse local files

Toggling on this option will allow the user to search through files on their local machine instead of only files that are stored in EngageCX.

Allowed Extensions

Here you can write all the file extensions which you want to add using the File Picker. For example, if you want to add PDF files, write *.pdf.

Icon

Choose the icon you would like to use for the rating, by default, this option is set to Stars but there are a total of 4 icons to select from.

* Stars
* Thumbs
* Hearts
* Lightbulbs

Scale

You will need to select the top number for the scale of the rating, by default, this number is set to 5.

EngageCX URL

You can provide the EngageCX Url or leave it blank and the form will populate it with the current EngageCX environment URL.

Username

Provide a default Username, or leave it blank and let the user fill it in.

Environment

Provide a default Environment, or leave it blank and let the user fill it in.

Test File

You can upload an XML file for testing operations from your local machine or within the Project folder.

Rows

You will need to provide a number of rows of text to allow in the form field; by default, this number will be 3.

Date Format

You can select from one of 3 predefined formats for the date to be presented in. * mm/dd/yyyy * dd/mm/yyyy * yyyy/mm/dd

Separator

You have the option to select from 3 predefined separators for the date components.

Not before the current date

The Date Picker will restrict the range of the date period by setting the lower limit after the current date.

Limits

You are able to set limits for the date that can be selected when filling out the calendar filed in the form. To insert a limit for either Not Before or Not After a certain date, type the date into the field or select the calendar button to select the date.

Add Button Template

Here you will have the ability to modify the add button. You can change the text, font weight and style, text and background color.

Schema

Select a schema (.als) file to be used. If you do not have a .als file created reach out to our support team (engagecxsupport@mhcautomation.com) for assistance in creating one.

Map Type

Select the map type to be used in the form. These types mirror the standard options available when using Google Maps.

Path

Specify the EngageCX location of the subform you want to add.

Style

Setting the style of a form field can be done within the Style section in the Form Editor.

1. Select the Style section from the Side Menu.
2. Adjust the style settings from the bottom of the Menu for the form to make it look as you wish.

To apply a style, simply select the field in the Design Surface and select the needed property from the Style list to apply.

Languages

1. Select the Languages from the Side Menu.

2. Click on the + button and choose a new language from the dropdown list.

3. The selected language will be shown in the Side Menu. To translate the text select the language and choose the phrase to perform manually translation.

4. From the Language Properties dialog, you can select the Delete Language and remove the newly created language.

Settings

1. Select the Settings section from the Side Menu.
2. Configure various properties of your form according to your needs.

• Mark required fields: Selecting this option will show a * next to the field names that are required to be filled in. The null value or the blank space will not be accepted.
• Use ReCaptcha: This option activates a service that protects your website from spam and abuse.
• Validate before going to the next page: This option will make sure that the information on the current form page is valid before allowing the user to move to the next page.
• Hide lookup button: When checking this feature, the search symbol will be removed, but this does not prevent from the usage of lookup mechanism.
• Pagination Type: This option helps you in choosing the view of form pages. Choosing the Tabs option will show tabs at the top of the form allowing easy access between the form pages, if any changes need to be made. Choosing the Pager option will remove the tabs from the top and you will need to use the continue and back buttons to navigate when filling out the form.

Working with the Inside Form Options

Edit a Field

1. In the Design Surface, hover over the field you want to edit.
2. From the contextual menu, select the Settings gear button.
3. You will notice that the Properties Pane will become visible on the right side of the page, from where you can review the field properties.

Delete a Field

1. In the Design Surface, hover over the field you want to remove.
2. From the contextual menu, select the Delete option.

Change Field Type

If you are importing a Word Document to start your Interactive document, or just simply need to make modifications to form fields, you can easily do so directly from Design Surface.

1. In the Design Surface, hover over the field you want to change.
2. From the contextual menu, select the Change Type option (the double arrow icon).
3. From the dropdown list, choose another type for your field then select the OK to update the changes.

Resize Form Fields

1. In the Design Surface, hover over the field you want to resize.
2. From the contextual menu, use the Shrink, Expand or Toggle Break buttons to resize the form fields. Using these, you will be able to modify how much the fields will expand. For example, if you want smaller fields on the same line, the Shrink option need to be used.

Apply Visibility Conditions

1. In the Design Surface, hover over the field you want to set visibility conditions.
2. From the contextual menu, select the Advanced Visibility option.
3. In the Hide Field If dialog, select the Add new clause button.
4. Create a condition for the visibility of the selected field, like below:
   • Select a field defined in your form which you want to base your condition on.
   • Select an operator for your condition.
   • Add a value for testing your expression.
5. After all configurations are finished, select the OK to save the changes.

Workspaces

EngageCX Develop EngageCX

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 productions needs to be stored in workspaces.

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.

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

Accessing Workspaces

1. Access the EngageCX Welcome page.
2. Select the Workspaces button in the Modules Menu or select the Settings button from the top-left corner and choose Workspaces under Design Module.

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.

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

Managing Workspaces

1. In the Workspaces page, select the workspace you want to edit.
2. Select the More options button, next to the workspace name.
3. Choose Manage from the contextual menu.
4. Within Manage Workspace dialog :
   • Edit the Workspace Name or Workspace Description as needed.
   • Enable\disable Review and Approval settings.
   • Update Publish settings.
   • Set up Tasks.
5. Once ready, select the Save to update the changes.

Deleting Workspaces

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

Viewing User Permissions

1. In the Workspaces page, select the workspace you want to monitor.
2. Select the More Options button, next to the workspace name.
3. Choose View Users 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.

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

Workspaces Content

After accessing a workspace, you can view and organize all the files and folders stored within. The view provides a hierarchical structure that allows you to keep your documents organized.

Folders

Folders provide a container that helps 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.

To create a new folder:

1. Go to the workspace location where you want to add a new folder.
2. Select the New Folder button, at the top-right corner.
3. Enter a Name for the folder, then select the Create.
4. The folder has been added to the Workspace. To access it, use the Sidebar or simply click on it within the Content Surface.

To import a folder:

1. Go to the workspace location where you want to import a new folder.
2. Select the More Options button from the toolbar.
3. Within Import Zip dialog:
   • Select the Choose File to navigate the files system.
   • Enter additional information about the folder imported in the Comments field.
4. Once ready, select the Import to save the changes.

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

To export a folder:

1. Go to the workspace location where the folder is stored.
2. Select the project folder that you want to export.
3. Select the More Options button from the toolbar and choose Export option from the contextual menu.

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

Shared Folders

Shared folders are useful to improve efficiency and consistency of your documents, and also 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.

To share a folder across multiple workspaces:

1. Access the workspace containing the assets you want to share.
2. Right-click on the folder you want to share.
3. Next, select the Share in the prompted window.
4. Switch to other workspace and notice that the folder you just shared is visible from other workspaces. You can identify a shared folder through the shared icon visible next to the folder name. Also, the Shared tag will also be added by default, within the folder content.

To unshare a folder:

1. Access the workspace containing the shared folder.
2. Right-click on the folder you want to unshare. A shared folder can be identified through the shared icon next to the folder name.
3. Select the Share/Unshare option from the contextual menu. You will be prompted to confirm your selection.
4. Notice that the folder will not be visible from other workspaces.

Hidden Folders

Within EngageCX Platform, you can now create hidden folders. These 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.

To create a hidden folder:

All folder that starts with the . sign will be hidden, by default.

1. Access the needed workspace.
2. Create a new folder.
3. Within Folder Name dialog, type the . character, then enter a name for the folder. For example, .Credit Order Letter.
4. Select the Create to add the hidden folder to the workspace.

To view hidden folders:

1. In the Enterprise Home page, select the account name, at the upper right side of the screen.
2. From the drop down list, select the Edit Account.
3. Select the Preferences tab under the Edit Account dialog.
4. Check the Show hidden folders option, then select the Save.
5. If you go back to your workspace, you will notice that the hidden folder are accessible and greyed out.

Files

Once you have created your main folder within a workspace, you will need to add all of the necessary project files or create other new folders to further organize your files.

To create a new file :

1. Access the needed folder within a workspace.
2. Select the New button, at the top-right corner.
3. Select the file type you may want to create. EngageCX Platform allows you to create new templates, content fragments, workflows, business rules or forms.
4. Provide a name and optionally, a description for the new file, then select the Create.

File Names

File Names should contain the subject of the content, a meaningful and specific name.

Document Template Names

Document Template names should be structural or purpose based. Even if they have the same name as the form or another file, they differentiate by the extension of the file (Document_Template_Name.epr). For example, FactSheet, Monthly Statement, Sign Up Template, AdventureWorksSales, Invoice, etc.

Email Template Names

Even if Email Template names have the same name as the form or another file, they differentiate by the extension of the file (Email_Template_Name.ehtml). For example, Email, Confirmation123-Email, etc.

Content Fragment Names

Content Fragment names should be specific and meaningful to what they represent as parts of the template. It is a good use to choose a content fragment name per component. One of the most important things when naming content fragments is that their names are meaningful and let you quickly search for. For example, Footer, Header, CompanyInfo, Company Address, etc.

Workflow Names

The Workflow name should define the goal to achieve at the end of its execution. It should represent a brief description of a scenario within a process or a particular task. For example: Main, Send, Send Proposal - Digital Signature, Send Email, etc.

Business Rules Names

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.

Form Names

Usually, the form names have the same title as the templates they make use of. They can be easily differentiated by the extension of the file format (Form_Name.efd). For example, Insurance Policy Form, Contract, Loan Agreement, Credit Order, etc.

Other Files

Many other files can enter in this category, that you use within your project, such as images, fonts, XML files, diagrams, etc. These files are usually imported, so you do not have to set a name, but in case of renaming the file, the same restrictions as above are applied. For example, logo.jpg, bank.gif, Customers.xml, BankAccounts.xml, etc.

Folders and Files Options

Within a workspace, you can perform the following actions:

Folders

View	Upload	Export	Synchronize Folder	Permissions
Tags	Copy	Rename	Move	Delete

Files

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

Open Folders

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

By selecting the folder:

1. Access the workspace that contains the folder you want to explore.
2. Select the folder that you want to see the content of.
3. Click on the needed folder.
4. You will be redirected to the Folder's content page. You can use the View Bar, at the bottom, to decide how you would like to view the files, Grid View or List View.

From More Menu:

1. Access the workspace that contains the folder you want to explore.
2. Navigate to the folder that you want to see the content of.
3. Select the More Options button next to the folder.
4. Choose View from the contextual menu.
5. You will be redirected to the Folder's content page.

From Sidebar:

1. Access the workspace that contains the folder you want to explore.
2. Right click on the folder from the Sidebar.
3. Choose View from the contextual menu.
4. You will be redirected to the Folder's content page.

Open Files

1. Access the workspace that contains the file you want to explore.
2. Navigate to the file location you want to open.
3. Select the More Options button next to the file.
4. Choose Open from the contextual menu.
5. You will be redirected to the selected file page preview.

Rename

Rename Files

1. Access the workspace that contains the file you want to explore.
2. Navigate to the file location you want to change the name.
3. Select the More Options button next to the file.
4. Choose Rename from the contextual menu.
5. Edit the file name and select the Rename.

Rename Folders

1. Navigate to the folder location in the workspace where you want to change the name.
2. Select the More Options button, next to the folder name.
3. Choose Rename from the contextual menu.
4. Edit the folder name and select the OK to save the changes.

Delete

Delete Files

1. Access the workspace that contains the file you want to explore.
2. Navigate to the file location you want to delete.
3. Select the More Options button, next to the file name.
4. Choose Delete from the contextual menu.
5. Confirm the deletion and select the Delete.

Delete Folders

1. Navigate to the folder location in the workspace where you want to delete.
2. Select the More Options button next to the folder name or right click on it.
3. Choose Delete from the contextual menu.
4. Confirm the deletion and select the OK.

Export Folders

From the Workspaces

1. Navigate to the folder location of your project within the workspace.
2. Select the More Options Menu of the selected folder or right click on it.
3. Select the Export from the contextual menu.
4. A zip archive will be downloaded on your local machine with all your project assets within.

Within the Project Folder

1. Navigate to the folder location of your project within the workspace.
2. Select the project to see all corresponding assets.
3. Select the More Options button from the toolbar.
4. Choose Export from the contextual menu.
5. A zip archive will be downloaded on your local machine with all your project assets within.

Download Files

1. Navigate to the file location you want to download within your workspace.
2. Select the More Options button, next to the file name or right click on it.
3. Choose Download from the contextual menu.
4. The file will be downloaded on your local machine.

Move

1. Navigate to the folder/file location of your project within your workspace.
2. Select the More Options button, next to the folder/file name or right click on it.
3. Choose Move from the contextual menu.
4. Set your Destination Folder where the folder/file will be moved.
5. Provide a new name for the folder/file if needed.
6. When you finished, select the Move to perform the operation successfully.

Copy

1. Navigate to the folder/file location of your project.
2. Select the More Options button, next to the folder/file name or right click on it.
3. Choose Copy from the contextual menu.
4. Set your Destination Folder where the folder/file will be copied.
5. Provide a new name for the folder/file if needed.
6. When you finished, select the Copy to perform the operation successfully.

Add or Remove Favorite

As you start to work with many different files 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.

1. Navigate to the file location of your project within your workspace.
2. Select the More Options button, next to the file name or right click on it.
3. Choose Add/Remove favorite from the contextual menu.
4. Notice that the favorite files will be displayed in the Welcome Page under Files section, when initially logging in.

Uploading Content

In order to add a file or a folder to any Project or another Folder in EngageCX Platform, you will need to understand how to use the Upload Feature. This is often the first step in getting started when 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

1. Navigate to the location of your project folder where you want to add the file within the workspace.
2. Select the More Options button from the toolbar.
3. Choose the Upload File option from the contextual menu.
4. Select the Choose File button to search for the file you want to upload from your local machine.
5. When enabling Use Versioning option, EngageCX will store the file in its previous state and use the new file as the latest version. This will prove useful for tracking and accessing the history of any file.
6. You can optionally add Comments.
7. Select the Upload button and your file will now be visible in your folder.

Zip Files

1. Navigate to the location of your workspace where you want to add the file.
2. Select the More Options button from the toolbar.
3. Choose the Import option from the contextual menu.
4. Select the Choose File and search for the ZIP file you would like to import from your local machine.
5. You can optionally add Comments.
6. Select the Import button and all of the files from your zip folder will be uploaded. Versioning will automatically be set for every file that is added from the ZIP file.

Or

1. Navigate to the location of your project folder within the workspace where you want to add the zip archive.
2. Select the More Options button from the toolbar.
3. Choose the Upload File option from the contextual menu.
4. Select the Choose File and search for the ZIP file you would like to import from your local machine.
5. When enabling Use Versioning option, EngageCX will store the file in its previous state and use the new file as the latest version. This will prove useful for tracking and accessing the history of any file.
6. You can optionally add Comments.
7. Once ready, select the Upload button. A new dialog will let you choose if the Zip file that you are uploading should be unpacked or not. If the case is to unpack the Zip file, select the Upload. Otherwise, select the Import.

From an EngageCXCX 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.

1. Open one of the EngageCX Studio tools (Publisher, Modeler or Analyst). Design and save your template or data diagram.
2. Access the EngageCX Drive tool and connect to the EngageCX Account.
3. Create a new project folder or select an existing one, then add the template created within that folder. Use the Add File options from the More Options menu.
4. If the Synchronize files automatically option is selected, the file will be added automatically in Enterprise Website.
5. To add the file manually, select the file that you want to add to the EngageCX Platform, and select the Check in pending changes option from the More Options menu.
6. Add a comment and select the Check in.
7. Once you log into Enterprise Website, you will be able to see the newly added file.
8. To learn more about connecting to EngageCX Drive from use the following link: EngageCX Drive.

Synchronize Folder

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

1. When the Amazon connection is created, navigate to a workspace that contains the folder you want to synchronize.
2. Right click on the folder, then select the Synchronize Folder option from the contextual menu.
3. Within the Synchronize Folder dialog, fill in the mandatory field.
   • Choose the Amazon Connection you want to use from the drop down list.
   • Optionally, fill the Amazon Path field, if you want to synchronize only one subfolder of the Amazon bucket or copy the Amazon Callback URL for real-time synchronization configuration.
4. Once you're ready, select the Save and synchronize to start the synchronization process.

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

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

1. Log in to the Amazon Web Services console and configure Simple Notification Service(SNS) topics and subscriptions.
2. Navigate to SNS and create a new topic.
3. Select the Create subscription within the topic page and add a subscription that uses the HTTP Protocol. Paste the Callback URL provided by EngageCX Platform when creating the synchronization in the Endpoint field, then select the Create Subscription.
4. By default, the Subscription Id would be displayed as Pending Confirmation, but in a few seconds, after refresh, the subscription should be confirmed by EngageCX Platform, and an ARN should be associated.
5. Navigate to the bucket that you set in EngageCX Amazon Web Service connection page and select the Properties.
6. Select the Events tile to add a new notification. Within Event dialog, provide a custom name, check the Put, Post, Copy and Delete events, then select the destination (Send to files) as SNS Topic and the topic created above.
7. If everything was set correctly, the real-time synchronization should start.

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:

• Provide the security needed when multiple users have access to project folders and the files within.

  Example

  Multiple users may have access to the same Publisher Template. In this case, versioning can be used to track the changes that have been made by each user.

• Users can add a comment to make it easier to see what that version represents and/or what changes have been made.

  Example

  Each time a file is uploaded or modified, a new version is created.

Accessing the File Versions

1. Select the More Options button of any file at your choice.
2. A dialog will display all existing versions of the asset.
3. You can download or select one of the versions of the file to be restored to a previous state.

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:

• Editing a Publisher Template file using the Online Editor in Enterprise Website.
• Editing and checking in a file directly from one of the EngageCX Studio products.
• Uploading a new file with the same file name.
• Restoring a snapshot or a previous version of a file.

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 Options 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.

1. Access the workspace, then the project that contains the needed file.

2. Click on the file to open it.

3. In the File Preview page, select the More Options button from the toolbar.

4. Click on the Share button to generate a public link. Select the Copy to clipboard option to select the link, then send it through email to the persons you want to show the file.

Folder Permissions

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

1. Access the workspace that contains your folder.
2. Locate the folder and select the More Options button next to the folder name. Or simply right-click on the folder.
3. Select the Permissions from the contextual menu.
4. In the Folder Permissions dialog, select the Add button and select the user(s) or group(s) you might want to provide or deny permissions.
5. Once an option is selected, tick in the boxes associated with each permission, as needed, such as read/write/delete files/folder, lock or zap.

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:

1. Access the workspace that contains the needed documents.
2. Identify the file or folder on which you want to add the tag, then select the More Options button next to its name. From the contextual menu, select the Tags.
3. Next, select the +Add Tag button. In the Tag dialog, you can either provide a name and a value for the tag or select from the drop-down menu, indicated by the right down-arrow, a specific property that will be used as the implicit name:
   • Select the Important option to inform your customer about tag’s high level of importance.
   • Select the New option to inform your customer that the file on which is applied is new or has new information.
   • Select the Public option, meaning that your files under the current folder can be accessed by anybody, without logging in.
   • By default, the tag's value is set to true, but can always change it according to your needs.
4. You can set the tag visibility either by restricting access by enabling the option Only visible to myself or just keep the document visible to the public by disabling the option.
5. After the tags where added, at any time, you can use the Search bar, from the top right-hand-side to type and search after the files or folders tagged.

Review and Approval

Within EngageCX Platform there are multiple ways to work with reviewing and approving projects and their assets:

• You can set the Review and Approval process for an entire workspace.
• Review and Approve a project before a Snapshot Project before deploying it in a production environment.
• Manually create a workflow to approve.

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.

1. Access the Workspaces Module and identify the workspace on which you want to enable the process.
2. Select the More Option menu, 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 the Ok to update the changes.

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 are not able to run any communication using files that are not approved. There are two ways to request a review for workspace's files:

• From Tasks, by creating a new Review Document task.
• From Workspaces.

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

• From Tasks, by creating a new Review Snapshot task.
• From Projects.

Requesting Review from Workspaces

1. Access the workspace that contains the needed files.
2. Select the More Options menu, 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 the 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

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 Options menu, 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 the 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:

• Create a snapshot of the project.
• Assign a Review Task to the Administrators group.
• If the snapshot is Approved, it will tag the assets as approved. They will then be able to be used the next time a communication is run.
• Delete the snapshot after a Approved or Rejected choice has been made.

Review and Publish Workflow

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

• Create a snapshot of the project.
• Tag the snapshot as pending.
• Assign a Review Snapshot Task to the Administrators group.
• Tag the asset as Approved or Rejected. They will then be able to publish the snapshot.

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.

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. These options are available in EngageCX, but if you do not see these options in your environment reach out to your account manager for an upgrade.

Communications

EngageCX

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

Accessing the Communications Module

1. Select the System button from the top-left corner of the Welcome page.
2. Choose the Communications option under the Engagement group.

Running a New Communication

1. In the Communications page, select the +New Communication button from the toolbar.
2. From the Communication dialog, you can either select the project you want to run from the list or use the Search bar to quickly find the needed project. Once ready, select Run button.
3. Next, the output summary page will open in a new tab. 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 your Communication list. If multiple communications are present, you can use the Sidebar to focus on them. At any time, you can look up for communications by project, or simply select 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. For more custom views, visit the Views section of this guide.

Each time you select a View or Project from the Sidebar, a filtered list with the communications entries will be displayed in the page, providing information such as Communication State of execution, the user that run the communication, the end date and/or the number of documents that are being produced according to their types : Forms, Documents, Emails and Clicked Emails.

For a more detailed view of the generated output, you can select the communication you are interested in and choose from the options in the Sidebar (Documents, Emails, SMS or Print). From the Communication Summary page, you can access also the Log button to view the 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:

• embed=true: if you want the communication to be integrated within the URL. (Required)
• tag: the filter(s) based on which the communication projects are sorted (e.g. tag=tagName). If no tag is specified, all the communications will be displayed in the New Communication UI.
• workItem: the data input file that will be passed to the communication's job (WorkspaceName:WorkspacePath, e.g. workItem=Default:Design\Uploads\Proposal1234123.xml). If this parameter is not specified within the URL, the communication will use the default file defining the corresponding workflow.

The Scheduled View

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

Scheduling a Communication

EngageCX Platform provides you the ability to automatically schedules 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.

1. Access the Communications module and select the Scheduled view from the Sidebar.
2. Select the +Add Schedule button, from the toolbar.
3. Next, choose the communication project you may want to schedule and select OK.
4. In the Configure Schedules dialog, select the New Schedule button.
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.

The Triggered View

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.

Configuring a Hot Folder 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\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, select 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.

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, select 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 means 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 be resolved to the path of the trigger file.

More Communication Options

There are some available options that can be easily accessed by selecting More Options Menu for any Communication in the list.

Open	Share	Export	Delete
Create New Version	Download Form Data	Go to Project

Open Communication

Access Open option and you will be redirected to Communication Summary page, where you can see a more detailed view of the documents that are being produced.

Share Communication

This option allows you to share the communication job content publicly or with your portal users. 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.

Export Communication

The Export feature will download the corresponding job together with inputs and log files, if needed.

Delete Communication

Access this option if you want the corresponding job for the communication to be removed.

Create New Version

Select this option if you want to create a new version for the communication with new inputs for it.

Download Form Data

This option will download the XML file of the communication with the last saved form data.

Go to Project

This option will redirect you to the Project folder this communication belongs to.

Journeys

EngageCX

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 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.

• Journeys: A Journey refers to a long-term narrative that automatically enrolls customers in a scenario based on Persona. You may want to insert such a type of Journey, if you want to restrict Contacts to be included in one Journey only. An example could be a journey that presents the experience customers are having, focusing on a single aspect, such as monthly statements special offers.

• Episodes: An Episode refers to a short-term scenario that automatically enrolls customers in a scenario based on Lists. You may want to insert such a Journey to allow Contacts to be included in multiple Episodes. An example could be, an episode that presents the experience customers are having, focusing on multiple aspects, such as ways to promote useful content and teach timely topics.

Accessing the Journeys Module

1. Access the EngageCX Website.
2. Select the Journeys button from the Modules Menu.

Or

1. Select the System button at the top-left corner of the EngageCX's Welcome page.
2. Choose the Journeys option under the Engagement group.

Creating a new Customer Journey

1. In 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 Empty template, to configure a customer journey from scratch,or other two predefined templates, Webinar, to create a web-based seminar for your customers, or Newsletter, to set up a journey that deliver newsletters to your customers.
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 a destination folder for your journey.
5. Once you're ready, select Finish. A confirmation dialog is displayed to inform you that there are changes related to contacts' state or not. Confirm if you want to apply these changes.

Enabling/Disabling Customer Journeys

You can enable or disable activity on a customer journey by checking in or out the Enabled parameter next to its name, under the Customer Journey module. It is best practice that while you edit an existing Journey\Episode, to deactivate it.

Assigning a Target Audience

After a Journey\Episode has been created, locate the Contacts 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 dropdown list.

More Customer Journey's Options

At any time, you can select the More Options button next to a customer journey name, and select from the following options:

Open	Validate
Delete	Properties

Open Journey

This option allows you to open the Journey page and view or edit the Journey Map. To open a Journey:

1. Select the More Options button for a Journey.
2. Choose Open option from the contextual menu.
3. You will be redirected to Journey Preview page.

Validate Journey

This option allows you to check that journey dependencies (such as Projects, Workflows, Task Types, etc.) are present in the system. To validate a Journey:

1. Select the More Options button for a Journey.
2. Choose Validate option from the contextual menu.
3. A pop-up message will inform you about the validation of your Customer Journey.

Delete Journey

Accessing this option, you can remove a Journey from the repository. To delete a Journey:

1. Select the More Options button for a Journey.
2. Choose Delete option from the contextual menu.
3. A confirmation dialog is displayed to inform you that there are changes related to contacts' state or not. Confirm if you want to apply these changes.

View Journey Properties

If you want to edit properties of a Journey you need to select this option. To access Journey's properties:

1. Select the More Options button for a Journey.
2. Choose Properties option from the contextual menu.
3. Edit Journey's properties according to your needs.
4. Select Save to update the changes.

Journey Editor

Selecting a journey\episode in the Customer Journeys module will redirect you to the Journey Preview page. On the left side of the page, you can view the Sidebar showing all the touchpoints defined and the journey/episode dependencies. Contacts Pane can be found on the right side, offering easy access and details on every customer enrolled to the current journey. The centered area of the Journey Preview 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 Preview 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 from where you can start adding elements to your journey.

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 that can be viewed in Contact 360 degree page. 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

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:

• Can your Customer state what he was able to accomplish?
• Is your Customer clear about the value he received?
• Does your Customer want to stay loyal to your company?
• Is your Customer compelled to tell others about the experience?

Contextual Stages Options

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:

Delete stage	Remove the current stage from your journey.
Rename stage	Edit the name of the current journey stage.
Color	Change the color of the stage according to your preferences.

Touchpoints

Touchpoints can be added to the journey map 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 your company, or when an address is changed, or when a specific document is received by the Contact, or a form is sent by 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 activates the touchpoint and executes the interactions, which basically runs an automated engagement 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

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

Editing a Touchpoint

1. Right-click on a touchpoint at your choice in the Journey Map.
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.

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

Touchpoint Triggers

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

Add a new 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 for all Contacts associated with the Account.
   • Contact Updated - activate the touchpoint when the Contact criteria is met.
   • Correspondence Submitted - activate the touchpoint when the Correspondence Document is submitted by a Contact.
   • Document Created - activate the touchpoint when the Document is created and associated with a Contact.
   • Email Read - activate the touchpoint when the email is read by a Contact.
   • Email Link Clicked - activate the touchpoint when the email link is accessed by a Contact.
   • Email Opted-Out - activate the touchpoint when a Contact opts out from an email using the unsubscribe footer of an email body.
   • Touchpoint Completed - activate the touchpoint when a Contact completes another touchpoint.
   • Tracked Event - is triggered by a Contact when tracked in a website.

3. When all configurations are finished, select Apply to save the changes.

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.

Add a new 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 repository or uploading from your local machine.

3. When all configurations are finished, select Apply to save the changes.

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 Preview page. It allows you to monitor your customers and manage them appropriately. The touchpoint last activated by each contact is also displayed here.

More Options

• Open: redirect you to the Contact page.
• Compose: sends correspondence to the contact.
• Move to: to move the selected contact to another touchpoint.

Personas

EngageCX

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. The most important rule here is that a Contact can be in only one Persona at a time. If the Contact switches Persona because of the rules, it can also cause the Contact to unroll from the current Journey and enroll to a different Journey, depending on the new Persona.

Accessing Persona Module

1. Select the System button from the top-left EngageCX's Welcome page.
2. Choose the Personas option under Engagement group.

Creating New Persona

1. In the Personas page, select the + New Persona button 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.
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.

More Personas Options

After a Persona entity is created, it will appear in the Personas list. To review properties for each Persona, simply select it from the list or follow the steps below.

Open	Delete	Properties

Open Customer Details

By accessing this option, you can open all the Contacts assigned to a Persona. To open a Persona:

1. Select the More Options button corresponding to a Persona.
2. Select Open option from the contextual menu.

All Contacts assigned to this Persona will be displayed in a list, from where you can easily make further configurations.

Delete Persona

By accessing this option, you can remove all the Contacts assigned to a Persona. To remove a Persona:

1. Select the More Options button corresponding to a Persona.
2. Select Delete from the contextual menu.
3. A confirmation dialog is displayed to inform you that there are changes related to contacts' state. Confirm if you want to apply these changes.

View Persona Properties

By accessing this option, you can edit properties of a Persona. To access Persona's properties:

1. Select the More Options button corresponding to a Persona.
2. Select Properties from the contextual menu.
3. Edit Persona's properties according to your needs.
4. Select Save to update the changes.
5. Confirm the changes related to contacts' state if you want to apply them.

Organization

Analytics

EngageCX

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 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

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

or

1. Select the System 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.

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 of them, select the All Menu and to create new views, please visit the Views chapter of this guide.

Creating New Dashboards

1. From the Analytics page select the New Dashboard button in the toolbar.
2. Choose the Project that should be executed from the New dashboard dialog. If many, you have the possibility to use the search bar for a specific project name.
3. Next, click on Run button 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

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.

Export to

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.

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.

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.

Show Hide Scrollbar

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

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.

1. Within Dashboard Output Preview, click on the Reports button, on the right side of 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 on the Generate report button.

The output file will be downloaded on your local machine.

Developer

EngageCX Develop EngageCX

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

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 the 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 the 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.

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.

More API Keys Options

At any time, you can click on the More Options 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.

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.

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.

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 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.

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 Options menu 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

Financial

Contract	Basic contract template showcasing advanced forms features.
Credit Order - Digital Signature	Demonstrates how you can use a digital signature with an interactive communication.
Credit Order - DocuSign	Demonstrates how you can use electronic signatures with an interactive communication.
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 Agreement	The Loan Agreement sample is an interactive document between a borrower and a lender, in which the borrower promises to pay back a loan to the lender according to a specified repayment schedule.
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.

Insurance

Insurance Policy	The Insurance Policy sample demonstrates how forms can retrieve directly the data from EngageCX contacts.
Smart Explanation of Benefits	Smart Document sample with interactive charts and tables that generates multiple statements from data.

Retail

Adventure Works	Collection of dashboards that describe 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.

Telecom

Analytics Telephone Invoice	Analyses usage accounts using interactive charts and visualizations.
Invitation for Special Deals Alerts	An email on-demand template used to notify contacts of special deals alerts access.
Request Quote	An interactive communication template that contains a form which requests a quote.
Sign up for Telecom Insider	Interactive template sample which contains a form used to sign up for Telecom Insider Program.
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.
Subscribe to Special Deals Alerts	An interactive sample containing a form which allows Special Deals Alerts once a customer joins the Insider Program.
Thank you for requesting a Quote	On demand sample used in Engagement after a user requests a quote.
Welcome to Insider Program	On-demand communication that allows customers to stay in touch with the new products and opportunities, monthly newsletters, special offers, and benefits.

Documentation

Accessing this module will take you to the Developer 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

• Create beautiful, dynamic documents from any data source.
• Comprehensive set of professional publishing features suitable for a wide range of applications including letters, invoices, statements, product catalogs and more.
• For more details, please visit our EngageCX Publisher User Guide.

For Data Models: Modeler tool

• Create professional communication or delve into insights that Business Intelligence provides.
• Features for visual, logic and easy-to-use interface that help users to connect to any data source and quickly generate a uniform output to power the dynamic document generation.
• For more details, please visit our EngageCX Modeler User Guide.

For Advanced Data Visualization Dashboard: Analyst tool

• Gain insight and perform analysis on any data using the intuitive visualizations and powerful algorithms.
• Powerful dashboards design features that enable users to design custom dashboards to successfully glean important insights from enterprise data and make use of the interpretation, analysis and prediction that make business intelligence so powerful.

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:

• Javascript for web programmers through the inclusion of EngageCX.EOS.Client.2.0.js.
• .NET for C# programmers by adding a reference to the EngageCX.EOS.Client.2.0.NET.dll assembly.
• Java for Java programmers through the EngageCX.EOS.Client.2.0.Java.jar package.

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 Developer Guide.

Accessing the Software Module

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 System button from the top-left corner.
2. Choose the Developer option under the Organization module.
3. Choose Software tile to download EngageCX tools and software products.

Admin

EngageCX Develop EngageCX

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

The Admin module allows you to access the following sections:

Home	Users	Groups
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. Click on the Settings gear button, at the top-right corner of the Enterprise Website.
2. Access the Home tab from the Sidebar.

Managing 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 the OK to save the changes.

Exporting Environments

1. Access the Home tab within the Settings page.
2. Select the 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 the Export.

The zip archive will be downloaded to your personal computer and will contain all files and folder stored within your environment.

Importing Environments

1. Access the Home tab within the Settings page.
2. Select the 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. Once ready, select the Import to save the changes and proceed with the import procedure.

Users

The Users Menu 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 the projects data and other administrative functions.

Accessing the Users Menu

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

Creating New Users

1. Access the Users tab within the Admin settings page and select the +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.

More Users Options

In the Users page you can select the More Options button, next to a specific username and execute the following actions:

Edit User

1. In the Users page, select the More Options button next to the user. Choose the Edit option from the contextual menu.
2. Modify the user's configurations that are needed and select the OK to update the changes.

Delete User

1. In the Users page, select the More Options button next to the user. Choose the Delete option from the contextual menu.
2. Confirm the deletion of the user by selecting OK.

Groups

By accessing Groups Menu, 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.

Accessing the Groups Menu

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

Creating New Groups

1. Access the Groups tab within Admin Settings page and select the +New Group button, 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 the Save to update the changes.

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

More Group Options

In the Groups page, at any time, you can select the More option, next to the group name and execute the following actions:

Edit Group

1. In the Groups page, select the More Options button next to the group. Choose the Edit option from the contextual menu.
2. Modify the group's configurations that are needed and select the OK to update the changes.

Delete Group

1. In the Groups page, select the More Options button next to the group. Choose the Delete option from the contextual menu.
2. Confirm the deletion of the group by selecting OK.

Users and Groups Permissions

EngageCX Platform gives you the ability to make your resources or EngageCX features accessible or limited 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:

• Include Users to Groups.
• Set up Workspace Permissions.
• Configure Folder Permissions

For each group, you can set up the following:

• Manage Environment Permissions
• Set up Workspace Permissions.
• Configure User Interface Profile.

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 the 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 the 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 the 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 the 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 Options menu, 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 the 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 the 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 the 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 the 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 the 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.

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
• environment-based license

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. 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

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 the 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 the 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 the 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 Options button next to the Key to perform the following actions:

Assign	Uninstall

Assign License to a User

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

1. In Licenses page, select the More Options 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 the 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 options 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 Options 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 the 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 the Uninstall Product Key, where you paste the string you have previously copied. Then, select the 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

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

Adding a New Domain

1. Access the Domain page and select the +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 geographical data, respectively what device detection you want to store.
3. Once you're ready, select the Create.

The domain will appear now on your Tracking list.

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 the Get Tracker Code.
3. Select the 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.

To learn more about website visitors, please access the Domain Visitors section of this guide.

More Tracking Options

Edit Tracker

1. Select the More Options button next to the tracker.
2. Choose the Edit option from the contextual menu.
3. Modify the tracker's configurations that are needed and select the Update to save the changes.

Delete Tracker

1. Select the More Options button next to the tracker.
2. Choose the Delete option from the contextual menu.
3. Confirm the deletion of the tracker by selecting Delete.

Channels

EngageCX Channels are used to deliver communications directly to the final recipients.

Accessing the Channels Menu

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

or

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

Creating an Email Channel

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.
   • 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 the Send test email if you want to check if the Email connection is successfully configured.
3. Once ready, select the Save to update the changes.

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

Sending Emails using EngageCX Platform

Synopsis:

Often, users want to create a workflow that allows sending emails once the documents are produced. You may want your workflow to send an email message for any of a wide variety of purposes. For example, you might want the workflow to send you a notification each time that it begins to run or when the workflow reaches specified stages or performs specified actions.

Answer:

This tutorial will guide you through the process of sending emails using an Email connection through the workflow.

Step 1: Set up an Email Connection

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

• A unique name for the connection.
• The SMTP Server Host name or IP Address.
• A username and a password.
• The Email address that should be used when sending emails using this connection.

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

• A unique connection name.
• A domain name.

The domain name has to be verified in order to be usable through EOS. 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 setup this domain in Amazon SES. However, if you are using the hosted version of EOS contact engagecxsupport@mhcautomation.com to request a new domain set-up in Amazon SES.

Step 2: Create an Email Channel

Configure an Email Queue to be used as a delivery channel for your messages. When creating you will need to provide the following:

• A unique queue name.
• An Email connection.

Step 3: Design the Email Template

To create the email body template you can use the EngageCX Design Studio Publisher. Follow this link to read more information on how to design a Publisher template.

Step 4: Set up the workflow

A workflow that is sending emails needs to contain the following steps:

• GetData: add the data source under the Source parameter from where you want to extract data within the email content.
• Render: add the template created at step 3. Here, the Output Format parameter needs to be Email Body. For the Template parameter, add the template created.
• Email: add the email step to include the recipient, the sender, email subject and other necessary parameters. All these parameters can be found under the +Add parameter list under the Advanced tab.

Creating a Print Channel

1. In the Channels page, select the +New Channel button from the toolbar. Choose 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 the 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 Channel

1. In the Channels page, select the +New Channel button from the toolbar. Choose 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 the Save to update the changes.

Your SMS 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 Options button, next to the channel name and execute the following actions:

Delete Channel

1. Select the More Options button next to the channel. Choose the Delete option from the contextual menu.
2. Confirm the deletion of the channel by selecting OK.

Access Channel Properties

1. Select the More Options button next to the channel. Choose the Properties option from the contextual menu.
2. Modify the channel's configurations and select the Save button to update the changes.

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

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

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 dropdown 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.

Apps

Promotions

Promotional Marketing plays an important role in establishing relationships between customers and the organization's offerings to the market. EngageCX Platform provides you the Promotions module, that has functionalities that help your organization to promote services, products or businesses to tell compelling stories. By using them, your customers are aware of your brand, just like when you hear "soda" and you think about Coca-Cola. Even if your product or service is extremely advanced and innovative, this can be useless until your clients do not know about it. These options are available in EngageCX Custom only, but if you do not see these options in your environment reach out to your account manager for an upgrade.

Accessing Promotions Module

1. Select the Systems menu from the top-left corner of the Enterprise Welcome page.
2. Choose the Promotions option under the Apps Module.

Creating a New Promotion

1. In the Promotions page, select the +New Promotion button from the toolbar.
2. Fill in the New Promotion form with the required fields:
   • Name: provide a name that will help you identify the current promotion later.
   • Description: optionally, choose a description where you define the purpose of this promotion.
   • Start and End: set the Start date & time and the End date & time for the promotion duration, using the date & time picker provided.
   • Enabled: check this option, to enable the promotion for the targeted period configured. If you do not check this option now, you do it later, by ticking the Enabled button within Promotions page.
3. Once ready, select the Create button to save the changes.

Notice that your Promotion has been added to the Promotions page. The Promotions page provide a straightaway view of all the existing promotions created within your EngageCX environment, along with substantial information such as the period when a promotion is active, whether a promotion is enabled or disabled or how many Ads are included within a promotion.

More Promotions Options

Additionally, you can access other options by selecting the More Options button next to a promotion's name:

Edit	Delete

Edit Promotion

1. In Promotions page, select the More Options button for the promotion that you want to edit.
2. Select the Edit from the contextual menu.
3. Configure the Promotion's properties according to your needs.
4. Once ready, select the Update to save the changes.

Delete Promotion

1. In Promotions page, select the More Options button for the promotion that you want to remove.
2. Select the Delete from the contextual menu.
3. Select the Delete button once again to confirm the deletion.

Include Advertisement

Once a new promotion is created, you will have to add advertisements (ads) to it. Ads offer companies a way to highlight different products and services, increase awareness and demonstrate the differences between your products and competing products in order to sell them.

To add a new ad to your promotions:

1. In the Promotions page, access the promotion you want to edit, then select the +New Ad button from the toolbar.
2. Fill in the form with the required fields:
   • Name: enter a unique name for your ad;
   • Description: optionally, provide a description to highlight your ad's purpose;
   • Next, select a Content for your ad. The content of a valid Ad have to consist in a subdocument (.epb file) or an image (.png, .jpg, .tiff, .gif, *.jpeg). Optionally, your ad can have multiple contents. You can choose between the default content, a small variant or a large variant. For each of the three categories, you can further add multiple variants. The engine will select the variants incrementally. For example, if you have three variants, V1, V2, V3; when the template will be rendered, if on the template page a large ad will fit, then the engine will choose the V1 variant. For the next large ad, will choose V2, then will select the third variant, V3. Then, will start again with the first variant.
3. Next, assign your promotion to a communication by selecting the template where you want to include the respective Ad.
4. Choose the location in the page, where the Ad will be places:
   • Bottom: At the render time it searches for an available space to insert the Ad in the bottom of the first page.
   • Left: At the render time it searches for an available space to insert the Ad in the left side of the first page.
   • Right: At the render time it searches for an available space to insert the Ad in the right side of the first page.
5. Select the +Add Rule button for the dynamical placement of this advertisement in the template. Rules are used to dynamically specify if an Ad can be used or not. Within an Ad, you can use one or multiple rules. For each rule, you need to specify a Name and a Rule (conditional expression). The conditional expression must be a valid boolean XPath (e.g.
   number(/ns:Invoices/ns:Invoice/ns:Invoices/ns:Invoice/@InvoiceNumber) > 10) ). Note that the XPath is relative to the XML used as data source for the selected template.
6. Once ready, select the Create to save the changes.

More Ad Options

After an Ad is included in a promotion, it will appear in the Ads list and the following properties can be easily accessed from the More Options button.

Delete	Edit

Delete Ad

Accessing this option, you can remove an Ad placement from the current campaign by following the steps below:

1. Select the More Options button for an Ad.
2. Choose Delete option from the contextual menu.
3. A confirmation dialog is displayed to inform you that the Ad placement will be permanently deleted. Select the Delete to confirm the removal.

Edit Ad

Access this option to edit the Ad placement in the current campaign and change its initial configurations.

1. Select the More Options button for the Ad.
2. Choose Edit option from the contextual menu.
3. Modify the Ad placement properties in the current promotion and select the Save to update the changes.

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 Enterprise Welcome Page. For every search that you intend to do, we recommend to:

• Make sure all words are spelled correctly.
• Try different search terms, in case you obtain unsatisfied results.
• Limit your search terms and try to use fewer words.

These options are available in EngageCX Develop and EngageCX, but if you do not see these options in your environment reach out to your account manager for an upgrade.

Quick Search

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.

Performing Quick search

1. In the EngageCX Enterprise 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.

Search Tips

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

• "your_content" - in case that your keyword is the middle part of the word you are looking for.
• start* - in case that your keyword is exactly the first part of the word you are looking for.
• *end - in case that your keyword is exactly the last part of the word you are looking for.
• property: your_value - in case you know the value of a property and you can use it as a keyword.

Sidebar Views

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.

Advanced Search

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.

Accessing Advanced Search

1. Access the EngageCX Enterprise 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

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, having a good view and clear idea of the project's onset, enhancing your organization to a successful management and completion of your document production.

Working with Tasks

Within Tasks module, you are allowed to create new tasks and issues for other users, review files and approve or add new document versions. These options are available in EngageCX, but if you do not see these options in your environment reach out to your account manager for an upgrade.

Accessing the Tasks Module

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

Creating a New 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 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.

Navigating through Tasks

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

• For approval: shows all the tasks that require approval by you or another administrator user, either created form Tasks or assigned using the Review and Approval process.
• My Tasks: display a view of all the tasks that have been assigned to you.

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:

• the Task Board, that shows the team member for which the task has been assigned, creation date or the status of work as it progresses from New to Active, then to Complete.
• the Timeline Board, providing a clear map of all the stages on which a task went through.
• the Comments Board, where you can add and review comments or attachments.

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

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 to add new attachments or comments, or simply select the OK to start working.
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.

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.

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.

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 Options menu, 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 Options menu, 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

1. Access the Tasks page and locate the task you want to remove.
2. Select the More Options menu, 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

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.

Configurations

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

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

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

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

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 the 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 the 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 which you are interested in to see in the view. For more details, please read Columns chapter.
   • Additionally, you can select the 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 the 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

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 the Save to update the changes.

Deleting 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 the OK and confirm the deletion.

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 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

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 the 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 the Save to update the changes and successfully create the task.

Editing a Task Type

1. Access the Task Types page and click on the More Options menu, next to the task you want to edit.
2. Select the 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.

Deleting a Task Type

1. Access the Task Types and click on the More Options menu, next to the task you want to edit.
2. Select the 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

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 the Add to save the changes.

Updating 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 the Save to update the changes.

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

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

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 the Save to update the changes.

Updating Environment Variables

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

Deleting Environment Variables

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

Using Environment Variables within Workflows

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 Enterprise, 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

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

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

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

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 the Save to update the changes. The new tag will appear in the custom tags list.

Updating Custom Tags

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

Deleting Environment Variables

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

Using Custom Tags within Workflows

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 the +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.

Single Sign-On

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 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 SSO 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 SSO

The SSO 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:

• SSO with Security Assertion Markup language (SAML 2.0).
• SSO with Web Services Federation (WS-Federation)

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 Enterprise 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). To read more information about SSO requirements, please access the Single Sign-On section of the Sysadmin Guide.
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 the 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 the 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 the 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.

• If the configuration was set up properly, you will be logged in to the EngageCX Enterprise/Customer Portal website.
• If the configuration failed, review the setup steps and use the link displayed in the How to use box to authenticate. It should look like below:

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

where:

• Environment : is the environment name on which you want to login with SSO. (Required)
• RelayState : is the return URL after the SSO authentication is successfully. (Optional)

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 the 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

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 Options menu from the toolbar.
2. Select the 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 the Save to update the changes.

Viewing 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

1. Within Audit page, select the More Options menu 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 the OK.

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

1. Within SysInternals page, select the Emails Bounce List button under the Configurations 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

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.

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

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

Configure OAuth

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 Enterprise 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:

• Hostname|IPAddress - is the EngageCX Server. (e.g. companyABC.ecrion.com)
• EnvironmentName - is the Environment name where the OAuth was configured. (e.g. Development).
• RelayState - is the return URL after the OAuth2 authentication is finished successfully. (e.g. https://companyABC.ecrion.com/EOS/EprEditor?embed=true&path=#workspace/Default/Retail/Invoice.epr)

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

• Next, you will be redirected to the third party login page, where you have to provide the corresponding user credentials and click Log In.

• Then you will be redirected again to the Enterprise Portal, where you can use any of the feature provided by the EngageCX solutions.

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
SFTP	Amazon S3	Azure	Salesforce	Microsoft Dynamics CRM	SMS	BPMOnline

Database

Accessing Database Connections

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

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 connectionstrings.com 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 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 Database Connection

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

1. Under the Database connection 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 the Delete.

SharePoint

Accessing Sharepoint Connections

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

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 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 SharePoint Connection

If you want to remove an unused connection, 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 delete and select the More Options button.
2. Select the Delete from the contextual menu.
3. Confirm the deletion and select the Delete.

Document DB

Accessing Document DB Connections

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

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 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 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 delete and select the More Options button on the right-hand side.
2. Select the Delete from the contextual menu.
3. Confirm the deletion and select the Delete.

DocuSign

Accessing Electronic Signature Connections

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

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 the 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 the Go to admin.
3. Once in the Admin Console select the API and Keys.
4. Select the Add Integrator Key button.
5. Enter a description for your key and select the 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 the Go To Admin.
3. Once in the admin console select the Connect under the Integrations section on the left.
4. Select the 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 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 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 delete and select the More Options button.
2. Select the Delete from the contextual menu.
3. Confirm the deletion and select the Delete.

Email Connections

Accessing Email Connections

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

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 the 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:

• Server Name - The SMTP Server Host name or IP Address.
• Port - The port number. By default, the port number is 25 for non-encrypted connections and 587 when SMTP SSL is checked.
• Username - The SMTP username
• Password - The SMTP password.
• From - The email address that should be used when sending email using this connection.
• Check if the connection is encrypted or not.

Amazon SES Connections

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

• Identity Type
• Email Address

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 support@ecrion.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 Options button.
2. Select the 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.

1. Under the Email 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 the Delete.

Facebook

Accessing Facebook Connections

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

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 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 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 delete and select the More Options button.
2. Select the Delete from the contextual menu.
3. Confirm the deletion and select the Delete.

FTP FTPS

Accessing FTP-FTPS Connections

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

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 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 FTP/FTPS Connections page and follow the steps described below.

1. Under the 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 the Delete.

SFTP

Accessing SFTP Connections

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

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 the 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 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 SFTP Connections page and follow the steps described below.

1. Under the SFTP connection 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 the Delete.

Amazon S3

Accessing Amazon Web Service Connections

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

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.

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 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 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 delete and select the More Options button.
2. Select the Delete from the contextual menu.
3. Confirm the deletion and select the Delete.

Azure

Accessing Azure Connections

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

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.

BPM Online

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

Accessing BPM Online Connections

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

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 BMPOnline Connection.
   • URL - The login URL of your BPM org.
   • Provider Type - The type of provider of the authentication service (Basic or Cookie).
   • 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)
   • Username - The BPM username.
   • Password - The BPM password.
   • 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

Accessing Salesforce Connections

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

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

1. Login to your Salesforce account.
2. From your personal settings, type Reset in the Quick Find box, then select the 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 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 Salesforce Connections page and follow the steps described below.

1. Under the Salesforce connection 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 the Delete.

Microsoft Dynamics CRM

Accessing Microsoft Dynamics Connections

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

1. Under the Microsoft Dynamics CRM connection page, select the +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 the 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 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 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 delete and select the More Options button.
2. Select the Delete from the contextual menu.
3. Confirm the deletion and select the Delete.

SMS Connections

Accessing SMS Connections

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

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 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 SMS Connection page and follow the steps described below.

1. Under the SMS connection 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 the Delete.

Channels

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.

Delete Channel Queue

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

View Channel Queue Properties

1. In the Email Queues page, select the More Options button under the toolbar.
2. Choose the Properties option from the dropdown menu.
3. Perform modifications for the selected Channel Queue and select the 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.

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

Jobs	Schedule	Triggers
Execution Log	Sync Log	Files

Jobs

Running a Job

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).

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

Download	Creates a Zip archive with all the files generated during Job execution. This includes data files.
Run Again	Restart execution of the current job.

From More Options Menu

Edit Workflow	Go to Workflow Preview.
Open Workflow Folder	Navigate to the Project folder where this workflow belongs to.
Restart from Step	Restart execution from a certain step forward.
Delete	Delete the current Job.

Schedule

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

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

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.

Trigger

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 type of Hot Folder; 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

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, those data will be stored in a 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:

• the date and time they are visiting and
• the location from where they are accessing your website.

All the data you want to store can be configured from the Domain 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.

Viewing Visitors

To view all the visitors that access your website, follow the steps below:

1. Go to the Domain section within SysInternals.
2. Select the Visitors option, next to the domain name you want 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:

• In the upper part of the page, you will be able to view the user form. At any time, you can click on the fields and add the information you want about those users. Once ready, do not forget to save by clicking the Save button, in the toolbar.

• In the bottom part, you will see the user's activity. Information such as accessed date, website context, or other tracking details will be displayed. To filter the activity displayed, select the Activity Filter, next to Date, and check the assets for which you want to display users actions.

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 Options button, next to the user and select from the following options:

Open	Delete	Properties

Open Visitor

This option will open the corresponding anonymous user page.

Delete Visitor

This option will permanently delete the selected user from the list.

View Visitor Properties

Selecting this option will open a dialog that allows you to edit the current user information.

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.

Navigating through EngageCX Modules

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:

• Performing a document Search.
• Accessing, creating or reviewing EngageCX Tasks.
• Getting help or tell us your feedback by selecting the ? button.
• Updating your account preference options.
• Seeing the environment you're working on, or if available for your account, switch between environments by selecting the drop down menu, halfway off the top bar.

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.

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

• Image Compression
  This option will set the type of image compression used by the rendering engine. The options to select from are JPEG and Flate.
  JPEG (Joint Photographic Experts Group) compression algorithm is used to compress true color (24 bit depth) images or gray scale images. JPEG is ideal for large images or photographs, and images with large areas of the same color or small variations of colors. Use JPEG when you want to reduce the output PDF size as much as possible.
  Flate (deflate) is a smart algorithm that adapts the way data is compressed. Flat is ideal for images that contain text or line art, and that have sharp transitions of color. Choose this format when you want to make sure that the image quality is unaltered even if it may mean that the generated files are larger.

• Conformance
  This is used to specify options for generating PDF output. Default value is 0, that is, system wide options configured in the Management Console will be used. EngageCX has the following conformance values to select from:

  • PDF/X
  • PDF/A-1a
  • PDF/A-1a-Accessible
  • PDF/A-1b
  • PDF/508

• Version
  This is used to specify which PDF version should be used. EngageCX has the following version types available.

  • PDF/1.4
  • PDF/1.5
  • PDF/1.6
  • PDF/1.7

• Owner Password
  Opening the document with the correct owner password (assuming it is not the same as the user's password) allows full (owner) access to the document. This unlimited access includes the ability to change the document’s password and access permissions.

• User Password
  Opening the document with the correct user password (or opening a document that does not have a user password) allows operations to be performed according to the user's access permissions specified in the document’s encryption dictionary.

• Encryption Strength
  The encryption strength applies to the password(s) you have set. The higher the value, the harder it is to break the password. Valid values for the parameter are 128 and 40, the default is 40.

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

• Encoding
  With this option you will be able to specify the encoding for the text output. The options available are:

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.

• Line Height
  Specifies the line height used for layout text in the output. It defines the amount of space above and below inline elements.

• Trim Pages
  When the value is set to "true", the server will calculate how many pages will be printed, taking into account the font size, line height and page size.

TIFF

TIFF (computer file format) output is very useful when the output must be sent to a FAX Machine.

Advanced Parameters

• Resolution
  This parameter will set the resolution for both the X and Y of the image in DPI (Dots Per Inch). The valid input for this parameter is an Integer, for example 300.

• Encode Compression Type:

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

• Include Images

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.

• Fixed Body Width
  This option will specify whether to preserve the width of the original page body or not. As this is a Boolean expression your only options to select from will be True or False.

• Fixed Body Align
  This option will specify the body alignment. The valid options to select from are:

HTML

EngageCX has the ability to produce HTML (Hypertext Markup Language) output. The following options will help you customize this output.

Advanced Parameters

• Fixed Body Width
  This option will specify whether to preserve the width of the original XSL-FO page body or not. As this is a Boolean expression your only options to select from will be True or False.

• Fixed Body Align
  This option will specify the body alignment. The valid options to select from are:

  • HOBA Left
  • HOBA Right
  • HOBA Center

PS

EngageCX can generate Post Script files.

AFP

EngageCX can generate AFP (Advanced Function Presentation) output.

Advanced Parameters

• Code Page
  A code page is a table of values that describes the character set used for encoding a particular set of glyphs, usually combined with a number of control characters. The available options to choose from are:

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.

• Convert Fonts
  You are able to select the font technology that is best suited for your printing process. The available options are:

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

• Resolution
  This parameter will set the resolution for both the X and Y of the image in DPI (Dots Per Inch). The valid input for this parameter is an Integer for example 600.

**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

• Resolution
  This parameter will set the resolution for both the X and Y of the image in DPI (Dots Per Inch). The valid input for this parameter is an Integer for example 600.