How do I deploy the XMBPM API alongside the Action Hub (BPM)?

In order to use the native XMPro mobile app (XMPro Act) you need to deploy the XMBPM API alongside your Action Hub (formerly known as XMWorkspace) instance.

Prerequisites

A working instance of the Action Hub.

Installing the XMBPM API Server

Step 1

Download the latest XMBPM API release from the Downloads section of XMPro Documentation.
Note: It is important to get the version of that corresponds to your Action Hub (BPMBusiness process management (BPM) is a discipline in operations management that uses various methods to discover, model, analyze, measure, improve, optimize, and automate business processes.  BPM focuses on improving corporate performance by managing business processes.  Any combination of methods used to manage a company's business processes is BPM.  Processes can be structured and repeatable or unstructured and variable.) version.

Step 2

Extract the .zip archive to C:\inetpub\wwwroot\XMBPM (or similar path)

Step 3

Copy all integration components (dlls found in Action Hub bin folder) used in XMPro Action Hub (previously called XMWorkspace) to the bin folder of XMBPM. Integration components such as “XMSQLConnect.dll”, “XMConnectSQLReadOnly.dll” as well as any custom integration components.

Step 4

Open Internet Information Services (IIS) Manager and create an Application from the XMBPM folder.

Step 5

Open the Web.config file in a text editor and make the following modifications:

1. Under the connectionStrings section, modify the ‘Context’ connection string details to point to the Action Hub database. The highlighted section in the image below indicates the part of the connection string to update.
2. Under the xmbpm section, on the setup element:
   • Update the webApiRootUrl to be the url of the XMBPM application you created in step 3.
   • Update the workspaceConfigurationFile to be the absolute file path to the site.config file of your Action Hub instance.
     NOTE: ensure that the Application Pool Identity of the XMBPM Application has read access to the site.config file.

Step 6

Open SQL Server Management Studio (SSMS) and execute the ‘View Creation Script.sql’ script against the Action Hub database.

Step 7

Open a browser and navigate to the XMBPM application URL (e.g. http://SKOLB1/xmbpm), you should see a simple home page displayed.

Step 8

The API Reference (/Help) page provides the details of the various calls supported by the API.