tibco activematrix businessworks plug-in for microsoft ... · creating a project ... businessworks,...

TIBCO ActiveMatrix BusinessWorks™

Plug-in for Microsoft Dynamics CRMUser's GuideSoftware Release 6.7February 2019

Two-Second Advantage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (ORPROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDERSEPARATE SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH,THESE SOFTWARE ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITHTIBCO, INCLUDING ANY TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES,AND INDEMNITIES. DOWNLOAD AND USE OF THESE ITEMS IS SOLELY AT YOUR OWNDISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDINGTO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THEFOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO PRODUCTS.

This document is subject to U.S. and international copyright laws and treaties. No part of thisdocument may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, Two-Second Advantage, TIBCO ActiveMatrix BusinessWorks, TIBCO Business Studio, TIBCOEnterprise Administrator, and TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft DynamicsCRM are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/orother countries.

Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform EnterpriseEdition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks ofOracle Corporation in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

This software may be available on multiple operating systems. However, not all operating systemplatforms for a specific software version are released at the same time. Please see the readme.txt file forthe availability of this software version on a specific operating system platform.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

2

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Dynamics CRM User's Guide

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer toTIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details.

Copyright © 2014-2019. TIBCO Software Inc. All Rights Reserved.

3


https://www.tibco.com/patents

Contents

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Plug-in Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Creating a Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Creating a Dynamics CRM Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Creating a Dynamics CRM REST Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Preparing to Use the Entity Event Source Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Creating an HTTP Connector Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Configuring SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Creating a Keystore Provider Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Configuring One-Way SSL Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Configuring Two-Way SSL Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Importing Dynamics CRM Solution to Microsoft Dynamics CRM Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Upgrading Listener Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Configurations for Dynamics CRM Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Registering Specific Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Preparing to Use the Execute Request Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Setting Timeout for the Asynchronous Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Setting Timeout for the Asynchronous Activity in TIBCO Business Studio at Run Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Setting Timeout for the Asynchronous Activity in TIBCO Enterprise Administrator at Run Time . . . . . . . . . . . . . . . . . . . . . . . . . 23

Dynamics CRM Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Dynamics CRM REST Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Registering an Application in Azure Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

Giving Permissions for the Registered Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Dynamics CRM Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Entity Event Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Create Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Update Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

Delete Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Retrieve Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Retrieve Multiple Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Associate Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

4


Execute Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Dynamics CRM REST Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

REST Entity Event Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

Create REST Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Update REST Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Delete REST Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58

Retrieve REST Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Associate REST Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61

Query REST Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Execute Batch Operations REST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Downloading Option Set Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71

Working with Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

SOAP Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Importing the SOAP Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74

Running the SOAP Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74

REST Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Importing the REST Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Running the REST Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Setting Up Logging in TIBCO Business Studio at Run Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

5


TIBCO Documentation and Support Services

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainlyin HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current than any otherdocumentation included with the product. To access the latest documentation, visit https://docs.tibco.com.

Product-Specific Documentation

Documentation for TIBCO products is not bundled with the software. Instead, it is available on theTIBCO Documentation site. To directly access documentation for this product, double-click thefollowing file:

TIBCO_HOME/release_notes/TIB_bwplugindynamicscrm_version_docinfo.html

where TIBCO_HOME is the top-level directory in which TIBCO products are installed. On Windows,the default TIBCO_HOME is C:\Program Files\tibco. On UNIX systems, the default TIBCO_HOMEis /opt/tibco.

The following documents for this product can be found on the TIBCO Documentation site:

● TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Dynamics CRM Installation

● TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Dynamics CRM User's Guide

● TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Dynamics CRM Release Notes

How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

● For an overview of TIBCO Support, visit http://www.tibco.com/services/support.

● For accessing the Support Knowledge Base and getting personalized content about products you areinterested in, visit the TIBCO Support portal at https://support.tibco.com.

● For creating a Support case, you must have a valid maintenance or support contract with TIBCO.You also need a user name and password to log in to https://support.tibco.com. If you do not have auser name, you can request one by clicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matterexperts to share and access their collective experience. TIBCO Community offers access to Q&A forums,product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, andtools that extend and enable customers to gain full value from TIBCO products. In addition, users cansubmit and vote on feature requests from within the TIBCO Ideas Portal. For a free registration, go to https://community.tibco.com.

6


https://docs.tibco.com

https://docs.tibco.com

http://www.tibco.com/services/support

https://support.tibco.com

https://support.tibco.com

https://ideas.tibco.com/

https://community.tibco.com

Plug-in Overview

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Dynamics CRM is an application that youcan use to exchange data between intranet and Microsoft Dynamics CRM. You can use the plug-in tointeract with data stored in the Microsoft Dynamics CRM Online server or Microsoft Dynamics CRMOn-Premises server.

TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Dynamics CRM plugs into TIBCOActiveMatrix BusinessWorks and adds Dynamics CRM Palette and Dynamics CRM REST Palette toTIBCO Business Studio™ . You can use the Dynamics CRM Connection or Dynamics CRM RESTConnection shared resource to create a connection between the plug-in and a Microsoft Dynamics CRMserver. After creating a connection, you can configure a process using the activities in the DynamicsCRM palette or Dynamics CRM REST palette. See Getting Started for more details about how to use theplug-in.

TIBCO ActiveMatrix BusinessWorks™ is a leading integration platform that can integrate a widevariety of technologies and systems within enterprise and on cloud. TIBCO ActiveMatrixBusinessWorks includes an Eclipse-based graphical user interface (GUI) provided by TIBCO BusinessStudio™ for design, testing, and deployment. If you are not familiar with TIBCO ActiveMatrixBusinessWorks, see the TIBCO ActiveMatrix BusinessWorks documentation for more details.

The existing Dynamics CRM palette is also called Dynamics CRM SOAP palette. The activities in theexisting palette use SOAP calls to communicate with the server.

The activities in the REST palette use REST API calls to communicate with the server.

TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Dynamics CRM provides the followingfeatures:

For Dynamics CRM SOAP:

● Creating, updating, deleting, associating, and disassociating entity records

● Retrieving entity records using entity record IDs or query criteria

● Listening to the create, update, and delete user events triggered on a specified entity record

● Executing organization requests

For Dynamics CRM REST:

● Creating, updating, deleting, associating, and disassociating entity records

● Adding, updating, and deleting entity records at a time as a batch job

● Retrieving entity records using entity record IDs or FetchXML or OData

● Listening to the create, update, and delete user events triggered on a specified entity record

● Downloading option set metadata at either the global level or per entity for a specified DynamicsCRM REST Connection resource

7


Getting Started

This tutorial is designed for beginners who want to use TIBCO ActiveMatrix BusinessWorks Plug-in forMicrosoft Dynamics CRM in TIBCO Business Studio.

A basic procedure for using TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Dynamics CRMincludes:

1. Creating a Project

2. Creating a Connection

3. Configuring a Process

4. Testing a Process

5. Deploying an Application

Creating a ProjectStart using the plug-in by creating a project. After creating a project, you can add resources andprocesses.

An Eclipse project is an application module configured for TIBCO ActiveMatrix BusinessWorks. Anapplication module is the smallest unit of resources that is named, versioned, and packaged as part ofan application.

Procedure

1. Start TIBCO Business Studio using one of the following ways:

● Microsoft Windows: click Start > All Programs > TIBCO > TIBCO_HOME > TIBCO BusinessStudio version_number > Studio for Designers.

● Mac OS and Linux: run the TIBCO Business Studio executable file located in the TIBCO_HOME/studio/version_number/eclipse directory.

2. From the menu, click File > New > BusinessWorks Resources to open the BusinessWorks Resourcewizard.

3. In the "Select a wizard" dialog, click BusinessWorks Application Module and click Next to openthe New BusinessWorks Application Module wizard.

4. In the Project dialog, configure the project that you want to create:a) In the Project name field, enter name of your project.b) By default, the created project is located in the workspace currently in use. If you do not want to

use the default location for the project, clear the Use default location check box and click Browseto select a new location.

c) Use the default version of the application module, or enter a new version in the Version field.d) Keep the Create empty process and Create Application check boxes selected to automatically

create an empty process and an application when creating the project.e) Select the Use Java configuration check box if you want to create a Java module.

A Java module provides the Java tooling capabilities.f) Click Finish to create the project.

Result

The project with the specified settings is displayed in the Project Explorer view.

8


Creating a ConnectionAfter creating a project, add a Dynamics CRM Connection or a Dynamics CRM REST Connectionshared resource to create a connection between the plug-in and the Microsoft Dynamics CRM server.

Creating a Dynamics CRM Connection

Prerequisites

The Dynamics CRM Connection shared resource is available at the Resources level. Ensure that youhave created a project, as described in Creating a Project.

To create a Dynamics CRM connection:

Procedure

1. Expand the created project in the Project Explorer view.

2. Right-click the Resources folder and click New > Dynamics CRM Connection to open theDynamics CRM Connection wizard.

3. The resource folder, package name, and resource name of Dynamics CRM Connection are providedby default. If you do not want to use the default configurations, change them accordingly. ClickFinish to open the Dynamics CRM Shared Connection Editor.

9


4. Configure the fields in the Dynamics CRM Shared Connection Editor.See Dynamics CRM Connection for more details.

5. Click Test Connection to validate the connection.

Creating a Dynamics CRM REST Connection

Prerequisites

The Dynamics CRM REST Connection shared resource is available at the Resources level. Ensure thatyou have created a project, as described in Creating a Project.

To create a Dynamics CRM REST connection:

Procedure


2. Right-click the Resources folder and click New > Dynamics CRM REST Connection to open theDynamics CRM REST Connection wizard.

3. The resource folder, package name, and resource name of Dynamics CRM REST Connection areprovided by default. If you do not want to use the default configurations, change them accordingly.Click Finish to open the Dynamics CRM Rest Shared Connection Editor.

10


4. Configure the fields in the Dynamics CRM REST Shared Connection Editor.See Dynamics CRM REST Connection for more details.

5. Click Test Connection to validate the connection.

Configuring a ProcessAfter creating a project, an empty process is created. You can add activities to the empty process tocomplete a task. For example, update entity records.

Prerequisites

Ensure that you have created an empty process when Creating a Project.

Procedure

1. In the Process Editor view, click the created project and open the empty process from the Processesfolder.

2. Select an activity from the Palette view and drop it in the Process Editor.For example, select and drop the Timer activity from the General Activities palette and the UpdateEntity activity from the Dynamics CRM palette.

3. Drag the icon to create a transition between the added activities.

4. Configure the added activities, as described in Dynamics CRM Palette and/or Dynamics CRM RESTPalette.

11


A Dynamics CRM/ Dynamics CRM REST connection is required when configuring theDynamics CRM/ Dynamics CRM REST activities. See Creating a Connection for moredetails about how to create a Dynamics CRM/ Dynamics CRM REST connection.

5. Click File > Save to save the process.

Testing a ProcessAfter configuring a process, you can test the process to check if the process completes your task.

Prerequisites

Ensure that you have configured a process, as described in Configuring a Process.

Procedure

1. On the toolbar, click Debug > Debug Configurations.

2. Click BusinessWorks Application > BWApplication in the left panel.By default, all the applications in the current workspace are selected in the Applications tab. Ensurethat only the application you want to debug is selected in the Applications tab in the right panel.

3. Click Debug to test the process in the selected application.TIBCO Business Studio changes to the Debug perspective. The debug information is displayed inthe Console view.

4. In the Debug tab, expand the running process and click an activity.

5. In the upper-right corner, click the Job Data tab, and then click the Output tab to check the activityoutput.

12


Deploying an ApplicationAfter testing, if the configured process works as expected, you can deploy the application that containsthe configured process into a runtime environment, and then use the bwadmin utility to manage thedeployed application.

Before deploying an application, you must generate an application archive, which is an enterprisearchive (EAR) file that is created in TIBCO Business Studio.

Deploying an application involves the following tasks:

1. Uploading an application archive

2. Deploying an application archive

3. Starting an application

See TIBCO ActiveMatrix BusinessWorks Administration for more details about how to deploy anapplication.

13


Preparing to Use the Entity Event Source Activity

Before using the Entity Event Source activity, you must establish a connection between the MicrosoftDynamics CRM server and the Entity Event Source activity; otherwise, the Entity Event Source activitywill not work.

The Entity Event Source activity is used to listen to the Create, Update, and Delete user events triggeredon specified entity records.

Complete the following tasks before using the Entity Event Source activity:

1. Creating an HTTP Connector Shared Resource

2. Importing Dynamics CRM Solution to Microsoft Dynamics CRM Server

3. Registering Specific Messages

An ActiveMatrix BusinessWorks application containing the Entity Event Source activity is treated as theserver and the Microsoft Dynamics CRM server is treated as the client.

Creating an HTTP Connector Shared ResourceThe HTTP Connector shared resource is used to receive user event messages from the MicrosoftDynamics CRM server for the Entity Event Source activity.

Procedure


2. Right-click the Resources folder and click New > HTTP Connector to open the HTTP Connectorwizard.

3. The resource folder, package name, and resource name of HTTP Connector are provided by default.If you do not want to use the default configurations, change them accordingly. Click Finish to openthe HTTP Connector editor.

4. Configure the HTTP connection in the HTTP Connector editor.

To use SSL to secure the message exchange between the plug-in and the MicrosoftDynamics CRM server, select the Confidentiality check box in the Security panel. See Configuring SSL for more details.

Configuring SSLYou can use SSL authentication to secure the message exchange of the user events triggered on aspecified entry.

TIBCO ActiveMatrix BusinessWorks provides a Keystore Provider resource to allow access to akeystore. A keystore is a mechanism designed to create and manage private keys/digital certificate pairsand trusted Certificate Authority (CA) signed certificates.

The Microsoft Dynamics CRM server accesses a trust store to authenticate the connected plug-in, oraccesses an identity store to pass the client information to the connected plug-in.

You must create a Keystore Provider Resource for either one-way SSL authentication or two-way SSLauthentication. See Creating a Keystore Provider Resource for more details.

After creating a Keystore Provider Resource, you can complete one of the following steps to configureSSL authentication:

● Configuring One-Way SSL Authentication

14


● Configuring Two-Way SSL Authentication

Creating a Keystore Provider Resource

The Keystore Provider resource provides access to a keystore.

Create a Keystore Provider resource according to the role of the keystore, which can either be a truststore for authenticating clients in a 2 way SSL authentication mode or an identity store for passing theidentity of the plug-in to the client in case of one way SSL authentication mode.

Procedure

1. In the Project Explorer view, right-click the Resources folder and click New > Keystore Provider.

2. In the Resource Name field, enter a name for the Keystore Provider resource.

3. In the Keystore panel, specify the following properties for the keystore:

● Provider: the provider of the keystore

● URL: the location of the keystore file that you want to use

● Password: the password to access the specified keystore

4. Save the created Keystore Provider resource.

Configuring One-Way SSL Authentication

The SSL Server Configuration shared resource is used for receiving user event messages over HTTPS. Inthe one-way SSL authentication mode, the Microsoft Dynamics CRM server authenticates the connectedplug-in and the the plug-in passes its identity to the Microsoft Dynamics CRM server.

Procedure


2. Right-click the Resources folder and click New > SSL Server Configuration to open the SSL ServerConfiguration. Configure the information of SSL Server Configuration in the wizard.The SSL Server Configuration editor is displayed.

3. In the Basic SSL Server Configuration panel, configure the parameters.

15


● Identity Store Provider: a Keystore Provider resource that provides access to the keystore of theserver. The plug-in accesses the keystore to load the certificate it will use to identify itself as theserver during SSL agreement with the client.

If no identity Keystore Provider resource is available, click Create Shared Resource to createone. See Creating a Keystore Provider Resource for more details.

● Key Alias Name: the alias of the keystore

● Key Alias Password: the password of the keystore

For the Keystore Provider resource, the generated keystore file in PKCS12 format containsa valid certification that must be authorized by a third-party.

The Dynamics CRM on-premise servers support self signed certificates. You can importthe self signed certificates as trusted certificates on to the Microsft Dynamics CRM on-premise servers.

4. To Configure one way SSL information in the Microsoft Dynamics server, select use SSL check boxon the Configuration page of the Dynamics CRM solution. See Configurations for Dynamics CRMSolution for more information.

Configuring Two-Way SSL Authentication

The two-way SSL authentication configuration is only used when the plug-in authenticates theconnected Microsoft Dynamics CRM server and the connected Microsoft Dynamics CRM server alsoauthenticates the plug-in.

If you want to use a two-way SSL authentication to secure the message exchange between the plug-inand Microsoft Dynamics CRM server, ensure that you select the Enable Mutual Authentication checkbox in the Basic SSL Server Configuration panel.

Procedure

1. On the Microsoft Dynamics CRM on-premise server, generate a keystore file in the PKCS #12 formatthat contains a valid certification for the client.For example,

Keytool -genkey -v -alias clientkey -keyalg RSA -storetype PKCS12 -keystore

file_fullpath

2. Configure SSL information in the Microsoft Dynamics CRM server:a) Change the extension of the keystore file from .p12 to .xml, and then upload it to the Web

Resources page.You can find the Web Resources page by clicking SETTINGS > Customizations > Customize thesystem > Components.

b) Specify the certification name and password on the Configuration page of the Dynamics CRMsolution.See Configurations for Dynamics CRM Solution for more information.

3. Configure the SSL server authentication for the SSL Server Configuration shared resource in TIBCOBusiness Studio:a) Export the client certification, created in step 1, and save it in the .cer format, and then import

the .cer file to the Trust Store located in the TIBCO_HOME/tibcojre64/1.8.0/lib/security/cacerts directory.

b) Select the Enable Mutual Authentication check box in the created SSL Server Configurationshared resource, as described in Configuring One-Way SSL Authentication.

c) In the Keystore Provider as Trust Store field, click to select a Keystore Provider resource.

16


The selected Keystore Provider resource provides access to a trust store. The plug-in accesses thekeystore to verify the identity of the connected Microsoft Dynamics CRM server.

If no Keystore Provider resource is available, click Create Shared Resource to create one. See Creating a Keystore Provider Resource for more details.

Importing Dynamics CRM Solution to Microsoft Dynamics CRM ServerThe Dynamics CRM solution named TibcoBWEventListenerSolution is used to send events triggered ona specified entity from the Microsoft Dynamics CRM server to the Entity Event Source activity.

Procedure

1. Log on to the Microsoft Dynamics CRM server website as an administrator.

2. From the menu, click SETTINGS > Solutions.

3. On the All Solutions page, click Import.

4. On the Select Solution Package page, click Browse to locate the Dynamics CRM solution file.The TibcoBWEventListenerSolution.zip Dynamics CRM solution file is located in theTIBCO_HOME/bw/palettes/dynamicscrm/version_number/scripts directory.

5. Click Next on the Select Solution Package and Solution Information page, and click Import on theImport Options page.By default, the Enable any SDK message processing steps included in the solution check box isselected.

6. In the Importing Solution dialog, click Close.

7. Configure the plug-in settings:a) On the All Solutions page, double-click TibcoBWEventListenerSolution to open theConfiguration page.

b) Configure the settings for the log level and plug-in listener, and click Save and then Publish topublish the configuration.See Configurations for Dynamics CRM Solution for more details.

The messages that fail to be sent to the listener are stored in the UnpublishedDataentity. Click Republish to resend unpublished messages.

c) Click Sdk Message Processing Steps under the Components node and ensure that the SDKmessage processing steps are available.

Upgrading Listener SolutionTo upgrade a listener solution from the plug-in version 6.4.0 HF-002 or above to the latest versionpackaged in this release:

Procedure

1. Launch the plug-in registration tool, and unregister the Tibco.BW.DynamicsCRM.Plugin assemblythat is already present.

This action removes the Tibco.BW.DynamicsCRM.Plugin assembly along with anyexisting message processing steps and images.

2. Repeat the steps in "Importing Dynamics CRM Solution to Microsoft Dynamics CRM Server"provided above.

17


Configurations for Dynamics CRM SolutionThe Configuration page contains the settings for logs and listener.

Field Description

Log level Specify the log level to trace different messages. See Log Levels formore details.

The TRACE log level is not supported for Dynamics CRMsolution.

Listener Settings/Listener

Server URL Specify the endpoint URL for the HTTP Connection. The format isdomain_name:port_number/relative_path.

● The domain name must be parsed by DNS. Youcannot use the IP address or local host.

● The information in the URL must be consistent withthe values specified in the Entity Event Sourceactivity.

use SSL Select this check box if you want to use SSL authentication tosecure the message exchange of the user event triggered on aspecified entry.

Entity type Select an entity from the list of entities on this Microsoft DynamicsCRM instance for which a listener is to be configured.

Event type Select the type of event, such as Select All, Create, Update, orDelete for which the listener is to be configured.

Username Specify the user name for the Entity Event Source activity.

Password Specify the password for the Entity Event Source activity.

18


Field Description

Retries Specify the amount of times for the Dynamics CRM solutionattempting to resend user event messages to the Entity EventSource activity if the previous sending failed.

RetryInterval Specify the interval period in milliseconds before the DynamicsCRM solution attempts to resend the user event messages.

X509Certification Specify the name or ID of the certification file uploaded on the WebResources page. See Configuring SSL Client Authentication formore details.

● This field is displayed when the use SSL check box isselected.

● The value for this field is not required if you chooseone way SSL authentication.

CertificationPassword CertificationPassword is not applicable because two way SSLauthentication is not supported in TIBCO Cloud Integration.

● This field is displayed when the use SSL check box isselected.

● The value for this field is not required if you chooseone way SSL authentication.

Enable Specify whether the listener configuration is enabled.

Registering Specific MessagesYou can use the Plug-in Registration tool to register specific messages for the plug-in. After you registerspecific messages for the plug-in, the Dynamics CRM solution can send events triggered on a specifiedentity.

The PluginRegistration.exe Plug-in Registration tool file is located in the SDK_HOME\Tools\PluginRegistration directory. You can download Dynamics CRM SDK from the Microsoft website.See the Microsoft documentation for more details about the Plug-in Registration tool.

Prerequisites

Ensure that you have imported the Dynamics CRM solution to the Microsoft Dynamics CRM server.See Importing Dynamics CRM Solution to Microsoft Dynamics CRM Server for more details.

Procedure

1. Open the Plug-in Registration tool and click CREATE NEW CONNECTION.

2. Enter the connection information on the Login page and click Login.

3. Register a step for the Create, Update, and Delete messages one by one:a) Right-click the TIBCO.BW.DynamicsCRMPluginEventListenerPlugin node and click Register

New Step.b) Configure the step information:

19


Field Value

Message Create, Update, or Delete

Event Handler Tibco.BW.DynamicsCRM.Plugin.EventListenerPlugin

Eventing Pipeline Stage of Execution The following value must be selected depending onthe message:

● Post Operation must be selected for Createmessage

● Pre Operation value must be selected forUpdate message

● Pre Operation must be selected for Deletemessage

Execution Mode Synchronous or Asynchronous

Deployment Server

c) Click Register New Step.

4. Register an image for the step, such as Create, Update, or Delete step:

The registration of an image is mandatory for the Delete step, but it is optional for theCreate step and the Update step.

a) Right-click the specific step, for example, Create step and click Register New Image.b) Configure the Image Information.

Ensure that the following values are specified in the corresponding fields:

Field Value

Image Type The following value must be selected depending on the step:

● Post Image must be selected for Create step

● Pre Image must be selected for Update step

● Pre Image must be selected for Delete step

Name The following value must be entered depending on the step:

● PostImageCrtEntityAlias must be entered for Create step

● PreImageUpdtEntityAlias must be entered for Update step

● PreImageEntityAlias must be entered for Delete step

Entity Alias The following value must be entered depending on the step:

● PostImageCrtEntityAlias must be entered for Create step

● PreImageUpdtEntityAlias must be entered for Update step

● PreImageEntityAlias must be entered for Delete step

20


Field Value

Parameters By default, all the attributes of the entity are selected. Ifrequired, you can click the button beside the field and chooseonly specific attributes.

Make sure that the parameters chosen here matchwith the attributes selected while configuring EntityEvent Source/REST Entity Event Source activities.

● If the image for Create Entity event type is not created, the details of all theattributes are sent in the event data.

● If the image for Update Entity event type is not created, the details of only thoseupdated attributes are sent in the event data.

c) Click Update Image.

21


Preparing to Use the Execute Request Activity

Before using the Execute Request activity, you must import the Dynamics CRM schema into a createdproject; otherwise, you cannot use the complex type or the simple type of the value in the ExecuteRequest activity.

The Execute Request activity is used to execute organization requests in the Microsoft Dynamics CRMserver.

Prerequisites

Ensure that you have created a project, as described in Creating a Project.

Procedure

1. In the Project Explorer view, right-click the project, click Dynamics CRM Tools > Import WSDLSchema.

2. In the Import WSDL Schema dialog, type the organization service URL address or click Browse toselect the single organization service WSDL file.

The organization service URL address must be consistent with the URL that you enteredin the Organization Service field when configuring the Dynamics CRM Connectionshared resource.

If you click Browse to select the single organization service WSDL file, ensure that the filecontains all schemas.

3. Click OK to import schemas into the Schemas folder.

4. Click OK in the Success window .

22


Setting Timeout for the Asynchronous Activity

You can set the timeout for asynchronous activities. By default, the timeout value is 600 seconds.

You can set the timeout in different conditions.

Setting Timeout for the Asynchronous Activity in TIBCO Business Studio atRun Time

Procedure

1. From the menu, click Run > Run Configurations.

2. In the Run Configurations dialog, click BusinessWorks Application > BWApplication in the leftpanel, click the Arguments tab in the right panel, and add the following parameters as per thepalette:

● For Dynamics CRM SOAP palette, add -Dcom.tibco.bw.palette.dynamicscrm.waitTime=600 parameter in the VM arguments field.

● For Dynamics CRM REST palette, add -Dcom.tibco.bw.palette.dynamicscrmrest.waitTime=600 parameter in the VM argumentsfield.

The value specified for the argument is an example, you can replace the argument valuewith your own data.

Setting Timeout for the Asynchronous Activity in TIBCO EnterpriseAdministrator at Run Time

Procedure

1. Navigate to the TIBCO_HOME/bw/version_number/bin directory and open the bwcommon.tra file.

2. Add the following parameters to the java.extended.properties property, based on the palette:

● For Dynamics CRM SOAP palette, add -Dcom.tibco.bw.palette.dynamicscrm.waitTime=600.

● For Dynamics CRM REST palette, add -Dcom.tibco.bw.palette.dynamicscrmrest.waitTime=600.

The value specified for the arguments is an example, you can replace the argument valuewith your own data.

23


Dynamics CRM Connection

You can use the Dynamics CRM Connection shared resource to create a connection to the MicrosoftDynamics CRM server.

General

In the General panel, you can specify the package that stores the Dynamics CRM Connection sharedresource, the shared resource name, and the shared resource description.

The following table lists the configurations in the General panel of the Dynamics CRM Connectionshared resource:

FieldModuleProperty? Description

Package No The name of the package where the new shared resource islocated.

Name No The name to be displayed as the label for the shared resource.

Description No A short description for this shared resource.

Service Configuration

In the Service Configuration panel, provide the information related to the Microsoft Dynamics CRMserver to which the plug-in connects.

The following table lists the configurations in the Service Configuration panel of the Dynamics CRMConnection shared resource:


DeploymentType

No Two types of deployment are supported:

● Online: used for connecting to the Microsoft Dynamics CRMonline server.

● On-Premises: used for connecting to the local MicrosoftDynamics CRM server.

If a self-signed SSL certificate is used to establish a connectionbetween the Microsoft Dynamics CRM On-Premises server and theplug-in, use Java Keytool to import the self-signed SSL certificateinto the JRE global truststore; the cacerts JRE global truststore fileis located in the TIBCO_HOME/tibcojre64/version_number/lib/security directory.

24



AuthenticationType

No The authentication types that are supported by the plug-in. Thetypes depend on the deployment type that you select.

● If you select the Online deployment, the plug-in only supportsOnlineFederation authentication.

● If you select the On-Premises deployment, the plug-insupports three types of authentication: Federation, NTLM, andKerberos.

User Name Yes The user name used to connect to the Microsoft Dynamics CRMserver.

Password Yes The password used to connect to the Microsoft Dynamics CRMserver.

OrganizationService

Yes The URL for the organization service that provides access to thebusiness data and metadata for your organization.

You can either type the URL for the organization servicemanually or find it automatically by using DiscoverService.

Timeout (sec) Yes The timeout value in seconds that applies to the communicationwith the Microsoft Dynamics CRM server. The default timeoutvalue is 1800 seconds.

The following fields are displayed only when the Kerberos authentication is selected.

LoginModuleFile

YesClick the icon to locate the LoginModule file.

The file contains the configuration information of the loginproperties in Java Authentication Authorization Service (JAAS).

The file starts with an application name called spnego-client-kerberos.

Kerberos File YesClick the icon to locate the Kerberos file.

The file contains the realm and server configuration information.

When the Kerberos authentication is selected, the proxyconfiguration is not available.

Server SPN Yes The Service Principal Names (SPN) for the server, which you canobtain manually from the Web Services Description Language(WSDL) file.

25


Proxy Configuration

In the Proxy Configuration panel, you can provide the information related to the proxy server to accessoutside of a firewall.

The following table lists the configurations in the Proxy Configuration panel of the Dynamics CRMConnection shared resource:


Use Proxy Yes If you use a proxy server to access outside of a firewall, select theUse Proxy check box.

Proxy Server Yes The host name or IP address of the proxy server.

Proxy Port Yes The port number of the proxy server.

ProxyUsername

Yes The user name used to connect to the proxy server.

Proxy Password Yes The password used for the specified user name when connectingto the proxy server.

Discover Service

Ensure that you have configured all the necessary parameters when using Discover Service. ClickDiscover Service to open the Discovery Service URL dialog, type the URL in the filed, and click Ok.The URL for the organization service is found automatically. If the discovery service information isauthenticated, the associated URL for the organization service is automatically entered in theOrganization Service field.

When the NTLM authentication is selected, Discover Service is not available.

Test Connection

Click Test Connection to test whether the specified configuration fields result in a valid connection tothe Microsoft Dynamics CRM server.

If illegal/incorrect key size error is displayed when testing the connection to the Microsoft DynamicsCRM server with the Kerberos authentication, you must replace the local_policy.jar andUS_export_policy.jar JRE security files that are located in the TIBCO_HOME/tibcojre64/version_number/lib/security directory with the files that you can download from Oracle website.For more details, contact TIBCO Support team.

26


Dynamics CRM REST Connection

You can use the Dynamics CRM REST Connection shared resource to create a connection to theMicrosoft Dynamics CRM server.

General

In the General panel, you can specify the package that stores the Dynamics CRM REST Connectionshared resource, the shared resource name, and the shared resource description.

The following table lists the configurations in the General panel of the Dynamics CRM RESTConnection shared resource:


Package No The name of the package where the new shared resource islocated.

Name No The name to be displayed as the label for the shared resource.

Description No A short description for this shared resource.

Service Configuration

In the Service Configuration panel, provide the information related to the Microsoft Dynamics CRMserver to which the plug-in connects.

The following table lists the configurations in the Service Configuration panel of the Dynamics CRMREST Connection shared resource:


Deployment Type No Two types of deployments are supported:

● Online: Used for connecting to the Microsoft DynamicsCRM online server.

● On-Premises: Used for connecting to the local MicrosoftDynamics CRM server.

If a self-signed SSL certificate is used to establish aconnection between the Microsoft Dynamics CRM On-Premises server and the plug-in, use Java Keytool to importthe self-signed SSL certificate into the JRE global truststore;the cacerts JRE global truststore file is located in theTIBCO_HOME/tibcojre64/version_number/lib/security

directory.

27



AuthenticationType

No The authentication types that are supported by the plug-in.The types depend on the deployment type that you select.

● If you select the Online deployment, the plug-in supportsonly OAuth authentication.

You must register your application withMicrosoft Azure Active Directory before youcan use OAuth authentication to connect to theMicrosoft Dynamics CRM online server. Formore information, see Registering a NewApplication in Azure Directory and GivingPermission for the Registered Application.

The plug-in supports OAuth 2.0 authorizationprotocol for all the palette activities that aresupported by Dynamics CRM on-premise.

● If you select the On-Premises deployment, the plug-insupports two types of authentication: NTLM andKerberos.

Grant Type No The grant type to authenticate user access when you selectOnline deployment.

Two types of grant types are supported:

● Password Credentials

● Client Credentials

The default value is Password Credentials.

Projects created in versions prior to version 6.7.0 ofthe plug-in support only password credentialsgrant type.

User Name Yes The user name used to connect to the Microsoft DynamicsCRM server.

This field is not visible for Client Credentials granttype.

Password Yes The password used to connect to the Microsoft DynamicsCRM server.

This field is not visible for Client Credentials granttype.

28



Service Root URL Yes The URL for the service root that provides access to thebusiness data and metadata for your organization.

You can either type the URL for the service rootmanually or find it automatically by using Discover Service.

Timeout (sec) Yes The timeout value in seconds that applies to thecommunication with the Microsoft Dynamics CRM server.The default timeout value is 1800 seconds.

The following fields are displayed only when the Kerberos authentication is selected.

LoginModule File YesClick the icon to locate the LoginModule file.

The file contains the configuration information of the loginproperties in Java Authentication Authorization Service(JAAS).

Kerberos File YesClick the icon to locate the Kerberos file.

The file contains the realm and server configurationinformation.

The following fields are displayed only when the OAuth authentication is selected.

Tenant ID Yes The unique ID of your Microsoft Azure Active Directorywith which you have registered your application.

To know the Tenant ID, in Microsoft Azure, click

App registrations and click Endpoints. In thefields that are displayed, the string value after hostname in the OAUTH 2.0 TOKEN ENDPOINT fieldis known as Tenant ID. You can copy the OAuth2.0 Token Endpoint field value by clicking the iconbeside it.

29



Client ID Yes The unique ID of the application that you want to connect tothe Microsoft Dynamics CRM Online server. This isapplication specific and is unique for each application.

The application must be of native type when thegrant type is Password Credentials; and it must beof Web app / API type when grant type is ClientCredentials.

To know the Client ID, in Microsoft Azure, clickApp registrations, and in the list of registeredapplications, select a specific registeredapplication. In the application pane, the valueassigned under Application ID is known as ClientID.

Client SecretKey Yes One of the passwords for your Web app / API applicationthat you want to use to connect to the Microsoft DynamicsCRM Online server.

Shown only when Grant type is ClientCredentials.

A Web app / API application can have one or morepasswords that can be used as a secret key whileobtaining OAuth2.0 keys.

To generate a new password in Microsoft Azure,1. Click App registrations in the Azure portal.

2. Select the registered application.

3. In the applications pane, click on the Settingsicon.

4. In the Settings pane, click Keys.

5. In the Keys pane, under Passwords section,enter details in the Description column andchoose a value for Expires from the drop-downmenu.

6. Click Save.

After the key is generated, copy it, and save itbecause the key value is never displayed again.

Proxy Configuration

In the Proxy Configuration panel, you can provide the information related to the proxy server to accessMicrosoft Dynamics CRM REST endpoints outside of a firewall.

Projects created using version 6.6.0 or earlier versions of the plug-in configured with proxy and onlinedeployment in Dynamics CRM REST connection must be opened in TIBCO Business Studio™ andreconfigured with proxy authentication type as NTLM. For online deployment, only NTLM issupported as authentication type for the proxy server.

30


The following table lists the configurations in the Proxy Configuration panel of the Dynamics CRMREST Connection shared resource:


Use Proxy Yes If you use a proxy server to access Microsoft Dynamics CRM RESTendpoints outside of a firewall, select the Use Proxy check box.

Proxy Server Yes The host name or IP address of the proxy server.

AuthorizationType

No The authentication type used by the proxy server for incomingrequests from the Dynamics CRM REST Connection resource.

● When the deployment type is Online, the value forAuthorization Type is NTLM.

● When the deployment type is On-Premises, the value forAuthorization Type is Basic.

Proxy Port Yes The port number of the proxy server.

ProxyUsername

Yes The user name used to connect to the proxy server.

Proxy Password Yes The password used for the specified user name when connectingto the proxy server.

Proxy Domain Yes The domain name to which the proxy user belongs to forauthentication with the proxy server.

This field is shown only when the proxy authorizationtype chosen is NTLM.

Discover Service

Ensure that you have configured all the necessary parameters when using Discover Service. You canclick Discover Service to open the Discovery Web API dialog, type the URL in the field, and click Ok.The URL for the service root is found automatically. If the discovery service information isauthenticated, the associated URL for the service root is automatically entered in the Service Root URLfield.

The Discover Service button is disabled when Grant type is Client Credentials.

Test Connection

You can click Test Connection to test whether the specified configuration fields result in a validconnection to the Microsoft Dynamics CRM server.

If illegal/incorrect key size error is displayed when testing the connection to the Microsoft DynamicsCRM server with the Kerberos authentication, you must replace the local_policy.jar andUS_export_policy.jar JRE security files that are located in the TIBCO_HOME/tibcojre64/version_number/lib/security directory with the files you can download from Oracle website. Formore details, contact TIBCO Support team.

If you enter an incorrect Kerberos file and correct it later, restart your Business studio.

31


Registering an Application in Azure Active DirectoryThe plug-in supports both native and Web app/API application types to be connected to the DynamicsCRM Online application. For more information on ADAL, see the page "Connect to MicrosoftDynamics 365 web services using OAuth" on the Microsoft website.

Prerequisites

You must log in to the Azure portal to register a new application .

To register a new application in Azure Active Directory:

Procedure

1. In the Microsoft Azure menu, select Azure Active Directory.

2. In the Azure Active Directory window, click App registrations.

3. In the App registrations pane, click New application registration.

32


4. In the Create pane, enter the details.

● If you want to create a native application registration, enter the details as shown.

● If you want to create a Web app/ API registration, enter the details as shown. (Screenshotrequired)

5. Click Create.

Result

The new application is registered, and a new row with the application details including a uniqueApplication ID is added to the list in the App registrations window. If you select the row, the registeredapplication pane opens with the essential details.

33


What to do next

You must give permissions for the registered application. To give user permissions, see GivingPermissions for the Registered Application.

Giving Permissions for the Registered Application

Prerequisites

You must first register the application in the Azure Active Directory. See Registering a New Applicationin Azure Active Directory

To give user permissions for the registered native or Web app/API application in Azure ActiveDirectory:

Procedure

1. Select the application from the list in the App registrations pane.The registered application pane and the Settings pane opens.

2. To delegate permissions, in the Settings pane, under API ACCESS select Required Permissions.a) To add the required permissions, in the Required Permissions pane, click Add.

a) In the Add API access pane, click Select an API.b) In the Select an API pane, select Dynamics CRM Online (Microsoft CRM).c) Click Select. When this step is completed, a green tick mark appears beside Select an API .

34


d) In the Add API access pane, for Select permissions, in the Enable Access pane, select Delegated

Permissions and Access CRM Online as organization users check boxes.e) Click Select. When this step is completed, a green tick mark appears beside Select permissions.

Click Done.Dynamics CRM Online (Microsoft CRM) is now added to the list in the Required Permissions pane.

3. To grant the delegated permissions, in the Required Permissions pane, click Grant Permissions.

35


Click Yes.

Result

A message that you have successfully granted permission for the registered application is displayed.

36


Dynamics CRM Palette

A Dynamics CRM palette is added after installing TIBCO ActiveMatrix BusinessWorks Plug-in forMicrosoft Dynamics CRM.

The existing Dynamics CRM palette is also called Dynamics CRM SOAP palette. The activities in thispalette use SOAP calls to communicate with the server.

The Dynamics CRM palette contains the following activities:

● Entity Event Source

● Create Entity

● Update Entity

● Delete Entity

● Retrieve Entity

● Retrieve Multiple Entities

● Associate Entities

● Execute Request

Entity Event SourceThe Entity Event Source activity is used to listen to the Create, Update, and Delete user events triggeredon specified entity records.

This activity can use either the HTTP or HTTPS communication mode to communicate with a MicrosoftDynamics CRM server when receiving user event messages.

Microsoft Dynamics CRM SDK provides a Plugin Registration tool to bind event handlers to entities.See Registering Specific Messages for more details.

To receive events from the Microsoft Dynamics CRM Online server, the process containing this activitymust be deployed on a demilitarized zone (DMZ) server. Therefore, you must have a DMZ server andinstall this plug-in on it.

General

In the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specifythe entity you want to listen to.

The following table lists the configurations in the General tab of the Entity Event Source activity:


Name No Specify the name of the activity in the process definition.

Dynamics CRMConnection

Yes Specify a shared connection resource.

Click the icon to select a Dynamics CRM connection. If nomatching Dynamics CRM connections are found, click CreateShared Resource in the Select DynamicscrmResource ResourceTemplate dialog to create one. See Creating a Dynamics CRMConnection for more details.

37



Dynamics CRMEntity

No Specify the entity you want to listen to.

Click Fetch Entity to open the Entity Selection Dialog dialog thatcontains all the available entities. Select an entity from the list andclick OK. The selected entity is automatically specified in thisfield.

After selecting the entity, click Build Schema to open theAttributes Selection Dialog that contains all the available attributesassociated with the entity. Select the attributes you want and clickOK. The selected attributes are displayed in the Output tab.

Event On No Select the user event triggered on the entity record that is listenedto:

● Create Entity: triggered only when the specified entity recordis created.

● Update Entity: triggered only when the specified entity recordis edited.

● Delete Entity: triggered only when the specified entity recordis deleted.

To successfully receive the messages triggered by userevents in the Microsoft Dynamics CRM server, the SDKmessage processing steps corresponding to the userevents specified in this field must be enabled in theMicrosoft Dynamics CRM sever.

HTTPConnection

Yes Specify an HTTP Connector shared resource.

Click the icon to select an HTTP connection. If no matchingHTTP connector resources are found, click Create SharedResource to create one. See TIBCO ActiveMatrix BusinessWorksBindings and Palettes Reference guide for more details.

Relative Path Yes Specify a URL path relative to the entity event source instance.

Relative Path is case sensitive, and must be uniquewhen there are multiple entity event source instances.

The relative path must be consistent with the valueconfigured for the Dynamics CRM solution.

Username Yes Specify the user name that is used for basic authentication to theruntime Entity Event Source activity.

The user name must be consistent with the valueconfigured for the Dynamics CRM solution.

38



Password Yes Specify the password that is used for basic authentication to theruntime Entity Event Source activity.

The password must be consistent with the valueconfigured for the Dynamics CRM solution.

Description

In the Description tab, enter a short description for the Entity Event Source activity.

Advanced

In the Advanced tab, specify the running sequence of processes and the custom job ID for the processinstance.

The following table lists the configurations in the Advanced tab of the Entity Event Source activity:


Sequence Key N/A An XPath expression specifies the order in which the processes run.Process instances with sequence keys that have the same value areexecuted sequentially in the order in which the process instanceswere created.

Custom Job Id N/A An XPath expression specifies a custom job ID for the processinstance.

Output

In the Output tab, the output of this activity varies depending on the entity and attributes selectedwhen configuring the General tab. See the Microsoft Dynamics CRM documentation for more details.

The output for Create and Update events varies according to the attributes selected in the DynamicsCRM plug-in registration tool. For more details, see Registering Specific Messages.

Make sure that the attributes selected using Build Schema matches with the parameters selected in theDynamics CRM plug-in registration tool.

Fault

The error code and error message of the Entity Event Source activity are displayed in the Fault tab. Formore details, see Error Codes.

The following table lists error schema elements in the Fault tab of the Entity Event Source activity:

Error SchemaElement Data Type Description

message String The error message returned by the plug-in.

messageCode String The error code returned by the plug-in.

39


Create EntityThe Create Entity activity is used to create entities in the Microsoft Dynamics CRM server.

This activity supports batch operations, which means you can create multiple entities at a time. If youwant to create a data collection in the Microsoft Dynamics CRM server in a batch, use the For-Eachstatement to map the data collection to the elements in the Input field in the Create Entity activity.

General

Establish a connection to the Microsoft Dynamics CRM server, and specify the type of entities you wantto create in the General tab.

The following table lists the configurations in the General tab of the Create Entity activity:





Click the icon to select a space connection. If no matchingDynamics CRM connections are found, click Create SharedResource in the Select DynamicscrmResource Resource Templatedialog to create one. See Creating a Dynamics CRM Connectionfor more details.

Dynamics CRMEntity

No Specify the type of entity you want to create.


After selecting the entity, click Build Schema to open theAttributes Selection Dialog dialog that contains all the availableattributes associated with the entity. Select the attributes you wantand click OK. The selected attributes are displayed in the Inputtab.

Description

In the Description tab, enter a short description for the Create Entity activity.

Input

The input of this activity, displayed in the Input tab, varies depending on the entity and attributesselected when configuring the General tab.

You can assign null value in the input schema for all data types in the Create Entity activity.

For more details, see the Microsoft Dynamics CRM documentation.

Output

In the Output tab, the ID of the created entity is returned. The output field name varies depending onthe type of the created entity .

40


Fault

The Fault tab displays the error code and error message of the Create Entity activity. See Error Codesfor a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Create Entity activity:




Update EntityThe Update Entity activity is used to update entity records in the Microsoft Dynamics CRM server.

This activity supports batch operations, which means you can update multiple entity records at a time.If you want to update a data collection in the Microsoft Dynamics CRM server in a batch, use the For-Each statement to map the data collection to the elements in the Input field in the Update Entityactivity.

General

Establish a connection to the Microsoft Dynamics CRM server in the General tab, and specify the typeof entity records you want to update.

The following table lists the configurations in the General tab of the Update Entity activity:






Dynamics CRMEntity

No Specify the type of the entity record you want to update.


After selecting the entity, click Build Schema to open theAttributes Selection Dialog dialog that contains all the availableattributes associated with the entity. Select the attributes you wantto update and click OK. The selected attributes are displayed inthe Input tab.

41


Description

In the Description tab, you can enter a short description for the Update Entity activity.

Input

The Input tab displays the input of this activity, which varies depending on the entity and attributesselected when configuring the General tab.

You can assign null value in the input schema for all data types in the Update Entity activity.

Output

In the Output tab, the ID of the updated entity record is returned. The output field name variesdepending on the type of updated entity record.

Fault

The Fault tab displays the error code and error message of the Update Entity activity. See Error Codesfor a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Update Entity activity:




Delete EntityThe Delete Entity activity is used to delete entity records in the Microsoft Dynamics CRM server.

This activity supports batch operations, which means you can delete multiple entity records at a time. Ifyou want to delete a data collection in the Microsoft Dynamics CRM server in a batch, you can use theFor-Each statement to map the data collection to the elements in the Input field in the Delete Entityactivity.

General

In the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specifythe type of entity records you want to delete.

The following table lists the configurations in the General tab of the Delete Entity activity:



42






Dynamics CRMEntity

No Specify the type of the entity record you want to delete.


After selecting the entity, click Build Schema to downloadassociated attributes from the server. The attributes are displayedin the Input tab.

Description

In the Description tab, you can enter a short description for the Delete Entity activity.

Input

In the Input tab, the ID of the entity record to be deleted is required. The field name that indicates theentity record ID varies depending on the entity selected when configuring the General tab.

Output

In the Output tab, the ID of the deleted entity record is returned. The field varies depending on the typeof deleted created entity record.

Fault

The error code and error message of the Delete Entity activity are displayed in the Fault tab. See ErrorCodes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Delete Entity activity:




Retrieve EntityThe Retrieve Entity activity is used to retrieve entity records from the Microsoft Dynamics CRM serverwith entity records IDs.

This activity supports batch operations, which means you can retrieve multiple entity records at a time.If you want to retrieve a data collection from the Microsoft Dynamics CRM server in a batch, use the

43


For-Each statement to map the data collection to the elements in the Input field in the Retrieve Entityactivity.

General

In the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specifythe type of entity records you want to retrieve.

The following table lists the configurations in the General tab of the Retrieve Entity activity:






Dynamics CRMEntity

No Specify the type of the entity records you want to retrieve.


After selecting the entity, click Build Schema to open theAttributes Selection Dialog dialog that contains all the availableattributes associated with the entity. Select the attributes you wantand click OK. The selected attributes are displayed in the Outputtab.

Description

In the Description tab, enter a short description for the Retrieve Entity activity.

Input

Enter the ID of the entity record in the Input tab. This is a required field. The field name that indicatesthe entity record ID varies depending on the entity selected when configuring the General tab.

Output


Fault

The Fault tab dsiplays the error code and error message of the Retrieve Entity activity. See Error Codesfor a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Retrieve Entity activity:

44





Retrieve Multiple EntitiesThe Retrieve Multiple Entities activity is used to retrieve entity records from the Microsoft DynamicsCRM server that match the specified query criteria.

General


The following table lists the configurations in the General tab of the Retrieve Multiple Entities activity:

Field Module Property? Description

Name No Specify the name of the activity in the processdefinition.



Click the icon to select a Dynamics CRMconnection. If no matching Dynamics CRMconnections are found, click Create Shared Resourcein the Select DynamicscrmResource ResourceTemplate dialog to create one. See Creating aDynamics CRM Connection for more details.

Dynamics CRMEntity

No Specify the type of the entity record you want toretrieve.

Click Fetch Entity to open the Entity Selection Dialogthat contains all the available entities. Select an entityfrom the list and click OK. The selected entity isautomatically specified in this field.

After selecting the entity, click Build Schema to openthe Attributes Selection Dialog that contains all theavailable attributes associated with the entity. Selectthe attributes you want and click OK. The selectedattributes are displayed in the Input tab or Outputtab.

45


Field Module Property? Description

Retrieve Mode No Specify the retrieve mode. Select Simple orFetchXML.

● In simple mode, you can specify Searchoperatorand select the attributes to be displayed in both theInput and Output tab.

● In FetchXML mode, you can only select theattributes displayed in the Output tab.

Use Pagination No Specify whether or not to use pagination feature whileretrieving multiple records.

The Use Pagination check box is visibleonly when Retrieve Mode is Simple. It isnot available for FetchXML mode.

Description

In the Description tab, enter a short description for the Retrieve Multiple Entities activity.

Input

The input of this activity varies depending on the entity and attributes selected when configuring theGeneral tab.

The following table lists the possible input elements in the Input tab of the Retrieve Multiple Entitiesactivity:

Input Item Data Type Description

pagenumber Integer Specify the number of pages to be returned in the Output tab.

pagesize Integer Specify the maximum number of entity records to be returnedon each page.

pagingcookie String Specify the value of paging cookie. The paging cookie is aperformance feature that makes paging in the applicationfaster for very large datasets.

attributes String Each attribute is associated with values and search operators.See the Microsoft Dynamics CRM documentation for moredetails about how to use the condition operators.

The following field is displayed in FetchXML mode.

46



FetchXML String Specify the retrieve criteria in XML format.

● The format of the XML string must conform tothe FetchXML syntax. See the MicrosoftDynamics CRM documentation for more detailsabout the FetchXML query specification andusage.

● Paging cookie is not supported in FetchXMLmode.

Output

The output of this activity varies depending on the entity and attributes selected when configuring theGeneral tab.

The following table lists the possible output elements in the Output tab of the Retrieve Multiple Entitiesactivity:

Output Item Data Type Description

pagenumber Integer The name to be displayed as the label for the activity inthe process.

pagesize Integer The maximum number of entity records that arereturned on each page.

pagingcookie String The value of paging cookie.

Paging cookie is only supported in simplemode.

totalcount Integer The total number of entity records that have beenretrieved.

hasMoreRecords Boolean A flag that indicates if there are more records toretrieve for the selected query after the current record.

This element is only supported in simplemode when Use Pagination is selected.

Fault

The error code and error message of the Retrieve Multiple activity are displayed in the Fault tab. See Error Codes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Retrieve Multiple Entitiesactivity:



47




Associate EntitiesThe Associate Entities activity is used to create or delete the link between entity records in the MicrosoftDynamics CRM server.

General

you can Establish a connection to the Microsoft Dynamics CRM server in the General tab and specifythe link of the entity records you want to create or delete.

The following table lists the configurations in the General tab of the Associate Entities activity:






DisassociateEntities

No Select this check box to delete the created link of the entityrecords.

Description

In the Description tab, enter a short description for the Associate Entities activity.

Input

Specify the entity records and the link that you want to create or delete in the Input tab.

The following table lists the input elements in the Input tab of the Associate Entities activity:


The following elements are included in the Entity node.

EntityLogicalNa

me

String Specify the logical name of the entity.

EntityId String Specify the ID of the related entity record.

The following elements are included in the Relationship node.

48



SchemaName String Specify the name of the relationship that is used to create ordelete the link.

You can check the name of the relationship in theMicrosoft Dynamics CRM server.

PrimaryEntityRo

le

String Specify the role of the primary entity.

The following elements are included in the Relatedentities > EntityReferenc node.

EntityLogicalNa

me

String Specify the logical name of the related entity records.

EntityId String Specify the IDs of the related entity records.

Fault

The error code and error message of the Associate Entities activity are displayed in the Fault tab. See Error Codes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Associate Entities activity:




Execute RequestThe Execute Request activity is used to execute organization requests in the Microsoft Dynamics CRMserver.

General

Establish a connection to the Microsoft Dynamics CRM server in the General tab, and specify whetheror not to parse the response of the request.

The following table lists the configurations in the General tab of the Execute Request activity:



49






Parse Result No Select this check box to parse the response of the request in theoutput tab.

Description

In the Description tab, you can enter a short description for the Execute Request activity.

Input

In the Input tab, specify the request that you want to execute.

The following table lists the input elements in the Input tab of the Execute Request activity.

You can check the forms and values of all input parameters in the Microsoft MSDN.


key String Specify the key word of the request.

value Any type Specify the key value of the request.

Right-click the value node and click Substitution to select atype that you want to specify:

● Complex Type: if you select this option, click the icon tobrowse the type list, and specify the type.

● Simple Type: if you select this option, click the icon tobrowse the type list, and specify the type.

● Native Type: if you select this option, specify the typedirectly from the type list.

RequestName String Specify the name of the request.

Output

In the Output tab, the key and value of the request are returned.

If you want to map the output to the activity to which you create a transition, you must select the ParseResult in the General tab. You can coerce the value element in the Data Source of the input tab for theactivity to which you want to map the output. See TIBCO ActiveMatrix BusinessWorks ApplicationDevelopment for more details.

50


Fault

The Fault tab displays the error code and error message of the Execute Request activity. See ErrorCodes for a detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Execute Request activity:




51


Dynamics CRM REST Palette

A Dynamics CRM REST palette is added after installing TIBCO ActiveMatrix BusinessWorks Plug-infor Microsoft Dynamics CRM.

The activities in this palette use REST API calls to communicate with the server.

The Dynamics CRM REST palette contains the following activities:

● REST Entity Event Source

● Create REST Entity

● Update REST Entity

● Delete REST Entity

● Retrieve REST Entity

● Associate REST Entities

● Query REST Entities

● Execute Batch Operations REST

REST Entity Event SourceThe REST Entity Event Source activity is used to listen to the Create, Update, and Delete user eventstriggered on specified entity records.

This activity can use either the HTTP or HTTPS communication mode to communicate with a MicrosoftDynamics CRM server when receiving user event messages.

Microsoft Dynamics CRM SDK provides a Plugin Registration tool to bind event handlers to entities.See Registering Specific Messages for more details.

To receive events from the Microsoft Dynamics CRM Online server, the process containing this activitymust be deployed on a Demilitarized Zone (DMZ) server. Therefore, you must have a DMZ server andinstall this plug-in on it.

General

In the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specifythe entity you want to listen to.

The following table lists the configurations in the General tab of the REST Entity Event Source activity:



Dynamics CRMRESTConnection


Click the icon to select a Dynamics CRM REST connection. Ifno matching Dynamics CRM REST connections are found, clickCreate Shared Resource in the Select DynamicscrmRestResourceResource Template dialog to create one. See Creating a DynamicsCRM REST Connection for more details.

52



Dynamics CRMEntity

No Specify the entity you want to listen to.



Event On No Select the user event triggered on the entity record that is listenedto:

● Create Entity: triggered only when the specified entity recordis created.

● Update Entity: triggered only when the specified entity recordis edited.

● Delete Entity: triggered only when the specified entity recordis deleted.

To successfully receive the messages triggered by userevents in the Microsoft Dynamics CRM server, the SDKmessage processing steps corresponding to the userevents specified in this field must be enabled in theMicrosoft Dynamics CRM sever.

HTTPConnection

Yes Specify an HTTP Connector shared resource.

Click the icon to select an HTTP connection. If no matchingHTTP connector resources are found, click Create SharedResource in the Select HttpConnResource Resource Templatedialog to create one. See TIBCO ActiveMatrix BusinessWorksBindings and Palettes Reference guide for more details.

Relative Path Yes Specify a URL path relative to the entity event source instance.

Relative Path is case sensitive, and must be uniquewhen there are multiple entity event source instances.

The relative path must be consistent with the valueconfigured for the Dynamics CRM solution.

Username Yes Specify the user name that is used for basic authentication to theruntime REST Entity Event Source activity.

The user name must be consistent with the valueconfigured for the Dynamics CRM solution.

53



Password Yes Specify the password that is used for basic authentication to theruntime REST Entity Event Source activity.

The password must be consistent with the valueconfigured for the Dynamics CRM solution.

Description

In the Description tab, enter a short description for the REST Entity Event Source activity.

Advanced

In the Advanced tab, specify the running sequence of processes and the custom job ID for the processinstance.

The following table lists the configurations in the Advanced tab of the REST Entity Event Sourceactivity:


Sequence Key N/A An XPath expression specifies the order in which the processes run.Process instances with sequence keys that have the same value areexecuted sequentially in the order in which the process instanceswere created.

Custom Job Id N/A An XPath expression specifies a custom job ID for the processinstance.

Output


The output for Create and Update events varies according to the attributes selected in the DynamicsCRM plug-in registration tool. For more details, see Registering Specific Messages.

Make sure that the attributes selected using 'Build Schema' matches with the parameters selected in theDynamics CRM plug-in registration tool.

Fault

The error code and error message of the REST Entity Event Source activity are displayed in the Faulttab. See Error Codes for more details.

The following table lists error schema elements in the Fault tab of the REST Entity Event Sourceactivity:



54




Create REST EntityThe Create REST Entity activity is used to create entities in the Microsoft Dynamics CRM server.

This activity supports creation of multiple entities at a time through successive REST API calls and notusing REST batch API call. If you want to create a data collection in the Microsoft Dynamics CRMserver, use the For-Each statement to map the data collection to the elements in the Input field in theCreate REST Entity activity.

Create REST Entity activity supports associating an entity which has single valued relationship with theentity being created.

General

In the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specifythe type of entities you want to create.

The following table lists the configurations in the General tab of the Create REST Entity activity:





Click the icon to select a space connection. If no matchingDynamics CRM REST connections are found, click Create SharedResource in the Select DynamicscrmRestResource ResourceTemplate dialog to create one. See Creating a Dynamics CRMREST Connection for more details.

Dynamics CRMEntity

No Specify the type of entity you want to create.


After selecting the entity, click Build Schema to open theAttributes Selection Dialog dialog that contains Optional InputAttributes and Optional Output Attributes associated with theselected entity. Select the attributes which you want to bepopulated in Input and Output tabs and click OK. The selectedattributes are displayed in the Input and Output tabs.

Description

In the Description tab, enter a short description for the Create REST Entity activity.

55


Input

The input of this activity, displayed in the Input tab, varies depending on the entity and attributesselected when configuring the General tab. See the Microsoft Dynamics CRM documentation for moredetails.

Input values for multi-select type of attributes, introduced in Dynamics 365 V9, must be passed ascomma separated integers of valid optionset options.

Output

In the Output tab, the ID of the created entity along with the output attributes selected when clickingBuild Schema in the General tab, is returned. The output field name varies depending on the type ofthe created entity .

Fault

The Fault tab displays the error code and error message of the Create REST Entity activity. See ErrorCodes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Create REST Entity activity:




Update REST EntityThe Update REST Entity activity is used to update entity records in the Microsoft Dynamics CRMserver.

This activity supports updating multiple entity records at a time through successive REST API calls andnot using REST batch API call. If you want to update a data collection in the Microsoft Dynamics CRMserver, use the For-Each statement to map the data collection to the elements in the Input field in theUpdate REST Entity activity.

Update REST Entity activity supports associating an entity which has single valued relationship withthe entity being updated.

General

Establish a connection to the Microsoft Dynamics CRM server in the General tab, and specify the typeof entity records you want to update.

The following table lists the configurations in the General tab of the Update REST Entity activity:



56






Dynamics CRMEntity

No Specify the type of the entity record you want to update.


After selecting the entity, click Build Schema to open theAttributes Selection Dialog dialog that contains Optional InputAttributes and Optional Output Attributes which are associatedwith the selected entity. Select the optional attributes that youwant to update and select the optional output attributes that youwant to be returned from the server. Click OK. The selectedattributes are displayed in the Input and Output tabs.

UpsertRestriction

No Provides three different options to update and/or insert the entityfor a given ID:

● None: Depending upon the existence of the ID that you enter,it will create or update the entity:

— For non-existing entity ID, it will create a new entity.

— For existing entity ID, it will update the entity.

By default, None is selected. If you want to change,select the option from Upsert Restriction drop-down.

The details of the newly created or updated entity will bedisplayed in the Output tab.

● Prevent Create: For an existing entity ID, it will only updatethe entity. For a non-existing entity ID, it will not create anentity.

The details of the updated entity will be displayed in theOutput tab.

● Prevent Update: For an existing entity ID, it will not updatethe entity. For a non existing entity ID, it will create an entity.The details of the newly created entity will be displayed in theOutput tab.

Description

In the Description tab, you can enter a short description for the Update REST Entity activity.

57


Input

The Input tab displays the input of this activity, which varies depending on the entity and attributesselected when configuring the General tab.

Input values for multi-select type of attributes, introduced in Dynamics 365 V9, must be passed ascomma separated integers of valid optionset options.

Output

In the Output tab, the ID of the updated entity is returned along with the output attributes which youhave selected by clicking Build Schema in the General tab. The output field name varies depending onthe type of updated entity record.

Fault

The Fault tab displays the error code and error message of the Update REST Entity activity. See ErrorCodes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Update REST Entity activity:




Delete REST EntityThe Delete REST Entity activity is used to delete entity records in the Microsoft Dynamics CRM server.

This activity supports deleting multiple entity records at a time through successive REST API calls andnot using REST batch API call. If you want to delete a data collection in the Microsoft Dynamics CRMserver, you can use the For-Each statement to map the data collection to the elements in the Input fieldin the Delete REST Entity activity.

General

In the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specifythe type of entity records or a specific attribute of an entity that you want to delete.

The following table lists the configurations in the General tab of the Delete REST Entity activity:






58



Dynamics CRMEntity

No Specify the type of the entity record you want to delete.


Use Atribute No Select this check box if you want to delete only one attribute ofany entity.

Click Choose attribute to delete to open Attribute SelectionDialog dialog that contains the list of attributes of the selectedentity. Select the attribute you want to delete.

Attribute Name No Displays the name of the attribute which you select in theAttribute Selection Dialog.

Description

In the Description tab, you can enter a short description for the Delete REST Entity activity.

Input

In the Input tab, the ID of the entity record to be deleted is required. The field name that indicates theentity record ID varies depending on the entity selected when configuring the General tab.

Output

In the Output tab, the ID of the deleted entity record is returned. The field varies depending on the typeof deleted entity record.

Fault

The error code and error message of the Delete REST Entity activity are displayed in the Fault tab. See Error Codes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Delete REST Entity activity:




Retrieve REST EntityThe Retrieve REST Entity activity is used to retrieve an entity record from the Microsoft DynamicsCRM server with a specific entity record ID.

This activity supports retrieving multiple entity records at a time through successive REST API callsand not using REST batch API call. If you want to retrieve a data collection from the MicrosoftDynamics CRM server, use the For-Each statement to map the data collection to the elements in theInput field in the Retrieve REST Entity activity.

59


General


The following table lists the configurations in the General tab of the Retrieve REST Entity activity:






Dynamics CRMEntity

No Specify the type of the entity records you want to retrieve.



Description

In the Description tab, enter a short description for the Retrieve REST Entity activity.

Input

Enter the ID of the entity record in the Input tab. This is a required field. The field name that indicatesthe entity record ID varies depending on the entity selected when configuring the General tab.

Output


Fault

The Fault tab displays the error code and error message of the Retrieve REST Entity activity. See ErrorCodes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Retrieve REST Entity activity:

60





Associate REST EntitiesThe Associate REST Entities activity is used to create or delete the link between entity records in theMicrosoft Dynamics CRM server.

General

You can establish a connection to the Microsoft Dynamics CRM server in the General tab and specifythe link of the entity records you want to create or delete.

The following table lists the configurations in the General tab of the Associate REST Entities activity:



Dynamics CRMREST Connection


Click the icon to select a Dynamics CRM RESTconnection. If no matching Dynamics CRM RESTconnections are found, click Create Shared Resource in theSelect DynamicscrmRestResource Resource Template dialogto create one. See Creating a Dynamics CRM RESTConnection for more details.

Dynamics CRMEntity

No Specify the type of entity records you want to associate.This is the base entity to which another entity will beassociated.

Click Fetch Entity to open the Entity Selection Dialogdialog that contains all the available entities. Select an entityfrom the list and click OK. The selected entity isautomatically specified in this field.

Associated Entity No Specify the type of the entity records you want to associatewith the base entity.

After selecting the entity, click Choose entity to associate toopen the Entity Selection Dialog dialog that contains all theavailable entities. Select the entity you want to associatewith the base entity and click OK. The selected entity willbe displayed in this field.

Schema Name No Displays the schema name that associates the two entities.

Disassociate Entities No Select this check box to delete the created link of the entityrecords.

61


Description

In the Description tab, enter a short description for the Associate REST Entities activity.

Input

In the Input tab, you can specify the entity IDs of the entities that you provide in the General tab.

Fault

The error code and error message of the Associate REST Entities activity are displayed in the Fault tab.See Error Codes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Associate REST Entities activity:




Query REST EntitiesThe Query REST Entities activity supports querying list items across different Microsoft DynamicsCRM lists and websites in a specific site collection. This activity supports two modes: FetchXML andOData to query for entities.

General


The following table lists the configurations in the General tab of the Query REST Entities activity:






62



Mode No Specify the retrieve mode. Select OData or FetchXML.

● In OData mode, you can specify Filter and Orderby ODataquery strings in the Query or Input tab based on which entityrecords are returned.

● In FetchXML mode, you can specify the XML query based onwhich entity records are returned.

If you select FetchXML mode,● The fields in the Query tab are not shown.

● The input schema is not required, and it is notgenerated in the Input tab.

Dynamics CRMEntity

No Specify the type of the entity record(s) you want to retrieve.

Click Fetch Entity to open the Entity Selection Dialog thatcontains all the available entities. Select an entity from the list andclick OK. The selected entity is automatically specified in thisfield.

If you select FetchXML mode, this field is hidden.

Select No Specify the attributes of the entity which you want to be returned.

After selecting the entity, click Select Attributes to open theAttributes Selection Dialog dialog that contains all the availableattributes associated with the entity. Select the attributes you wantand click OK. The selected attributes are displayed in the Outputtab.

This field is shown only when you select OData mode.

63



FetchXML No Specify the FetchXML query.

You can use different FetchXML Query types such as:

● Inner and Outer Joins: In Outer Join, the link-type attribute isspecified as outer in the FetchXML query. An outer join in theFetchXML query result is equivalent to the result of the leftouter join in an SQL query. If the link-type is not mentioned inthe FetchXML query, the join is considered as inner join.

● Multiple Join: The Multiple Join joins different entities to abase entity. All the link entities with their attributes are shownin sorted order under the LinkedEntities node in the outputschema.

● Nested Join: The Nested Join is similar to sub joins in an SQLquery. All the link entities with attributes are shown in sortedorder under the LinkedEntities node in the output schema.

● Support for Aliases in Base Entity and Link Entities: The BaseEntity with alias name has no effect on the output schema. Ifthe alias name is specified for base entity attributes, link entityor to its attributes, the output schema is generated with thealias names in the query.

● All Attributes in Base Entity and Link Entities: The <all-attributes> tag is specified as a child element of the entity nodein the FetchXML query to retrieve all attributes for an entity.The output schema is generated with all the attributes in theentity metadata.

● Aggregate Functions: Aggregate functions has aggregateattribute set to true in a FetchXML query. Aggregate functionscan be applied on base entity or link entity attributes. Multipleaggregate functions can also be specified in the query on sameattribute.

● Aggregate Group by: Group by can be used either on baseentity attributes or on link entity attributes with aggregatefunctions. Multiple group by clauses can be used in the queryon the same attribute.

After you provide the FetchXML query, the Build Schema buttonis enabled.

Click the Build Schema button to open the Build Schema dialogbox that contains a list of base and linked entities retrieved fromthe FetchXML input.

Select the entities from the list and click Refresh to refresh theschema.

Click OK to build the output schema.

This field is shown only when the mode is FetchXML.

64


Description

In the Description tab, enter a short description for the Query REST Entities activity.

Query

You can specify the criteria in this tab to query the entities or expand on the associated entities.

The Query tab is empty if the mode is FetchXML.

The following table lists the configurations in the Query tab of the Query REST Entities activity:


Filter Yes Specify Search operator and attribute names to get the entityrecords.

Order By Yes Specify the order in which you want the entity records to bereturned.

Entity to Expand No Specify the entity or entities to be associated with the base entity.

Click Select Entity to open the Entity Selection Dialog thatcontains all the available entities. Select an entity or multipleentities from the list and click OK.

Click Clear Entity to clear the field.

Expand Query No Displays the query based on the output attributes selected for anexpanded entity or entities. This is a read-only field.

To have the query displayed in this field, click Build MultipleEntities Schema to open the Attributes Selection Dialog.

● Select an entity for which you want to configure schema nameand output attributes.

● In Schema Name, select the schema or relationship name forthe associated entities.

● If the chosen schema is a single valuednavigation property, the Use Ref to expand?check box is enabled, and you can select or clearthe check box. If you select the check box, theChoose Output Attributes column is hidden.

When you select this check box, the odataid isdisplayed in the Output schema.

● In Choose Output Attributes, select the output attribute perschema for each associated entity.

This field is enabled only for collection valuednavigation property and for single valuednavigation property if the Use Ref to expand? checkbox is not selected.

65



RestrictionOption

No Select the option from the drop-down based on which you want torestrict the output.

By default, None is selected.

Top Restriction Yes Specify the number of entity records to be returned in the Outputtab.

This field is enabled if you select Top from RestrictionOption drop-down.

PageSize Yes Specify the number of entity records to be displayed in a page.

This field is enabled if you select PageSize fromRestriction Option drop-down.

Using a single valued navigation property with Use Ref to expand? along with a collection valuednavigation property on a Query REST Entities activity is not supported by Microsoft Dynamics CRM.

Input

The input of this activity varies depending on the selected entity when configuring the General tab. Ifyou select FetchXML mode in the General tab, the plug-in does not generate any input schema becauseit is not required. No configuration is required in the Input tab.

The values in this tab will be given higher preference over the values that you provide in the Query tab.

The following table lists the possible input elements in the Input tab of the Query REST Entitiesactivity:

Input ItemDataType Description

The following fields are displayed in OData mode.

FilterQuery String Specify the attribute names and Searchoperators to get theentity records.

OrderbyQuery String Specify the order in which you want the entity records to bereturned.

NextPageLink String Specify the URL which the activity uses to get next bunchof data while querying data.

This parameter is displayed in the Input tabwhen you select PageSize or from the RestrictionOption drop-down.

66


Input ItemDataType Description

Top String Specify the number of entity records to be returned.

This parameter is displayed in the Input tabwhen you select Top from the Restriction Optiondrop-down.

Output

If you select the Odata mode in the General tab, the output schema is built based on input provided inthe General, Query and Input tabs.

If you select FetchXml mode in the General tab, output schema is built based on the XML provided inthe FetchXML field in the General tab.

The following table lists the possible output elements in the Output tab of the Query REST Entitiesactivity:

Output ItemDataType Description

The following fields are displayed along with the entity attributes in FetchXML mode.

nextPageNumber String The next page number.

pagingcookie String The value of paging cookie.

The following fields are displayed along with the entity attributes in OData mode.

If the Query configuration contains expanding on a single valued navigation property with Use Refto expand? check box selected, only the following two items are displayed as child elements of anoutput element. The name of the output element is the attribute name of a single valued navigationproperty association.

If Use Ref to expand? check box is not selected, instead of the following two output items,all the output attributes that were selected in the Attributes Selection Dialog for thatassociation are displayed as child elements of an output element. The name of the outputelement is the attribute name of a single valued navigation property association.

entitylogicname String The attribute names of the associated enity.

This field is displayed when you select Use Refto expand? check box.

odataid String The OData ID of the associated entity is displayed.

This field is displayed when you select Use Refto expand? check box. This parameter will notbe displayed if schema name is collectionvalued.

nextPageLink String If you select PageSize from the Restriction Option drop-down, the URL is dispalyed in this filed for pagination.

67


Fault

The error code and error message of the Query REST Entities activity are displayed in the Fault tab. See Error Codes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Query REST Entities activity:




Execute Batch Operations RESTThe Execute Batch Operations REST activity is used to add, update, and delete entity records in theMicrosoft Dynamics CRM server.

This activity supports adding, updating and deleting multiple entity records at a time through using aREST batch API call.

The Execute Batch Operations REST activity is treated as a single operation. If any of the operationswithin the Execute Batch Operations REST activity fails, the remaining operations are rolled back andthe activity faults.

General

In the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specifythe type of entity records or specific attributes of an entity for which you want to execute a batchrequest.

The following table lists the configurations in the General tab of the Execute Batch Request RESTactivity:






68



Build BatchRequest

No Build a batch request.

To build a batch request:

1. Click the Build Batch Request button.

2. In the Batch Request Builder dialog box that opens, from theSelect Operation drop-down list, select the operation youwant to perform, such as create, update, or delete operation.

If you select update operation, Upsert Restriction isdisplayed and you can select None, Prevent Create,or Prevent Update. By default, None is selected.

For delete operation, in Optional Input Attributes,you can select and delete only one attribute of anyentity.

3. In the Select Entity list, select the entity on which you want toperform the operation. If required, select input attributes in theOptional Input Attributes list.

4. Click Add.

The operation is added as an entry (batch item) in the List ofOperations for Batch table.

If you want to edit or delete an entry (batch item) inthe List of Operations for Batch table, select theentry and click the Edit or Delete button and makethe required change. You can select only one entryand edit at a time. You can however select multipleentries and delete at a time.

5. After adding all the operations you want to perform in thebatch, click Confirm Batch to generate the input and outputschema for the batch items.

6. Click Save.

Description

In the Description tab, you can enter a short description for the Execute Batch Operation REST activity.

Input

In the Input tab, the input of this activity is displayed. The input varies depending on the type ofoperation, entity, and attributes selected in the Batch Request Builder dialog box in the General tab.

The input schema has as many number of operations as were configured using the Batch RequestBuilder dialog box and the order of the operations is maintained as seen in the dialog box.

Output

In the Output tab, the corresponding entity IDs for the operations in the batch are returned. The outputvaries depending on the type of operations and entities.

The output schema has as many number of operations as were configured using the Batch RequestBuilder dialog box and the order of the operations is maintained as seen in the dialog box.

69


Fault

The error code and error message of the Execute Batch Operation REST activity are displayed in theFault tab. See Error Codes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Execute Batch Operation RESTactivity:




70


Downloading Option Set Metadata

An option set is a list of defined options from which you can select an option to capture specificinformation.There are two types of option sets - local and global. A local option set is created for a particular entityand is available to only one entity. A global option set allows you to reuse the metadata in any entity oroption set field type. You can download both local and global option set metadata.

Procedure

1. Right-click a BusinessWorks Application Module/Shared Module, select Dynamics CRM RESTTools, and do one of the following:

● For local option set, click Get per entity OptionSet metadata.

● For global option set, click Get Global OptionSet metadata.

2. In the Download Optionset Metadata dialog, click Browse to select the Dynamics CRM RESTConnection resource for which we need to download the option set metadata.All the Dynamics CRM REST Connections under selected app module and shared modules aredisplayed.

3. In the Select DCRM REST Connection dialog, select a Dynamics CRM REST Connection resource,and click OK.Based on your selection in step 1, the relevant screen is displayed.

71


4. If you selected Get per entity OptionSet metadata, click Fetch Entity, select an Entity, click OK,and then click Download Option Set per entity. OR if you selected Get Global OptionSetmetadata, click Download Global OptionSet.The relevant option set is downloaded successfully to a .JSON file in the DynamicscrmRest folderunder the Project.

72


Working with Sample Projects

The plug-in packages three sample projects with the installer which are DCRM Sample, DCRM RESTSample, and DCRM Cloud Sample. The sample projects show how TIBCO ActiveMatrix BusinessWorksPlug-in for Microsoft Dynamics CRM works.

After installing the plug-in, you can locate the sample projects in the TIBCO_HOME/bw/palettes/dynamicscrm/version_number/samples directory.

SOAP Sample ProjectThis sample project only supports the Microsoft Dynamics CRM online server. If you want to use theMicrosoft Dynamics CRM on-premise server, you must do the specific configurations with eachauthentication server.

The SOAP sample project contains the following processes:

● AssociateEntities

This process shows how to use the Associate Entities activity to create and delete a link of createdentity records.

● EntityEventSource

This process shows how to use the Entity Event Source activity to listen to the Create, Update, andDelete user events triggered on specified entity records.

● ExecuteRequest_Assign

This process shows how to use the Execute Request activity to assign an entity record in theMicrosoft Dynamics CRM server.

● ExecuteRequest_Create_Retrieve_Delete

This process shows how to use the Execute Request activity to create, retrieve and delete an entityrecord in the Microsoft Dynamics CRM server.

● ExecuteRequest_RetrieveEntity

This process shows how to use the Execute Request activity to retrieve metadata of an entity recordin the Microsoft Dynamics CRM server.

● RetrieveMultipleEntities_FetchXML

This process shows how to use the Retrieve Multiple Entities activity to retrieve entity records inXML format in the Microsoft Dynamics CRM server.

● RetrieveMultipleEntities_Simple_Paging

This process shows how to use the Retrieve Multiple Entities activity to retrieve entity records inpaging criteria in the Microsoft Dynamics CRM server.

● RetrieveMultipleEntities_Simple

This process shows how to use the Retrieve Multiple Entities activity to retrieve entity records insimple criteria in the Microsoft Dynamics CRM server.

● Scenario_CRUD

This process shows how to create, retrieve, update, and delete entity records in the MicrosoftDynamics CRM server.

73


Importing the SOAP Sample ProjectBefore running the project, you must import the SOAP sample project into TIBCO Business Studio.

Procedure




2. From the menu, click File > Import.3. In the Select dialog, expand the General folder and select Existing Studio Projects into Workspace.

Click Next.4. Click Browse next to the Select archive file field to locate the sample. Click Finish.

The sample project is located in the TIBCO_HOME/bw/palettes/dynamicscrm/version_number/samples directory.

Result

The sample project is imported into TIBCO Business Studio.

Running the SOAP Sample ProjectYou can run the SOAP sample processes to see how TIBCO ActiveMatrix BusinessWorks Plug-in forMicrosoft Dynamics CRM works.

Prerequisites

Ensure that you have imported the SOAP sample project to TIBCO Business Studio, as described in Importing the SOAP Sample Project.

Procedure

1. In the Project Explorer view, expand DCRM_Samples > Resources > dcrm_samples. Double-clickNewDynamicsCRMConnection.dynamicscrmResource to edit the Dynamics CRM connection, andthen click Test Connection to validate your connection.

74


If you modify the URL in the Organization Service field, you have to import the relativeschemas before running the processes that contain the Execute Request activity. See Preparing to Use the Execute Request Activity for more details.

2. Optional: Double-click HTTPConnectorResource.httpConnResource to configure the HTTPConnector shared resource.HTTP Connector shared resource is only used for the EntityEventSource process listening to userevent messages.

3. Configure the module property value of AssigneeID. To configure, expand Module Descriptors inthe Project Explorer view, double-click Module Properties, make changes to the value forAssigneeID.

4. Configure the components:a) In the Project Explorer view, expand the Module Descriptors resource, and then double-click

Components.

b) In the Components editor, click , and then double-click the process that you want to run.

Select the process that you do not want to run and click .

5. On the toolbar, click the icon to save your changes.

6. From the menu, click Run > Run Configurations to run the selected process.

7. In the Run Configurations dialog, expand BusinessWorks Application and click BWApplication. Inthe right panel, click the Applications tab, select the check box next toDCRM_Samples.application.

8. Click Run to run the process.

9. Click the icon to stop the process.

Result

The selected sample process is run.

REST Sample ProjectThe REST sample project contains the following application packages:

1. batchsample: This package contains the following processes to demonstrate Execute BatchOperations REST activity's features:

a. batch_CUD.bwp: This process shows how to use the Execute Batch Operations REST activity toCreate, Update and Delete entities in a single batch.

75


b. batch_update_with_preventcreate.bwp: This process shows how to update entities with thePreventCreate upsert restriction using Execute Batch Operations REST activity.

c. batch_update_with_preventupdate.bwp: This process shows how to update entities with thePreventUpdate upsert restriction using Execute Batch Operations REST activity.

2. dcrmrestsample: This package contains the following processes:

a. AssociateEntities.bwp: This process shows how to use the associate entities activity to associateor disassociate two entities.

b. CRUD.bwp: This process shows how to create, retrieve, update, and delete entity records in theMicrosoft Dynamics CRM server.

c. Query_With_OData_Pagination.bwp: This process shows how to perform a query on entitiesusing the Pagination feature.

d. Query_With_OData.bwp: This process shows how to perform a query on entities withoutpagination. Query_With_OData contains two QueryREST activities:

a. QueryREST activities:QueryRESTEntities_OData_UseRef activity demonstrates useReffeature for a single valued navigation property.

b. QueryRESTEntities_OData_MultipleExpand_WithOutputattr activity shows how toexpand on a collection valued navigation property and a single valued navigation propertywithout useRef.

3. fetchxmlsample: This package contains the following processes to demonstrate support for differenttypes of FetchXML queries in Query REST entities activity including FetchXML with Joins:

a. inner_join.bwp: This process shows how to use the Query REST Entities activity to retrieveentity records using FetchXML mode using a FetchXML query that uses inner joins.

b. multiple_aggregate_groupby.bwp: This process shows how to use the Query REST Entitiesactivity to retrieve entity records using FetchXML mode using a FetchXML query that usesaggregate and groupby functions on more than one attribute of the base entity.

c. multiple_and_nested_link_entities.bwp: This process shows how to use the Query RESTEntities activity to retrieve entity records using FetchXML mode using a FetchXML query thatuses more than one linked-entity for the base entity with one or more such linked entities inturn having linked entities themselves.

d. outer_join.bwp: This process shows how to use the Query REST Entities activity to retrieveentity records using FetchXML mode using a FetchXML query that uses outer joins.

Importing the REST Sample ProjectBefore running the project, you must import the REST sample project into TIBCO Business Studio.

Procedure




2. From the menu, click File > Import.

3. In the Select dialog, expand the General folder and select Existing Studio Projects into Workspace.Click Next.

76


4. Click Browse next to the Select archive file field to locate the sample. Click Finish.The sample project is located in the TIBCO_HOME/bw/palettes/dynamicscrm/version_number/samples directory.

Result

The sample project is imported into TIBCO Business Studio.

Running the REST Sample ProjectYou can run the REST sample processes to see how TIBCO ActiveMatrix BusinessWorks Plug-in forMicrosoft Dynamics CRM works.

Prerequisites

Ensure that you have imported the REST sample project to TIBCO Business Studio, as described in Importing the REST Sample.

77


Procedure

1. In the Project Explorer view, expandDCRMRestSample > Resources > dcrmrestsample .

You can see three Dynamics CRM REST Shared Resources:

● DynamicsCRMRestConnection_On_Premise_Kerberos.dynamicscrmRestResource

● DynamicsCRMRestConnection_Online_OAuth.dynamicscrmRestResource

● DynmicsCRMRestConnection.dynamicscrmRestResource

2. Double click the shared resource to edit the Dynamics CRM REST connection.

3. Replace the module property's values for the selected shared resource. To replace the value, expandModule Descriptors in the Project Explorer view, double-click Module Properties, expand theshard resource which you want to configure and make changes in the respective fields.

You can also navigate to the Module Properties window from the respective Dynamics

CRM REST connection shared resource editor. Click , Goto the Module CompositeProperty, to go to the Module Properties window. Replace the values.

4. After successfully replacing the module property's value in the Module Properties wizard, go backto your selected Dynamics CRM Rest Shared Connection Editor window and click TestConnection.

5. Configure the components:a) In the Project Explorer view, expand the Module Descriptors resource, and then double-click

Components.

b) In the Components editor, click , and then double-click the process that you want to run.

Select the process that you do not want to run and click .

6. On the toolbar, click the icon to save your changes.

7. From the menu, click Run > Run Configurations to run the selected process.

8. In the Run Configurations dialog, expand BusinessWorks Application and click BWApplication. Inthe right panel, click the Applications tab, select the check box next toDCRMRestSample.application.

9. Click Run to run the process.

10. Click the icon to stop the process.

Result

The selected sample process is run.

78


79


Managing Logs

When an error occurs, you can check logs to trace and troubleshoot the plug-in exceptions.

By default, error logs are displayed in the Console view when you run a process in debug mode. Youcan change the log level of the plug-in to trace different messages and export logs to a file. Different loglevels correspond to different messages, as described in Log Levels.

Log LevelsDifferent log levels include different information.

The Dynamics CRM solution supports the following log levels:

Log Level Description

OFF No information is captured.

If you set the log level to OFF, logs in all the levels, ERROR, WARN,INFO, and DEBUG are not captured.

The OFF log level is only supported for the Dynamics CRM solution.

DEBUG Indicates a developer-defined tracing message.

If you set the log level to DEBUG, logs in the ERROR, WARN, INFO,and DEBUG levels are captured.

INFO Indicates normal plug-in operations. No actions are required. A tracing messagetagged with Info indicates that a significant processing step is reached, andlogged for tracking or auditing purposes. Only info messages preceding atracking identifier are considered as significant steps.

If you set the log level to INFO, logs in the ERROR, WARN, and INFOlevels are captured.

WARN Indicates that an abnormal condition was found. Processing continues, but forbest practice, you can contact the administrator to investigate it.

If you set the log level to WARN, logs in the ERROR and WARN levelsare captured.

ERROR Indicates that an unrecoverable error occurred. Depending on the severity ofthe error, the plug-in might continue with the next operation or might stop.

If you set the log level to ERROR, logs only in the ERROR level arecaptured.

Setting Up Log LevelsYou can configure a different log level for the plug-in and plug-in activities to trace different messages.

By default, the plug-in uses the log level configured for TIBCO ActiveMatrix BusinessWorks. Thedefault log level of TIBCO ActiveMatrix BusinessWorks is Error.

80


Setting Up Logging in TIBCO Business Studio at Run Time

Procedure

1. Navigate to the TIBCO_HOME/bw/version_number/config/design/logback directory and openthe logback.xml file.

2. Add the following node in the BusinessWorks Palette and Activity loggers area to specify the loglevel for the plug-in:<logger name="com.tibco.bw.palette.dynamicscrm.runtime"> <level value="DEBUG"/></logger>

The value of the level element can be Trace, Debug, Info, Warn, or Error.

If you set the log level to Debug, the input and output for the plug-in activities are alsodisplayed in the Console view. For more information on the logging levels, see the "LoggerProperties" topic in the TIBCO CLOUD Integration Documentation.

3. Optional: Add the following node in the BusinessWorks Palette and Activity loggers area tospecify the log level for an activity:<logger name="com.tibco.bw.palette.dynamicscrm.runtime.ActivityNameActivity"> <level value="DEBUG"/></logger>

For example, add the following node to set the log level of the Create Entity activity to Debug:<logger name="com.tibco.bw.palette.dynamicscrm.runtime.CreateEntityActivity"> <level value="DEBUG"/></logger>

Add the following node to set the log level of the Entity Event Source activity to Debug:<logger name="com.tibco.bw.palette.dynamicscrm.runtime.EntityEventSourceActivity"> <level value="DEBUG"/></logger>

The activities that are not configured with specific log levels use the log level configuredfor the plug-in.

4. Save the file.

Exporting Logs to a FileYou can update the logback.xml file to export plug-in logs to a file.

Procedure

1. Navigate to the TIBCO_HOME/bw/version_number/config/design/logback directory and openthe logback.xml file.

After deploying an application in TIBCO Enterprise Administrator, navigate to theTIBCO_HOME/bw/version_number/domains/domain_name/appnodes/space_name/

node_name directory to find the logback.xml file.

2. Add the following node to specify the file where the log is exported:<appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>c:/bw6-dynamicscrm.log</file> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}-%msg%n</pattern> </encoder></appender>

The value of the file element is the absolute path of the file that stores the exported log.

81


3. Add the following node to the root node at the bottom of the logback.xml file.<root level="DEBUG"> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE" /></root>

4. Save the file.

82


Error Codes

The following tables list error codes for SOAP and REST palettes, detailed explanation of each error,and where applicable, ways to solve different errors.

SOAP Palette

Error Code and ErrorMessage Role Category Description Solution

TIBCO-BW-RUNTIME-DYNAMICSCRM-505001

{0}

error BW-Plug-in

General errorinformation.

No action.

TIBCO-BW-RUNTIME-DYNAMICSCRM- 505002

Error encountered

when processing

entity event

source,details: {0}.

error BW-Plug-in

An error occurredwhen processingevents.

No action.


Exception encountered

when parsing

authorization HTTP

header information

for basic auth,

details :{0}

error BW-Plug-in

An error occurredwhen parsing theAuthorization HTTPheader information.

Specify the correctuser name andpassword.


Error encountered

when processing {0}

activity,details:{1}

error BW-Plug-in

An error occurredwhen processing anactivity.

No action.



when executing entity

event source,

details :{0}

error BW-Plug-in

An error occurredwhen executing anentity.

Specify validconfigurationvalues for theactivity.


Error encountered

when processing

posted data from

incoming

request,details:{0}.

error BW-Plug-in

An error occurredwhen processing aposted data fromincoming request.

No action.

83




Execution exception:

{0},{1}

error BW-Plug-in

An exception isthrown.

No action.


Error encountered

when attempting to

start entity event

source,details:{0}.

error BW-Plug-in

An error occurredwhen attempting tostart an entity.

No action.


Error encountered

when attempting to

stop entity event

source,details:{0}.

error BW-Plug-in

An error occurredwhen attempting tostop an entity.

No action.


POST DATA from

incoming request is

empty, incoming

request should be

triggered from TIBCO

Plugin deployed on

CRM server.

error BW-Plug-in

An error occurredwhen post data fromincoming request isempty.

No action.

REST Palette


TIBCO-BW-RUNTIME-DYNAMICSCRMREST-500001DYNAMICSCRM_REST_SHAREDCONNECTION_CREATE_

SHAREDRESOURCE_FAILED=Cr

eating {0} {1} failed.

{2}.

error BW-Plug-in

An error occurredwhile creating theDynamics CRM Restshared resourceconnection.

Specify validconfigurationvalues for theDynamics CRMRest connectionshared resource.

TIBCO-BW-RUNTIME-DYNAMICSCRMREST-500002

Error encountered when

processing entity event

source,details: {0}.

error BW-Plug-in

An error occurredwhen processingevents.

No action.

84





when parsing

authorization HTTP

header information for

basic auth, details :{0}

error BW-Plug-in

An exception isthrown when parsingthe AuthorizationHTTP headerinformation.

Specify the correctuser name andpassword.



processing {0}

activity,details:{1}

error BW-Plug-in

An error occurredwhen processing anactivity.

No action.



when executing entity

event source, details :

{0}

error BW-Plug-in

An error occurredwhen executing anentity.

Specify validconfigurationvalues for theactivity.



processing POSTed data

from incoming

request,details:{0}.

error BW-Plug-in

An error occurredwhen processing aposted data fromincoming request.

No action.


Execution exception:{0},

{1}

error BW-Plug-in

An exception isthrown.

No action.


Input of activity {0} is

missing mandatory

elements.Details: {1}

error BW-Plug-in

Input activity missing Provide themandatoryelements for theentity.

85





attempting to start

entity event

source,details:{0}.

error BW-Plug-in

An error occurredwhen attempting tostart an entity.

No action.



attempting to stop

entity event

source,details:{0}.

error BW-Plug-in

An error occurredwhen attempting tostop an entity.

No action.


POST DATA from incoming

request is empty,

incoming request should

be triggered from TIBCO

Plugin deployed on CRM

server.

error BW-Plug-in

An error occurredwhen post data fromincoming request isempty.

No action.


Use attribute check box

for DeleteRESTEntity

activity is enabled but

attribute name is

missing.

error BW-Pug-in An error occurredwhen Use attributecheck box for DeleteREST Entity activity isenabled but attributename is missing.

Specify the attributeto be deleted.


Input of activity {0}

should contain integer

or comma separated

integers.

error BW-Pug-in An error occurredwhen the format ofinput data for multi-select type ofattributes is incorrectfor Create REST andUpdate RESTactivities of DCRMREST palette.

Provide the inputdata for multi-selecttype of attributes asa comma separatedintegers of validoptionset options.

86


tibco activematrix businessworks plug-in for microsoft ... · creating a project ... businessworks,...

Documents