XMPro's WorkFlow empowers business users and subject matter experts to configure a workflow application without coding. It consists of the following components:

XMPro WorkFlow

XMPro WorkFlow is a browser-based interface that employees in your company use to start processes, and to take action on those processes. Processes available in the WorkFlow will differ from company to company and user to user. Processes are custom built to suit your company’s needs.

XMPro WorkFlow Designer

XMPro WorkFlow Designer Windows application is used to administer role groups, roles and users; as well as to create and amend processes.

XMPro WorkFlow Monitor

XMPro Workflow Monitor, previously known as Business Activity Monitor (BAM) has two components, a browser-based interface that is used to manage jobs, and a Windows service that executes the time-based jobs.

How The Documentation Is Organized

• Getting Started - Get to know XMPro WorkFlow and features of each component.

• Resources - A goldmine of general articles such as release news, security, and FAQs to elevate your product experience.

• Concepts - Get detailed explanations of the platform's essential concepts, like Processes, Activities, Business Groups.

• How-To Guides - Follow step-by-step tutorials to help you create workflows.

• Administration - Find out how to manage users, roles, business groups. This documentation is only relevant to administrators.

• Installation - Learn how to install XMPro WorkFlow. This documentation is only relevant to administrators.

• Release Notes - Stay up to date on the latest features and bug fixes.

XMPro places a high priority on security, performing app security checks every 3 months using Veracode. Veracode's comprehensive analysis helps identify, prevent, and fix vulnerabilities through multiple testing methods: Static Analysis (white-box testing), Dynamic Analysis (black-box testing), and Software Composition Analysis.

Security Technologies and Practices

Our suite of products leverages robust technologies and practices to maintain a high security standard:

• WorkFlow, WorkFlow Designer and WorkFlow Monitor are built on .NET 4.8.0.

In the event a vulnerability is identified in any of these technologies, Microsoft promptly releases an update. We integrate these updates into our products and regularly release new versions that include essential security fixes.

Static Application Security Testing (SAST)

Static Application Security Testing (SAST) is a form of white-box testing used to scan an application’s source, binary, or byte code.

Dynamic Application Security Testing (DAST)

Dynamic Application Security Testing (DAST) analyzes a web application through the front end to find vulnerabilities through simulated attacks. This is also called Penetration testing.

Software Composition Analysis (SCA)

Software Composition Analysis scans all the components used in an application for security risks and vulnerabilities.

Results

Support and Recommendations

.NET versions are supported by Microsoft for 3 years after release, as detailed in their support policy. To ensure you have the most secure XMPro offerings, we recommend upgrading as soon as a new version becomes available to take advantage of the latest security updates and features.

Overview

This release introduces significant updates, including enhanced encryption processes, new database logging capabilities, and expanded authentication options like OAuth for email security. Additionally, several legacy features have been removed or deprecated, such as OleDb Provider support, advanced browse pages, and certain social login authentications. The update also includes improvements in site configuration, streamlined import/export options, and modifications to ActivityDisplay scripts for better security and functionality.

Key Changes

• Enhanced security with new encryption methods

• Email logging system for all Activity Server communications

• Error logging for activity processing issues

• OAuth support added for email functionality

• Visio support limited to x64 only (disabled by default)

Connectors integrate to third-party data sources in WorkFlow Designer

Database & Technology

Applications

XMPro Internal

Others

Supported Browsers

The XMPro WorkFlow platform can be run on a variety of browsers and operating systems.

Supported Operating Systems

The following operating systems are supported for browsers running the XMPro WorkFlow platform:

How do I rename a database?

You can rename a database by using the code:

EXEC sp_renamedb 'OldName', 'NewName'

How do I rename a physical database filename?

To rename a physical database filename, use the code:

ALTER DATABASE <Database name>  MODIFY FILE  ( NAME = <current_logical_name>, NEWNAME = <new_logical_name>)

How do I change the database collation?

To change the database collation, use the following code:

use master
go
ALTER DATABASE <Database> collate <collation>
go

How do I find the XML (XSD) schema for a table or view in SQL?

If you need to find the XML (XSD) schema for a table/view in SQL the following can help:

select top 0 * FROM [table name] FOR XML AUTO, XMLSCHEMA
replace [table name] with appropriate table name

How do I calculate business working days using SQL?

To calculate the business working days ins SQL, you can use the below:

SELECT (DATEDIFF(dd, @StartDate, @EndDate) + 1) -(DATEDIFF(wk, @StartDate, @EndDate) * 2) -(CASE WHEN DATENAME(dw, @StartDate) = 'Sunday' THEN 1 ELSE 0 END) -(CASE WHEN DATENAME(dw, @EndDate) = 'Saturday' THEN 1 ELSE 0 END)

How do I remove public holidays in a date range – design

Create a table with public days details and use them in the query to exclude those days from a date range.

For Example:

select count(*) from xx_publicHolidays where (date, between @startdate and @ endDate)

Date in the where condition is the column name in the table.

How do I reassociate an orphaned SQL user with SQL login?

If you ever have the need to move an SQL Server Database from one server or instance to the next then you may come across orphaned SQL Users, for example, the User is present in the database, but it is no longer associated with the SQL Login on the Server.

When that happens you have a couple of options.

You can delete the database user, re-add them, re-grant the appropriate role or rights, and be on your way.

It gets a bit more complicated, though, when the user owns schema(s) in the database.

If you try to delete and re-add them you’ll receive an error similar to the following:

"Drop failed for User 'sqlusername'.
An exception occurred while executing a Transact-SQL statement or batch.
The database principal owns a schema in the database, and cannot be dropped."

In order to get around that error, you would have to temporarily re-assign the owner of the schema(s) to another user in the DB before being able to delete their User Login.

In addition to the schemas the user may own, they may have been added to roles within the database, they may even have been granted explicit permissions that you would then have to manually reproduce (If you know what they were).

If that’s ‘the case, recreating those rights can be a meticulous task.

A much better alternative is to execute a statement very similar to the one shown below:

EXEC sp_change_users_login 'UPDATE_ONE' , 'sqlusername', 'sqlloginname'

It will re-associate the SQL User with the SQL Login and the Schema(s), Roles, and Permissions are retained.

How do I generate a unique ID for a form to store the form’s data in the database?

1. Create a procedure in the database with the input parameter and NEWID() function in the procedure’s body.

The parameter is not going to be used in the procedure but is necessary in order to map the procedure output to a form’s control using an Integration wizard which will require the input a value in the Input Parameter tab.

1. Map the control on the form to the procedure’s output as follows:

CREATE PROCEDURE <ProcedureName>
@type varchar(50)
AS
BEGIN
-- SET NOCOUNT ON added to prevent extra result sets from
-- interfering with SELECT statements.
SET NOCOUNT ON;
SELECT NEWID() as <IDName>
END

How do I debug a Connector manually?

If you run into an issue that a connector is not configurable when selected in Data Integration Wizard, use following code in any OnLoad event and look at the error message:

{
XMConnect.Connector plug = (XMConnect.Connector)Activator.CreateInstance(Type.GetType("TYPE CONNECTOR ASSEMBLY NAME HERE"));
Dictionary<string, string> constructorParams = new Dictionary<string, string>();//add all required settings
constructorParams.Add("SETTINGNAME", "SETTINGVALUE");
plug.SetHiddenParams(constructorParams);
List<InitializingParameter> initializingParameters = plug.GetInitializingArgumentsList();
throw new Exception("***" + initializingParameters.Count + " parameters found***" );//success
}
catch(Exception ex)
{
throw new Exception(ex.Message + "\n" + ex.StackTrace);
}

How Do I Track Changes with Change Data Capture in SQL?

If you need to monitor changes to tables in SQL Server you can make use of a feature called Change Data Capture (CDC) which is currently available in SQL Server 2008, SQL Server 2008 R2, and SQL Server 2012.

Following are some excerpts from the CDC MSDN page:

What does CDC do?

“Change data capture records insert, update, and delete activity that is applied to a SQL Server table. This makes the details of the changes available in an easily consumed relational format.”

How do you consume this information?

“Table-valued functions are provided to allow systematic access to the change data by consumers.”

“The function that is used to query for all changes is named by prepending fn_cdc_get_all_changes_ to the capture instance name.”

How do I get started?

1. “…change data capture must be explicitly enabled for the database. This is done by using the stored procedure sys.sp_cdc_enable_db.”

USE AdventureWorks2012;
GO
EXECUTE sys.sp_cdc_enable_db;
GO

1. “When the database is enabled, source tables can be identified as tracked tables by using the stored procedure sys.sp_cdc_enable_table. When a table is enabled for change data capture, an associated capture instance is created to support the dissemination of the change data in the source table.

USE AdventureWorks2012;
GO
EXECUTE sys.sp_cdc_enable_table
@source_schema = N'HR'
, @source_name = N'Employee'
, @role_name = N'cdc_Admin';
GO

1. Now you can access information about changes to your table by using the function fn_cdc_get_all_changes_HR_Employee

USE AdventureWorks2012;
GO
DECLARE @from_lsn binary(10), @to_lsn binary(10)
SET @from_lsn = sys.fn_cdc_get_min_lsn('HR_Employee')
SET @to_lsn   = sys.fn_cdc_get_max_lsn()
SELECT * FROM cdc.fn_cdc_get_all_changes_HR_Employee(@from_lsn, @to_lsn, N'all');
GO

“The first five columns of a change data capture change table are metadata columns.

These provide additional information that is relevant to the recorded change.

The remaining columns mirror the identified captured columns from the source table in name and, typically, in type.

These columns hold the captured column data that is gathered from the source table.

Each insert or delete operation that is applied to a source table appears as a single row within the change table.

The data columns of the row that results from an insert operation contain the column values after the insert.

The data columns of the row that results from a delete operation contain the column values before the delete.

An update operation requires one row entry to identify the column values before the update, and a second row entry to identify the column values after the update.

Each row in a change table also contains additional metadata to allow interpretation of the change activity.

The column __$start_lsn identifies the commit log sequence number (LSN) that was assigned to the change. The commit LSN both identifies changes that were committed within the same transaction, and orders those transactions.

The column __$seqval can be used to order more changes that occur in the same transaction. The column __$operation records the operation that is associated with the change: 1 = delete, 2 = insert, 3 = update (before image), and 4 = update (after image).

The column __$update_mask is a variable bit mask with one defined bit for each captured column.

For insert and delete entries, the update mask will always have all bits set. Update rows, however, will only have those bits set that correspond to changed columns.”

SQL Connector – invalid object name ‘#temp’ when reading input/output properties

When attempting to use the SQL Connector in the WorkFlow Designer may see the following (or similar) error message: invalid object name #temp.

This error will occur in a very specific scenario:

You are attempting to map the SQL Connector to a stored procedure and the stored procedure in question makes use of a temp table (or tables)

This error is caused by a limitation in SQL server, but can thankfully be easily avoided, in one of two ways:

Table Variable

The ideal solution when you encounter this issue is to make use of table variables (@temp) in your SQL Stored Procedure, and not temp tables (#temp).

Disable FMTONLY

Temp tables perform significantly faster than table variables, especially when processing large volumes of data. If the use of a table variable is not appropriate (possibly due to performance reasons), add the following statement to the start of your SQL Stored Procedure, before the temp table is addressed or referenced:

if 1=0 SET FMTONLY OFF

If you do use this approach to address your issue, please ensure that your stored procedure will execute successfully when all input parameters are passed a null value. You can verify this directly in SQL Server Management Studio.

Find answers to some of the most frequently asked questions.

This section provides guidance in using XMPro WorkFlow features as follows:

WorkFlow

WorkFlow Designer

WorkFlow Connectors

A plugin Framework that provides a standard way to connect WorkFlow tasks with third party systems, for example, CRM, Database, and Microsoft Word, etc.

For more information, click here.

WorkFlow Monitor

WorkFlow Monitor, formerly known as Business Activity Monitor (BAM) is primarily a service which can perform time-based jobs.

For more information, click here.

“License expired or invalid” error when license is up to date and valid?

Issue:

New license has been applied successfully, but when logging in, system still showing the error message “License expired or invalid”.

Resolution:

This could be because the number of active users has been exceeded or invalid login details used. Check the number of active users allowed for your license, should this be the problem; check if there are any users that can be deactivated to bring your count down inline with your license or request for an increase in users to your current license by contacting your account manager or support@xmpro.com.

Login error when trying to log on to WorkFlow Designer

Issue:

Login error occurred when trying to log on to WorkFlow Designer.

“The system could not log you in because your password expired.”

Resolution:

When a user’s password becomes expired, a user can use the Reset Password functionality from within the WorkFlow to reset the password. Follow the steps:

1. Go to WorkFlow to request a password reset.

2. Enter the User Name and E-mail of the user to be reset of the password.

3. Wait for the email that contains the new password.

4. Use the new password to log in and straightway, change your password.

For password reset to be working, the site needs to be set up correctly with

• SMTP server (in ApplicationSettings via Administration > Workspace).

• ServerMailAddress (in ApplicationSettings via Administration > Workspace).

• User’s email (in User Editor via Administration > User Editor).

How to enable trace logging in SAML2?

Issue:

SAML authentication has been configured in XMPro as described in Configure SAML 2 Authentication for XMPro Action Console and the following steps have completed by the SAML2 authentication service provider and XMPro in How to Setup SAML2 Authentication.

The user is successful redirect to the login URL as provided by the service provider. After signing in the user redirect to XMPro causes a continuous loop between the SAML authentication server and XMPro.

Resolution:

The only way to determine the issue is to see the response returned to XMPro. To view this, you will need to enable trace logging for XMPro.

Update your application’s web.config to include a <system.diagnostics> section as shown in the configuration below.

<system.diagnostics>
    <trace autoflush="true">
      <listeners>
        <add name="TextWriter"/>
      </listeners>
    </trace>
    <sources>
      <source name="ComponentSpace.SAML2" switchValue="Verbose">
        <listeners>
          <add name="TextWriter"/>
        </listeners>
      </source>
    </sources>
    <sharedListeners>
      <add name="TextWriter"
           type="System.Diagnostics.TextWriterTraceListener"
           initializeData="D:\Temp\logs\SAML\idp.log"/>
    </sharedListeners>
  </system.diagnostics>

The value for initializeData=”D:\Temp\logs\SAML\idp.log” is the file where the entries will be written to. Ensure that the IIS users have full access to the folder and file.

Some of the most common errors are:

• The username provided in the SAML response does not match the username in XMPro. In the response look for xml node saml2:NameID. The value returned for this node must match the username in XMPro.

• The partner identity provider value configured in XMPro is not correctly configured. Look for ComponentSpace.SAML2 Verbose: 0 : 12:41:23 AM: Exception: ComponentSpace.SAML2.Exceptions.SAMLConfigurationException entries.

What should I do if I encounter the error "Failed to enable constraints when using SQL Connector?

Issue:

At runtime, the SQLConnector throws an exception with a message: “Failed to enable constraints. One or more rows contain values violating non-null, unique of foreign-key constraints.”

This is a very generic error message that is raised by the .NET framework when it executes the query and populates the underlying dataset that is created by the SQLConnector.

Resolution:

This problem is usually caused by one of the following:

• Null values returned for columns not set to AllowDBNull.

• Duplicate rows being returned with the same primary key.

• A mismatch in column definition (e.g. size of character field) between the database and the dataset.

To resolve this issue, try the following:

• If the query was changed or the underlying tables/views used have been changed then remap the query for the SQLConnector using the Integration Wizard. This is especially true if a new field was added to the query.

• Run the query natively and look at the results, if the resultset is not too large. If you’ve eliminated null values, then the problem usually is that the primary key column is being duplicated.

• Include all the key columns and the columns defined as “not null” into your queries.

How to resolve issue Upload Control Not Responding?

Issue:

From Chrome Version 61 onwards, Upload Control in Object Groups is not responding for older versions of WorkFlow (6.1, 6.5, etc.).

Resolution:

Open Site.Master file in <XMPro_Installation_Directory>

Inside <script type=”text/javascript”></script> place the following JavaScript window.onload function

// Some code
window.onload = function () {

var GetDocumentScrollTop = function () {

var isScrollBodyIE = ASPx.Browser.IE && ASPx.GetCurrentStyle(document.body).overflow ==”hidden” && document.body.scrollTop > 0;

if (ASPx.Browser.WebKitFamily || isScrollBodyIE) {

if (ASPx.Browser.MacOSMobilePlatform)

return window.pageYOffset;

else if (ASPx.Browser.WebKitFamily)

return document.documentElement.scrollTop || document.body.scrollTop;

return document.body.scrollTop;

}

else

return document.documentElement.scrollTop;

};

var_aspxGetDocumentScrollTop = function ()

if (__aspxWebKitFamily) {

if (__aspxMacOSMobilePlatform)

return window.pageYOffset;

else

return document.documentElement.scrollTop || document.body.scrollTop;

}

else

return document.documentElement.scrollTop;

}

if (window._aspxGetDocumentScrollTop) {

window.aspxGetDocumentScrollTop = _aspxGetDocumentScrollTop;

window.ASPxClientUtils.GetDocumentScrollTop = _aspxGetDocumentScrollTop;

} else {

window.ASPx.GetDocumentScrollTop = GetDocumentScrollTop;

window.ASPxClientUtils.GetDocumentScrollTop = GetDocumentScrollTop;

}

/* Begin – > Correct Scrollleft */

var GetDocumentScrollLeft = function () {

var isScrollBodyIE = ASPx.Browser.IE && ASPx.GetCurrentStyle(document.body).overflow ==”hidden” && document.body.scrollLeft > 0;

if (ASPx.Browser.WebKitFamily || isScrollBodyIE) {

if (ASPx.Browser.MacOSMobilePlatform)

return window.pageXOffset;

else if (ASPx.Browser.WebKitFamily)

return document.documentElement.scrollLeft || document.body.scrollLeft;

return document.body.scrollLeft;

}

else

return document.documentElement.scrollLeft;

};

var_aspxGetDocumentScrollLeft = function () {

if (__aspxWebKitFamily) {

if (__aspxMacOSMobilePlatform)

return window.pageXOffset;

else

return document.documentElement.scrollLeft || document.body.scrollLeft;

}

else

return document.documentElement.scrollLeft;

}

if (window._aspxGetDocumentScrollLeft) {

window._aspxGetDocumentScrollLeft = _aspxGetDocumentScrollLeft;

window.ASPxClientUtils.GetDocumentScrollLeft = _aspxGetDocumentScrollLeft;

} else {

window.ASPx.GetDocumentScrollLeft = GetDocumentScrollLeft;

window.ASPxClientUtils.GetDocumentScrollLeft = GetDocumentScrollLeft;

}

/* End -> Correct ScrollLeft */

};

This will fix the issue of Upload Control not responding to the latest Chrome versions and older XMPro versions.

How do I update the Connection String when the site.config is encrypted?

This version of XMPro by default encrypts the site.config versus an unencrypted file in previous versions. It was found that the site.config was left unencrypted when a site was implemented even though the encrypt function was present.

This encrypting of the file raises some interesting questions around the updating of details specifically the main SQL connection string to the site.

The update of the SQL connection string can be done in the following manner:

1. You need to be on the web server that is hosting the XMWorkspace (The web services cannot be accessed remotely).

2. Navigate to (replacing the items in [] as required): http://[Server name]/[site name]/administration/genericwebservice.asmx

3. Click the UpdateConnectionString.

4. In the Value text box update the connection string (replacing the [] as required): Data Source=[];Initial Catalog=[];User ID=[];Password=[]

5. Click Invoke and wait for the popup to state Completed.

6. Once done an IISRESET or an APP Pool reset for the site in question is required. This is required as your updating the main SQL connection string for the site.

How do I resolve the Unexpected Runtime JavaScript Errors?

This can be resolved using the following steps:

1. Uninstall the Google Frame for IE 8 using the Administrative Tools-> Add Remove Programs.

2. Restart IE and make sure that Google Frame does not appear in the Add Ins.

3. Open the WorkFlow and the issue will be resolved.

The reason for the unexpected JavaScript errors is that the Dev Express controls that are used within the WorkFlow do not support the Google Frame plugin.

Refer to the following Dev Express Support article: http://www.devexpress.com/Support/Center/p/S33520.aspx

How to resolve “Error triggering: Access to the path.” is encountered when attaching file via File Attachment control?

Issue:

When attempting to attach a file via a File Attachment control, below error is thrown after clicking the submit trigger button:

Error triggering access path: ‘C:\inetpub\wwwroot\XMPro Site\uploads\Document1.xlsx’ is denied.

Resolution:

Allow Modify and Write rights for Users group for the uploads folder sitting under the XMPro web folder.

Follow the steps to achieve this:

1. Locate the uploads folder under the XMPro Site.

2. Right-click on the uploads folder to Properties and Edit the Users group.

3. Tick on Modify and Write to allow the rights and click ‘OK’.

How to resolve "Error Triggering: The device is not ready." when submitting a task?

Issue:

An error is encountered when submitting a task with a file attached. Error displayed:

"Error Triggering: The device is not ready."

Resolution:

Check the Repository Directory setting in the WorkFlow Designer. This can be found under the Administration tab Workspace. Make sure the path exists in the XMPro application server.

A process is created but is not displaying on the website?

Issue:

A process is created but is not displaying on the website.

Resolution:

The first activity of a process needs to be assigned to a Business Group. Make sure that certain users are part of the Business Group. Click the Activity, then in the Property window click on EventCreate. Assign the Creation Type as ‘First Activity’ and for the Creation Value, select a Business Group.

Browse page not displaying value

Issue:

In WorkFlow, Browse Page fields may not display their values. The underlying field contains the value but it is not displayed.

This is caused by a styling issue on the underlying Dev Express control due to enforcing a “strict” DOCTYPE on all controls. The styling issue causes the font-size attribute to be set to 0 (zero) on all td elements:

td.dxic 
{ 
font-size: 0; 
}

Resolution:

To resolve this, override the style in the style.css file in your skin directory by adding the following CSS rule:

td.dxic 
{ 
font-size: inherit !important; 
}

This issue has been encountered in v6.5 of XMWorkspace.

For further information see the following ticket in Dev Express Knowledge Base: ASPxTextBox - Font Size with em stopped working

How to resolve when task is missing in both “In Progress” and “Completed” track list?

Issue:

This can be possibly be caused by the following:

1. The account being used does not have the tracking right to the process the task belongs to.

2. Tracking permission has not been set up properly for the activity.

Resolution:

For possible cause 1:

• Assign the user account tracking right of the process the task belongs to.

• Find the role in the All Employees group and highlight the role, then click the Tracking Rights button.

• The Tracking Editor window will then open. Select the process from Available Processes to Current Processes by clicking the > button.

• Processes can be removed from Current Processes by highlighting and clicking the < button.

• When finished, click OK and save.

For possible cause 2:

• Highlight the activity, set Allow Tracking to True so that users that have tracking rights to the process can track the tasks in the tracking menu.

• Set Allow Value Tracking to True so that users that have tracking rights to the process can track the details of the tasks. If this property is set to False and the Allow Tracking property is set to True, the user can track the process in the tracking menu in the XMPro Workspace, but the user cannot click on the activity in the tracking to see the values entered in that activity.

Why am I getting a "Server Error – Maximum Request Length Exceeded"?

Cause:

The attached file size is larger than the upload file size that has been set up in Web.config.

Resolution:

1. Attach a file that doesn’t exceed the file size that has been set up.

2. To increase the upload file size, use the following section in web.config file:

<httpRuntime maxRequestLength=”2097151″ />

Resolving error when opening a Process Group: “An unhandled exception of type System.Runtime.InteropServices.COMException”

Issue:

This error occurs when trying to open a process group:

“An unhandled exception of type System.Runtime.InteropServices.COMException has occurred.”

This issue applies to XMPro v6.0 or below running under Windows Server 2008 R2.

Resolution:

To resolve this type of issue, register the msscript.ocx.

1. efore running Regsvr32 msscript.ocx, make sure the msscript.ocx file is in C:\Windows\System32 folder.

2. Click the Start button, then in the Start Search box, type CMD but to NOT press Enter.

3. In the Programs section of the displayed list, right-click the command prompt > Run as Administrator and click Continue.

4. In the open window, type the following command and press Enter:Regsvr32 msscript.ocx.

5. Verify that the registration is successful.

An alternative way to register the msscript.ocx is by navigating through your computer’s local directory.

How do I resolve the error: ‘A column named already belongs to this table’?

Issue:

When getting an error similar to this in a form/activity:

Resolution:

Check fcEventCreate table in the XMPro database with the EventID of your activity, there might be two rows in fcEventCreate table for this particular activity. Remove the one that is not required should solve the problem.

How to handle empty space in a dashboard?

Issue:

If we have a Dashboard with few controls, when we open the dashboard from XMPro WorkFlow the dashboard viewer will auto expand the dashboard controls to the maximum space. This will stretch the dashboard controls and may not look good.

Look at the dashboard below where the chart bars are very thick and unnecessarily occupy all the space and stretches the chart on the entire page.

Resolution:

To overcome the auto stretch, we can add a few card controls to the dashboard without a caption. The card control introduces space and will not auto stretch the existing chart control.

So if we look at the updated dashboard in the below diagram we can see the chart control is not auto stretched till the end.

If we look at the design time for the above dashboard:

We can see the card control (without a caption) is placed next to the chart control. This card control will stop the auto expand of the chart control until the end. This way we can better align the dashboard to provide a better look and feel based on end users requirements.

Dashboard – Group Control Changing Ignore Master Filter

First, you need to remove the Ignore Master Filter set on the group so that the master filters apply to the dashboard controls added to the group. You can access to the Ignore Master Filter setting for a group by clicking on the group and click on the data tab.

For example, you can see in the below dashboard designer, we have a group control and the group controls Ignore Master Filter is on by default, we need to click the ignore Master Filter once to turn it off. This applies the master filters to any controls that are added to the group.

The dashboard below shows when the Ignore Master Filter for the group is off.

Drop-down List in Managed Code

Use Case:

• You need to change the list values in a drop-down box on refresh.

• The list of values in a drop-down are different, based on the current user.

Solution:

The following code should be placed in the code editor for the control being changed.

public void NS10Dropdown_OnRefresh()
{
    Grp = activity.ObjectGroups["0"]; //Object group containing the control
    List<string> list = new List<string> { "o1", "o2", "o3", "o4"}; //list containing all dropdown values
    Grp["NS10Dropdown"][0, true] = list;
}

Code Recommendations:

• When setting the drop-down list, you should trim each value of whitespaces otherwise the control value might not be set properly in code.

• The drop-down list is not passed from one activity to another but the value is. Trying to retrieve the list will result in a null reference exception.

• Setting the drop-down value to a value that doesn’t match 1:1 with the value in the drop-down will result in the value being blank.

Why doesn’t “Enable Script IDE” option show in WorkFlow Designer for my process?

Issue:

The “Enable Script IDE” option is not showing in WorkFlow Designer.

Solution:

To display the option, follow the steps listed. Note that one should be a Super Admin to be able to perform the process.

• Open the Options Editor by clicking on the file tab.

• Select “Options” from the menu.

• In the Options Editor prompt, click the “…” button under Access Rights, making sure that Administration is highlighted/selected from the options list.

• Select the user that needs access to Script IDE. Under the “Other” tab, tick “Allowed Access” for Script IDE. Then click OK to wrap.

How to enable out of the box XMPro processes such as Process Archive?

XMPro has a few admin processes that are readily available and needs to be enabled if these processes are meant to be accessed by an admin user.

The out of the box processes are:

• Archive Process

• Edit Best Next Action Guide

• Edit Landing Page Options

• Task Reassign

Solution:

1. Enabling access to the Process Archive process design.

• Log in to the site

• Go to Options > Administration > Access Rights

• In the Access Rights Editor, find the administrator who can access the XMPro Process

• Click on the Processes tab

• Tick on Read and/or Write for Process Archive

• Click OK

2. Find out the Creation Type and Creation Value

• Go to the Process Groups > XMPro Processes > Process Archive

• Click on Archive Process Task

• Go to the Task Properties

• In property Event Create, note the Creation Value of the task

For example: Creation value is XMPro Administration

3. Enabling access to Business Group XMPro Administration

• Go to Options > Administration > Access Rights

• In the Access Rights Editor, find the administrator who can access Business Groups

• Click on Business Groups tab

• Tick on Read and/or Write for Business Group XMPro Administration

• Click OK.

4. Assign User to the Business Group so that the Archive Process can be initiated by the user

• Go to the Business Groups > All Employees > [User]

• In the Properties, go to Business Groups to see the list of business groups the user is part of

• Tick on XMPro Administration and click OK.

5. Verify the process is accessible in WorkFlow

• Log in to WorkFlow

• Click + to initiate a new process

• Select Process Group XMPro Processes

• Make sure that Archive a Process is there.

How to configure SQL Server on port 443

In many enterprise networks, outgoing traffic is only allowed on HTTPS i.e. port 443. In such scenarios, it becomes impossible to connect to a SQL Server running on the default port. A solution to this problem can be to configure SQL Server to run on port 443. Use the following steps to achieve this:

1. Open SQL Server Configure Manager

2. Drill down to Protocols for SQL20XX

1. Right-click on TCP/IP and open Properties

2. Specify 443 for TCP Port

1. Restart SQL Server service

You can now connect to SQL Server over port 443.

Please note: IIS cannot be running on port 443 on this particular machine.

Error occurs after upgrading XMPro Action Hub to 6.7 with Subscription Manager

Scenario:

An error occurs when trying to log in to the Action Hub after upgrading to version 6.7 with Subscription Manager authentication.

Solution:

This is caused by the WebsiteUrl setup in the site.config file of the Action Hub folder does not match with the Product URL setup in Subscription Manager.

For instance:

WebsiteUrl setup in site.config of Action Hub:

https://server/actionhub/default.aspx

Product URL of Subscription Manager:

https://server/actionhub/

Correct the WebsiteURL setting in site.config using XMDesigner by the following steps:

1. Log on to the upgraded website using an XMPro account with administrative rights.

2. Click on the Administration Tab.

3. Click the Workspace button.

4. Search for WebsiteUrl from Name column of the middle panel.

5. Remove “defualt.aspx” in the Value column.

6. Save the changes by clicking on the Save button.

7. On the Apply Server Settings message prompt, click Yes.

How to Create a Select/Un-select All Checkbox for a Column Checkbox in a Grid

Scenario

There are instances when a select/un-select all needs to be added to a checkbox column in a grid on a form.

Solution

The above can be achieved by adding HTML code in the control caption.

Default HTML code caption:

{Column Caption}<br/><input id='{Unique ID of select all checkbox}' type='checkbox' onclick="$('input#{Control Name}').
each(function(){$(this).prop('checked',$('input#{Unique ID of select all checkbox}').prop('checked'));})" />

Sample HTML code in Control Caption:

Delete<br/><input id='deleteall' type='checkbox'onclick="$('input#PC30200Delete').
each(function(){$(this).prop('checked',$('input#deleteall').prop('checked'));})"/>

Please note that this method only works from XMPro 6.5 onwards

Please find below example for guidance:

1. Log on to XMDesigner with Administrative rights account.

2. Double click on Process Group from Process Explorer

3. Create a Process Group by dragging an activity icon from Toolbox to the middle panel

4. Modify the Process Group name and description from the Properties panel

5. Press Ctrl + S on the keyboard to save the changes then double click on the newly created process group

6. Modify the Process name and description from the Properties panel

7. Press Ctrl + S on the keyboard to save the changes then double click on the newly created process

8. Create an Activity by dragging an activity icon from Toolbox to the middle panel

9. Modify the Name and the static Activity Description of the activity from the Activity Configuration Wizard

10. Press Ctrl + S on the keyboard to Save the changes.

11. Click on the newly created Activity and go to the Properties panel.

12. Click on the ellipsis button next to the Event Create option

13. Change the Creation Type to “First Activity” and Creation Value to “All Employees”

14. Press Ctrl + S on the keyboard to save the changes.

15. Click on the ellipsis button next to the Object Group option.

16. Click on the “Add” button in Maintain Object Groups window, to create a new object group

17. Click on the newly created Object Group and modify the name and Description

18. Change the Grid option to “True”

19. Click OK to save the changes.

20. Double click on the Activity to open Activity Designer.

21. Drag and Drop a new checkbox control from the Toolbox panel to Activity Designer

22. Modify name and caption to the below format from Object Configuration Wizard.

    Copy

    Name: TP1050Select
    Caption: Select <br/> <input id='cbxSelect' type='checkbox' onclick="$('input[id*=TP1050Select]').each(function(){$(this).prop('checked',$('input#cbxSelect').prop('checked'));})" />

23. Select the Object Group created earlier

24. Click “OK” to confirm the changes.

25. Press Ctrl + S on the keyboard to Save the changes

How do I configure a user account to run XMAlertService?

When installing XMAlertService to run under a domain user account, the account must have the right to logon as a service in the XMPro server

This logon can be granted in the Local Security Policy using the following steps:

1. Logon to the computer with administrative privileges.

2. Open the ‘Administrative Tools’ and open the ‘Local Security Policy’.

3. Expand ‘Local Policy’ and click on ‘User Rights Assignment’.

4. On the right pane, right-click ‘Log on as a service’ and select properties.

5. Click on the ‘Add User or Group…’ button to add the new user.

6. In the ‘Select Users or Groups’ dialogue, find the user you wish to enter and click ‘OK’.

7. Click ‘OK‘ in the ‘Log on as a service Properties’ to save changes.

Ensure that the user which you have added above is not listed in the ‘Deny log on as a service’ policy in the Local Security Policy.

Configuring the IIS in a local server for a new XMPro site installation

This applies to Windows Server 2012 and above.

1. In the server, type Server Manager.

2. In the top right menu, click Manage > Add roles and features.

3. Click Next on Before You Begin

4. Select “Role-based or feature-based installation” and click Next.

1. Select“Select a server from the server pool” and click Next

1. Select the Server Roles to add and click Next. Under the Web Server (IIS), tick the options per below:

1. Select the Features to add and click Install. Tick the .NET Frameworks per below:

How to pass information to a new First Activity using Parameterization?

If you want to pass an information along to a new First Activity one easy way to do it is via parameterization.

1. Create a submit button in WorkFlow Designer in your activity. Provide an appropriate name and save the activity.

2. Double click your submit button to open up the Script IDE. Under _OnSubmit, enter the following lines of codes:

string url = String.Format ("{0}/ProcessItem.aspx?g={1}&id={2}&{3}={4}",
<Workspace URL>,
<Process group ID>,
<Activity ID>,
<Name of Control>,
<Value>);
return String.Format("[NavigateTo: {0}]", url);

Where:

<Workspace URL> is the URL of your workspace

• The URL you connect to

<Process Group ID> is the value of your Process Group’s ID

• Can be found by opening the Process Group your activity belongs to, clicking your activity, and looking in Properties under Identification for the Parent value.

<Activity ID> is the value of your Activity’s ID

• Can be found by opening the Process Group your activity belongs to, clicking your activity, and looking in Properties under Identification for the ID value.

<Name of Control> is the name of the control you want to pass a value to

<Value> is the value you want to pass

If you want to pass values to multiple controls, just add an extra &{x}={y} to the end of the first string, as well as the appropriate <Name of Control> and <Value>s at the end of url.

You should end up with something like this:

1. Save the script and your activity, and you’re done!

How to customize and save Grid Layout in XMPro?

The grid layout customization can be used in versions 6.1 and above. This option can be used when a grid has many columns and read-only fields.

This section demonstrates how to customize and save grid layout in forms.

1. Create a reference label.

2. Set the value of the reference label on load or refresh as shown in the example below:

stringquery = string.Format(@"EXEC sp_RequestReport_TRDataMetrics %27{0}%27, %27{1}%27, %27{2}%27, %27{3}%27",
activity.GetControlValue("DM1050StartDate"),
activity.GetControlValue("DM1060EndDate"),
activity.GetControlValue("DM1018TestSite"),
activity.GetControlValue("DM10180ProductLine"));
activity.SetControlValue("TD10180Savegrid" ,@"<iframe width='100%' height='700' frameborder='0' src='GridView.aspx?gridname=MainTR&columnHide=
True&noColumns=6&pagesize=15&cn=DataMaster&sp=" + query + "'></iframe>");

1. In the above example, change the stored procedure name to the one that returns the report and pass in any input parameters if required.

2. When setting the value to reference label, iframe has a property called gridname which can be any name.

3. The property columnhide defines whether the columns should be hidden when the grid is loaded.

4. The property noColumns defines the number of the columns to be shown in the grid by default and the rest of the columns will be added to the show customization filter control window.

5. The property cn is the connection string.

6. Below is a sample screenshot of a customized grid layout:

1. Clicking the Show customization window option, a pop up namely ‘Field Chooser’ will open and a user can drag and drop columns from and to the grid.

1. When a user clicks on save layout option, the current modified grid layout is saved and whenever a user opens the report, the saved layout is loaded by default.

2. When a user clicks on load layout, it loads the previously saved layout.

How can Object Group parameters be used on Browse Pages?

Browse Pages can be configured in object groups via the XMPro Integration Wizard and using the SQL Connector option to create an Integration. However, this method cannot be used if the browse pages are expecting input parameters that are also located within the Object Group, as the integration will fail to differentiate between the different parameters and combine the results. For this Use Case, a custom workaround must be used.

First, open the EditPage popup window under the browse page’s Properties section.

In the Browse Page Editor popup window, open the Data Source script

Add the below code snippet, modifying the input parameters, stored procedure and Data Connection as required.

System.Data.DataTable dt = new System.Data.DataTable();
System.Data.DataSet ds = new System.Data.DataSet();
string type = activity.GetControlValue("BW1080Type", groupId, lineNumber);
using (System.Data.SqlClient.SqlConnection conn = new System.Data.SqlClient.SqlConnection(customSetting.Value(process.Company, @"Connections\MASTER")))

{
     conn.Open();
     System.Data.SqlClient.SqlCommand command = new System.Data.SqlClient.SqlCommand("int_Resource_GET", conn);
     command.CommandType = System.Data.CommandType.StoredProcedure;
     command.Parameters.Add(new System.Data.SqlClient.SqlParameter("@Type", type));
     dt.Load(command.ExecuteReader());
}

ds.Tables.Add(dt);

return ds;

After saving the Data Source, open the Page Objects window.

In this editor, you will be creating and mapping the columns from the stored procedure to the browse page grid.

• Description – Caption that will appear for the Browse Page column

• ID – System generated identifier

• Index – Used for ordering the Browse Page columns

• Name – User specified identifier

• Source – Name of the corresponding result column in the SQL query executed

• Target – If a row is selected from the browse page, what XMPro field will be populated.

• Leave blank if the column is only needed to be displayed within the browse page grid.

Now, your grouped browse page should be returning results dependent on the parameter in its individual row.

Resolving ASP.NET Error – A potentially dangerous Request.Path value was detected from the client

Issue

ASP.Net 4.0+ comes with a very strict built-in request validation, part of it checks for potentially dangerous characters in the URL which may be used in XSS attacks.

In XMPro this issue will normally occur in the following instances:

• A file was uploaded containing an invalid character in the file name and is referenced in the next activity as a clickable link.

• Some HTML special characters are present in a Simple Text Box or Large Text Box control during any post back event, i.e. the AutoPostBack option is set to true on a control or when submitting the form.

Resolution

Invalid file link

• If the issue is caused by a file that was uploaded in upstream activities or another process in XMPro, check the “ProbihitedFileNameCharacters” setting in the site.config file. If the value is empty it will default to ‘#,&,+,?,/,:’. To add additional characters, supply the default value plus any additional characters separated by a comma, for example: #,&,+,?,/,:,~,’.This will prevent further files from being uploaded with invalid characters but will not change existing values. The XMPro engine will remove the invalid characters when the file is uploaded.

• If it is a link to an existing file already uploaded or references from your site there are the following options:

  • The best approach is to remove the special characters from the path. These characters should cause no problem if they are passed not as part of the path but as part of the query string. This will necessitate modifying both the web page which is handling the request and those links (or services) which use it. If you absolutely need to allow one of these characters, then you can change the configuration to allow it. The setting to change is the requestPathInvalidCharacters which is part of the httpRuntime section in the web.config file.

  • In all likelihood even if you do have a httpRuntime section in your web.config file then you won’t have requestPathInvalidCharacters, so you will need to add it. Be aware that you are using this to specify which characters not to allow, you cannot specify which characters to allow. The default character are “<, >, *, %, &, :, \, ?”.

When entering these characters remember to HTML encode them as shown below:

<httpRuntime requestPathInvalidCharacters=”&lt;,&gt;,*,%,:,\,?” />

When setting it you can use the empty string, but it is probably better just to remove those characters which you need as show below:

<httpRuntime requestPathInvalidCharacters=”” />

In .Net versions prior to 4.0 you might need to add the requestValidationMode property as well, as shown below:

<httpRuntime requestValidationMode=”2.0″ requestPathInvalidCharacters=”” />

• Correct it at the source. This means the following:

  • Updating the name of the file in the Repository Directory,

  • Changing the name of the file in the fcEventValue table.

  • AND if referenced from another database, correct it there.

Text Box Controls

• If the issue is caused by XMPro reading a value from a previous activity or a database with HTML characters, there are three options available:

  • Replace the Large Text Box with the new HTML Editor Control. Only available in XMPro 6.5 and higher.

  • Keep the Large Text Box or Simple Text Box and try and clean the value BEFORE rendering the control using the String.Replace() method, e.g. String text = “This should break </br> this is a new line”; activity.SetControlValue(“FI1080CheckingChars”, text.Replace(“</br>”,”\n”)); The problem with the above is obviously that in the worst case scenario you will need to account for more than one type of html tag. Fortunately, only the </br> or </br > characters need removing when using the XMPro Large Text Box or HTML editor type of control. For a more complete html removal functionality search Google or try this url: https://www.dotnetperls.com/remove-html-tags.

  • Replace the Large Text Box or the Simple Text Box with a Reference Label. The downside of this is that if there is a lot of content, then everything will be rendered on the form. With a Large Text Box where the ReadOnly property is set to True, a scrollbar will be shown if the content exceeds the height of the control.

Resolving ASP.NET Error – ThrowIfMaxHttpCollectionKeysExceeded

Issue

On December 29, 2011, Microsoft released a security update KB2656356 / MS11-100 for ASP.NET to address a potential Denial of Service vulnerability. In the update, Microsoft introduced a limit to the number of data elements on an ASP.NET form or on a JSON payload. The default limit is 1000 data elements. Exceeding this limit will cause a ThrowIfMaxHttpCollectionKeysExceeded error.

In XMPro, this issue will occur during a post back event, e.g. submitting a form when there are more than 1000 controls on a form. This number is very easy to be exceeded, especially in data capturing type forms.

Resolution

Fortunately to fix this issue is very easy. To change the default MaxHttpCollectionKeys limit, add the following to your web.config file in the section in the section and put a large value.

<appSettings>
<add key=”aspnet: MaxHttpCollectionKeys” value=”5000″></add>
</appSettings>

References

Knowledge Base article: An ASP.NET request that has lots of form keys, files, or JSON payload members fails with an exception

How do I sync data warehouse with my XMPro WorkFlow Database?

Create a SQL Job that runs the “xmi_Update” stored procedure located in the Data Warehouse database.

Recommendations:

• Create the Job to run the update overnight (“xmi_Update” stored procedure) on the Data Warehouse.

• If more frequent updates are required, for example, update every 15 minutes, monitor the SQL Server to ensure there is no excessive load that could have a negative impact on other systems using the SQL server.

• The first run of the data warehouse update on a pre-existing XMPro database could take many hours to complete. Please take this into consideration when scheduling the first update.

• After the stored procedure has run for the first time amend the “xmi_Update” stored procedure and comment out the command “exec xmi_SchemaRemoveCustomTables”.

“xmi_Update” stored procedure structure:

The following commands are responsible for updating the data warehouse data from the XMPro Core Database

• exec xmi_BatchUpdateTransactionLog

• exec xmi_BatchUpdateTransactionValue

• exec xmi_SetLastTaskID

When major changes to the XMPro Processes/Activities are made, it is recommended that the “exec xmi_SchemaRemoveCustomTables” command is run.

The command “exec xmi_SchemaRefresh” will amend any changes to tables or create any new custom tables.

The command “exec xmi_BatchUpdateCustomTables” will populate the custom tables created by the “xmi_SchemaRefresh” stored procedure above.

How to change IIS in Process Session Timeout?

The default in process session timeout value is 20 minutes. This means that when a user is logged in to the XMPro WorkFlow and is for more than 20 minutes, IIS will recycle the session data resulting in the user being logged out automatically. The below steps show how to configure and amend the timeout period. For more information on Session States and in Process sessions read this article on the MSDN Microsoft developer site.

Step 1:

In the XMWorkspace web.config file (found in the root folder of the website) the following setting is available:

“<sessionState mode=‘InProc’ timeout=‘20’ />”

To amend the timeout value, find the setting in the web.config file and amend the timeout value to the required value.

Step 2:

In IIS, find the appropriate website application pool that the WorkFlow is linked to. Navigate to Advanced Settings (right click->Advanced Settings) and change the setting “Idle Time-out (minutes)” value to the required value.

How to setup SAML2 authentication?

Before configuring XMPro to use SAML2 to authenticate users, as described in the article: Configure SAML 2 Authentication for XMPro Action Console, the following steps must be completed by the SAML2 authentication service provider and XMPro.

XMPro

XMPro must provide the following to the service provider to be used to configure SAML2 authentication:

• Logout service: https://xmproapplication.com/authentication/saml/sloservice.aspx

• Assertion service: https://xmproapplication.com/authentication/saml/AssertionConsumerService.aspx

• Service provider name (SPID): Set it to the domain name of the XMPro application e.g. xmproapplication.com

The service provider might require a metadata file that contains all this information above. An example provided below.

<!-- Service provider SAML metadata -->
<md:EntityDescriptor entityID="xmproapplication.com" xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata">
    <md:SPSSODescriptor WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
        <md:KeyDescriptor>
            <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
                <ds:X509Data>
                    <ds:X509Certificate></ds:X509Certificate>
                </ds:X509Data>
            </ds:KeyInfo>
        </md:KeyDescriptor>
        <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://xmproapplication.com/authentication/saml/sloservice.aspx"/>
        <md:NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:transient</md:NameIDFormat>
        <md:AssertionConsumerService index="1" Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://xmproapplication.com/authentication/saml/AssertionConsumerService.aspx"/>
    </md:SPSSODescriptor>
    <md:Organization>
<md:OrganizationName xml:lang="en">XMPro</md:OrganizationName>

Service Provider

The service provider will provide the following to XMPro.

• PartnerIdentityProviderName: samlprovidername.com

• SingleSignOnServiceUrl: https://samlprovidername.com/idp/profile/SAML2/Redirect/SSO

• SingleLogoutServiceUrl: https://samlprovidername.com/idp/profile/SAML2/Redirect/SLO

• SAML signed certificate: Copy this into the root folder of the XMPro website.

The service provider may provide XMPro also with the metadata file generated by the SAML2 server that will contain the information above. An example snippet from the file is shown below:

<?xml version="1.0" encoding="utf-8"?>
<EntityDescriptor …..
<SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://samlprovidername.com/idp/profile/SAML2/Redirect/SLO " />
    <SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location=" https://samlprovidername.com/idp/profile/SAML2/Redirect/SSO " />
    <SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location=" https://samlprovidername.com/idp/profile/SAML2/Redirect/SSO " />
  </IDPSSODescriptor>
</EntityDescriptor>

How to embed CAD drawings in XMPro Activity?

Background

To view CAD drawings currently in XMPro, the drawings are loaded as images or as a hyperlink.

The option below embeds the CAD drawings directly into the activity.

Configuration

To configure and load CAD drawings inside a XMPro activity:

• Create a reference label and set the value using the CAD link. Below is an example:

activity.SetControlValue("LW70620CAD", "<iframe src='http://cad.emersonregulators.com/
item/630-series/630-series/pn-630-6?pageFrom=pc&configToken=I3T5OMY7x4g3lzGFtU2l
-BZdzmff5gZAaNJoIDdJhhQSLOUqgpii3LRayg0K7lUY' width='100%' height='1200' frameborder='no'></iframe>");

How to configure SAML 2 authentication for XMPro WorkFlow?

Background

The XMPro WorkFlow supports four modes of authentication, namely:

• XMPro: Users are presented with an XMPro login screen

• Windows: The Action Console will attempt to log the user in automatically using the user’s active Windows credentials. The domain username must match the username of the user in XMPro.

• SAML 2: The WorkFlow will attempt to log the user in automatically using the user’s associated SAML credentials. The domain username must match the username of the user in XMPro.

• Mixed: A mixture of the (aforementioned) ‘XMPro’ and ‘Windows’ and ‘SAML2’ authentication modes. The WorkFlow will first attempt to log the connecting user in using the user’s associated SAML2 credentials, should this fail Active Directory credentials.

XMPro and Windows authentication have been around for a long time in the XMPro WorkFlow, whereas SAML 2 authentication has been available only from XMPro WorkFlo v6.1. This article will focus on the configuration of SAML 2 authentication for use in the XMPro WorkFlow.

Configuration

The following settings are set from the Workflow Designer that is part of the XMPro Agile Design Studio.

1. On the Settings tab click on Workspace in the General section. This will open the ApplicationSettings window. Change the value of the AuthenticationMode to ‘SAML2’ or ‘mixed’. It might be required to set the mode to ‘mixed’ to allow access when using the Workflow Designer. Click on Save or Ctrl+S to save your changes. You will be prompted to ask if you want to reload Server Settings. Click No. The server settings will be reloaded as the last step.

2. On the Settings tab click on SAML2 in the Custom Settings section. Change the ‘enabled’ value to ‘true’ as shown below. The other two ‘key’ type settings will be configured in the next steps.

• On the Settings tab click ServiceProvider in the Custom Settings section. It will show the following values that needs setting. After setting the values Click on Save or Ctrl+S to save your changes. *ServiceProviderName: The provider name. Set it to the domain name of the XMPro application, e.g. xmproapplication.com

• *AssertionConsumerServiceUrl: the service provider’s assertion consumer service (ACS) URL. The assertion consumer service URL is the endpoint at which the SAML response is received.

• ServiceProviderCertificateFile: The certificate file path. The file path is either absolute or relative to the application folder

• CertificatePassword: The certificate file password. (*) are required fields.

1. On the Settings tab click on PartnerIdentityProvider in the Custom Settings section. It will show the following values that needs setting. After setting the values Click on Save or Ctrl+S to save your changes.

• PartnerIdentityProviderName: The provider name that will be providing the service.

• SignAuthnRequest: A false or true value indicating whether to sign authentication requests.

• WantSAMLResponseSigned: a false or true value indicating whether SAML responses should be signed.

• WantAssertionSigned: A false or true flag indicating whether SAML assertions should be signed.

• WantAssertionEncrypted: A false or true flag indicating whether SAML assertions should be encrypted.

• SingleSignOnServiceUrl: The partner identity provider’s single sign-on service URL.

• SingleLogoutServiceUrl: The partner provider’s single sign-on service URL.

• CertificateFile: The certificate file path. The file path is either absolute or relative to the application folder.

• OverridePendingAuthnRequest: A false or true value the flag indicating whether a pending authentication request may be overridden and an IdP-initiated SAML response received. If a service provider sends an authentication request, then it expects the SAML response it receives to come from the identity provider it sent the authentication request to and that the SAML response is in response to this authentication request. If a different identity provider sends a SAML response or the expected identity provider sends a SAML response but it is not in response to this authentication request, this is treated as an error if this flag is false. If this flag is true then these restrictions do not apply. Setting this flag to true supports an SP-initiated SSO flow being supplanted by an IdP-initiated SSO. All the fields are required.

1. The last step is to apply the changes to the site. On the Home tab in the Deployment section click on the Reload Server Settings icon and click Yes when prompted. Please note that you might need to reset the XMPro application pool for the changes to take. This is normally not required.

Dashboard – Rotating chart control view

Requirement:

There are some instances that you might want to change the view of the dashboard chart control, due to layout and space constraints.

By default, the dashboard chart plots the “Arguments” in X-Axis and “Values” in Y-Axis which will present the data as below:

The chart presents information regarding “Top 10 Most Time-Consuming Users”. On X-Axis, users are plotted and on Y-Axis the time is plotted for each user. We can also clearly see from the chart that the alignment of the X-Axis labels is not clear.

The view might be better in this case if the users are plotted on Y-Axis and the Time is plotted on X-Axis.

Solution:

To change the view of the dashboard chart control, follow the steps below,

Step 1: Click on the chart.

Step 2: Click on the Design tab and click on the Rotate tab which will then rotate the view.

The updated chart below is simple, clear and presents the information without layout issues.

How to define global parameters in XMPro Dashboard and filter data using Global Parameters?

Defining Global Parameters

Often there will be a need to define global parameters in dashboards to pass on values and filter data.

Step 1: Open Dashboard Designer.

Step 2: Click on Parameters on the top tool bar.

Step 3: In the open Parameters Page, you can define your global parameters by providing Name, Description and a Default Value.

In this example, the default value is set to 90 and the global variable name is ‘ExcludeActivitiesGreaterthanDays’. This Global parameter can be used in the dashboard to filter data.

Using the Global Parameter to Filter Data

Now we have defined our global parameter, we now want to use the Global parameter to filter data records that are present in a dashboard chart control.

Step 1: Right click the chart control and click on “Edit Filter” where we wanted to apply filter to exclude all records where the data is more than the global parameter value.

Example:

This presents Top 10 Time Consuming Activities, excluding records wherein the activity time is greater than 90 days.

How do I plot values inside the chart control?

By default, the chart control plots the arguments on X-axis and plots the values on Y-axis as shown in the image below.

The chart presents the users on X-axis and time consumed on Y-axis. If I want to find out for each user the exact time consumed, this representation is a bit difficult and not clearly visible. In this case, it might be beneficial to display the value for each user inside the chart bar.

To display the value inside the chart bar:

Step 1: Click on the existing designed chart in the dashboard designer.

Step 2: Click on the little Chart Icon next to the Values.

Step 3: In the opened ‘Series Options’ page navigate to Point Label Options, select ‘Value’ in Content Drop Down and Select ‘Inside’ in Position Drop Down and click OK.

This will now present the value associated with each user inside the chart bars as shown below.

How to view only few data points in a dashboard chart?

Issue:

Often there would be a requirement that you want to view the top 5 or 10 data points in a chart by default.

Solution:

Step 1: Click on the chart where you wanted to view 10 points at a time.

Step 2: Click on the “Design” tab and click on X-Axis settings.

Step 3: In the open X-Axis settings page, Click on “Limit visible points”, mention the exact number of items you wanted to view at a time and click OK.

Step 4: The chart will now present only 10 data items.

The Process Model defines the relationship between different components in workflow in XMPro.

Process Groups

The Process Group is the topmost structure in a process. It is a logical grouping of different processes. For example, Company ABC has several human resources processes. An employee can request leave, put in an overtime claim, place a grievance against a colleague, or put in a resignation. These are separate processes, but they all fall underneath an HR Related Documents heading. There is no wrong or right way to group your processes. As mentioned already, it is a logical grouping.

Process

The logical grouping of activities, events, or steps that form part of a process, for example, the Leave Application process could have two steps: Request and Authorization. A process can be a Structured Process (one-step after the other and pre-define) or an Unstructured Process (the flow cannot be defined at solution design time but is determined at run-time) or a Hybrid Process (combination of structured and unstructured characteristics in one process).

Activity

A specific step in a process. It will be the user interface for that step (web form or a screen), for example, the Leave Application (screen interface or web form) will be the first Activity in the Leave Requisition process. The Leave Application Authorization will be the second step or Activity in the Leave Requisition process. One Process can have multiple activities.

Activity Fields

An activity field has a specific type, e.g. Text Box, Label, Checkbox, etc. that is placed on the user interface for the activity.

Process Groups, Processes, Activities, and Objects are all configured in the WorkFlow Designer.

XMPro has Visio embedded for a rich process design experience. To use Visio as a process designer a licensed installation of Visio 2019 (64bit) or later is required. By default, this option is disabled.

To enabled Visio Designer go to File Tab/Options/General.

Visio Shapes

XMPro supports Visio stencils. These stencils enable business users to have basic flow charts or complex Business Process Modeling Notation (BPMN) and Case Management Modeling Notation (CMMN) based models.

XMPro is installed with a default XMPro stencil that is a combined subset if BPMN and CMMN. It has all the shapes to support structured, unstructured and hybrid processes.

The following shapes are supported in the XMPro stencil:

XMPro Trigger Styles

XMPro step from one activity to another through a trigger mechanism. XMPro supports three trigger styles that are all accomplished without coding:

1. Simple Trigger: Simply draw a connector from one activity to another and name the connector (arrow) with the trigger name. This will automatically create the trigger and name the button on the activity form.

2. Conditional Trigger: Draw a connector from a decision block (diamond) and double-click each outgoing connector to use XMPro Conditional Routing wizard to set up the routing rules. This can be as simple as Approve or Reject or as complex as an approval matrix and nested conditions.

3. Dynamic Allocation Trigger: XMPro’s unique Dynamic Allocation Logic allows a process designer to set up dynamic or unstructured routing for case style processes where connectors or arrows cannot be defined.

XMPro Decision Shapes and Gates

The XMPro stencil supports decisions as part of the process models. The simple diamond shape with a blank center represents a typical IF decision. It does include nested IF’s in the support wizard that sets up the decision logic.

The diamond shape with the circle represents a process split and the diamond with the Plus (+) Sign represents a join after a process split. The default configuration is set up as an AND gate which means all the legs need to be completed for the joined activity to happen. It is often referred to a WAIT action that waits for all the preceding activities to complete.

XMPro Wizards in Visio

XMPro supports a range of right-click wizards in the Visio design environment.

XMPro Activity Wizard

This XMPro Activity Wizard allows you to set the properties of an Activity (form or screen).

Right-click an Activity Shape to show the XMPro Wizard and the XMPro Data Wizard:

The General tab shows the basic Activity options.

The Advanced tab shows additional notification and escalation options, including behavior and styling settings.

The XMPro WorkFlow Designer is a Windows application that is used to configure business processes in XMPro.

Workflow Designer Navigation

The Designer has the following sections:

The Ribbon Bar

The ribbon bar at the top of the window is the main navigation menu and has several tabs and menu items. Many of the items on the menu are access controlled and only certain users may be able to use them. If an item is greyed out, it means that a user does not have the necessary rights to access the item.

The following sections cover the different tabs of the ribbon bar and its menu items.

The File Tab

The File tab contains the following menu items.

The Design Tab

The Publish Tab

The Administration Tab

The Help Tab

The Visio Tab

XMPro has Visio embedded for a rich process design experience. XMPro supports Visio Stencils. This enables business users to have basic flow charts or complex Business Process Modelling Notation (BPMN) and Case Management Modelling Notation (CMMN) based models. XMPro also supports these business or industry specific modelling notations.

An Activity specific step in a process. It will be the user interface for that step (web form or a screen), for example, the Leave Application (screen interface or web form) will be the first Activity in the Leave Requisition process. The Leave Application Authorization will be the second step or Activity in the Leave Requisition process. One Process can have multiple activities.

Next Activities are triggered by users by completing the information required in the web form and then submitting by clicking on the relevant action option. Activities have notification and escalation rules associated with them.

Properties

An activity has the following properties:

The Event Create Property

The Event Create property of an activity specifies who must do, or who can access an activity.

What you choose in the Creation Type property, will determine what you can choose in the Creation Value property.

The Administrator Model defines the way in which a company’s organizational structure is captured and managed within XMPro. XMPro is a role-based solution and access control is determined by the Role of a User and the Business Groups that the user's role is associated with.

Summary of the Administrator Model

XMPro is a role-based solution and access control is determined by the Role of a User and the Business Groups that the user’s role is associated with.

Business Group

A Business Group is a logical group of business roles that have access to the same processes. Typical examples for Business Groups are:

• Sales Representatives

• Finance Clerks

• Quality Special Interest Group

• Oversight Committee

• C-Level Executive

• All Employees

Any number of Roles can be associated with a Business Group.

It is used in various routing and approval scenarios and is specifically for access control to start a new process. Only users/roles that belong to the Business Group designated to start a new process will see that process option in their list of available New Processes.

Creating your Business Group(s) is always the first thing you do in your new site.

Role

• A role group can have more than one role inside it.

• A role can be part of more than one group.

A role is typically the position on the organizational diagram. Typical examples are:

• Financial Controller

• Sales Manager

• Maintenance Superintendent

• Account Manager

• SHEQ Inspector

A User is associated with a Role and the Role is primarily responsible for the completion of the task. Only one User can be linked to a Role at any point in time, but users can change roles as they get promoted, move or leave the organization.

This Role-based approach ensures the integrity of process audit trails as it will show a User in the Role that the person had at the point in time when the transaction was submitted. It will, for example, show that Keith was a Sales Representative when requesting a credit increase for a customer, even though Keith is now a Sales Manager as a result of a promotion.

User

Provides a unique login in the XMPro WorkFlow.

• A user can only be assigned to one role.

• A role can only have one user assigned to it.

A user is a named individual that is linked to a role. This is a one-to-one mapping and represents the person that physically transacts on the system.

User information is stored for both current and past users to ensure the integrity of audit trails. Users are marked inactive when they leave the employment of the organization but remain on the system to ensure that the history of all transactions is correct.

Users can change Roles in the XMPro solution, but they cannot belong to multiple Roles at the same time.

When creating Business Groups, Roles or Users you create them in the following sequence:

When deleting Business Groups, Roles or Users you need to do it in the following sequence:

The XMPro Workflow Monitor, previously known as Business Activity Monitor (BAM) is primarily a service which can perform time-based jobs.

It has a Controller/Mediator and a Database to store its data. It communicates to WorkFlow using an XMPro API while the WorkFlow and any third-party can communicate to a WorkFlow Monitor using the WCF Service exposed by it. It has a default UI which is an ASP application and uses the same WCF Service to communicate.

Job

A job is a combination of following

1. Schedule

2. Trigger

3. Action(s)

Schedule

A Schedule defines the timing of the Trigger to be evaluated at. It is defined by the end-user through UI at the time of configuring a job. Currently, it provides following Recursive scheduling options:

WorkFlow Monitor Controller continually evaluates each job’s next time to occur. If the time to occur is current it creates a Thread and assigns it the relevant Trigger.

Trigger

A trigger physically exists in a folder which WorkFlow Monitor has access to, specified in the config file. It is a DLL extended from a generic DLL (XMMonitor.dll) provided with some built-in functions, for example, checking for new Tasks, etc.

A trigger’s primary responsibility is to evaluate if the Job needs to be executed or not. A trigger may get data passed in as static parameters at the time of configuration.

If the trigger evaluates to true it calls the current job’s associated Action(s). The outcome of Job is logged to database at the end of execution of all Actions.

Action

An action physically exists in a folder which WorkFlow Monitor has access to, specified in the config file. It is a DLL extended from a generic DLL (XMMonitor.dll) provided with some built-in functions, for example, creating a Task, sending an email, creating an XMPro User, etc.

Users can create a custom Action which will have access to all standard functions which can be mixed and matched for individual requirements.

Every Action has a set of inputs and outputs in a form of Named Value Pairs which in case of Sequenced Actions are passed from one Action to another.

The XMPro WorkFlow is the interface that the general employee is going to work in. It is a browser-based interface that employees in your company use to start processes, and to take action on assigned tasks. Processes available in the WorkFlow will differ from company to company and user to user. Processes are custom built to suit your company’s needs.

The Login Page

If the site uses XMPro Authentication, the user will have to log in to the XMPro WorkFlow using a username and password.

Providing a valid username and password will allow the user to access the home page of the site.

If the user provides an invalid username and password or the organization license has expired, he/she will be prompted to try again.

If the site is using Windows Authentication Mode, the user will not be required to provide valid login information. XMPro will authenticate the user against the Active Directory. When the user has logged in successfully the user will be logged authenticated as valid user in WorkFlow.

If the site is using SAML Authentication mode, the user will be redirected to the single sign-on URL configured in application settings. When the user has logged in successfully the user will be logged authenticated as valid user in WorkFlow.

The Home Page

On the home page the user will view and access the tasks assigned to the user or the business groups that the user belongs to, start new processes, and track processes in progress or completed.

The look and feel is customizable. The images, colors, fonts, and layout can be modified to fit the company's profile. These are called skins, and can be configured in the application settings. XMPro also use themes to help standardize the look and feel throughout the site.

The Menu Bar

The XMPro WorkFlow has a collapsible vertical menu bar on the left of the page. The menu bar consist of four sections with submenus.

Dashboard

The Dashboard displays all configured dashboards available to the current user. It also allows the user to configure dashboard within WorkFlow.

Home

The Home menu option contains three sub options.

To-Do

To-Do is where logged in user can view the tasks or activities to which the user has to respond or can take action on. If processes and activities are setup correctly, users can view To-Do item by "All Tasks", "Overdue", "Current", "Upcoming" and "Unscheduled".

In Progress

There are three views for the user to choose from “Own”, “Follow” and “Involved”. “Own” allows the current user to view their own pending tasks, those processes which the user started themselves. “Follow” allows the user to view processes that the current user has tracking rights on. “Involved” allows the user to view those processes in which the current user has been involved with, i.e. The current user has completed an activity which he/she did not start the process as well as does not have tracking rights on.

Completed

There are three views for the user to choose from “Own”, “Follow” and “Involved”. “Own” allows the current user to view their own completed tasks, those processes which the user started themselves. “Follow” allows the user to view completed processes that the current user has tracking rights on. “Involved” allows the user to view those completed processes in which the current user has been involved with, i.e. The current user has completed an activity which he/she did not start the process as well as does not have tracking rights on.

Report

The Report allows current user to display all reports configured in WorkFlow Designer.

Manage

The Manage functionality within XMPro is available to Super Admin users of XMPro such as site administration. The manage functionality allows the super admin user to manage following:

• Users

• Roles

• Business Groups

• Meta Data

• Site Settings

• Site Styles

• Dashboard

BAM job history not showing

When accessing the ‘History’ tab in the WorkFlow Monitor UI (The XMMonitorUI Web App is installed alongside the XMMonitor service), if the history does not display and you notice the URL in the browser address bar contains the text “aspxerrorpath=/XMMonitorUI/History.aspx”, it means that an error has occurred in loading the job history.

In order to see the full error message, you will need to turn off custom errors in the web.config file. Set mode=Off in the customErrors element:

You should then see a more detailed (Yellow Screen Off Death) error message. If the error you are receiving is, The maximum message size quota for incoming messages (65536) has been exceeded. To increase the quota, use the MaxReceivedMessageSize property on the appropriate binding element., it means the size of the history records is larger than the default allowed transfer size of the XMMonitor API.

To resolve this you need to increase the maximum allowed message size in the web.config file by adding the maxReceivedMessageSize attribute to the binding element and setting its value to an appropriate value. The example below increases the size to 256KB (from the 64KB default).

How do I configure a user account to run XMAlertService?

When installing XMAlertService to run under a domain user account, the account must have the right to logon as a service in the XMPro server.

This logon can be granted in the Local Security Policy using the following steps:

1. Logon to the computer with administrative privileges.

2. Open the ‘Administrative Tools’ and open the ‘Local Security Policy’.

3. Expand ‘Local Policy’ and click on ‘User Rights Assignment’.

4. On the right pane, right-click ‘Log on as a service’ and select properties.

5. Click on the ‘Add User or Group…’ button to add the new user.

6. In the ‘Select Users or Groups’ dialogue, find the user you wish to enter and click ‘OK’.

7. Click ‘OK‘ in the ‘Log on as a service Properties’ to save changes.

Ensure that the user which you have added above is not listed in the ‘Deny log on as a service’ policy in the Local Security Policy.

BAM Callback Request Error

Issue

This error relates to the configuration of Actions or Triggers and can be due to:

• Multiple Actions were configured that use the same dll. The same assembly was uploaded every time in the field below shown in yellow.

• Multiple Actions were configured that use the same dll. The same assembly was uploaded once and not again for the subsequent actions.

Resolution

To resolve the issue, you will need to:

Step 1:

Navigate to the C:\Program Files (x86)\XMProPty Ltd\XMMonitor\Actions and/or C:\Program Files (x86)\XMPro PtyLtd\XMMonitor\Triggers folder. There should only be one instance of the dll you uploaded. If for example you configured 3 actions, and for each you attached the dll, you will see the following:

Delete all the dll’s not needed. In the example above delete the v2.0 and v3.0 dll’s.

Step 2:

Open the SQL Server Management Studio and navigate to the XMMonitor database. It will normally be installed as CompanyName_XMMonitor. Open the Action table. You will see one of the following:

• If the dll was attached for each of the actions, you will see the following:

• If the dll was attached once and not for the other actions, you will see the following:

The resolution in both cases is the same. Ensure that the value specified in the DLLFileName field is the same for All Actions and is the same as found in the Actions folder. The result should look like this:

Step 3: Restart the XMMonitor service

Step 4: Continue to configure the Jobs.

Task Link in XMAlert Emails is not Working

Issue

It has been reported that the task / activity link in reminder emails is not working.

The email link was something like “http://localhost/XMPro/…. “.

From the email context, the localhost is the server from where the email is accessed and the following 404 page not found error.

Resolution

1. Modified the Site URL for XMPro XMAlert Service using XMPro XMManagement Console to point to the server URL instead of local host and saved the configuration.

2. Restart the XMAlert Service. The link in the reminder emails is working as expected.

How Do I use the File Monitor Function of XMAutomate?

To use the file monitor function of XMAutomate requires three areas of setup.

The first being the XML/CSV source file, a sample follows:

Note: When using XML a root node is REQUIRED.

The second is the activity that will be triggered:

Note: The file attachment object is required to load the original document (can be access through the process as required).

The third being the XMAutomate configuration setting:

The file prefix can be used to separate different XMAutomate activities depending on the requirements (Can be left blank).

Note: The groupnode being used in reference to the source XML file. RepeatingNode is used when populating an object group using a common node in the XML.

What is the Location of the XMAutomate Error Log?

Question

Our project has been configured so that XMAutomate will monitor a folder path and initiate a process if there is a new file in the folder.

This is working fine until today until a few configuration changes were made in the process and then deployed the process again.

From then onwards, XMAutomate is not invoking the process (or) processing the files.

An attempt to debug and see why XMAutomate is not able to invoke the process even when there are files to be processed.

Where are the error log files or what is the issue?

Answer

In event viewer, custom views ..> Administrative Events, the error log for the XMAutomate was found.

The script in the Process is having an extra ‘}’ as a result the files are not picked and processed by XMAutomate.

The script was modified and everything is working as expected now.

If you cannot submit the activity manually, then the automated services will not be able to.

Incorrect URL when using the XMAlert Service

Issue

Users are getting a 404 error when clicking the link in the notification e-mail.

The link looks as follows:

(The [siteurl] has been blanked out for the above)

The templates have a [LINK] placeholder which is correctly set.

Resolution

The problem is because the myActionItem has been renamed to ActionItem and the URL is being redirected incorrectly.

To resolve, create a new file in the website folder called myActionItem.aspx and add the following code into it:

How Do I Install v5 XMAlert Service Release?

XMAlert

Added a debug option to help identify when emails are not being generated where the issue is being generated from.

To Install

1. Stop the service

2. Close the MMC console

3. Copy the two files into the installed service directory (C:\Program Files\eXomin\XMAlert Service\[Service Name])

4. Open the XMAlert.Service.exe.config in a text editor and add the following:

The enable should be set to false in production and set to true when a debug is required When set to true the debugLocation is used to store the file it generates. This can be any location on the machine

1. Close the text editor

2. Copy the file XMAlert.Configuration.dll to C:\Program Files\eXomin\XMManagement Console\ and override

3. Open the MMC console and restart the service

The reason for the text editor adding and enabling/disabling is so that the option is not accidently switched on via the MMC console.

It is a debug option and should only be used as required and then disabled. Please ensure that when you enable the logging to disable it, otherwise the file is going to grow and performance and space starts becoming an issue. Please contact your implementation partner for details on the above.

A Business Group is a logical group of Roles and is used for routing, notification and escalation purposes in XMPro. A role can form part of more than one business group. The business group is always the first thing you need to create in a new site.

Business Group Management can be performed in the WorkFlow Designer or in WorkFlow.

Only users with the appropriate rights will be able to add, edit or delete Business Groups in WorkFlow or in WorkFlow Designer. In WorkFlow Designer, if Business Groups are not showing in the explorer pane, check that the Read and Write boxes are checked for Business Groups in the Options Editor.

If you are not able to access the Business Group under Manage in WorkFlow , in WorkFlow Designer in the Options Editor, check that the user has access to Read and Edit Users.

For more information on how to manage Options, click here.

Properties of a Business Group

The Business Group is always the first thing you need to create for a new site.

Creating a New Business Group

1. Double-click Business Groups. The Business Groups will be listed under this category and all existing Business Groups will be displayed in your work area.

2. Click Toolbox.

3. Drag the Business Group icon to the work area.

4. Click the New Business Group in your work area.

5. Click the Properties window tab.

6. Provide the Description, Name, and Escalate To [optional].

7. On the quick access toolbar, click Save icon or press CTRL+S to save your changes.

Editing an Existing Business Group

1. Double-click Business Groups. The Business Groups will be listed under this category and all existing Business Groups will be displayed in your work area.

2. Click the Business Group that you want to edit.

3. Click the Properties window tab.

4. Edit the properties of the Business Group as required.

5. On the quick access toolbar, click Save icon or press CTRL+S to save your changes.

Deleting a Business Group

1. Double-click Business Groups. The Business Groups will be listed under this category and all existing Business Groups will be displayed in your work area.

2. Click the Business Group that you want to delete within the WorkFlow.

3. Above the ribbon, click the Delete icon. A message will be displayed, “Are you sure you wish to delete the selected item(s)?”

4. Click OK.

5. On the quick access toolbar, click Save icon or press CTRL+S to save your changes.

The XMPro Integration Wizard provides a user-friendly way to integrate WorkFlow Connector Plugins with XMPro Activities. It allows users to create activities based on structures specified by a connector and to map the existing Activity objects to the connectors.

Wizard Features

The Wizard is available on three levels in the XMPro WorkFlow Designer:

1. Activity Level

2. Trigger Level

3. Control or Object Level

A User-friendly way to map controls to a data source is by means of Predictive Mapping.

Automatic Control creation, which includes:

• Automatic Data type constraints.

• Automatic Required constraints.

• Create, Read, Update, Delete (CRUD) on Object Groups which updates all line items to the Source Object in one operation.

Browse Page features includes:

• Populating the page.

• Automatic Browse objects creation.

• Configuration of target objects.

• Lookups are populated.

• Chart Controls are populated.

• Define conditions for which an operation should execute.

• Define a Where clause consisting of Constants, Table Columns, and Controls.

Detailed information on how to use the Integration Wizard can be found here.

The Activity Configuration Wizard is a tool that will help you to set up the primary properties, for example, the name, the creation type of the activity, the notification, escalation, tracking and triggering as well as the style of the form or the screen. This wizard enables you to configure the properties as discussed for Activities in the Process Groups, Processes, and Activities section.

The General tab shows the basic Activity options.

The Advanced tab shows additional notification and escalation options, including behavior and styling settings.

The purpose of the Dashboard Designer wizard is to provide a fully integrated tool to create dashboards in XMPro. The DevExpress Dashboard Designer are used to provide this functionality. Access the Dashboard Designer from the WorkFlow Designer, Design tab, Dashboard Designer.

The purpose of the Report Designer wizard is to provide a fully integrated tool to create reports in XMPro. The DevExpress End-User Report Designer is used to provide this functionality. Access the Report Designer from the WorkFlow Designer, Design tab, Report Designer.

User Management can be performed in the WorkFlow Designer or in WorkFlow.

Only users with the appropriate rights will be able to add, edit or delete Users in WorkFlow or in WorkFlow Designer. In WorkFlow Designer, if the User Editor is greyed out are not showing in the explorer pane, using the Options Editor, check that the user has access to Read and Edit Users.

If you are not able to access the Users under Manage in WorkFlow , in WorkFlow Designer in the Options Editor, check that the user has access to Read and Edit Users.

Properties of a User

Accessing Role Management

1. Click Manage > Roles on the left side menu as shown below.

1. This will load the Role Management interface as shown below.

Creating a New Role

1. Click Manage > Roles as shown above.

3. Provide the details in the previous figure as required and click the Update button to save the record.

Editing an Existing Role

1. Click Manage > Roles as shown above.

3. Make your changes as required.

4. Click the Update button to save the record.

Deleting an Existing Role

To ensure the integrity and the auditability of the solution, you will not be able to delete any Role that has been used in the system. However, you will be able to delete a Role that has not been used.

1. Click Manage > Rolesas shown above.

3. Click OK.

Viewing Roles

1. Click on the Business Groups Category.

2. Double-click the Business Group Category item. This will show all the Roles linked to the Business Group.

3. Click on the Role. The properties of the role will be shown in the Properties Window.

Creating a New Role

1. Click on the Business Groups Category.

2. Double-click the Business Group Category.

3. Double-click the Business Group in which you want to create a new Role. This will open the Business Group’s details in the main work area, for example, Sales.

4. Drag in a new Role from the Toolbox to the work area.

5. (Not shown) Click on the New Role.

6. Click Properties tab.

7. Provide the Description for the new Role. Configure the other properties as required including the Escalate To, Report To and Route To properties as per Role Properties previous explained.

8. On the quick access toolbar, click Save icon or press CTRL+S to save your changes. The asterisk next to the Business Group tab (in this example Sales) will disappear. An asterisk indicates that the record has not been saved.

9. Click on Business Groups.

10. Click on Organogram in your work area in the following figure.

Editing an Existing Role

1. Click on the Business Groups Category.

2. Double-click on the Business Group with which your Role is associated. This will open the Business Group’s details in the main work area.

3. Click on the Role you want to edit.

4. Click Properties tab.

5. Edit the properties of the Role as required.

6. On the quick access toolbar, click Save icon or press CTRL+S to save your changes. The asterisk next to the Business Group tab (in this example Sales) will disappear. An asterisk indicates that the record has not been saved.

Deleting an Existing Role

1. Click on the Business Groups Category.

2. Double-click on the Business Group with which your Role is associated. This will open the Business Group’s details in the main work area.

3. Click on the Role you want to delete.

4. On the ribbon, click the File tab, click Delete to delete the role. A message will appear to confirm that you want to Delete the Role.

5. Click OK. A Role can be part of more than one Business Group.

6. On the quick access toolbar, click Save icon or press CTRL+S to save your changes. The asterisk next to the Business Group tab will disappear. An asterisk indicates that the record has not been saved.