EngageCX 11.0 (Lillipup) Users Guide

Release Notes

Summary

The Lillipup release bundles a complete view of your forms settings by allowing you to set up configurations that are globally applied across the whole environment. In addition, it brings a more accessible interface of System Administrator website. Improvements are applied to the Auditing service too, that creates a more restricted audit trail of security-related events due to log files that, with this release, can be cleaned-up.

New Features in Lillipup

• The Lillipup release provides a new Multi environment users architecture. Users can now select the environment when logging in. This ensures a higher level of accessibility and continuity across environments. The feature is available in EngageCX Converse and EngageCX.

• Share files with your team. Starting with the Lillipup release, users can share folders across workspaces, that helps improving data integrity, reduces storage space and saves time. Just organize your files into a folder, then share it across other workspaces. It so simple. The feature is available in EngageCX Converse and EngageCX.

• Everyone pseudo group has been implemented. In this way, all registered users are automatically parts of this group, being able to set workspace rights or folder permissions across the whole group. This brings a security improvement and a better user experience through this type of group. The feature is available in EngageCX Converse and EngageCX.

• The System Administrator website has been updated for full backup and restore. In addition, administrators can easily manage domain settings on the server.

People

In the people module, you are able to add, edit or remove information about persons involved with your organization, and you can also manage the Customer Portal credentials. These options are available in EngageCX, if you do not see these options in your environment reach out to your account manager for upgrade.

Accounts

EngageCX

From Accounts, you can view and manage your organizations or persons involved with your enterprise. x

Accessing Accounts Tile

1. Select the People button from the modules menu from the top of the EngageCX Platform welcome page.
2. Select the Accounts tile.

Or

1. Select the System button from the top left corner.
2. Choose the Accounts option under the People group.

Creating a New Account

1. Under the Accounts page, click on the +New Account button located in the upper right corner of the accounts toolbar.
2. Fill out the Account form with the appropriate values:
   • Account Type: to indicate the account purpose. You can choose from the provided drop-down list (CompanyBranch, CompanyGroup or Individual) or you can create your custom account types from Settings.
   • Parent Account: add a parent account if you want to create a hierarchy of accounts. This is useful when you want to create accounts for partners of your customers and you need to identify those accounts.
   • Account Information: adding a name for each new account is mandatory. Optionally, you can add other useful information by completing the available fields.

EngageCX Solutions allows you to set up your own custom account form from Settings.

Viewing Account Details

To visualize your account details:

1. Access the Accounts page.
2. Select the appropriate account from the available list.
3. Visualize the information in the newly opened page.

or

1. Access the Accounts page.
2. Click on the More Options button next to the account name.
3. Select the Open option.

The number of items displayed on the accounts page can be configured from the drop-down list located at the end of the accounts list.

Updating Account Details

To update your account details:

1. After selecting an account, click on the More Options button located in the upper right corner of the Accounts toolbar.
2. Select Properties.
3. Edit the form values, then click OK to save the changes.

or

1. Access the Accounts page.
2. Click on the More Options button next to the appropriate account name.
3. Select the Properties option.
4. Edit the form values, then click OK to save the changes.

Deleting an Account

You can delete an account at any time. You must note that once an account is deleted, you will not be able to recover it.

1. Select an account from the Accounts list.
2. Click on the More Options button located in the upper right corner of the Accounts toolbar.
3. Select Delete and confirm the deletion.

or

1. Access the Accounts page.
2. Click on the More Options button next to the appropriate account name.
3. Select the Delete option and confirm the deletion.

Creating Documents

1. Access the Accounts page.
2. Click on the More Options button next to the appropriate account name.
3. Select the Create Document option.
4. Choose a communication from the New document dialog, then click Run.
5. You will be redirected to the Document Editor from where you need to fill out the form with the needed values. You are also able to see a preview of the output document on the right side. For more details about Communications, please read the Documents chapter.

Contacts

EngageCX

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

Accessing Contacts Tile

1. Click on the People button from the modules menu from the top of the EngageCX Platform welcome page.
2. Select the Contacts tile.

Or

1. Click on the Systems button from the top left.
2. Choose the Contacts option under the People group.

Creating a New Contact

1. Under the Contacts page, click on the +New Contact button located in the upper right corner of the Contacts toolbar.
2. Fill out the Contact details in the form:
   • Parent Account: add a parent account for each contact if you want to set up a hierarchical relationship between your contacts and accounts.
   • Contact Details: the last name and the email address are mandatory for each contact. Check the Is Primary Contact option if you want to make the current contact the main contact person.

You can also set up your own custom contacts form from Settings.

Viewing Contact Details

To visualize your contact details:

1. Access the Contacts page.
2. Selected the desired contact from the available list.
3. Visualize the contact information in the newly opened page.

or

1. Access the Contacts page.
2. Click on the More Options button next to the contact name.
3. Select the Open option.

The number of items displayed on the contacts page can be configured from the drop-down list at the end of the accounts list.

Updating Contact Details

To update your contact details:

1. After selecting a contact, click on the More Options button located in the upper right corner of the contacts toolbar.
2. Select Properties.
3. Modify the contact details in the Contact form, then click ok to save the changes.

or

1. Access the Contacts page.
2. Click on the More Options button next to the appropriate contact name.
3. Select the Properties option.

Deleting a Contact

You can delete a contact at any time. You must note that once a contact is deleted, you will not be able to recover it.

1. Select a contact from the Contacts list
2. Click on the More Options button located in the upper right corner of the contact toolbar.
3. Select Delete and confirm the deletion.

or

1. Access the Contacts page.
2. Click on the More Options button next to the appropriate contact name.
3. Select the Delete option and confirm the deletion.

Importing Contacts

EngageCX provides the ability to load Contacts from a CSV file. When importing, you can choose how the values in the CSV are being mapped to Contact fields.

Before importing a CSV file into Contacts, you must note that, each row from the CSV file will create a new Contact. Also, the first row from the CSV file is reserved for headings and is used to map the Contact fields.

To import contacts from CSV:

1. Access the Contacts tile.
2. Select the Import option from the More Options button on the upper right corner of the contacts toolbar.
3. Select the Choose File button to upload a .csv file for your contacts.
4. Map the existing fields from the .csv with the existing Contact Fields. If you want to ignore a field from the .csv file, select ignore from the drop-down list.
5. After mapping all contacts, click on the Import button.

Creating Documents

1. Access the Contacts page.
2. Click on the More Options button next to the appropriate contact name.
3. Select the Create Document button.
4. Choose the communication from the New document dialog, then click Run.
5. Next, fill out the communication form with the appropriate values under Documents page. For more details , please visit the Documents chapter.

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 contact 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. Select the Accounts tile.
2. Go to the account information page by selecting Properties.
3. Click on the Manage Contacts button.
4. Add or remove new contacts from the new Account dialog opened. Furthermore, set up the primary contact for the appropriate account.

Adding more accounts to a contact

1. Select the Contact tile.
2. Go to the contact information page by selecting Properties.
3. Click on the Parent Account field and add accounts from the available list. Furthermore, choose if you want the selected contact to be primary or not from the Is Primary Contact option available in the lower left corner of the Contact dialog.

Lists

EngageCX

Lists are used to group Contacts for a specific purpose, such as receiving mass emails. Lists can be static or dynamic.

Accessing the List tile

1. Select the People button from the modules menu from the top of the EngageCX platform welcome page.
2. Select the Lists tile.

Or

1. Select the Systems button from the top left.
2. Choose the Lists option under the People group.

Creating a New List

1. Access the Lists page.
2. Click on the +New List button from the upper right corner of the Lists toolbar.
3. Fill out the Create New List form by providing a name, a description, specify if the list is dynamic or static, and select if you want your contacts to receive regular emails.
4. Optionally, you can allow other users to add themselves by creating a public list. In addition, you can specify a form for user registration by selecting the +Add \ Add Registration option.
5. Click on the Create button to successfully create a new List.

The number of items displayed on the list page can be configured from the drop-down list at the end of the list items.

Static and Dynamic Lists

For a successful business, it is important to group your contacts into 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. In a dynamic list, contacts will be added automatically if they satisfy a set of rules. You can use a dynamic list when you want to send emails more than once to a certain list of contacts that changes and get updated frequently. The Rule Principle is that : Contacts who match the criteria rules, are added to the list.

Adding Contacts to a Static List

1. Select the appropriate List Name from the Lists page.
2. Click on the +Add Contacts button from the Static List page.
3. Choose the needed contacts, then select Save. Optionally, click on the Add option to filter contacts. When you add a filter to a static list, this will add contacts filtered only once. To automatically add contacts based on a defined rule, use Dynamic Lists.

Adding Rules for Dynamic Lists

1. Under the dynamic list page, click on the More Options button.
2. Select the Edit Rules option.
3. Add a filter from the drop-down list, representing the Contact's parameter that needs to be checked in the rule.
4. Select the operator (Equal,Non Equal or Contains) and choose a value for operand's comparison.
5. Click on the Save button to apply the rules to the list.

When editing rules, you can choose any Contact or parent Account fields, as well as Engagement properties (such as Persona or current Touchpoint).

Importing Contacts from CSV

EngageCX allows users to import their contacts within a list from a CSV file. When importing, you can choose how the values in the CSV are being mapped to Contact fields.

Before importing a CSV file into Contacts, you must note that, each row from the CSV file will create a new Contact. Also, the first row from the CSV file is reserved for headings and is used to map the Contact fields.

1. Select the name of the list from the Lists page.
2. Select Add from CSV from the More Options button in the upper right corner of the menu bar.
3. Click on the Choose File button to upload a .csv file.
4. Mapp the existing fields from the .csv with the existing fields.
5. After mapping all contacts, click Import to add them to the list.

Sending Mass Emails using Bulk Communication

1. Select the corresponding list from the Lists page.
2. Click on the Send Bulk Communication button from the upper right corner of the list toolbar.
3. Next, you will be prompted to use a communication. Run the desired communication from the list. For more details about Communications, please read the Documents chapter.
4. You will be redirected to the Documents page from where you will see a detailed view of all the emails generated when sending the communication. In addition, you can also configure the communication templates to display a summary view of the job instead. If you would like to view the Summary view when running that communication you can specify that in the communication’s Properties. Visit the Documents chapter for more details.
5. To view the past mass-email jobs, you will need to access the Documents\On-Demand module. From there, click on the Communication column to view only the jobs for a specific Communication.

Subscriptions

Lists can also be used to manage users that subscribe to various updated, sent by your organization.

1. Select the corresponding list from the Lists page.
2. Click on the More Options button from the right of the list name.
3. Select Properties.
4. When the list is used to regularly send email communication, Contact recipients should have the option to unsubscribe from the list. To enable this, you should check the Allow Contacts to Unsubscribe option.

Deleting a list

You can delete a list at any time. You must note that once a list is deleted, you will not be able to recover it.

1. Select a list from the Lists page.
2. Click on the More Options button located in the upper corner of the list toolbar.
3. Select Delete and confirm the deletion.

or

1. Access the Contacts page.
2. Click on the More button next to the applicable contact name.
3. Select the Delete option and confirm the deletion.

Customer Portal

EngageCX

Using Customer Portal, you can manage credentials of the contacts allowed to access portal and self-service functionality. Only users included in the Administrator group will be able to manage customer portal credentials.

Accessing Customer Portal Tile

1. Click on the People button from the modules menu from the top of the EngageCX platform welcome page.
2. Select the Customer Portal tile.

or

1. Click on the Systems button from the top left.
2. Choose the Customer Portal option under the People group.

The number of items displayed on the customer portal page can be configured from the drop-down list at the end of the customers list.

Adding New Contacts

1. From the Customer Portal tile, click on the + New User button, located in the right corner under the menu bar.
2. Fill in the form with the appropriate values:
   • Select a Parent Account for the user, from the drop-down list.
   • Choose the username.
   • Mark the Generate password automatically option, if you want to receive automatically the password on email.
   • Enable access to Customer Portal by checking the Enabled option.
3. Click OK to successfully complete the user registering.

Opening Customer Portal

1. Click on the Open Portal button next to +New User from the Customer Portal toolbar. You will be redirected to the customer portal login page.
2. Sign in using your contacts credentials.
3. From Customer Portal, contacts can visualize the documents produced.

Updating Contacts Credentials

1. Click on the More Options option next to the contact username.
2. Select Properties.
3. Change the username or reset the password from the User dialog.

Restricting Access to Customer Portal

Environment administrators can provide or restrict access of contacts to the customer portal. If a contact was added in the Customer Portal 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.

To enable permissions to a contact:

1. Click on the More Options option next to the needed contact username.
2. Select Properties.
3. Check the Enable option to provide permissions.

Furthermore, if you want to delete a contact from your EngageCX Software database, select the Delete option.

Creating Documents

To publish a document to a portal user:

1. Select the contact from the Customer Portal page.
2. Click on the New Document button located in the upper right corner of the Customer Portal page.
3. Select a communication from the New document dialog, then click Run.
4. You will be redirected to the Document Editor page from where you need to fill out the form. You will be able to see a preview of the dynamic document in the right side of the screen.
5. After the communication workflow was finished, the output will automatically appear under the contact account.

Documents

EngageCX Solutions provides three different types of Documents: Batch,Correspondence and On-Demand. These options are available in and EngageCX. If you do not see these in your environment, reach out to your account manager or sales@ecrion.com for the upgrade.

Batch Document Production

EngageCX

A batch workflow produces documents for multiple customers from only one input data file. Within the workflow, the data input is split into records and a document is produced for each record. Batch production is optimized to generate high volumes of documents in a short amount of time. Monthly statements are a typical batch use case.

Accessing the Batch Documents Module

1. Click on the Documents button from the modules menu from the top of the EngageCX platform welcome page.
2. Select the Batch tile.

Or

1. Click on the Systems button from the top left.
2. Choose the Batch option under the Documents group.

Running Batch Documents

1. Click on the Run Batch button located in the upper right corner of the Batch toolbar.
2. Choose the communication that should be executed from the Run batch dialog opened(If many, you have the possibility to use the search bar for a specific communication name).

More Batch Job Options

At any time, you can click on the More Options button next to the name of the Job to perform the following actions:

1. Open to view all files that are produced in that run.
2. Run Again to run the current job again.
3. Export and download the run as a Zip file.Here you have two options, you can choose whether or not include inputs or log file.
4. Delete the related Job files.

Reviewing Output and Job Log

After a Batch job is completed, it will appear in the Recent job list from the Batch module.The list will show all Batch Jobs that have been completed and if they finished successfully or failed.You will have the ability to review the documents that were created by the job and to look at the job log for a specific run if an error occurred.

Review Output

To review the output documents of any job simply click on the Job name from the Batch list or select the Open option from the Batch Job options. You are also able to select the Communication name under the Project tab, and view a list of all the jobs using that Communication.

Use the scroll bar in the side menu to look through the documents that have been produced. On each produced document, you can select the More Option button and perform the following actions:

1. Open, to visualize a PDF preview of the selected document.
2. Download, to download a PDF output of the selected document.
3. Share, if you want to create a public link for you, and then email it to the person you want to create the share with.
4. Tag, to add metadata to your output. You can add usual tags to inform your customer, like Important or New, or you can set the Tag to Public, which means that your file can be accessed by anybody, without logging in.

Review Job Log

1. From the preview of the produced documents, click on the More Options button located at the top-right corner of the menu bar.
2. Select the Execution Details option.

This will open a new tab, with the job log for the selected document, specifying the type of each (Diagnostic, Information, Warning or Error) alongside a corresponding message. The steps involved in the document production workflow will also be displayed. For more information about this visit Jobs.

Exporting Documents

1. From the preview of the produced documents, click on the Export button located at the top-right corner of the toolbar.
2. Select if you want to download the inputs and logs, then click Download.
3. A Zip file will be downloaded, and it will contain all the documents produced at each step from the associated workflow.

Review Project Files

1. From the preview of the produced documents, click on the More Options button located at the top-right corner of the menu bar.
2. Select Go to design.
3. You will be redirected to the Communications page from where you can view, edit or delete your batch project files. For more information about this visit Communications.

Correspondence Document Production

EngageCX

Correspondence document production provides a way to enter data manually before running a document production workflow. It is a special use case where the data flowing into the document under production does not come from a database, but rather, comes from manual input. This can cover everything from filling out a standard form to personalizing a letter to a client.

Accessing the Correspondence Documents Module

1. Click on the Documents button from the modules menu from the top of the EngageCX platform welcome page.
2. Select the Correspondence tile.

Or

1. Click on the Systems button from the top left.
2. Choose the Correspondence option under the Documents group.

Producing Correspondence Documents

To produce a Correspondence Document, simply:

1. Click on the New Document button on the right side of the menu bar.
2. Choose the Communication that should be used and click Run.
3. Provide any parameters, if needed.
4. A new Form will be generated and will be ready to be filled in. Once you have entered all the required fields and press Send, a new Job will be started.

More Correspondence Document Options

At any time, you can click on the More Options button next to the name of the Job to perform the following actions:

1. Open the Document to view all files that are involved in producing the outputs as well as all the Jobs for that Document.(Displaying the Jobs for a specific communication can be done also by clicking on the Communication name.)
2. Share will allow you to share the Document publicly or to your portal users.
3. Export and download as a Zip file. (Here you have two options, you can choose whether or not include inputs or log file in the archive.)
4. Delete the Document and, optionally, the related Job files. Note that the project files associated with this Document will not be deleted.
5. Create New Version will update the current Job to the latest changes.
6. Download Form Data which will allow you to download the XML generated by the created document in a specific Job.

From the Correspondence View, you have an option to select items per page for each grid. Once selected, this option will become persistent across the entire user session for the current environment.

Reviewing Output and Job Log

After a Correspondence job is completed it will appear in the My Correspondence job list from the Correspondence module. The list will show all the Correspondence Jobs that have been completed and if they finished successfully or failed. You will have the ability to review the documents that were created by the job and to look at the job log for a specific run if an error occurred.

Review Output

To review the output documents of any job, simply select the Job name from the list. You are also able to select the Communication name and view a list of all the jobs that have been run using that communication.

You will see a preview of the fields that were filled in the form to better assist in selecting the correct document to view easier. On each produced document, you can select the More Option button and perform the following actions:

1. Open, to visualize a PDF preview of the selected document.
2. Download, to download a PDF output of the selected document.
3. Share, if you want to create a public link for you, and then email it to the person you want to create the share with.
4. Tag, to add metadata to your output. You can add usual tags to inform your customer, like Important or New, or you can set the Tag to Public, which means that your file can be accessed by anybody, without logging in.

Switch between Summary and Documents Mode

There are two modes to view the output that have been produced by a specific job. From the Document Editor, on the left side under the toolbar, you can choose between Documents or Summary options.

Documents Mode

By default, the detailed mode will be displayed when selecting the corresponding job, where you are able to see the whole content of the document.

Summary Mode

The Summary option, reveal short reports about documents produced, documents sent, if there are unsubscriptions recorded and so on.

Review Job Log

1. From the preview of the produced documents, click on the More Options button on the top right of the menu bar.
2. Select the Execution Details option.

This will open a new tab, with the job log for the selected document, specifying the type of each (Diagnostic, Information, Warning or Error) alongside a corresponding message. The steps involved in the document production workflow will also be displayed.

Exporting Documents

1. From the preview of the produced documents, click on the Export button located at the top-right corner of the menu bar.
2. Select if you want to download inputs or logs, then click Download.
3. A Zip file will be downloaded, and it will contain all the documents produced at each step form the associated workflow.

Downloading Form Data

1. From the preview of the produced documents, click on the More Options button located at the top-right corner of the menu bar.
2. Select Download Form Data.
3. An XML file will be downloaded, and it will contain all the input data typed before running the form.

Review Project Files

1. From the preview of the produced documents, click on the More Options button located at the top-right corner of the menu bar.
2. Select Go to design.
3. You will be redirected to the Communications page from where you can view, edit or delete your correspondence project files. For more information about this visit Communications.

On-Demand Document Production

EngageCX

On-Demand Document Production happens whenever there is a need to generate documents in real-time. A typical use case for on-demand is when a customer visits your website and click on a button to generate a price quote.

Accessing the On-Demand Documents Module

1. Click on the Documents button from the modules menu from the top of the EngageCX platform welcome page.
2. Select the On-Demand tile.

Or

1. Click on the Systems button from the top left.
2. Choose the On-Demand option under the Documents group.

Running On-Demand Documents

1. Click on the Create Document button on the right of the menu bar.
2. Choose the communication to create.
3. Provide any parameters that are needed.

More On-Demand Document Options

At any time, you can click on the More button next to the name of the Job to perform the following actions:

1. Open to view all files that are produced in that run (if the Job completed successfully).
2. Run Again to run the current job again.
3. Export and download the run as a Zip file. (Here you have two options, you can choose whether or not include inputs or log file)
4. Delete the related Job files.

Reviewing Output and Job Log

After an On-demand job is completed it will appear in the Recent log list from the On-Demand Module. The list will show all On-Demand Jobs that have been completed and if they finished successfully or failed. You will have the ability to review the documents that were created by the job and to look at the job log for a specific run if an error occurred.

Review Output

To review the output documents of any job, simply select the Job name from the list. You are also able to select the Communication name and view a list of all the jobs that have been run using that communication. On each produced document, you can select the More Option button and perform the following actions:

1. Download, to download a PDF output of the selected document.
2. Share, if you want to create a public link for you, and then email it to the person you want to create the share with.
3. Tag, to add metadata to your output. You can add usual tags to inform your customer, like Important or New, or you can set the Tag to Public, which means that your file can be accessed by anybody, without logging in.

Review Job Log

1. From the preview of the produced documents, click on the More Options button on the top right of the menu bar.
2. Select the Execution Details option.

This will open a new tab, with the job log for the selected document, specifying the type of each (Diagnostic, Information, Warning or Error) alongside a corresponding message. The steps involved in the document production workflow will also be displayed.

Exporting Documents

1. From the preview of the produced documents, click on the Export button located at the top-right corner of the menu bar.
2. Select if you want to download the inputs or logs, then click Download.
3. A Zip file will be downloaded, and it will contain all the documents produced at each step from the associated workflow.

Review Project Files

1. From the preview of the produced documents, click on the More Options button located at the top-right corner of the menu bar.
2. Select Go to design.
3. You will be redirected to the Communications page from where you can view, edit or delete your correspondence project files. For more information about this visit Communications.

Design

The Design module allows you to create new communications, as well as modify any of the existing communication you have access to, in the environment. Here, you can also import interactive dashboards and create analytics projects, or construct and deliver personalized Advertisements.

Communications

EngageCX

Communications organize the interactions with your customers and manage the flow of information for one-on-one, group or mass communications.

Accessing the Communications Tile

1. Click on the Design button from the modules menu at the top of the EngageCX platform welcome page.
2. Select the Communications tile.

Or

1. Select the Systems menu from the upper left corner.
2. Choose the Communications option under the Design group.

Creating a new Communication from Scratch

1. Select the New Communication button from the upper right corner of the menu bar.
2. Choose the type of template you would like to create (either a blank, invoice, letter template, salesforce lead or email blast), and select Next.
3. Provide a name for the new communication project. This name will appear in the workspace as the folder name for this project.
4. Select the Workspace where the project has to be added to, by choosing from the available drop-down list or create a new folder inside an existing Workspace.
5. Choose how the document should be produced. Depending on the type of template you selected you will have seen different options.
   • Interactively: Blank, Lead or Letter
   • In Batch: Blank, Invoice or Letter
   • On-Demand: Blank, Email or Letter
6. Optionally, you can search for a Word document to upload it as a data source.
7. Select Create and a new communication will be created with all the necessary assets.

Creating a new Communication from a Word Document

Using a Word document as the base for a Communication is a quick way to create a template and a form for interactively produced communication. In order to properly create an interactive communication you will need to highlight, in yellow, the parts of the Word document that should become sections to be filled in by the form. EngageCX will take the Word document you provide and creates a template (.epr file) and a form (.efd file) using the highlighted sections.

1. Select the More Options button at the top-right corner of the Communications menu bar.
2. Choose the Import Word Document option.
3. Search for the Word document to be used.
4. Select the Workspace this new communication should be added to.
5. Select Import and a new communication will be created with all the assets.

Importing a Communication

EngageCX has the ability to export a communication, to move to another system or environment. To import the Communication into a new system or environment you simply need to:

1. Select the More Options button at the top-right corner of the Communications menu bar.
2. Choose the Import Communication option.
3. Search for the Communication zip file to be used.
4. Select the Workspace this communication should be added to.
5. Select Import and a new communication will be created with all the assets.

Optionally, you can check the Import Tags option, if you want to import the tags in the new communication, too. After the communication has been imported you will need to modify the template, form and/or workflow to meet your needs.

Creating a Communication from a Workflow

In EngageCX platform you are able to add all the project assets and create the Workflow before creating the communications themselves. If this is the approach that has been taken you will need to create the communication from a workflow.

1. Select the More Options button at the top-right corner of the Communications menu bar.
2. Choose the Create from Workflow option.
3. Select the type of communication: Interactive, Batch or On-Demand.
4. Provide a name for the communication; this can be different than the folder where the workflow is.
5. Add a description if needed.
6. Search and select the Workflow to be used.
7. Select OK and a new communication will be created with all the assets.

For all cases, after the new communication has been created you will need to modify the template, form and/or workflow to meet your needs and also follow the above Review and Approval steps, to agree the current versions of the Project assets.

More Communications Options

At any time, under the Communications page, you can select the More Options menu next to the name of your communication to perform the following actions:

Open

This option allows you to open the Communication page and view or edit all the assets included.

Test

This option will redirect you to the Documents page, from where you can configure and generate test files.

Export

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.

Snapshots

Select this option if you want to create a snapshot of the entire communication project. More information regarding snapshots can be found here.

Share

This option allows you to share the communication publicly or to your portal users. To share communications, you need first to generate a public link. Public links are view-only and anyone with the link can view and download its contents.

• Select Get Public Link to generate a link for the Enterprise Users. Copy the link to clipboard, then send it through email to any persons that might need access to the communication. You can also select the Get HTML Code if you want to redirect a page once submitted. Under the Redirect URL field, add the link to the page, e.g. http://www.mysite.com.
• Select Get Portal Link to generate a link for the Customer Portal Users. 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 and the project will be available for all portal users.

Cleanup

This option allows you to create a filter in order to delete obsolete files. Here, you can also create a scheduled cleanup for your files. To do that, under the Schedule Cleanup dialog, select how often do you want to delete files and check Enabled to start the process.

Lock\Unlock

This option allows you to lock the communication project or files within it, make changes, and then unlock it so another enterprise user from EngageCX Platform can edit it. When a project is locked, it will be marked with the locked icon, visible on the right side of the project.

Delete

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

Properties

Here, you can edit the configuration name, add a description or configure the way you want to view your produced documents. After a communication is run, in Documents section, it can display the output, show a message, display a summary or automatically submit the files. You can manage this views by selecting the appropriate option under Run mode. Check Enabled to be able to produce documents using the selected communication. Selecting the Advanced icon, allows you to enable/disable features such as life preview before running your documents, providing names for the produced documents, etc.

Templates

EngageCX EngageCX Develop

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. As such, templates are used for all types of document production: batch, on-demand and correspondence. To learn more about how to create a basic Template using the Publisher please visit the EngageCX Design Studio Publisher Help Manual documentation.

Within the templates created there may be subdocuments, 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. It is best practice to create new folders within the project to hold each of the different types of needed files.

Online Editing

EngageCX

Accessing the Online Editor

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

From the Communication Tile

1. Access the Communication Tile.
2. Select the Communication name for the template to be edited.
3. Select the template from the list of Project Assets.

From the Project Folder

1. Access the workspace for the project of the template that needs to be modified.
2. Select the Files tile, inside Collaboration group.
3. Select the Project Folder where the template is located.
4. From the list of project assets and workflows, select the template to edit.

By creating a new Template

1. Access the project folder in the Files submodule on which you want to add a template file.
2. Click on the +New button at the top-right side of the menu bar.
3. Choose the Template option.
4. Provide a name, and optionally a description, then click Create.
5. Notice that the template has been added to the workspace folder and you will be redirected to the Online Template Editor.

Online Editor Interface Terminology

Before you get started designing your form within Form Editor, it is important to take some time to familiarize yourself with the terminology used to describe where options are available for you in the user interface.

Left Side Menu

The left side menu is used to access the necessary functionalities needed to design a template. You can select from different sections and access different groups to find the feature you would like to explore. Below, you can information about each section available in the left side menu.

Properties Pane

The Properties Pane can be used to modify the properties of any object present in your document template.

To enable the Properties Pane, you will need to:

• Select the Format button (brush icon) from the menu bar.
• The Properties Pane will be available in the right side.
• If no element is selected in the Design Surface, you will not be able to see any property in the Properties Pane.

Navigation Bar

The Navigation Bar is a component of the Online Editor that allows you to select specific elements in order to modify their attributes accordingly.

When an element is selected in the Design Surface, you can notice the Navigation Bar displayed at the bottom of the Design Surface.

Design Surface

The Design Surface is the dedicated region in the Online Editor that you will use to add and remove content, adjust alignment and formating, and perform all of your template design needs. This is the largest region of the screen and will display what your template will look like as you design it.

Working with the Side Menu

Data

Add a Data Source

1. From the side panel, select the Data section.
2. Select the More Options menu to the right of the DATA library.
3. Click on the File Path under the Data Model dialog and choose an appropriate input file for the selected template.
4. Select OK. You can notice that your data source is displayed in the left side panel.

Remove a Data Source

1. From the side panel, select the Data section.
2. Select the More Options menu to the right of the DATA library.
3. Click on the Remove hyperink. This will request a confirmation of deletion.

Content Library

The Content Library houses all of the content fragments (or subdocuments) found within a given workspace. If there are no Content Fragments listed you will need to create some that you need.

Create a New Content Fragments

1. Open a document template.
2. Select the Content Library section from the side menu.
3. Click on the + button to the right of the CONTENT LIBRARY.
4. Provide a Name and an optional Category.
5. Select the folder where the content fragment will be saved.
6. In the content box add the content needed in the fragment. For example you could use a Content Fragment to take a first and last name field and combine them.
7. To add dynamic fields click on the fx button and select from the list of data fields.

Edit Content Fragments

1. Access the online editor.
2. Select the Content Library section from the side menu.
3. Click on the Settings gear button from the right of the fragment.
4. Edit the fragment directly in the Content section or click on the Open button.

Add Conditions to Content Fragments

1. Access the online editor.
2. Select the Content Library section from the side menu.
3. Click on the Settings gear button from the right of the fragment.
4. Click on the gear icon from the Edit Content Fragment dialog.
5. Select the Edit option, then add or edit a condition under Condition field.
6. Select the field this condition is based on, the appropriate operator and value.For example
   • Field Sex
   • Operator Equal
   • Value M

Add Repeating Content

1. Access the online editor.
2. Select the Content Library section from the side menu.
3. Click on the Settings gear button from the right of the fragment.
4. Click on the gear icon from the Edit Content Fragment dialog.
5. Select the Edit option, then add or edit a repeating expression under the Repeating field.
6. Select the input field this repeating is based on. For example
   • Field /root/customer

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.

Add a new Section

1. From the side panel, select the Sections option.
2. Select the + button to add a new section to your template.

Edit a Section

1. From the side panel, select the Sections tile.
2. Select the Section to be modified.
3. To rename the section:
   • Select the pencil icon next to the section name.
   • Provide a new name, then select Rename.
4. Adjust the printing options by selecting the necessary check boxes.
5. To make this section dynamic:
   • Click on the fx button.
   • From the pop up dialog click on the fx button for either the Condition or Repeating options.
   • Select the field this condition is based on, the appropriate operator and value. For example:
     • Field Sex
     • Operator Equal
     • Value M
   • Select the element that the section should repeat for and select OK.

Design

Pages

Add a New Page

1. From the side panel, select the Design section.
2. Select Pages.
3. Click on the + button to add a new page to your template.
4. Choose the desired format of the page: Letter, A3, A4 or A5.
5. You will notice that the page was added in the PAGES panel.

Edit a Page

1. From the side panel, select the Design section.
2. Select Pages.
3. Select the Page to be edited.
4. Rename the Page by selecting the pencil symbol, on the right of its name or modify its size, orientation or margins.

Styles

Create a new Stylesheet

1. From the side panel, select the Design section.
2. Select the Styles section.
3. Click on the More Options button to the right of the DESIGN.
   • If you already have a stylesheet (a .css file) created, you can click on Add existing stylesheet to add it from the EngageCX project.
   • If you do not have a style sheet created, select the Create stylesheet option to build one in the online editor.

Add Styles to a Stylesheet

1. From the side panel select the Design section.
2. Select the Styles section.
3. Select the stylesheet to add a new style to.
4. Click on the + button next to the stylesheet name.
5. Provide a name for the style.
6. Use the options provided for the newly added style to make any formatting modifications needed. The changes will be saved automatically.

Modify Styles in a Stylesheet

1. From the side panel select the Design section.
2. Select the Styles section.
3. Select the stylesheet from which to modify a style.
4. To rename the style click on the Settings gear button next to the name.
   • Select the Rename option.
   • Modify the name and select OK.
5. To delete the style click on the Settings gear button next to the name.
   • Select the Delete option.
   • Confirm you want to delete the style by click on Remove.
6. Use the options provided for the style to make any formatting modifications needed.

Delete a Stylesheet

1. From the side panel, select the Design section.
2. Select Styles.
3. Hover over the .css file you intend to delete, click on the Settings button, near the name of the desired stylesheet and select Remove.

Fonts

Add a new Font

1. From the side panel, select the Design section.
2. Select Fonts section.
3. Select the + button to add a new font file from project assets.
4. You can also upload a font file from your computer by selecting Upload File. In the Add Font dialog, select provide a name for the font and the path where you want to store the file.

Edit the Font

1. From the side panel, select the Design section.
2. Select the Fonts section.
3. Select the font file you want to edit.
4. Provide a new name and a new path for the selected font file, then click OK.

Delete the Font

1. From the side panel, select the Design section.
2. Select the Fonts section.
3. Select the Settings button, near the name of the desired fon.
4. Choose the Remove option.

Languages

Add a new Language

1. From the side panel, select the Languages section.
2. Click on the + button to add a new language to your template.

Change the default language

1. From the side panel, select the Languages section.
2. Select the language you want to make as default by accessing the Language Properties and click Set as Default.
3. In the new opened dialog, select Set as Default to confirm the changes.

Delete the Language

1. From the side panel, select the Languages section.
2. Select the language you want to remove by accessing Language Properties and click on Delete Language.
3. Confirm removal by clicking on Delete.

Working with the Design Surface

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.

Add a new Paragraph

1. Place your cursor in the Design Surface.
2. Select the + button available in the left side.
3. Select Paragraph from the available menu.

Edit a Paragraph

1. Select the paragraph you want to edit from the Design Surface.
2. Click on the Format button (brush icon) form the menu bar. This will open the Properties Pane, where you can make more advanced modifications.
3. From Properties Pane, you can view and manage various properties, related to the selected paragraph.

Delete the Paragraph

1. Select the paragraph you want to delete from the Design Surface.
2. Click on the Format button (brush icon) form the menu bar. This will open the Properties Pane, where you can make more advanced modifications.
3. From Properties Pane, select the Paragraph Properties option.
4. Select the Delete option.

Fields

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

Add a New Field

1. Place your cursor in a paragraph where you want to add the field to.
2. Select the + button available in the left side.
3. Select Field from the available menu.
4. Under the Insert Field menu, use the up and down arrows to navigate through the data source, the select the needed field and click Ok.

Change the field

1. Select the field you want to change, from the Design Surface.
2. Use the scroll bar to navigate through the Data Fields
3. Select a new field, then click Ok to apply the changes.

Format a field

Once you insert a Field into your template, you may wish to make adjustments to how this field will be displayed in your output.

1. Select the field you want to change, from the Design Surface.
2. From the required formatting options from the Format drop down list.

3. More Formatting option will take you to the Format dialog, where you can easily change the structure of your field to be presented the way you intend in your output:

   • Select the type of formatting you wish to apply to your field. Availble options include Number, Percentage, Currency, Date\Time, and Custom formatting.
   • Upon selecting the type of formatting to apply, options will be displayed related to the choice in the right side of the dialog.
   • For any selection, you will be given two options: to select a predefined format or to create a custom format. Predefined formats will be highlighted with the format and an example. Simply make the predefined selection of your choosing if your desired format is available.
   • To create more custom formatting, first select the Custom option from the drop down list.
   • Once you have completed your formatting specifications, select Ok. By previewing your output, you can notice the appropriately applied formatting.

Create Advanced Expressions

1. Select the field you want to change, from the Design Surface.
2. Select Other in the Edit Field dialog.
3. Click on the Advanced Expression option.
4. Select the Edit Expression dialog, below the expression box.

5. In the Expression dialog, add an expression item by selecting from the available options available. For example, you can add an expression to concat two data points. For this,

   • Double click on the concat function from the Functions menu.
   • Next, you will need to add different string arguments that you want to combine, one at a time. Notice that we can extend the number of arguments for this functions to as many as required. Simply, replace the string text from the Expression Box with a field from the Fields pane.
   • Use the Insert the selected path from the tree and Insert only the selected element option to include new fields.
   • Once the expression is ready, select Ok.

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.

Create a New Table

1. Place your cursor in the Design Surface.
2. Select the + button available in the left side.
3. Select the table option from the contextual menu.
4. Add the number of cells and rows you want your table to have; optionally, check to a add a header or a footer to your table.
5. You can also select the Dynamic Table hyperlink to create a dynamic table.
6. In the Insert Dynamic Table dialog, select the elements from the data source that you wish to add to your table.
7. Select Ok. You will notice that your table has been added to the Design Surface. You can now fill the cells with the needed content.

Edit a Table

1. Select the Table element you want to edit, from the Navigation Bar.
2. Click on the Format button (brush icon) form the menu bar. This will open the Properties Pane, where you can make more advanced modifications.
3. From Properties Pane, you can view and manage various properties, related to the selected table.

Delete a Table

1. Select the table you want to delete, from the Navigation Bar.
2. Click on the Format button (brush icon) form the menu bar. This will open the Properties Pane, where you can make more advanced modifications.
3. Select the Delete option.

Conditional Paragraphs

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

Create a Conditional Paragraph

1. Place your cursor in the Design Surface.
2. Select the + button from the left side.
3. Select the Condition option from the contextual menu.

4. In the Insert Conditional Paragraph dialog you need to set your initial condition:

   • Select the field from your data source on which you want to base your condition on.
   • Select an operator for your condition.
   • Based on the operator selected, you might need to add a value for your expression.
   • Select Advanced to create more complex expressions for your condition.
   • For example, you can fill in the form like this:
     • Field : number
     • Operator : Equal
     • Value : 24
   • When you are finished configuring the condition, select Ok.
   • You will notice in the Design Surface that your first condition will be added as a paragraph.

Edit a Conditional Paragraph

1. Select the Condition element of the conditional paragraph you want to edit, form the Navigation Bar.
2. Click on the Format button (brush icon) form the menu bar. This will open the Properties Pane.

3. From the Properties Pane, you can manage conditional paragraphs:

   • To edit the current condition, select the Edit condition option (brush icon) and add edit the current expression.
   • To add new conditions, select the New condition option (plus icon) and create new expressions for your template.
   • To add a fallback section, select the Custom condition drop down list, then Otherwise.
   • To delete the current condition, select the Delete condition option.

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.

Create a Repeating Paragraph

1. Place your cursor in the Design Surface.
2. Select the + button from the left side.
3. Select the Repeating option from the contextual menu.
4. In the Repeating Paragraph dialog, navigate to the element you wish the paragraph to repeat for in the Data Source Tree and select that item.
5. Select Ok. In the Design Surface, you will notice that a repeating paragraph is now inserted.

Edit a Repeating Paragraph

1. Select the Repeating element you want to edit from the Navigation Bar.
2. Click on the Format button (brush icon) form the menu bar. This will open the Properties Pane.

3. From the Properties Pane, you can manage repeating paragraphs:

   • To edit, select the Edit repeating option (brush icon) and add a new repeating context for the selected paragraph.
   • To delete, select the Delete repeating option.

Content Fragments

Content Fragments helps you to 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 contains it, will be updated.

Insert a Content Fragment

1. Place the cursor in the Design Surface.
2. Select the + button from the left side.
3. Select the Content Fragment element available in the contextual menu.
4. Search for the content fragment and insert it to the template .
5. In the Insert Content Fragment dialog, you will find options to select if you want to insert it as a Paragraph or Inline, and the fragment context.
6. When you are finished, select Ok. Your Content Fragment is now added in the Design Surface.

Change Content Fragment

1. Select the content fragment you want to change from the Design Surface.
2. In the _Insert Content Fragment, select the Browse button.
3. Search for the new content fragment you want to add, then click Ok.
4. In the Preview box, you can notice that it will display the preview of the new fragment. Select Ok to add it to the template.

Images

Add a New Image

1. Place your cursor in the Design Surface
2. Select the + button from the left side.
3. Select the Image option from the contextual menu.
4. Browse for the image you might want to add in the Design Surface.

Workflows

EngageCX

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 the Communication Tile

1. Access the Communication Tile.
2. Select the Communication name for the template to be edited.
3. Click on the Configure Workflow button from the menu bar and adjust the properties.

From the Project Folder

1. Access the workspace for the project of the workflow that needs to be modified.
2. Select the Files tile, inside Collaboration group.
3. Select the Project Folder where the workflow is located.
4. From the list of project assets and workflows select the workflow (.wk4 file) to edit.

By creating a new Workflow

1. Access the workspace where the project is located that a new workflow needs to be created for.
2. Select the Files tile, inside Collaboration group.
3. Select the Project folder where the workflow should be stored.
4. Click on the + New button from the menu bar.
5. Choose the Workflow option.
6. Give the workflow a name and optionally a description and then click on Create.

By default, the new created workflow will be an empty one. In order to generate the desired output, you need to start adding steps.

Workflow Steps Settings

Add New Steps

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

1. Select the Steps section from the side menu.
2. Click on the + button next to the Steps title.
3. Select the step you want to add or select More to see all the steps.
4. Configure the needed parameters, then select Insert. For more information about step parameters view Workflow Steps.

Modify a Step

1. Select the Steps section from the side menu.
2. Hover over the step you want to edit, then select the Settings gear button next to it.
3. Here you can make any modification to the step parameters.

Or

1. Select the Steps section from the side menu.
2. Double click on the step to edit in the workflow design surface.
3. Here you can make modification to the step parameters.

Delete a Step

1. Select the Steps section from the side menu.
2. Open the step settings dialog by double-clicking on it or selecting the gear icon.
3. Select the Delete Step button. You will be prompted to confirm the deletion.

Connecting Workflow Steps

The workflow editor in EngageCX Platform is smart enough to connect the steps you add together, as long as you are creating them 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 connect the steps by following the directions below.

Connecting Steps on Insert

When you are first adding each of your steps to the workflow, EngageCX will automatically connect the step to the proceeding one. However, if you are adding steps out of order follow the steps below:

1. Select the Connections tab, from the Step-Settings dialog.
2. From the Inputs section, remove the current connection, this connection will have been automatically created to connect to the previous step.
3. Select the + Add input option, and select the step that you would like to flow into this step.
4. From the drop down menu under the step name, select if the step should flow into the current step and if it succeeds or if it fails. For example, if a render step fails, you may want to flow into a step that will send an email to be check out.
5. In the Outputs section, select the + Add output option to add an output connection if the step succeeds or fails. Note that it is not required that you have connections if steps fail, but it is highly recommended.

Editing Connections after Insert

To edit workflow connections after the steps are already inserted, follow the steps below:

1. Select the step you would like to update.
2. Select the Connections tab.
3. From the Inputs section, update the step that will flow into the current one. You can remove the step that is currently there, or select Succeeded / Failed from the drop down menu.
4. If you have removed the input selection, click on the + Add input button to choose which step you would like to have flow into this one, and select if it should happen on a success or a failure.
5. In the Outputs section you can leave the current connection, or select a step from the drop down list of available steps.
6. Click on the + Add output button in the Outputs section to add an output connection if the step succeeds or fails. Note that it is not required that you have connections if steps fail, but it is highly recommended.

Complex Expressions

The Complex Expression Dialog allows you to build dynamic values whenever a dynamic value button (fx)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:

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 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.
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 Enterprise 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.
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)

Workflow Settings

Job Name Pattern

By default, the Job name will be a combination of the Workflow name, and date/time when the Job was run.

1. Select the Settings section from the side menu.
2. Enter the Job Name Patten to show for this job.
3. Click on the fx button to create complex expressions (if needed).

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. Select the Settings section in the side menu.
2. Click on the + Add Parameter button.
3. Give your parameter a name and a default value.
4. Add your workflow steps as normal. When you are configuring the parameters for a step, click on the dynamic value button (fx)and where available you will see a Workflow Parameter option that will allow you to choose from the parameters that you have set up.

Business Rules

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 conditional translation (For example, each property has a value and this can be changed from English (default language) to Spanish.

1. Select the Settings section in the side menu.
2. Click on the + Add Business Rules button.
3. Search for the business rule file (.rules) in EngageCX or upload it locally from your computer.
4. Add comments, optionally, and click on OK/Upload.

Other Workflow Options

At any time you can use the menu bar or select the More Options menu to perform the following actions:

Save

Select the Save option, located at the middle of the menu bar each time you make an edit to the workflow.

Test Run

This option allows you to run the workflow without needing it to be approved first if you have a workspace review and approval set. The test run will also limit the number of documents produced or sent.

Run

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.

Save as

Select this option to save the workflow with a new file name.

Go to Folder

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

Share

This option allows you to make the workflow public. Select 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

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

Versions

This option allows you t 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.

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

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

Move

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

Delete

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

Rename

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.

Get Data	Split	Render	Assembly
Email	SMS	Tag	Index
Archive	Copy to Folder	Copy to EngageCX Folder	Copy to FTP
Overlay	Print	Custom	Validation
Post to Social Media	Copy to SharePoint	Copy to Amazon S3	Electronic Signature
Decompress	Render DITA	Create Snapshot	Delete Snapshot
Create Correspondence	Web Request	Publish Snapshot	Create Communication
Maintenance	Group	Append	Run Workflow
Run Communication	Extract Sub-Form Data	Create/Update Customers	Wait

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 EngageCX Data Modeler, which is part of EngageCX Design Studio. Data models created in EngageCX Data Modeler can retrieve data from any data source including SQL databases, Web Services, spreadsheets and more.

Basic Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

• Input

  By default the input connection will be the set to the the successful completion of previous step, you may select to change that if needed.

• Source

  Select the Choose File button to choose the data source file you would like to use.

Advanced Parameters

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

Split

If your input data is in XML that contains nodes for multiple documents, you can use the Split step to produce several sub-XML's, 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.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

• XML Node

  This parameter will allow you to select the exact node that EngageCX will use to create the sub-XML’s. By default, EngageCX will use the first repeating node as the split point.

• Keep Context

  The Keep context option will ensure that when the sub-XML’s 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 Split step, the output documents will be stored in memory, not on the disk, resulting faster rendering.

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.

It is important to note that changing the Output Format will automatically reset all parameters related to the previous output format that have been configured previously.

Basic Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

• Input

  By default, the input connection will be set to the successful completion of previous step, you may select to change that if needed.

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

• Template

  Use the Choose File button so 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.

Advanced Parameters

Depending on the Output format you have selected there will be different advance 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.

• 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 fx button to the right of the field and add Date and or Standard Parameters to make the file name unique.

• Language id

  Using the EngageCX Design Studio Publisher to create your templates, you are able to create multiple translation files to use with your template. This is where you would indicate the translation id. This is only available for templates that have at least one translation file.
  This can be a static value that you enter, or you can have the value be driven dynamically by the data source by selecting the fx button to the right of the field and select the data 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.

• 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 (page-number-citation, page-number etc.). You can choose from: Disabled, parallel, Serial and Optimized. If this parameter is "Disabled", fo:page-number and fo:page-number-citation will display ###, instead of the page number / page count.

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

• Associate with Account(s)

  In EngageCX you are able to associate emails to 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 to 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.

• Additional Copies Output Name

  You can use this parameter, in order to customize the name of the document copies.

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.

Advance Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

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

• 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).

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

• Split by Max Output Size

  Sometimes, when merging files together, the resulting file is too large to be use 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.

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

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

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.

Basic Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

• Input

  By default the input connection will be the set to the the successful completion of previous step, you may select to change that if needed.

Advanced Parameters

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

• Subject

  In the basic parameters section you are able to add an email subject line 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.

• Queue

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

• 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 to 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 to 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 the email once sent.

SMS

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

• Queue

  Select a SMS Queue to be used for delivery from the drop down menu.

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

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.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

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

• Update tags

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

Index

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

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

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

Archive

Use the Archive step to create a ZIP archive.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

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

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

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

• 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 EngageCX Folder

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

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

• Workspace

  You will need to select the Environment 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.

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

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

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

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.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

• 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 place 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.

Print

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

• 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 of 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 to different company accounts. This will allow you to select an account and view all files that were created for them.

• Associate with Customer(s)

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

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.

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do.

  To add a step description, select the +Add step description button.

• Command Line

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

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

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.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

• 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 a XML schema diagram that must be uploaded from your local machine.

Post to Social Media

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

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

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

Copy to SharePoint

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

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

• Connection

  You will need to select a connection for the drop down list.

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

• 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 Amazon S3

Advanced Properties

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

• Connection

  You will need to select a connection for the drop down list.

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

• Amazon Metadata

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

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.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

• Signature Provider

  You will need 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.

Decompress

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

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

Render DITA

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

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

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.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

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

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.

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

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

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.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

• Communication

  Select the Batch Communication from the drop down to be used to create the Correspondence Documents.

• 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 Data Modeler visit the Data Modeler help.

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

Web Request

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

• 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 gather from a GET request, the way in which it might be structured.

Header Parameters

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

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.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

• EngageCX 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 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 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.

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

Create Communication

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

Create Communication 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.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

• Communication Type

  Select the type of communication that will be created; Batch, Interactive or On-Demand.

• Communication Name

  Provide a name for the new Communication.

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

Maintenance

The Maintenance step will delete old jobs, based on the values indicated from 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.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

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

• Unit Type

  Select the Unit Type for the Other Than value.

• Stages

  Filter the Jobs that will be deleted based on Job outcome. Available values are: Aborted, Succeeded, Failed or Waiting for Input.

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

Group

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

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

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

• 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 use as is. Using the output size parameter, will allow you to select the size of the group.

• Group condition

  Conditional sequence that can be also configured as a complex expression to limit the performing of a certain Group criteria.

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.

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

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

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

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.

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

• Workflow File

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

• Workflow workspace

  Provide the name of the Workspace project that houses the workflow needed to be execute.

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

Run Communication

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

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

• Communication

  This parameter allows you to choose from a drop down list the Communication project that need to be run.

• 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 Communication 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.

Extract Subform Data

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

• Source

  Choose the subform from which you would like to extract data.

Create/Update Customers

Advanced Parameters

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

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

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

• Accounts Field

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

• Contacts Field

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

Wait

• Description

  Adding a description to the step is helpful to ensure that the any user fully understands what the step is configured to do. To add a step description, select the +Add step description button.

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

Forms

EngageCX

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 a form template within EngageCX platform.

From the Communication Tile

1. Access the Communication Tile.
2. Select the Communication name for the template to be edited.
3. Select the form template from the list of project assets.

From the Project Folder

1. Access the workspace for the project of the form template that needs to be modified.
2. Select the Files tile, inside Collaboration group.
3. Select the Project Folder where the form template is located.
4. From the list of project assets and workflows select the form template (.efd file) to edit.

By creating a new Form

1. Access the workspace where the project is located, for which a new template needs to be created for.
2. Select the Files tile, inside Collaboration group.
3. Select the Project folder where the template should be stored.
4. Click on the New button from the menu bar.
5. Choose the Form option.
6. Give the Form a name and select Ok.

Form Interface Terminology

Before you get started designing your form within Form Editor, it is important to take some time to familiarize yourself with the terminology used to describe where options are available for you in the user interface.

Left Side Menu

The left side menu is used to access the necessary functionalities needed to create an EngageCX Form. You can select from different sections and access different groups to find the feature you would like to use. Below, you can find information about each section available in the left side menu.

Properties Pane

The Properties Pane can be used to modify the properties of any object present in your form.

To enable the Properties Pane, you will need to:

• Select the Settings button (gear icon) from the menu bar.
• The Properties Pane will be available in the right side of the window.
• If no field is selected in the Form, you will not be able to see any property in the Properties Pane.

Design Surface

The Design Surface is the dedicated region in the Form Editor that you will be use to add and remove form fields and perform all of your form design needs. This is the largest region of the screen and will display what your form will look like as you design it.

Working with Side Menu

Fields

Add a New Form 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.

1. Select the Fields section from the side menu.
2. Click on the + button next to the existing Page Name.
3. Select the Page option and a new page will be added to the form.

Add a Subform

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

1. Select the Fields section from the side menu.
2. Click on the + button next to the Page Name.
3. Select the Subform option and a subdocument section will be added to the form.
4. In the Properties pane to the right, you can select the path for the subform to be used, by selecting the Browse button.

Add Form Fields

To build up your form, you will need to add different fields to be filled out at the time when the document is being created.

1. Select the Fields section from the side menu.
2. Click on the + button next to the Page Name.
3. Choose the type of field to add and configure it to your needs by selecting it and make the necessary changes in the Properties Pane.

Edit a Form Field

1. Select the Fields section from the side menu.
2. Expand the corresponding page and select the form field that you want to configure.
3. Edit the form field using the various properties visible in the Properties Pane.

Form Fields

In each of your Forms you will be able to customize it to your needs by adding any of the following fields.

Text	Currency
Number	Text Area
Rich Text	Contact Field
Date	Time
Password	Repeating Section
Group	Label
Separator	Dropdown
Radio	Checkbox
File Picker	Image Picker
Rating	Structured Data
EngageCX Authentication	Script
Google Address	Google Map
XML Field

Text

Basic Properties

• Caption

  The caption for your Textbox will be shown in the Form editor as well as in the Interactive 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. 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.

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

More Properties

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

• 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 effecting 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.

• 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 in the right side of a field and help you populate the current field with values from data source added before.

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

Currency

Basic Properties

• Caption

  The caption for your field will be shown in the Form editor as well as in the Interactive 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 selected field, either to the left or on top of the field.

• Name

  The text in the Name field will be the default value for the field and be 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.

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

  By default for the Currency field the Amount option will be selected.

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

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

More Properties

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

• 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 effecting the value stored in the XML file.

• 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 selected currency, select Administrators.

Number

Basic Properties

• Caption

  The caption for your field will be shown in the Form editor as well as in the Interactive 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 be 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.

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

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

More Properties

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

• Placeholder

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

• 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 selected number, select Administrators.

Text Area

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

Basic Properties

• Caption

  The caption for your field will be shown in the Form editor as well as in the Interactive 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 selected field list, either to the left or on top of the field.

• Name

  The text in the Name field will be the default value for the field and be 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.

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

• Rows

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

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

More Properties

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

• Placeholder

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

• 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 selected text area, select Administrators.

Rich Text

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

• Caption

  The caption for your Rich Text will be shown in the Form editor as well as in the Interactive 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.

• Name

  The text in the Name field will be the default value for the field and be show both in the Form that is being filled out and the Layout Template preview. This information could be the default answer for this field or an example of what the user should be adding.

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

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

• 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 selected text area, select Administrators.

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

• Toolbar

  Here, you can select the formatting options that you want to enable in the selected rich text. Once you selected an option in the Toolbar property, you will be shown in the Form editor as well as in the Interactive Communication Module when a user is filling it out.

Contact Field

• Caption

  The caption for your field will be shown in the Form editor as well as in the Interactive 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 selected field list, either to the left or on top of the field.

• 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 Settings\Integration.

• Validation

  A validation type can be selected to ensure that the user fills in the contact field 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. 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.

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

More Properties

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

• Name

  The text in the Name field will be the default value for the field and be show both in the Form that is being filled out and the Layout Template preview. This information could be the default answer for this field or an example of what the user should be adding. By default, it will be completed with the value from the Contact Field.

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

• Placeholder

  Provide a place holder for the field. A place holder can act as an example of what the user should enter in the field without effecting 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.

  By default for the Currency field the Amount option will be selected.

• 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 in the right side of a field and help you populate the current field with values from data source added before.

• 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 contact field, select Administrators.

Date

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

Basic Properties

• Caption

  The caption for your Date will be shown in the Form editor as well as in the Interactive 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 be 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.

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

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

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

More Properties

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

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

• 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 effecting the value stored in the XML file.

• 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 contact field, select Administrators.

Time

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

Basic Properties

• Caption

  The caption for your field will be shown in the Form editor as well as in the Interactive 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 selected field, either to the left or on top of the field.

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

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

• Format

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

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

More Properties

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

• 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 effecting the value stored in the XML file.

• 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 time field, select Administrators.

Password

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

Basic Properties

• Caption

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

• Caption Position

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

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

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

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

More Properties

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

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

• 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 effecting the value stored in the XML file.

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

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 to the Repeating Section, select the + button next to the Repeating sections name.

• Caption

  The caption for your Repeating Section will be shown in the Form editor as well as in the Interactive 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.

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

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

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

• Data Field Binding

  Here you will need to select a data source from the drop down list, then select the repeating context from the Data Source Tree on which you want your field to repeat for.

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

Group

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

• Caption

  The caption for your Repeating Section will be shown in the Form editor as well as in the Interactive 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.

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

• Data Field Binding

  Here you will need to select a data source from the drop down list, then select the element from the Data Source Tree on which you want to group the selection.

Label

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

Basic Properties

• Caption The caption for your Label will be shown in the Form editor as well as in the Interactive Communication Module when a user is filling it out.

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

Separator

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

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

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 insure 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 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".

Basic Properties

• Caption

  The caption for your Dropdown will be shown in the Form Editor as well as in the Interactive 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 Dropdown 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.

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

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

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

More Properties

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

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

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

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

• Caption

  The caption for your Radio buttons will be shown in the Form editor as well as in the Interactive 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 Dropdown list, either to the left or on top of the list.

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

• 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 set 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.

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

Checkboxes

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

Basic Properties

• Caption

  The caption for your Checkboxes will be shown in the Form editor as well as in the Interactive 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 Dropdown list, either to the left or on top of the list.

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

• 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 set 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.

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

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 though the workflow. This file will be in addition to the file that is created from the form.

Basic Properties

• Caption

  The caption for your File Picker will be shown in the Form editor as well as in the Interactive 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 Dropdown 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.

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

• Browse EngageCX Platform 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.

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

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

More Properties

• Default Value

  The form editor allows you to set 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.

• 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 curent textbox, select Administrators.

Image Picker

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

Basic Properties

• Caption

  The caption for your File Picker will be shown in the Form editor as well as in the Interactive 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 Dropdown 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.

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

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

• 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 curent textbox, select Administrators.

Rating

• Caption

  The caption for your File Picker will be shown in the Form editor as well as in the Interactive 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 Dropdown 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.

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

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

• 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 set 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.

• 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 curent textbox, select Administrators.

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.

• Caption

  The caption for your File Picker will be shown in the Form editor as well as in the Interactive 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.

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

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

• Schema

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

EngageCX Authentication Form

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.

Basic Properties

• Name

  The name of the EngageCX Authentication Form will be the unique element name in the XML that is created when using the form. It is important to note that this name must follow the XML standards for element names, and must be unique from the other page names in the Form. Font features, such as Bold, Italic, etc., will be hidden and will become visible, only after you choose a name in the corresponding Name form.

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

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

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 for to set advanced custom validations, field visibility options, restrictions on content and much more.

For more information about working with Scripts please reach out to our support team (support@ecrion.com).

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.

• Caption

  The caption for your File Picker will be shown in the Form editor as well as in the Interactive 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 Dropdown 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.

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

• 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 set 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.

• 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 curent textbox, select Administrators.

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.

• Caption

  The caption for your File Picker will be shown in the Form editor as well as in the Interactive 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 Dropdown list, either to the left or on top of the list.

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

• Map Type

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

• Default Value

  The form editor allows you to set 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.

Style

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

1. From the side menu select the Style section.
2. Adjust the style settings of the form to make it look as you need it to.

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

Languages

1. Select Languages from the side menu.
2. Click on the + button and choose a new language from the drop down list.
3. The selected language will show in the side menu.
4. To translate the text select the name of the language and choose the phrase to perform manually translation.
5. You can set as default the new introduced language for your form, by clicking on Settings button, on the right of the language name and check the Is Default option.
6. Also from the dialog mentioned in the step above, you can delete the new created language.

Settings

1. Select the Settings section from the side menu.
2. Configure various properties according to your needs.

• Mark required fields : Selecting this option will show an * 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 check this feature, the search symbol will be removed, but this does not prevent from the usage of lookup mechanism.
• Pagination Type : This option help 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 Design Surface

Edit a Field

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

Delete a Field

1. In the Design Surface, hover over the field you want to resize.
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 drop down list, choose the type of the field you want to change, then select Ok.

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 take up. 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 resize.
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 to base the visibility of the selected field, like below:
   • Select a field defined in your form on which you want to base your condition on.
   • Select an operator for your condition.
   • Add a value for your expression.

Analytics

EngageCX

In Analytics, you can create interactive dashboards to allow intelligent business decisions based on meaningful patterns in transactional data.

Accessing the Analytics Tile

1. Click on the Design button from the modules menu from the top of the EngageCX platform welcome page.
2. Select the Analytics tile.

or

1. Click on the Systems button from the top left.
2. Choose the Analytics option under the Design group.

Creating and Importing Analytic Projects

Analytic Projects consist in grouping diagrams and dashboards with the scope of generating interactive outputs. EngageCX allows you to create new dashboards in EngageCX Design Studio Architect, which is a powerful tool used to design application for visualizing, filtering, analyzing, and interpreting enterprise data. Dashboards consist of lists, tables, charts, and widgets in terms of structure and in terms of features, it provides filtering and marking or filter by marking. The last feature and the most important suppose to select an item from the existent lists and the data in the dashboard will be changed according to the specified criteria.

To use dashboards through EngageCX, you can upload your dashboard in an EngageCX Software project, then create an associated workflow, from where you can create analytics projects, or import directly an existing dashboard from which you can generate analytics outputs.

To create an analytics project from a workflow:

1. From the Design\Analytics page, click on the New Project button located at the top-right corner of the Analytics toolbar.
2. In the Create Analytics Dashboards dialog, provide a name and a short description of the project.
3. Choose a Workflow, that uses an .edm, .csv or .xlsx file as a data source for Get Data step in order to retrieve data for the dashboard (the .edm file have to be created and configured in EDS Data Modeler).

To import existing dashboards:

1. From the Design\Analytics page, click on the More Options button located at the top-right corner of the Analytics toolbar.
2. Select Import Dashboards.
3. Select a Zip file, then choose the workspace on which you want to deploy the project.

More Analytics Job Options:

At any time, you can click on the More Options button next to the name of the Job to perform the following actions:

1. Open, to view all the files that are produced in a run.
2. Export and download the run as a Zip file.
3. Snapshots, to save the state of a job and its content as a backup that you can restore later or publish to a different EngageCX portal.
4. Cleanup, to remove older jobs instantly.
5. Schedule, to create a repeatable schedule in order to delete older jobs automatically.
6. Lock\Unlock, to submit files project for lock\unlock.
7. Delete the related job files.
8. Properties, to visualize and edit all the properties applied to the current job.

Ads

EngageCX

Using Ads, you can deliver personally meaningful messages and resonate with your customers by ringing true. There are many elements that can be used as Ads, such as images, content fragments, etc.

Accessing Ads

1. Select Design module from the modules menu from the top of the EngageCX platform welcome page.
2. Select the Ads tile.

Or

1. Click on the Systems button from the top left.
2. Choose the Ads option under the Design group.

Creating a new Ad

1. From the Ads tile within Design Module, click on the + New Ad button, located in the right corner of the menu bar.
2. Choose a Name to help you reference this ad later.
3. Optionally, choose a description for your ad.
4. Provide the Content Path, by clicking on the Add Content button. You can either search for a specific Ad within communication project folders or upload a new Ad from your computer.
5. The Content Workspace will be automatically determined from the path you have selected above.
6. You can select the format of the Ad from the three available tabs: Content, Small Content, Large Content.
7. Click on the Change Content button and you can select different Ads for each one of the three sections mentioned above.
8. Click on the Create Ad button to successfully create the Ad.

More Ads Options

From the Ads View, you can right-click on More Options button, next to the name of a specific Ad at your choice, to perform the following actions:

• View Ad Content,to inspect and modify the content of the Ad within Template Editor.
• Delete, to permanently delete the current ad.
• Properties, to edit Advertisement and to modify initially configured Ad's properties.

Some marketing campaigns can be affected and the Ad will no longer show up in the dashboard due to deletion action.

Reviewing Ads

After clicking on the View Ad Content option, in the Template Editor you have the following possibilities:

• Format elements within the current Ad and edit their properties
• Preview the Ad in a specified format by opening it in a new tab
• Inside Preview drop down list, Manage Parameters option allows to reconfigure Date and Language Parameters
• Either edit the Ad in Template Editor or EDIT IN PUBLISHER

Analytics

Using Analytics, 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 also is intend to simplify complex data flows to provide users with a glance awareness of their current performance.

The Analytics module is available in EngageCX. If you do not see these in your environment, reach out to your account manager or sales@ecrion.com for the upgrade.

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.

Accessing the Dashboards Tile

1. Click on the Analytics button from the modules menu, on top of the EngageCX Platform welcome page.
2. Select the Dashboards tile.

Or

1. Click on the Systems button from the top left corner.
2. Choose the Dashboards option under the Analytics group.

Running Dashboards

1. From the Dashboards tile within Analytics Module, click on the New Dashboard button, located in the right corner of the toolbar.
2. Choose the communication that should be executed from the New dashboard dialog opened(If many, you have the possibility to use the search bar for a specific communication name).
3. Click on Run button and you will be redirected to the Dashboard Preview.

Reviewing Output and Job Log

After an Analytics job is completed, it will appear in the All jobs list from the Analytics\Dashboards module. The list will show all the analytics jobs that have been completed and if they finished successfully or failed. You will have the ability to review the documents that were created by the job and to look at the job log for a specific run if an error occurred.

Reviewing Output

To review the output documents of any job simply click on the Job name from the Dashboards list or select the Open option from the Dashboards Job options(More button). You are also able to select the Communication name under the Project tab, and view a list of all the jobs using that Communication.

You can use lists on the right-hand side to filter your data according to some specified criteria or right click on each widget from the dashboard preview and choose from the available options.

Review Job Log

1. From the preview of the produced documents, click on the More Options button on the top right of the menu bar.
2. Select the Execution Details option.

This will open a new tab, with the job log for the selected document, specifying the type of each (Diagnostic, Information, Warning or Error) alongside a corresponding message. The steps involved in the document production workflow will also be displayed.

Generating Reports

1. Click on the Reports button, on the right side of the Analytics 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. Click on the Generate report button and the output file will be downloaded on your local machine.

Exporting Documents

1. From the dashboard preview, click on the Export button located at the top-right corner of the toolbar, under More contextual menu.
2. Select if you want to download the inputs and logs related to the job, then click Download.
3. A Zip file will be downloaded on your local machine, and it will contain all the documents produced at each step from the associated workflow.

Review Project Files

1. From the dashboard preview, click on the More Options button located at the top-right corner of the menu bar.
2. Select Go to design.
3. You will be redirected to the Project Assets related to your Communication project, from where you can view, edit or delete your analytic project files.
4. For each Project Asset, you can access the More Options button and choose from the available options below:
   • Download selection will save the selected project asset locally on your machine as a .bid file. In order to open this file, you will need EDS Architect tool.
   • Versions option allows you to see all the versions of the selected document, created usually, after a change has been made.
   • Dependencies option allows you to see which files depends on the selected document and where it is used (ex. Analytics.wk4).
   • Tags option will reveal in a new pop-up dialog if there are any tags associated with the selected .bid file. You have also the possibility to + Add Tag for the document and make it visible only for you.

Publishing dashboards to the Customer Portal

Let's say you want to create a dashboard to track the release changes of your product and send it to other persons that have access to the Customer Portal. Below you can find the steps that you need to follow to accomplish this with EngageCX Solutions.

1. Organize your data by creating a BI in-memory analytics (IMDB) diagram (.edm file) within EngageCX Design Studio - Data Modeler. (Make sure to use relative paths when adding external data; otherwise, EngageCX Software will not be able to find the input).
2. Create your dashboard within EngageCX Design Studio - Architect by using the diagram created or a spreadsheet file.
3. Upload your files to an EngageCX project.
4. Create the workflow. The workflow needs to contain the following steps:
   • Get Data: for IMDB files;
   • Render: for .BID(s) file(s). The Output Format parameter needs to be EAD.
   • Tag: to tell EngageCX Software to publish your dashboard to the Customer Portal.
5. Edit the Tag step to publish the dashboard to the portal. The Tag step needs to contain the following parameters:
   • Public: This will create a unique ID to be used to create the public URL. The value, in this case, should be true;
   • Portal Available: This will allow the document to be visible in the Customer Portal. Users have to be authenticated before accessing the document. In this case, the value should be true;
   • contact-id: Associate this document with the specified contact. The contact ID can be statically added or pulled in for your data source. The Contact ID is visible under the People\Contacts module, by selecting the desired contact, then go to Properties;
   • Portal Category: Choose where this document will be stored in the Customer Portal. In this case, you need to write Analytics. Thus, your customer will find the output in the Analytics section of the Customer Portal;
6. Save the workflow.
7. Create an Analytics Dashboard project from Design\Analytics using the workflow created.
8. Run the dashboard from Analytics\Dashboard.
9. Log in to the Customer Portal.
10. The report can be found under the Analytics section.

Marketing

Marketing plays an important role in establishing relationships between customers and the organizations offering to the market.

Marketing is responsible for the increase in the organizations profitability and in addition, it also helps growing of the customer/client base for the enterprise. This is especially so, when the organization is dealing with more of corporate customers, and where decisions involve more than one party. These options are available in EngageCX, if you do not see these options in your environment reach out to your account manager for upgrade.

Campaigns

You can promote your services, products or business using marketing campaigns that tell compelling stories. Multi-ad support for marketing campaigns enhances AD placement in your documents by selecting from multiple options that fit space left on a page. For example, a typical use case could be developing a marketing campaign for a fast food restaurant franchise. Finding the right marketing promotion is a challenge, but when done right, it can lead to a whole new audience of hungry customers walking through your doors.

Accessing Campaigns Tile

1. Click on the Marketing button from the modules menu, on top of the EngageCX Platform page.
2. Select the Campaigns tile.

Or

1. Click on the Systems button from the top left corner.
2. Choose the Campaigns option under the Marketing group.

Creating a New Campaign

1. From the Campaigns tile within Marketing Module, click on the + New Campaign button, located in the right corner under the EngageCX Platform toolbar.
2. Choose a name and optionally, a description for your campaign, describing the purpose of it.
3. Choose the campaign duration, by selecting Start date & time and End date & time for it, from the date & time picker provided.
4. Check Enabled option, if you want the campaign automatically starts when the start date is targeted.
5. Click on the Create campaign button to successfully finish the configuration.

More Campaign options

From the Campaigns View, you can select the More Options button, next to the name of a specific Campaign at your choice, to perform the following actions:

• Open, to display the Campaign Ads related to your campaign and to inspect properties or delete an advertisement, if needed.
• Disable, to disable the current campaign which status was initially set to Enabled.
• Delete, to permanently delete the current campaign.
• Properties, to access Edit Campaign Dialog and modify initially configured campaign's properties.

Include Advertisement

Marketing ads offer companies a way to highlight different products and services, increase awareness and demonstrate the differences between products and competing products in order to sell them.

1. If the current Campaign is free of Ads, you have the opportunity to add new ones, by clicking on the Include Ad button, located in the right corner under the EngageCX Platform's toolbar.
2. Select one of the available advertisements in the list.
3. Choose the communication project which contains the template where you want to include the respective Ad.
4. Select the position of the advertisement on the template.
5. Optionally, you can associate a condition related to the appearance of the Ad, by providing a name and an expression for it.
6. Select the limit period for the Ad in the selected campaign. Otherwise, it will last the exact same period as the Campaign itself.
7. Check Enabled option, if you want the Ad automatically starts when the start date is targeted.
8. Click on the Include Ad button to successfully add the advertisement.

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

Using the Engagement module, you can define your audience, create customer maps or see all the events and interactions that customers go through when interacting with your company. The module is available in EngageCX, if you do not see these options in your environment reach out to your account manager for upgrade options.

Persona

Under Persona section you are able to manage the target audience. 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.

Accessing Persona Tile

1. Click on the Engagement button from the modules menu from the top of the EngageCX welcome page.
2. Select the Persona tile.

Or

1. Click on the Systems button from the top left.
2. Choose the Persona option under the Engagement group.

Persona

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

Creating new Persona

1. Click on the + New Persona button, from the Target Audience toolbar.
2. Provide a name and optionally, a description for the new persona you want to create.
3. Select the Segmentation Criteria from the drop down list meaning the contacts must satisfy this condition before being assign to this Persona.
4. Select a Journey from the drop-down list, in such a way, all contacts that satisfy the Segmentation Criteria will be enrolled in the selected Journey. If none applies, create your own journey. For more details, read Journey.
5. Click on the Create button to successfully create a new instance of Persona.
6. A confirmation dialog will appear to inform you if there are any changes related to contact's state. You can select View Contacts to see the change, then Confirm if you want to apply these.

More Options

Updating Persona

After a Persona entity is created, it will appear in the Persona list from the Target Audience module. To review details for each Persona entity simply click on the Persona name from the list or select Properties from the More Options button next to the Persona name.

Deleting Persona

To delete a Persona entity, select Delete from the More Options button next to the Persona name. Deleting a Persona will not delete the journey. Instead, it will unenroll all Contacts in that Persona from that journey. The journey is still there, and can continue to be active with multiple other Personas. Think about Toy Store journey with Grandparents and Parents personas. Deleting Parents will not affect the journey of the Grandparents.

Journeys

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

Accessing the Journeys Tile

1. Click on the Engagement button from the modules menu from the top of the EngageCX platform welcome page.
2. Select the Journeys tile.

Or

1. Click on the Systems button from the top left.
2. Choose the Journeys option under the Engagement group.

Creating a new Journey

1. Click on the + New Journey button, from the Customer Journeys tile.
2. Provide a name and optionally, a description for the new entity you want to create.
3. Click on the Create button to successfully create a new instance of a Journey.

Reviewing Journeys

After a Journey is created, it will appear in the Journey list from the Customer Journey module. To review details for each Journey, simply click on the Journey name from the list or select Open from the More Options button next to the Journey name. From the Journey preview, you can see all the stages through which your contact group has passed.

More Journey Options

At each time, you can click on the More Options button next to the appropriate journey and perform the following actions:

1. Open, to go to the journey map edit page.
2. Validate if all the connections and files are available in projects.
3. Delete the current journey and all its details.
4. Properties, to change the name and description of the Journey.

Journey Editor

Accessing the Journey Map is possible by selecting the Journey name from the Customer Journey list.
In the Journey Editor, you have the possibility to configure the Journey Map, by inserting stages using the flow map editor. When naming them think about what customers are trying to achieve as a result of their interaction with you. You can add touchpoints at which a person comes into contact with your company. There are also referred to as moments of truth and can be considered the interactions that have the greatest impact on customer loyalty.

The journey is structured in a sequence of stages, which usually happens over time. EngageCX Contacts pass through stages, over time, activating certain touchpoints based on some predefined event rules. During a time period, a Contact connects touchpoints together and expresses a Contact Journey. This is depicted using a dotted line which 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.

Touchpoints can be added to the board and are contained within stages. Each touchpoint can be edited, in a separate page. The touchpoint editor allows the user to define the event rules that activates 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 type and data filters, the user can target specific key moments, like when a Contact first joins EngageCX, or when an address is changed, or when a specific document is received by the Contact, or a form is sent from a Contact.

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

On the right side of the page you will also see the Narrative section, which describes the Journey Map with all its assets (touchpoints, milestones and connections in between). The narrative is an additional support for your journey map, in a more linear way. For example, it can focus on customers emotional state changes.​

Touchpoints

A touchpoint is referring to any interaction that may alter your customers experience in the time they uses your products. To edit a touchpoint:

1. Right-click on a touchpoint at your choice from the Journey Map.
2. Select Edit touchpoint option.
3. Modify Touchpoint Information (name and description) in the editable area, if needed.
4. Configure Workflow parameters for configuring your Journey according to your needs.
5. Select an Event from the ones in the list, that represents a trigger factor for activating the touchpoint. Each touchpoint can have multiple events that can trigger a Contact transition (e.g. when a form is submitted: Pricing Info Form Submission etc.) When an event is triggered, the Engagement Engine analyzes all touchpoint events and finds a match for the Contact that triggered the event. After the Contact transitions in the current touchpoint (e.g. Requested a quote) the interactions start to run.
   • Account Updated - activate the touchpoint when Account Criteria is met.
   • Contact Updated - activate the touchpoint when Contact Criteria is met.
   • Correspondence Submitted - activate the touchpoint when Correspondence is submitted.
   • Document Created - activate the touchpoint when Document is created.
   • Touchpoint Completed - activate the touchpoint when another touchpoint is completed.
6. Select an Interaction from the available ones in the list:
   • Communication - run a specific communication, after the touchpoint is activated.
   • Wait - pause execution for a given duration.
   • Advanced Workflow - run custom workflow file by selecting another workflow or uploading a certain one from your local machine.

Events

FromEvents you can inspect the events that caused touchpoint transitions. For each of the touchpoints the customer will complete several actions and activities, which will be different for each industry and business (e.g. For a hotel chain the use of product/service may want to be expanded to look at key elements such as check-in, use of amenities, check out & departure).

Accessing Events Tile

1. Click on the Engagement button from the modules menu from the top of the EngageCX platform welcome page.
2. Select the Events tile.

Or

1. Click on the Systems button from the top left.
2. Choose the Events option under the Engagement group.

The Events View displays all the events that have triggered specific touchpoints for a contact and by clicking on the contact's name you have the possibility to inspect its personal Journey Map together with the Contact Activity log. EngageCX allows you to inspect real time logs to understand what Customers are doing.

Hovering the mouse over an Event, a dialog box will appear with the complete description of that event, including the Form that was submitted, the Contact who completed and the corresponding Communication project.

Interactions

From Interactions you can view all the interactions with the customers. Each time a run communication step runs (from touchpoint workflow) an Interaction entry is added in this list.

Accessing Interactions Tile

1. Click on the Engagement button from the modules menu from the top of the EngageCX platform welcome page.
2. Select the Interactions tile.

Or

1. Click on the Systems button from the top left.
2. Choose the Interactions option under the Engagement group.

The list of Interactions reveal the communications which have been attached to a campaign, together with the corresponding Timestamp, Contact, Account, Journey and Touchpoint.

Hovering the mouse over an Interaction, a dialog box will appear with a few details of that interaction, including the type of document produced within the current Job, the Contact, the type of communication and the format of the output file.

More Engagement Options

Generating Reports

To generate a PDF report containing all your Engagement details:

1. Click on the Reports button, in the right side of the Engagement tool bar.
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, such as Include filters or/and Include marks .
5. Click on the Generate report button and the output file will be downloaded on your local machine.

Import\Export

In order to move an Engagement configuration from one environment to another (e.g. from Test to Production), the user needs to use the Export feature (found in Engagement module root toolbar).

This will export a zip file containing all the Personas and Journeys.

Channels

EngageCX Channels are used to deliver communications directly to the final recipients. These are available in EngageCX, if you do not see these options in your environment reach out to your account manager to upgrade them.

Email Queue

All outbound email messages within EngageCX Platform are delivered through Email Queues. Queues contain various parameters that affect the email delivery. Whether you are sending an email through a workflow or mass emails using Lists, EngageCX adds them automatically into an email queue with other messages: the delivery starts from the first ones and then carries on with the others. EngageCX

Accessing the Email Tile

1. Click on the Channels button from the modules menu, on top of the EngageCX Platform welcome page.
2. Select the Email tile.

Or

1. Select the Systems button from the top left, next to EngageCX's logo.
2. Choose the Email option under the Channels group.

To create a new Email Queue:

1. From Email tile, select the + New Queue button on the top right corner, under the toolbar.
2. Provide a unique name and optionally, a description.
3. Select an Email Connection from the drop down list. If there are none available you will need to create a new email connection.
4. The Track Email Read 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.
5. Verify if the email connection is working properly by selecting the Send Test Email button.
6. Select Save to create the email queue.

Sending Emails through EngageCX Platform

Prerequisites

1. A connection to a SMTP Server;
2. An Email Queue;
3. A template that contains the content that will be displayed in the email.
4. A workflow.

Steps

1. Set up the Email Connection from Settings\Connections.
2. Create an Email Queue.
3. Design your 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.
4. Set up the workflow.

To send emails through workflow, it must be necessary to include the following steps:

• GetData : add the data source under the Source parameter.
• Render : add the template created at point 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.

Possible email statuses are:

Sent	The email has been sent to the email server.
Bounced	The email could not be delivered to your intended recipient due to various reasons such as invalid destination email address, blocked incoming emails, mailbox is full, etc.
Spam	The email recipient has marked the email as spam.
Read	The email has been read.

Working with Email Messages

At any time, you can select a queue to view the list of Jobs that are used by the queue to deliver messages. Note that you will not see here any Jobs that have finished before the Email step.

Select a Job name to view the list of Email messages posted to the queue by that Job. From the More options button next to the destination email, you can click on the View option to inspect the email message and the delivery log.

Print

All print files sent within EngageCX Platform are delivered through Print Queues. Queues contain various parameters that affect the printer delivery. EngageCX

Accessing the Print Tile

1. Click on the Channels button from the modules menu, on top of the EngageCX welcome page.
2. Select the Print tile.

Or

1. Click on the Systems button from the top left, next to EngageCX Software's logo.
2. Choose the Print option under the Channels group.

To create a new Print Queue:

1. Click on the + New Queue button.
2. Provide a unique name and optionally, a description.
3. Click on the + Add Printer button to select a device to use for printing jobs in this queue.
4. Select Save.

Working with Print Files

At any time, you can select a queue to view a list of Jobs that are used by the queue to print files. Note that you will not see here any Jobs that have finished before the Print step.

Select a Job name to view the list of print files posted to the queue by that Job. You can select the Context project name to view the documents that were sent to the printer.

SMS

All SMS messages sent in EngageCX are delivered through SMS Queues. Queues contain various parameters that affect the messaging delivery. EngageCX

Accessing the SMS Tile

1. Click on the Channels button from the modules menu, on top of the EngageCX welcome page.
2. Select the SMS tile.

Or

1. Click on the Systems button from the top left, next to EngageCX Software's logo.
2. Choose the SMS option under the Channels group.

To create a new SMS Queue:

1. Click on the + New Queue button.
2. Provide a unique name and optionally, a description.
3. Select a SMS connection to use for jobs in this queue. If there are none available you will need to create a new SMS connection.
4. Select the Save button.

Working with SMS Messages

At any time, you can select a queue to view a list of Jobs that are used by the queue to send SMS Messages. Note that you will not see here any Jobs that have finished before the SMS step.

Select a Job name to view the list of SMS Messages posted to the queue by that Job. You can select the Context project name to view the documents that were sent.

Workspaces

Workspaces enable collaboration and storage of all assets involved in your customer communication management processes. These are logical divisions of Environments, usually associated with departments within a company. All the files needed for document 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.

Management

Accessing Workspaces

EngageCX EngageCX Develop

To access a workspace in Enterprise Website, use one of the methods described below:

1. Sign in to the Enterprise Website and select Workspaces from the modules menu.
2. Select the needed workspace from the Workspaces page.

or

1. Click on the Systems button at the top-left side of the Enterprise Welcome Page.
2. Choose the needed workspace under the Workspaces group.

Creating Workspaces

EngageCX EngageCX Develop(available only in core-only installation)

During the software installation, a Default workspace is added to the system. It is used to store the Project Ideas content and you can freely rename or delete it. To create a new personalized workspace, you will need to follow the steps from below:

1. Select the + New Workspace button at the top-right hand side of the Workspaces Page.
2. Provide a unique name and optionally, a description for the workspace, then select Create.
3. Notice that the workspace has been added to the Workspaces page. Select the upper part of a workspace to view all the available workspace features, or click Explore Files to start adding content.

Managing Workspaces

EngageCX EngageCX Develop

1. Select the upper part of the workspace you want to edit, in the Workspaces page.
2. Select the Manage Workspace hyperlink in the Configuration tile.
3. Here you have the ability to:
   • Rename the current workspace, by typing a new name under the Workspace Name field.
   • Edit the current workspace description, by typing new strings under the Description field.
   • Delete the current workspace, by selecting the Delete Workspace hyperlink, at the bottom-left side of the Manage Workspace dialog. It is important to know that deleting a Workspace is an irreversible operation. Make sure you have created a backup copy of any files you may need before deleting the workspace.
4. In addition, you can configure Review and Approval, Publish and Tasks options. For more details, review the Tasks chapter of this guide.

Viewing Users Permissions

EngageCX EngageCX Develop

1. Select the upper part of the workspace you want to edit, in the Workspaces page.
2. Select the View Users Permissions hyperlink in the Configuration tile.
3. The View Users Permissions dialog provides a list with all the users that has permissions to access or manage the selected workspace. For example, users with Access Workspace permissions can view the content of the current workspace, while users with Manage Workspace permissions can view and manage the content of the current workspace.

Users Permissions can be enabled from the Admin Settings\Users section. You can read more information in the Access Control chapter of this guide.

By selecting any workspace within the workspaces page, you can explore multiple submodules, such as Files, Tasks, Jobs, Triggers or Logs.

Files

In the Files submodule you can view and organize all the files and folders stored in an workspace. It provides a hierarchical structure that allows you to keep your documents organized.

Folders

EngageCX EngageCX Develop

The Files submodule provides a hierarchical structure that helps you organize and store your production documents. Within a workspace, you can add various folder types and files.

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

To create a project folder:

1. Access the workspace in which you want to add a new folder and select the Files submodule.
2. Select the New Folder button at the top-right side of the toolbar.
3. Provide a name for the root folder, then select Create. Notice that the root folder has been added to the workspace and you can start adding or importing files to it.

To create a normal folder:

1. Access the Files submodule on a workspace and select the root folder on which you want to create a normal folder.
2. Select the +New button at the top-right side, and choose the Folder option.
3. Provide a name for the root folder, then select Create. Notice that the root folder has been added to the workspace and you can start adding or importing files to it.

Shared Folders

EngageCX EngageCX Develop (not available in core-only installation)

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. Login to the Enterprise Website and access the Workspaces module.
2. Select the Files submodule to view and manage all the existing folders and files.
3. A folder can become shared by right-clicking on it and selecting the Share/Unshare option from the contextual menu. Note that only root folders can be shared. If you are not able to see this option within the contextual menu, use the upper menu bar to return to the main folder.
4. Next, you will be prompted to confirm your selection.
5. 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. Login to the Enterprise Website and access the Workspaces module.
2. Select the Files submodule and right-click on the folder you want to unshare. A shared folder can be identify 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

EngageCX EngageCX Develop (not available in core-only installation)

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.

Create hidden folders

All folder that starts with the . sign will be hidden, by default. To create a new hidden folder, you need to :

1. Access the workspace you want to add hidden folders and select the Files tile.
2. Select the New Folder button at the top-right side of the menu bar.
3. Type the . character, then add a name for the folder. For example, .Credit Order Letter.
4. Select Create to successfully create the hidden folder.

View hidden folders

1. Access the Enterprise Home welcome page.
2. Select the account name at the right-top of the screen.
3. From the drop down list, select Edit Account.
4. Select the Preferences tab under the Edit Account dialog.
5. Check the Show hidden folders option, then select Save.
6. 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 folder in the Files submodule where you will need to create the new file.
2. Select the New button at the top-right of the menu bar.
3. Select the file type you may want to create. In a project folder, you can create a new template, content fragment, workflow, business rule or a form.
4. Provide a name and optionally a description for the new file, then select Create.

Folders and Files Options

Uploading Project Files

Single Files

1. Select the Upload File button to search for the file you would like to upload. When selecting the 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.
2. Click on the Upload button and your file will now be visible in your folder.

Zip Files

1. Select the Upload File button.
2. Search for the ZIP file you would like to import.
3. A new dialog will let you choose if the Zip file that you are uploading should be unpacked or not.
4. If the case is to unpack the chosen Zip file, click on the Import button and a folder will be automatically created, with all of the files from your zip folder. Versioning will automatically be set for every file that is added from the ZIP file.

From an EngageCX Design Studio product

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

1. Open one of the Design Studio tools (Publisher, Data Modeler or Architect). Design and save your template or data diagram.
2. Access the EngageCX Drive tool and connect to the EngageCX Platform.
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 "Option" menu.
6. Add a comment and click Check in.
7. Once you log into Enterprise Website, you will be able to see the newly added file.

To learn more about connecting to EngageCX Drive from use the following link: EngageCX Drive

Sample Projects

EngageCX Platform comes with a variety of projects that you can work with. See Project Ideas for instructions on how to deploy them.

Version Control

EngageCX EngageCX Develop (not available in core-only installation)

As you work in any of the Projects you create in EngageCX, you may modify files and upload newer versions. 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 the security needed when multiple users have access to project folders and the files within. For 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. Each time a file is uploaded or modified, a new version is created. When creating a new file version, users can add a comment to make it easier to see what that version represents and/or what changes have been made. Comments are optional.

The File Versions dialog can be accesses by selecting the More Options button of any file you choose and displays all the versions of the asset, along with useful information such as version number, date created, the size, the author that created the version, as well as any comments associated with that version and the status of it. From here you can download or select one of the versions of the file to be restored to a previous state.

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 Design Studio products.
• Uploading a new file with the same file name.
• Restoring a snapshot or a previous version of a file.

Dependencies

EngageCX EngageCX Develop (not available in core-only installation)

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 accesses 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

EngageCX EngageCX Develop (not available in core-only installation)

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 and the project that contains the needed file.
2. Click on the file to open it.
3. Select the Share option available in the top right corner or by selecting the More Options menu.
4. Click on the Share button to generate a public link.
5. 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

EngageCX EngageCX Develop

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

1. Access the workspace that contains the given folder.
2. Locate the folder and select the More Options menu, next to the folder name. Or simply right-click on the selected folder in the left menu.
3. Select Permissions from the contextual menu.
4. In the Folder Permissions dialog, click on 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.

To read more information about Users, navigate to the Access Control section.

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 Files submodule in 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 menu next to its name. From the contextual menu, select 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 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 tags 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 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 tagged.

Business Rules

Business behavior is governed by business rules that dictate how flows should be initiated and directed. Business Rules 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. An example for 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 New Business Rule

1. Access a project folder and select the +New button at the top-right hand-side.
2. Select the Business Rules option from the contextual menu.
3. Provide a name and optionally a description for the newly rule.
4. Notice that the Business Rules Editor has been opened that allows you to manage rules and properties.

Adding a Business Rule to a Workflow

1. Access a project folder and open a workflow on which you need to add a business rule.
2. In the workflow editor, access the Settings menu from the Side Bar.
3. Select the Add Business Rules button to add an existing rule to the workflow.
4. Select a .rules file format then click Ok. You can add as many files as you want according to your needs. Notice that the path file(s) is (are) listed in the Business Rules section on the left.

Accessing the Bussiness 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. Access the Files submodule within the workspace and choose a project folder where you have previously defined the business rule(s)
2. Select the business rule file (.rules file format).
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. Select the New Rule button from the toolbar.
2. Provide a representative description for your business rule.
3. Configure a condition for your rule by selecting the Dynamic Value button (fx).
4. Build your complex expression using the available fields of the Data Representation.
5. After finishing the configurations, select OK to successfully add the business rule in the list.

Adding a Property

1. Select the New Property button from the toolbar.
2. Provide a property name.
3. Choose the Category from the drop-down list available options. If you need to add more Category types, please go to the Add a Category section.

Business Rules Settings

Configuring Languages

1. Select the Languages button from the toolbar.
2. The default language set for the rules is English, but you can easily change this property by selecting it.
3. Configure another default language in the Edit Language dialog, 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. Select the Data Source button from the toolbar.
2. Search, locally or not, for a data source that you need to add instead of the old one (if it exists).
3. Select OK to successfully insert the data source file.

Adding a Category

1. 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 OK.

Grouping

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

Filtering

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

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 use a complex expression by selecting the Dynamic Value button (fx).
3. From the same Edit Value dialog you can also remove the value associated to the business rule.

Save Changes

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

More Options

On the right side of the Business Rules toolbar you can click on the “More Options” button and expand a contextual menu with various options.

• Save as - allow you to save the business rule file in a project folder, different from the one you have defined the business rule itself.
• Go to Folder - opens another window from where you can select another project folder within the workspace.
• Share - allow you to share the file, encapsulated in a link.
• Download - exports the file on your local machine.
• Versions - open the File versions dialog of all business rules versions. Here you can restore to a certain point of the business rule configuration back in time or upload a new version.
• Dependencies - show you tree structured data of the files upon which the business rules are dependent on and where the file is actually used (usually in a workflow).
• Copy - allows you to create a copy of your business rule file by adding it to another project folder.
• Move - change the local originated path of your business rule file.
• Delete - removes the business rule file from the project folder where it is saved.
• Rename - edits the name of the business rule file.

Creating and adding business rules to the workflow parameters

Define the rule

1. Access a project folder for which you want to define a business rule and create or open a .rules file.
2. In the Business Rules editor, select the New Rule to create a new rule.
3. Provide a representative description and add a static or dynamic condition for which the rule will be applied, then select Ok. For dynamic conditions, please make sure to add a data source to the business rule. For example, create a rule named MultipleLanguages that will apply only when the @country element available in the Data Source is equals with USA.
4. Next, right click on the business rule created and select the Add Property option. In our example, we will add two properties: Email Subject and Send Email applied on the Email task. Additionally, you can add multiple properties for the Template task.
5. After the properties has been added to the rule, click on the corresponding Content(English) cell and enter the subject. In our example, for the Email Subject property, we will add the value that we will want to appear in the email body as subject. Repeat the steps for the other properties, and respectively for the other languages added. By default, the default language is English, but after adding multiple languages, you can at any time to check the Is Default option in the Languages dialog to switch the default language.
6. After finishing adding the needed rules, analyze the priority of the business rules created and place it on the top of the others. To move a rule, right click on the rule and Move Up or Move Down options to reach the needed behavior.
7. When the configuration is ready, save the work and check in to update the changes.

Update the Workflow

1. In the project folder, access and open the workflow you need to use the business rule.
2. In the workflow editor, select the Settings menu from the Side Bar and verify if the Path of the Business Rules file is correctly defined. If no parameter is defined, select the Add Business Rules button to insert the file.
3. Check if the workflow contains the steps for which you have created the rules. In our example, we will add an Email step.
4. Double-click to open the step. Select the Add parameter button from the Advanced tab and add the parameter for which you created the rule. In our example, we will add two parameters, Subject and Send condition.
5. For each selected parameter, select the Dynamic value(fx) button from the right side, then add the rule created from the My Rule drop-down list. For example, we will add the Email Subject rule to the Subject box, and the Send Email rule to the Send condition box.
6. Save the workflow changes, then select the Test Run button to ensure that everything is functioning properly. Note that, for email rules, you will have to set up an email connection and an email queue.
7. After the job finished, in the Jobs dialog you will find information message stating that email has been distributed. This means that the workflow successfully completed its corresponding jobs, without errors. The Channels submodule of the EngageCX platform allows you to verify the email distributions. In our case, the emails have been rendered with the Subject defined in the Business Rule according to the default language set.

Tasks

EngageCX

The Tasks section was made for users included in the Administrator groups. Here, you can create new tasks and issues for other users, review files and approve or add new document versions.

Before starting using Tasks, the first step is to understand snapshots, and how this affects other files or processes and also how to enable the Review and Approval process.

Snapshots

Snapshots allow you to save the state of a folder 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. Snapshots can be created only for Communication projects. It is suggested, as a best practice, to create a snapshot 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 snapshot, this will be used as the latest version when running a communication. EngageCX Develop (not available in core-only installation) EngageCX

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

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

Creating a snapshot

1. Select the Communications tile from the Design module.
2. Click on the Options button from the right side of the communication for which you want to create the snapshot.
3. From the drop down list, select the Snapshots option.
4. In the Project Snapshots dialog, click on the + New Snapshot button.
5. Give the snapshot a name and add a comment, if needed. The name of the Snapshot will be the name of the folder created if Published to a new Environment.

Snapshots Publishing

By default, EngageCX will use a built-in mechanism for the Publish operation, that can be easily configured and changed from Manage Workspace within Configuration tile.

1. Access your Workspace Folder.
2. Select the Manage Workspace hyperlink from Configuration tile, under Settings group.
3. You have various options to select from, related to Publish operation:
   • Check Approve communication projects before publish, if you want to force the workflow to pass through a Review and Approval verification before enabling _Publish operation_. After checking the option, you have the possibility to click on Edit Approval Workflow to customize the Review Publish workflow steps.
   • Check Use custom workflow, under the Publish section, if you want to customize the Publish workflow step, according to your needs.
4. Next, go to Design\Communication and access the Project Snapshots dialog using the "Options" menu.
5. From the Project Snapshots dialog, select from the list of available snapshots and use the drop down menu to select the Publish option. If no Snapshots are listed, create a new one.
6. Under the Log-in credentials dialog you will need to provide the EngageCX Destination Server, as well as log-in credentials for that server and optionally, the Environment, then select Next.
7. From the Choose Workspace dialog, select the workspace to add the snapshot to and click on the Publish button. You will get a notification that the snapshot has been published successfully by email and when you access the workspace you will see the folder with all the updated files in it. You have several options to check, before Publish.

If the Snapshot'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 Snapshot prior to writing them in the destination folder. This means the versions are lost in 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 Snapshot.

Snapshots vs Import/Export

While there are some similarities between snapshots 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 upload or download files from Enterprise Website.

For backup, restore and publishing to a different EngageCX instance or environment, the recommendation is to use snapshots. Snapshots 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 snapshots so you can switch between them at any time, an important feature which is not possible if you just use import/export.

Review and Approve

EngageCX

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

• You can set the Review and Approve process for an entire workspace.
• Review and Approve a 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 communication project. A user must belong to a Group that has Manage Environment Permission in order to enable the Review and Approval process within a workspace.

1. Access the workspace to add the process to.
2. Select the Manage Workspace hyperlink under the Configuration tile.
3. Under the Review and Approval section, you can select from the following options:
   • Run only approved files: When this option is configured, you will be able to run only the latest approved communications. If there are no approved communications,you will see a notification that there is no approved version available.
   • Approve communication projects before publish: When this option is configured, you will be able to publish only snapshots of an approved communication. You cannot publish a communication project directly, you will need to create a Snapshot for it first.
   • If both options are configured, you can run and publish only approved assets.
4. For each configuration from above, you will have the option to install the default workflow or choose a review and approval workflow that was manually created.
5. Choose if the Enforce four-eyes principle for tasks should be selected. If the "four-eyes" principle is enabled, the user who requested the Review will not be able to Approve any changes.

Requesting Review

After you enabled the Request and Review process using the steps from above, you will also need to request a review to be able to run approved files. Below you can find step by step instructions in order to request a review and approval.

From the Files section, you can request review on an entire folder or only for a single file.

Requesting Review for projects

1. Access the workspace that contains the needed project.
2. From the left side panel, right click on the project on which you want to request a review.
3. Select the Request Review and Approval option.
4. In the Request Review and Approval dialog select the files you want to send for review, and also a convenient date to receive feedback. Optionally, you can add comments or attach new documents.
5. Select OK. You will be able to see a notification that your files has been submitted for review. Select the Execution Details hyperlink to track the evolution of the review workflow.

Requesting Review for files

1. Access the project folder that contains the needed file.
2. Locate your file and click on the More Options menu, next to it.
3. Select the Request Review and Approval option.
4. In the Request Review and Approval dialog, select a convenient date to receive feedback. Optionally, you can add comments or attach new documents.
5. Select OK. You will be able to see a notification that your files has been submitted for review. Select the Execution Details hyperlink to track the evolution of the review workflow.

Requesting Review for snapshots

If you enabled the review process, and want to publish snapshots, requesting a review for it it may be necessary.

1. Access Design\Communication and then go to the Project Snapshots dialog containing the needed snapshot.
2. Select the Request Review and Approval option from the More Options menu. If a snapshot has the status Published, the Request Review and Approval option will not be available anymore.
3. In the Request Review and Approval dialog select the files you want to send for review, and also a convenient date to receive feedback. Optionally, you can add comments or attach new documents.
4. Select OK. You will be able to see a notification that your files has been submitted for review. Select the Execution Details hyperlink to track the evolution of the review workflow.

Reviewing the Task

When a new Review and Approve process is started, using the default workflow, a task will be assigned to the Administrators group of users. If you are in the Administrators group you will have the ability to review any changes and either approve or reject them.

1. Within the workspace where the Review request came from, select the Tasks tile.
2. A list of all tasks that have been assigned directly to you or any groups you belong to will be listed. Select a convenient task from the For Approval list.
3. To start the Review and Approval process, select the Start Work button and add any comments, if needed.
4. Once you have completed the review, you can either approve or reject the changes by selecting the corresponding button. Make sure to add any comments that might be needed.
5. If the task requires approval from other users or groups, select the Edit button at the top right corner, then re-assign the task using the drop-down list below the Assign To option.
6. Expanding History, a diagram of the main progression and regression states of the task will be shown.

The next time the associated workflow is run, the latest approved assets will be used.

Assigning new tasks or issues

1. Access the Tasks tile from the needed workspace.
2. Select the +New Task button located at the top right side.
3. Depending on the context, you can either select to create a new Task or a new Issue.
4. In the new opened dialog, you will need to provide a name for the newly task/issue and assign it to a user or a group. Optionally, provide a description or add a new attachment.
5. When you are ready, select the OK button. A new task/issue will be added to the Tasks list. Also, the person or users from the group to whom it was assigned will be notified through email as well.

Creating a Custom Review and Approve Workflow

EngageCX comes with a default Review and Approve workflow which will:

• 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 production job is run.
• Delete the snapshot after a Approved or Rejected choice has been made.

To create your own Review and Approve workflow the only required steps are:

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

Using only these two steps, there will not be any approval task. Simply these steps will create a snapshot and automatically approve it for use. Some other workflow options that might be helpful are:

1. Creating a serial workflow, which will allow multiple users or groups to approve the project assets. To set this up your workflow should look something like this:

   • Get Data
   • Create Snapshot
   • Task which is assigned to the first group or user that should approve it
   • If the task is approved the workflow should move to the next user or group by adding another Task step.
   • If the task is rejected you can decide what to do. You might want to end the workflow or have an Email sent to a user or group letting them know.
   • Repeat these steps until all of the users and groups that should approve the projects are listed.

2. By default, all review emails will be sent to users belonging to Administrator Group. If you want to change this, you must edit the Review Workflow.

   • In Workspace, under Files section, go to the default review workflow which is located in ReviewAndApproval Folder.
   • Select the Review.wk4.
   • Double click on the Review Snapshot step from the workflow diagram. A dialog will pop-up.
   • Modify the reviewer user group from the Assign To section.

Jobs

EngageCX

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

Starting a Job

Working inside of the Workspace module there are 3 ways to start a Job. To start a Job follow the steps below.

Folder

1. Select the Files Tile in the Workspace Module.
2. Choose a Folder that has the Workflow file you want to run.
3. From the More Options menu select the Run option.
4. You will be redirected to the Jobs Tile where you can monitor the Job.

Workflow

When you are creating a Workflow it is helpful to be able to run it directly from the file to test.

1. Save and Check in the Workflow file.
2. From the toolbar select the Test Run button.
3. You will be redirected to the Jobs Tile where you can monitor the Job.

Jobs Tile

1. Select the Jobs Tile in the Workspace Module.
2. Search for the Job you have to run and click on it.

Monitoring a Job

To view the current state of execution simply select the Jobs Tile within the Workspaces Module.

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.

At any time the follow commands are available:

Job Commands

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 the Options button:

Edit Workflow	Go to Workflow Editor.
Open Workflow Folder	Navigate to the Workflow that this Job is based on.
Restart from Step	Restart execution from a certain step forward.
Delete	Delete the current Job.

Scheduler

EngageCX

Scheduler allow you to configure EngageCX to start specific jobs at a certain time. You can schedule jobs to run hourly, daily, weekly, monthly, or every number of minutes, on certain days of the week, several times a month, etc.

Accessing Scheduler

1. Access the requested workspace.
2. Select the Schedule Tile to view all Jobs scheduled in the current workspace.

Configuring a Schedule

1. Select the New Schedule button at the top right side of the Scheduler page.
2. Choose the time frame you would like to schedule the Job for, by selecting the Hourly, Daily, Weekly or Monthly tab.
3. Upload the Workflow to be used for this Schedule, by clicking on the Choose File button.
4. Configure the timing of the Schedule.
5. After step 4, you will be able to click on Configure parameters button to modify already defined parameters (if exist) from the Workflow that need to be set before the Job runs.
6. Toggle on or off Enabled option to activate or deactivate the Schedule.
7. When you're ready, select the Save button.
8. The new scheduler will be added to the Schedules list. Select the View Log option to see log messages.

Triggers

EngageCX

Triggers allow you to configure EngageCX to start specific jobs as an automatic response to an action. Currently, the supported methods for triggering jobs are Hot Folders (supported in EngageCX Develop, core-only installation) and Microsoft Message Queues (MSMQ).

Accessing the Trigger Tile

1. Access the requested workspace.
2. Select the Triggers Tile to view all Triggers presented in the selected workspace.

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.

To configure a new hot folder :

1. Select the Hot Folder option from the More Options menu from at the top right side of the Triggers page.

2. Fill out the form. The following parameters need to be configured:

3. Path : Provide the path of the folder.

4. 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 a SFTP Connection to use. If none is available, configure a SFTP Connection from Settings\Connections.
5. 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.
6. Workflow : Click on the Choose File button and navigate to the Workflow that should be run when a file is found.
7. Pooling Interval : The number of seconds between 2 consecutive attempts to check for new files.
8. Enabled : On or off Enabled option to activate or deactivate the Hot Folder Trigger.
9. 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, 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.

To configure a new MSMQ trigger:

1. Select the Microsoft Message Queue option from the More Options menu from at the top right side of the Triggers page.

2. Fill out the form. The following parameters need to be configured:

3. Path : Provide the path of the MSMQ.

4. Formatter Type : Choose the Formatter Type to be used: BinaryFormatter or XmlFormatter.
5. Workflow : Select the Choose File button and navigate for the Workflow that should be run when a file is found.
6. Pooling Interval : The number of seconds between 2 consecutive attempts to check for new files.
7. Enabled : On or off Enabled option to activate or deactivate the MSMQ Trigger.
8. Configure Parameters : Configure the parameters (if any) from the Workflow that need to be set before the Job runs.

Workflow Settings for Triggers

When building your workflow, you will need to reference the trigger file in your dynamic expressions. This can be accomplished by selecting the Trigger File parameter from the Parameters\Standard drop down list. Or just write {PARAM:TriggerFile} inside the complex expressions. This will be resolved to the path of the trigger file.

For example, let's say your EngageCX Project contains only a main template, content fragments and images. To generate documents, you will need to use multiple files, located on a local or remote machine. To tell the workflow to use that files, when configuring the Get Data step, make sure to add the Trigger File parameter under the Source field.

Execution Log

EngageCX EngageCX Develop

When you execute a Job stream, a log file will show progress information.

Accessing the Execution Log Tile

1. Access the requested workspace.
2. Select the Execution Log Tile 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.

Settings

From the Settings page you can configure access control, software integration or environment settings. The Settings module is available in EngageCX Develop and EngageCX.

Access Control

Users

From Users, you can create and manage users and permissions across your EngageCX Platform, so for example, if you have multiple environments, you can control who has access to each environment.

Accessing the Users Tile

1. Click on your Admin gear button from the menu bar in Enterprise Home Website.
2. Select the Users tile, under the Access Control section.

Working with Users

• Select New User to create a new user.
• Select an existing user from the list, to edit or remove.

When creating / editing a user, you will need to provide the following:

1. User's email address. This email address will be used for system notifications and password resets.
2. Authentication method. You can choose between EngageCX Authentication and Windows Authentication (only when configured by the System Administrator).
3. An unique username.
4. Personal details, such as first name, last name, job title.

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

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

Configuring Permissions

For each user, you can configure permissions by either selecting from a list of groups, set explicit rights or both.

To configure the list of groups this user belongs to:

• Select one or more of the available groups. By default, you will be able to see the Administrators and Everyone groups.

To set explicit rights:

• Select access or manage for the individual workspace(s) this user has access to.

After applying permissions select Effective Rights to see the final permissions for this user across workspaces. See More About Permissions for more details.

Groups

Use this configuration group to manage User Groups. By creating Groups, 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 Tile

1. Click on your Admin gear button from the menu bar in Enterprise Home Website.
2. Select the Groups tile, under the Access Control section.

Working with Groups

• Select New Group to create a new group.
• Select an existing group to edit or remove.

When creating / editing a User Group you will need to provide the following:

1. An unique Group Name.
2. Optionally, you can select user(s) to make them members of this group.

Configuring Permissions

For each group, you can configure permissions at the Environment or Workspace level.

To configure permissions at Environment level:

• Check the Manage Environment 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. Environment Administrators can also create, edit and delete workspaces.

To configure permissions for each individual Workspace:

• Select access or manage for the individual workspace(s) the user(s) belonging to this group will have access to. Note that these options depend on the environment permissions selection.

After applying permissions select Effective Rights to see the final permissions for this user across workspaces.

User Interface Profiles

For more accurate permissions, you can select one of the user profiles available in the drop down list (Front-Desk Agent, Operations Manager or Developer-the Default profile), or you can create a custom user profile to suits your needs.

Creating a new profile

• Select the Edit Profiles option.
• Click on the Add User Profile button from the Manage Profiles dialog.
• Provide a name for the new profile and enable the needed actions and modules.
• Click the Add button to create the new user profile.
• To include the group in the created user profile, make sure to select it from the Interface Profile drop down list.

Editing a user profile

• Click on the Edit Profiles button;
• Select the profile you want to change from the list;
• Check\Uncheck the available properties that apply to the current user profile.

More About Permissions

For each User or Group, 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 workspace that is created you will have the ability to give the User or Group, Access or Manage rights.

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.

For users specifically, these rights will be combined with the rights of the group(s) they are in, if any. You can see all the rights for the user by selecting the Effective Rights tab.

You will have the ability to add or remove users from groups directly from the User dialog. When you select these options you will notice that the user's rights will update based on the group's rights.

Account Preferences

Account Details

After login to an EngageCX environment, at any time you can update your personal details or change the current password.

1. Login and select your username from the top right-hand side of the EngageCX Welcome page.
2. Select the Account tab.
3. Enter your personal information in the empty boxes. You can update your existing First and Last Name, Job Title, Email or Telephone.
4. Scroll down and select Change Password to create a new password for your account.
5. Once completed, select Save to successfully update your details.

Account Timezone

Your account time zone serves as the default time zone for all documents and automatic process in your environment.

1. Login and select your username from the top right-hand side of the EngageCX Welcome page.
2. Select the Preferences tab.
3. Select the Timezone drop-down menu and select the timezone you would like to use.
4. Once completed, select Save to successfully update the changes.

Account Alerts

Alerts allows you to stay updated with all the changes encountered in your environment. Within your account, you can turn on alerts for emails, jobs, triggers or print processes.

1. Login and select your username from the top right-hand side of the EngageCX Welcome page.
2. Select the Preferences tab.
3. In the Alerts zone, check or uncheck the processes for which you may want to be notified through email. For example, if you schedule to run some automated jobs, by selecting the Job Failed option, you will receive an email whenever a job error occurs.

Audit

Audit logs allows 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 cleanups.

Accessing the Audit Tile

1. Click on your Admin gear button from the menu bar in Enterprise Home Website.
2. Select the Audit tile, under the Access Control section.

Configure Audit Options

To configure what information to appears in the Audit logs:

1. Select the More Options menu at the top-right side of the Audit page.
2. Select the Configure Audit Options option.
3. In the Customize Audit Options dialog, enable the needed actions you want to log.
4. Select Save.

View Audit Logs

1. In the Audit log page, select the down arrow from the top left side.
2. Select what types of audit logs you want to see from the contextual menu, such as Files logs, System Logs or Users Logs.

Clean Up

1. Select the More Options menu at the top-right side of the Audit page.
2. Select the Clean up option.
3. Check if you want to remove files or user logs, then click Clean Up.

Integrations

Connections

SharePoint	Salesforce
Microsoft Dynamics CRM	Document DB
Electronic Signature Providers	Database
Email	Social Media
FTP/FTPS	SFTP
Amazon Web Service	SMS

SharePoint

Accessing the Sharepoint page

1. Login to EngageCX Platform as Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down SharePoint connections.
3. Within the SharePoint page you can manage existing connections or create new connections.

Adding a New Connection

To add a new connection, you need to:

1. Under the SharePoint connections page, select the +New Connection button from the toolbar.

2. To create a connection to SharePoint, the following information are required to provide:

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

When the connection is created, navigate to the People\Integration section from Settings, select the SharePoint connection and start synchronizing your data.

Updating a connection

To update a connection (change credentials, update password or change connection name), you can make changes in the SharePoint connection page.

1. Under the SharePoint connection page, go to the connection you would like to update and select the More Options button on the right-hand side.
2. Select Edit from the contextual menu and make the necessary changes.

Deleting a connection

If you want to remove an unused connection, you can make changes to your connections in the SharePoint connection page.

1. Under the SharePoint connection page, go to the connection you would like to delete and select the More Options button on the right-hand side.
2. Select Delete from the contextual menu.

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

**Salesforce **

Accessing the Salesforce page

1. Login to EngageCX Platform as Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down Salesforce connections.
3. Within the Salesforce page you can manage existing connections or create new connections.

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, the following information are required to provide:

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

When the connection is created, navigate to the People\Integration section from Settings, select the Salesforce connection and start synchronizing your data.

Updating a connection

To update a connection (change credentials, update password or change connection name), you can make changes in the Salesforce connection page.

1. Under the Salesforce connection page, go to the connection you would like to update and select the More Options button on the right-hand side.
2. Select Edit from the contextual menu and make the necessary changes.

Deleting a connection

If you want to remove an unused connection, you can make changes to your connections in the Salesforce connection page.

1. Under the Salesforce connection page, go to the connection you would like to delete and select the More Options button on the right-hand side.
2. Select Delete from the contextual menu.

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

Requesting Saleforce Security Token

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

**Microsoft Dynamics CRM **

Accesing the Microsoft Dynamics Connection page

1. Login to EngageCX Platform as Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down Dynamics connections.
3. Within the Microsoft Dynamics page you can 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, the following information are required to provide:

   • 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 name and crm4.dynamics.com is the domain 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.

When the connection is created, navigate to the People\Integration section from Settings, select the Microsoft connection and start synchronizing your data. When the synchronization is done, you will notice that all your Microsoft Dynamics accounts and contacts are available within the People module.

Updating a connection

To update a connection (change credentials, update password or change connection name), you can make changes in the Microsoft Dynamics CRM connection page.

1. Under the Microsoft Dynamic connection page, go to the connection you would like to update and select the More Options button on the right-hand side.
2. Select Edit from the contextual menu and make the necessary changes.

Deleting a connection

If you want to remove an unused connection, you can make changes to your connections in the Microsoft Dynamic connection page.

1. Under the Microsoft Dynamic connection page, go to the connection you would like to delete and select the More Options button on the right-hand side.
2. Select Delete from the contextual menu.

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

Document DB

Accessing the Document DB Connection page

1. Login to EngageCX Platform as Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down Document DB connections.
3. Within the Document DB page you can manage existing 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, the following information are required to provide:

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

Updating a connection

To update a connection (change credentials, update password or change connection name), you can make changes in the Document DB connection page.

1. Under the Document DB connection page, go to the connection you would like to update and select the More Options button on the right-hand side.
2. Select Edit from the contextual menu and make the necessary changes.

Deleting a connection

If you want to remove an unused connection, you can make changes to your connections in the Document DB connection page.

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 Delete from the contextual menu.

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

Electronic Signature Providers

Accessing the Electronic Signature Connection page

1. Login to EngageCX Platform as Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down Electronic Signature connections.
3. Within the Electronic Signature page you can manage existing connections or create new ones.

Adding a New Connection

1. Under the Electronic Signature connection page, select the +New Connection button from the toolbar.

2. To create a connection to Electronic Signature, the following information are required to provide:

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

Updating a connection

To update a connection (change credentials, update password or change connection name), you can make changes in the Electronic Signature connection page.

1. Under the Electronic Signature connection page, go to the connection you would like to update and select the More Options button on the right-hand side.
2. Select Edit from the contextual menu and make the necessary changes.

Deleting a connection

If you want to remove an unused connection, you can make changes to your connections in the Electronic Signature connection page.

1. Under the Electronic Signature connection page, go to the connection you would like to delete and select the More Options button on the right-hand side.
2. Select Delete from the contextual menu.

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

Generating Docusign API Key

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

To generate your key follow the steps below.

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

Configuring Callbacks

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

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

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

1. An unique name for the connection.
2. The URL to Publish. This Url should be an EngageCX link in following format: http://{ecrionURL}/api/callback?callbackType=esignature&signatureType=docusign

3. Make sure the following options are checked:

   • Enable Log (maximum 100)
   • Require Acknowledgement
   • Document PDFs
   • Certificate of Completion
   • Time Zone Information
   • Document Voided Reason
   • Sender Account as Custom Field
   • Document Fields
   • All Users (includes 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.

Database

Accessing the Database Connection page

1. Login to EngageCX Platform as Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down Database connections.
3. Within the Database page you can manage existing 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, the following information are required:

   • 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.
   • Verify if the Database connection can be done using the specified fields by selecting Test Connection.

Updating a connection

To update a connection (change credentials, update password or change connection name), you can make changes in the Database connection page.

1. Under the Database connection page, go to the connection you would like to update and select the More Options button on the right-hand side.
2. Select Edit from the contextual menu and make the necessary changes.

Deleting a connection

If you want to remove an unused connection, you can make changes to your connections in the Database connection page.

1. Under the Database connection page, go to the connection you would like to delete and select the More Options button on the right-hand side.
2. Select Delete from the contextual menu.

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

Email Server Connections

Accessing the Email Connection page

1. Login to EngageCX Platform as Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down Email connections.
3. Within the Email Connections page you can manage existing 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, the following information are required to provide:

   • Connection Name - A name for your Database Connection.
   • Email Type - Select between SMTP or Amazon SES connections.

SMTP Connections

When creating / editing a SMTP (Simple Mail Transfer Protocol) Email connection you will need to provide the following:

• 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 the connection is encrypted or not.

Amazon SES Connections

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

• 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 setup 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 a connection

To update a connection (change credentials, update password or change connection name), you can make changes in the Email connections page.

1. Under the Email connections page, go to the connection you would like to update and select the More Options button on the right-hand side.
2. Select Edit from the contextual menu and make the necessary changes.

Deleting a connection

If you want to remove an unused connection, you can make changes to your connections in the Email connections page.

1. Under the Email connections page, go to the connection you would like to delete and select the More Options button on the right-hand side.
2. Select Delete from the contextual menu.

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

**Social Media **

Accessing the Social Media Connection page

1. Login to EngageCX Platform as Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down Social Media connections.
3. Within the Social Media Connections page you can 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, the following information are required to provide:

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

FTP/FTPS

Accessing the FTP/FTPS Connection page

1. Login to EngageCX Platform as Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down FTP/FTPS connections.
3. Within the File Transfer Protocol/File Transfer Protocol over SSL Connections page you can 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, the following information are required to provide:

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

Updating a connection

To update a connection (change credentials, update password or change connection name), you can make changes in the connections page.

1. Under the connections page, go to the connection you would like to update and select the More Options button on the right-hand side.
2. Select Edit from the contextual menu and make the necessary changes.

Deleting a connection

If you want to remove an unused connection, you can make changes to your connections in the connections page.

1. Under the connections page, go to the connection you would like to delete and select the More Options button on the right-hand side.
2. Select Delete from the contextual menu.

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

SFTP

Accessing the SFTP Connection page

1. Login to EngageCX Platform as Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down FTP/FTPS connections.
3. Within the SSH File Transfer Protocol Connections page you can manage existing 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, the following information are required to provide:

   • 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 FTP/FTPS connection can be done using the specified fields by selecting Test Connection.

Updating a connection

To update a connection (change credentials, update password or change connection name), you can make changes in the SFTP connection page.

1. Under the SFTP connection page, go to the connection you would like to update and select the More Options button on the right-hand side.
2. Select Edit from the contextual menu and make the necessary changes.

Deleting a connection

If you want to remove an unused connection, you can make changes to your connections in the SFTP connection page.

1. Under the SFTP connection page, go to the connection you would like to delete and select the More Options button on the right-hand side.
2. Select Delete from the contextual menu.

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

Amazon Web Service

Accessing the Amazon Web Service connection page

1. Login as an Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down to Amazon Web Services connections.
3. Within Amazon Web Service page you can do both, manage existing connections or create new connections.

Adding a New Connection

1. Under the Amazon Web Service connections page, select the +New Connection button from the toolbar.

2. To create a connection to Amazon, the following information are required to provide:

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

Creating an Amazon Synchronized folder in Enterprise Website

1. When the connection is created, navigate to a workspace and create a new folder within the Files module.
2. Select Synchronize Folder from the contextual menu, in the top right corner.
3. Within the Synchronize Folder dialog choose an Amazon connection 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. Select Save and synchronize to start the synchronization process.

Bidirectional synchronization check box isn’t available in current EngageCX platform versions but will be available in one in the future.

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

Synchronization Folder Log

1. After receiving an information message specifying the success of the synchronization process, go back to the Files module and select the folder with an Amazon mark next to it.
2. Go to Options in the toolbar and select again Synchronize Folder option.
3. Select View Synchronization Log to access the folder log of the Amazon synchronization process. If the synchronization has been finished you can see its activity log for 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 (using Windows Services).
4. In case of errors, during the preview of the Folder log, check in EngageCX configuration file (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.

Adding Tags

1. Each folder that has an Amazon synchronization contains, by default an Amazon synchronized tag visible, at the top-left side of the page. Select the Amazon synchronized tag to edit the current tag or select Add Tag to create new tags for the current folder.
2. In the Tag dialog you can provide a custom name for your tag or select from the drop-down menu a specific property that will be used as implicit name:
   • Select the Important option to inform your customer about tag’s high level of importance.
   • Select New option to inform your customer that the tag is new.
   • Select Public Option, meaning that your files under the current folder can be accessed by anybody, without logging in.
3. Set the Value for the current tag, according to your needs, that is by default, configured to true.
4. You can set the tag visibility either by restricting access and enable the option Only visible to myself or keep the public visibility by disabling the option.

Configuring Amazon S3 bucket to push notifications to EngageCX Platform

1. Login into Amazon Web Services console and configure Simple Notification Service(SNS) topics and subscriptions. Note that the login user must have permissions to administrate the Simple Storage Service (S3).
2. Navigate to SNS and create a new topic.
3. Select Create subscription within 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 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 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 filed) as SNS Topic and the topic created above.
7. If everything were set correctly the real time synchronization should start.

Updating a connection

To update a connection (change credentials, update password or change connection name), you can make changes in the Amazon connections page.

1. Under the Amazon connections page, go to the connection you would like to update and select the More Options button on the right-hand side.
2. Select Edit from the contextual menu and make the necessary changes.

Deleting a connection

If you want to remove an unused connection, you can make changes to your connections in the Amazon connections page.

1. Under the Amazon connections page, go to the connection you would like to delete and select the More Options button on the right-hand side.
2. Select Delete from the contextual menu.

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

SMS Connections

Accesing the SMS Connection page

1. Login to EngageCX Platform as Enterprise Admin User and access the Administrator module.
2. Select the Connections tile to drill down FTP/FTPS connections.
3. Within the SMS Connections page you can manage existing 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, the following information are required to provide:

   • Connection Name - A unique name for your connection.

This connection created can be used in Channels, when creating SMS Queues.

Updating a connection

To update a connection (change credentials, update password or change connection name), you can make changes in the SMS connection page.

1. Under the SMS connection page, go to the connection you would like to update and select the More Options button on the right-hand side.
2. Select Edit from the contextual menu and make the necessary changes.

Deleting a connection

If you want to remove an unused connection, you can make changes to your connections in the SMS connection page.

1. Under the SMS connection page, go to the connection you would like to delete and select the More Options button on the right-hand side.
2. Select Delete from the contextual menu.

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

EngageCX Account

In order to use EngageCX Products, as a client, you need to have an EngageCX Account (accounts.ecrion.com), from where you can retrieve and keep track of your product keys. EngageCX manages automatic integration with the EngageCX Account, in order to provide keys for EDS products.

Customers and prospects can request a cloud trial of these products by contacting Sales (sales@ecrion.com). Trials for EngageCX Develop™, EngageCX Converse™ and EngageCX™ will be granted on case-by-case basis.

Accessing the EngageCX Account Tile

1. Click on your Admin gear button from the tool bar in Enterprise Website.
2. Select the EngageCX Account tile, under the Integration section.

Configuring EngageCX Integration

1. Select the Configure button.
2. Provide your EngageCX account credentials and select Ok.
3. Your environment is now integrated with EngageCX Accounts. Select EngageCX Account Sign-In to be redirected to the Default EngageCX Account website, where you can view and manage all product keys.

People

People Module manages the integration of EngageCX accounts and contracts with external systems and customize fields.

This section provides features for:

• Configuring custom fields of EngageCX accounts and contacts
• Setting Accounts, Contacts and Portal account screen layout
• Configuring dynamic fields for the Portal User
• Configure, run and observe the synchronization log with a CRM

Accessing the People Tile

1. Click on your Admin gear button from the tool bar in Enterprise Website.
2. Select the People tile, under the Integration section.

Or

1. Click on the Admin button from the modules menu from the top of the EngageCX welcome page.
2. Select the People tile, from the Integration section.

Configuring EngageCX custom fields for Accounts or Contacts

Accounts

1. Select Manage Account Fields option, from the Accounts tile.
2. Click on Preview button to configure fields in Form Editor.
3. Click on the Save button from the menu bar to apply the changes.

You can always click on Restore to Default button, if you want to restore the Account Form to the initial configuration.

Contacts

1. Select Manage Contact Fields option, from the Contacts tile.
2. Click on Preview button to configure fields in Form Editor.
3. Click on the Save button from the menu bar to apply the changes.

You can always click on the Restore to Default button if you want to restore the Contact Form to the initial configuration.

Configuring screen layout for EngageCX Accounts, Contacts or User Portal

Accounts

1. Select Customize Accounts Screen Layout option, from the Accounts tile.
2. Click on Preview button to configure display page in Template Editor.
3. Confirm if you want the changes to be applied.

You can always click on the Restore to Default button to restore to the initial configuration.

Contacts

1. Select Customize Contacts Screen Layout option, from the Contacts tile.
2. Click on Preview button to configure display page in Template Editor.
3. Confirm if you want the changes to be applied.

You can always click on the Restore to Default button to restore to the initial configuration.

Customer Portal

1. Select Customize Portal Account Screen Layout option, from the Portal tile.
2. Click on Preview button to configure display page in Template Editor.
3. Confirm if you want the changes to be applied.

You can always click on the Restore to Default button to restore to the initial configuration.

Configuring dynamic fields for the Portal User

1. Select Portal Settings option, from the Portal tile.
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. Click on the Save button.

Enabling synchronization

1. Click on the Manage Integration option from the Integration tile.
2. Select a CRM connection from the drop down list under the Configuration tab. If there are not any connections, you have to configure an external system integration from Settings->Integration section->Connections.
3. Check the Enable synchronization option, for the EngageCX be able to synchronize CRM entities, such as Accounts, Contacts and Leads, according to some rules.
4. 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. Click on Add button, to create a new EngageCX - CRM field mapping, if needed. The new 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 Synchronize Now option, from Integration tile, for start the synchronization process.

You can click on View Synchronization Log option from the Integration tile and see the progress of the synchronization process in the Sync Log View.

Single Sign On

Single Sign-On allows an EngageCX user to use only one set of login credentials (e.g., username and password) to access multiple applications. For example, if you log in into a third party application (e.g., Office365), you can have access to Enterprise Website without having to provide again your authentication details.

SSO configurations are made from Enterprise Home website, by following a setup assistant that presents you a sequence of dialog boxes. The wizard lead you through a series of well-defined steps.

Single Sign-On is available for the Enterprise Home and Customer Portal websites.

Accessing SSO

1. Click on your Admin gear button from the tool bar in Enterprise Website.
2. Select the Single Sign On tile under the Integrations section.

Or

1. Click on the Admin button from the modules menu from the top of the EngageCX welcome page.
2. Select the Single Sign On tile under the Integrations section.

Managing SSO Configurations

From the Single Sign On section:

1. Select one of the identity providers, based on which website you want to enable SSO for.

   • Setup enterprise SSO or
   • Setup Portal SSO

2. Select Single Sign-On standard.

   • Security Assertion Markup Language (SAML 2.0)
   • Web Services Federation Language (WS-Federation)

3. Specify some information that you can get from the Identity Provider.

   • ACS URL

     Assertion Consumer Service URL will be used for enabling the Identity Provider from IdP site.

   • IdP Login URL

     The Login Url is used when a user attempts to login. EngageCX triggers a redirect to the URL and expects a POST request with the SAML Assertion Response on the SAML Assertion Consumer endpoint, /Security/ConsumeSAMLToken. In response, the EngageCX service provider produces an EngageCX access token for the assertion subject and redirects the now authenticated user to EngageCX homepage.

   • IdP Logout URL

     Optionally, you can provide logout page for your identity provider.

   • Signing Certificate

     Click on the Choose File button to locate and upload the authentication certificate issued by your identity provider. Provide the X.509 public key certificate in PEM format from the IdP. This establishes a trust relationship between the SP and the IdP. During runtime EngageCX uses the certificate to validate that the digital signature originated from the IdP.

4. Click on the + Add new mapping button to to create a one-to-one mapping between IdP users and EngageCX users.

   • Under the first empty field, type in the identify provider attribute issued for mapping;
   • Select from the available user profile fields from the drop down list;

5. After finished the settings above, you will be able to see under the Start using tab a notification like below: Enterprise SSO has been successfully configured with {Identity Provider Name}

6. To access the EngageCX Enterprise website using the identity provider configured, the URL should look like below: http://localhost:8094/Security/ConsumeSAMLToken?environment=Test

   where Test is the name of the environment used.

7. Click on the Login now using SSO to verify if setup finished successfully.

After the configuration is done, you are able to see it by accessing the Single Sign-On tile. To edit or delete the configuration, you can need to select the More options button from the right of the Provider name.

Environment Settings

Views

A View is a custom perspective for all the files, jobs, tasks, campaigns or authoring documents present in EngageCX Platform. Throughout EngageCX there are different default views depending which section you are in. However, you are able to create new views to customize your user experience. For example, if you have tagged files in a project as important you are able to create a view which will allow you to quickly and easily see all of 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. Some examples of built-in views: Recent Jobs, My Tasks, Favorites.

Accessing the Views Tile

1. Select your Admin gear button from the tool bar in EngageCX Platform.
2. Select the Views Tile under the Environment Settings section.

or

1. Select the Admin button from the modules menu from the top of the EngageCX Platform welcome page.
2. Select the Views Tile under the Environment Settings section.

Working with Views

1. Select New View to create a new view.
2. Choose an existing View to edit or remove. It is important to note that you will only be able to remove or modify views that have been created by an Environment Administrator. You will not be able to modify or remove any default views.

When creating a new view you will need to:

1. Select a View type from the drop down list. This will be where the View will be able to be seen.
2. Provide an unique name and a description.
3. Choose how this View will be presented, either list, grid, or collapsed.
4. Select the filters and column fields for this View.

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

Task Types

From Task Types, 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, visit the Tasks section.

Accessing the Task Type Tile

1. Select your Admin gear button from the tool bar in EngageCX Platform.
2. Select the Task Types Tile under the Environment Settings section.

or

1. Select the Admin button from the modules menu from the top of the EngageCX Platform welcome page.
2. Select the Task Types Tile under the Environment Settings section.

Working with Task Types

• Select New to create a new Task.
• Choose an existing Task to edit or remove.

When creating / modifying a task you will need to provide:

• A unique name for the Task and an optional description.
• Add the different states that this task can go through.

Create a Custom Task Type

Below you can view step by step instructions on how to create a new task type.

1. Select the New Task Type button from the right of the menu bar.
2. Provide a name and optionally a description for the task. For example, you can create a task type, named Design and assign it to your colleagues that design the template.
3. Select the Add State button to create new states. Task states defines how a work item progresses upon its creation to closure. In our example, you can add the following states Hand Sketch, Layout Design, Formatting Refinement and Review.
4. In the New State dialog, provide a name for the new state (e.g. Layout Design) and select what types of assets applies : Documents or Snapshots. Optionally, select if the state will be the first state or select a reminder time. Select Ok when ready.
5. Select the + button next to state name to add transitions. Transitions are required and defines how a task passes from one state to another. For example, in our example, you can create a transition between the Hand Sketch and Layout Design states, named Start Work.
6. In the New Transition dialog, provide a name for the transition (e.g. Start Work or Sent to Technical Team) and the state to go. Optionally, disable email notifications or create a form for the user input request. Select Ok when ready.
7. Select Save. You will notice that the new task will be added in the Tasks list and also will be available under the Task section.
8. From Task Type, select the new task created and you will notice new email notification in the Notifications tab.

Preferences

Using the Preference page, you can manage various environment settings such as environment time zone, allowed custom paths, User Profiles, environment variables, and custom tags.

Accessing the Preferences Tile

1. Click on your Admin gear button from the toolbar in Enterprise Website .
2. Select the Preferences tile under the Environment Settings section.

or

1. Click on the Admin button from the modules menu from the top of the EngageCX Platform welcome page.
2. Select the Preferences Tile under the Environment Settings section.

Modifying Time Zone

1. Click on the Manage time zone button from the Time Zone tile.
2. Choose the time zone for this environment from the drop down list provided.
3. Check 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.

User Profiles

The user profiles feature allows you to specify custom rights for a group of users. This includes the ability to allow and deny access to files or EngageCX modules.

Managing user profiles

1. Click on the Manage user profiles button from the User Profiles tile
2. Select the desired user profile from the list available
3. Check\Uncheck the available properties that apply to the current user profile

Creating a new user profile

1. Select the Manage user profiles button from the User Profiles tile
2. Click on the + Add User Profile button
3. Under the Add User Profile dialog you will need to set a name for the user profile and select from the feature available for which you want to provide access
4. Click on the Add button and then Save.

Environment Variables

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

Add New Environment Variable

1. Under Environment Variables tile, within Preferences, click on "Manage environment variables".
2. Click on + Add Variable button.
3. Choose a name for your newly created variable.
4. Provide a corresponding value.
5. The variables will be displayed on the Manage environment variables Dialog list and once introduced, you can click on Close.

Use Custom Tags within Workflow

Below you can find the basic steps to create and use custom tags within EngageCX Solutions workflows.

1. Access the EngageCX Enterprise website using an environment administrator credentials.
2. Visit the Admin settings page by clicking on the gear button located in the top right corner of your home page.
3. Select the Preferences tile and click on Manage Custom Tags to view and edit current custom tags.
4. Select the Add Tag button to create a new tag for your environment.
5. Provide a name for the tag. Optionally, add a default value. When the Default Value is specified, it will be used in workflow; however, you can choose to edit it later. It can take static values or workflow placeholders like XPaths, Dates or GUID. For example, you can add a tag having the Name = "CorrelationId", and the Default Value = {GUID} placeholder.
6. Select Save to apply the changes. You can notice that your new tag will appear in the Manage Custom Tags dialog.
7. To edit or delete the tag, simply select the contextual menu available in the right side of the appropriate tag.
8. Access the Design\Communication module and select a communication from the list, e.g. select the sample - Bookstore Invoice.
9. Select Configure Workflow button from the top right of the menu bar.
10. From the Configure Workflow Dialog you can configure actions like generating documents, send emails and print files. Select EDIT IN DESIGNER to configure tags.
11. From the advanced workflow editor, you can edit and observe connections between the steps and paths that will be followed.
12. If your workflow contains a Tag step, double click on it for editing.
13. If your workflow doesn't contains a Tag step, add a new one by selecting STEPS and + (plus) button from the left side bar.
14. Select More.. from the contextual menu, then insert a Tag step.
15. Next, from the Edit Tag Dialog, add the required parameters or create connections between the input and output steps.
16. Using the +Add parameter hyperlink, you can add new step parameters like new tag, run condition, or update tags. Select the Tag option from the drop down list to insert a new key pair value parameter.
17. Fill out the tag name and value under the available fields or use one of the predefined tags or environment Custom Tags, defined above. For example, select the CorrelationId (custom tag defined in Step 5). You will notice that the inputs will be populated with the tag name and the default value defined in Custom Tag section, under Admin page.

Forms

Here you can access and manage settings that apply to all the forms in your environment.

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.

Add Google API Key

1. Provide a Google Map API from the Google APIs
2. Click on Update Settings to save changes and the new configurations will be globally applied for all forms.

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

Add New Domain

1. Under Forms tile, within Settings, provide some domains, for which you want emails being blacklisted, one at a line.
2. Click on Update Settings to save changes and the new configurations will be globally applied for all forms.

Analytics

Tracking

Under this section you can configure analytics tracking for your website.

Add New Tracker

1. Under the Tracking tile, click on + New Tracker button, on the top right corner of the page.
2. Provide a name and choose 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.
3. Click on Create button to successfully add a new tracker.

Developer

Developer module is intended to bring a strong starting point of EngageCX platform users. Accessing Developer module will lead users to various samples and documentation links, latest versions of both, desktop design software and software development kits, and also will allows developers to generate API Keys to authenticate custom applications. These options are available in EngageCX Develop and EngageCX, if you do not see these options in your environment reach out to your account manager for upgrade options.

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.

Accessing API Keys Tile

1. Click on the Developer button from the modules menu from the top of the EngageCX platform welcome page.
2. Select the API Keys tile

or

1. Click on the System button from the top left corner.
2. Choose the API Keys option under the Developer group.

Managing API Keys

Add API Key

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

1. Click on the Manage API Keys button from API Key tile.
2. From the Manage API Keys dialog, select the Add API Key option
3. Type a short description for the API Key under the Reason field, then click Create.

Add API Key on Behalf

The feature is available only for users that belong to groups that have the Manage Environment option enabled, also called 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 an 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.

1. Click on the Manage API Keys button from API Key tile.
2. From the Manage API Keys dialog, select the Add API Keys On Behalf option.
3. Add the user(s) for which you want to generate API Keys. You can use the navigation bar to select or deselect all users, or click in the Users field to see the drop-down list. Optionally, write a simple description to justify the scope of the API Key. If many users are selected, EngageCX will generate a new API Key for each user.
4. Check the Send Notification option if you want your users to be notified through the email. 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 a API Key by clicking on the Delete button and confirming the deletion. 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 description of 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 tile from the Setting page.
2. Under the #Keys list, you can view how many keys are assigned to each account. Clicking on the number will open the managing API Keys dialog from where you can manage the existing keys or generate others.

Code Samples

Document Production Code Samples

Code samples related to document production represent a collection of code snippets that examine different ways of producing document with EngageCX Platform. The examples vary depending on the available EngageCX Platform (Converse or Develop) where these code can be tested. By clicking 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. The code samples that enable running are those written in Java Script, only.

Design Tools Code Samples

In this section you will find information on how to embed the EngageCX template editor in your solution. For example, Online editing document using embedded Template Editor is a possible solution available for EngageCX Converse, only.

Project Ideas

Within EngageCX you will have access to several sample projects.

To set up these projects, access the Project Ideas tile from the Developer module. Below is a description of each sample project, samples intended to emphasis different capabilities of the EngageCX Platform.

Financial

Contract	Basic contract template showcasing advanced forms features.
Credit Order - Digital Signature	Demonstrates how you can use 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.
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.

Retail

Adventure Works	Collection of dashboards that describe performance metrics for AdventureWorks, a fictional company.
Bookstore Invoice	Basic example with fields and dynamic tables.
Bookstore Newsletter	Basic newsletter for showcasing forms structured data feature.

Telecom

Analytics Telephone Invoice	Analyse usage accounts using interactive charts and visualizations.
Smart Monthly Telephone Invoice	Smart Document example with interactive charts and tables.

EngageCX Solutions has multiple Project Ideas for you to view and use and for better understanding on how to set up your projects.

1. Click on the Developer button from the modules menu from the top of the Enterprise Website welcome page.
2. Under the Developer tile, select the Project Ideas menu.
3. Select the Sample Project that you would like to use and click on the INSTALL button.
4. Select where you would like to add the Sample Project to, from the list of available Workspaces.
5. To the left of the drop down list, select the Setup button to deploy the project.
6. The dialog will reload and provide you with a confirmation that the project was deployed successfully.
7. Select OK, and navigate to the Workspace that you have added the project to, and you will see a new folder with the Sample Project listed.
8. You can perform a test Run of the Sample Project to view its output using mockup data, by clicking on the Test button, under More option, in the right corner of every document.

Bookstore Invoice - Generate a single invoice from data

• Uses XML data as input. The data source contains transactions for a single invoice.
• Easy to understand without any advanced features.

Telephone Invoice - Generate one or more invoices from data

• Moderately complex template with a Transpromo placeholder and subdocuments.
• Uses CSV data as input. 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.

Explanation of Benefits - Generate multiple statements from data

Documentation

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

Software

In Software section you will find useful tools, to help you actually develop professional document templates, data models and interactive visualization, under EngageCX Design Studio or create application that uses EngageCX API to generate documents.

Accessing Software Tile

1. Click on the Developer button from the modules menu from the top of the EngageCX platform welcome page.
2. Select the Software tile, under Tools group.

or

1. Click on the System button from the top left corner.
2. Choose the Software option under the Developer group.

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 Access Control section and start configuring users, groups and permissions.

Keep your document production and customers in synch

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. In this section 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 EngageCX Design Studio Publisher. A reusable sub-document that can be inserted in multiple templates has the .epb or .xfc extension.

Note: The process of creating documents dynamically from data is called “document composition”. This is why, throughout this documentation, EDS Publisher is in some cases referred to as a “visual document composition tool”.

Workflows

A workflow describes what should happen in a high-volume document production job. Typical workflow steps are Get, Render, Email, etc.

A workflow file has the .wk4 extension and can be edited directly in Enterprise Website.

Jobs

Document production workflows can be executed in the Jobs module. 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 Platform.

Communications	Organize the interactions with your customers and manage the flow of information for one-on-one, group or mass communication.
Channels	Deliver communications directly to the final recipients.
Workspaces	Collaborate and store all assets involved in your customer communication management processes.

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:

Communications Module
Batch	Allows you to produce a large number of documents in an unattended fashion.
Correspondence	Allows you to produce interactive documents, using the user interface.
On-Demand	Allows you to produce documents in real time via the user interface or using EngageCX API.
Channels Module
Email	Provides all the email communication capabilities.
Print	Allows you to setup print communications.
SMS	Provides all the sms capabilities.
Workspaces Module
Files	The EngageCX repository for all templates, data source files, workflows and other project files stored in the selected workspace.
Jobs	Allows a user to view detailed information about all jobs. From here a user will be able to run time information about a specific job as well as quickly navigate back to the workflow if any edits need to be made.
Tasks	Here users to create new tasks as well as review and edit tasks created manually or automatically by a workflow.
Scheduler	Enables users to schedule and track the execution of workflows that must run at predetermined times.
Trigger	Allows users to configure local or remote locations to be monitored as well as the actions that must be taken once an event occurs.

---

Batch

Batch communications produce multiple documents using the same template without any administrative involvement. A batch job may be started on a schedule or by a specific operator action. Monthly invoice production is typical example for batch jobs.

On-Demand

On-demand communications are intended to produce a single document set for delivery for a specific customer. The on-demand job will typically be started with a parameter that identifies the customer within a database (e.g. phone number or AccountID), and the output will be populated with data from this customer’s records.

Correspondence

Correspondence communications require operator input as part of the production process. As the job proceeds, information collected from the operator is applied into the document. At the end of the interaction, the document is rendered and distributed.

An example of an interactive job is providing a quote for an insurance policy at a customer service desk. The customer’s name, address, type of insurance, and the coverage limits would be entered into the document interactively then rendered and distributed.

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.

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.