TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · Creating an HTTP Connector...

TIBCO ActiveMatrix BusinessWorks™

Plug-in for Microsoft Dynamics CRMUser's GuideSoftware Release 6.3February 2016

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(OR PROVIDE 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.

This document contains confidential information that is subject to U.S. and international copyright lawsand treaties. No part of this document may be reproduced in any form without the writtenauthorization 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, NOTALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASEDAT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWAREVERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR 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.

Copyright © 2014-2016 TIBCO Software Inc. All rights reserved.

TIBCO Software Inc. Confidential Information

2

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

Contents

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Plug-in Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Creating a Dynamics CRM Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

TIBCO Business Studio Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

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

Creating an HTTP Connector Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Configuring SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Creating a Keystore Provider Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Configuring One-Way SSL Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Configuring Two-Way SSL Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

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

Configurations for Dynamics CRM Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Registering Specific Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

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

Setting Timeout for the Asynchronous Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Dynamics CRM Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Dynamics CRM Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Entity Event Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Create Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Update Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

Delete Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Retrieve Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Retrieve Multiple Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Associate Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Execute Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Working with Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Importing the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Running the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

3


TIBCO Documentation and Support Services

Documentation for this and other TIBCO products is available on the TIBCO Documentation site. Thissite is updated more frequently than any documentation that might be included with the product. Toensure that you are accessing the latest available help topics, please 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

For comments or problems with this manual or the software it addresses, contact TIBCO Support:

● For an overview of TIBCO Support, and information about getting started with TIBCO Support,visit this site:

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

● If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a user name, you canrequest one.

How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is aplace to share and access the collective experience of the TIBCO community. TIBCOmmunity offersforums, blogs, and access to a variety of resources. To register, go to the following web address:

https://www.tibcommunity.com

4


https://docs.tibco.com

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

https://support.tibco.com

https://www.tibcommunity.com

Plug-in Overview

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Dynamics CRM is an application that canbe used 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™ 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.

TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Dynamics CRM plugs into TIBCOActiveMatrix BusinessWorks and adds Dynamics CRM Palette to TIBCO Business Studio™. You canuse the Dynamics CRM Connection shared resource to create a connection between the plug-in and aMicrosoft Dynamics CRM server, and then configure a process using the activities in the DynamicsCRM palette, see Getting Started for more details about how to use the plug-in.

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

● Creating, updating, deleting, associating, and disassociating entity records.● Retrieving entity records through entity record IDs or query criteria.● Listening to the Create, Update, and Delete user events triggered on a specified entity record.● Executing organization requests.

5


Getting Started

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

All the operations are performed in TIBCO Business Studio. See TIBCO Business Studio Overview toget familiar with TIBCO Business Studio.

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

1. Creating a Project

2. Creating a Dynamics CRM Connection

3. Configuring a Process

4. Testing a Process

5. Deploying an Application

Creating a ProjectThe first task using the plug-in is 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 a project name.b) By default, the created project is located in the workspace current 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.

6


Creating a Dynamics CRM ConnectionAfter creating a project, you add a Dynamics CRM connection shared resource to create a connectionbetween the plug-in and the Microsoft Dynamics CRM server.

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.

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.

7


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.

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 Explorer view, click the created project and open the empty process from theProcesses folder.

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.

8


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

4. Configure the added activities, as described in Dynamics CRM Palette.

A Dynamics CRM connection is required when configuring the Dynamics CRM activities.See Creating a Dynamics CRM Connection for more details about how to create aDynamics CRM 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.

9


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.

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.

TIBCO Business Studio OverviewTIBCO Business Studio is an Eclipse-based integration development environment that is used todesign, develop, and test ActiveMatrix BusinessWorks applications.

TIBCO Business Studio provides a workbench in which you can create, manage, and navigate resourcesin your workspace. A workspace is the central location on your machine where all data files are stored.

10


The workbench consists of:

1. Menu: contains menu items such as File, Edit, Diagram, Navigate, Search, Project, Run, Window,and Help.

2. Toolbar: contains buttons for frequently used commands such as New , Save , Enable/

Disable Business Studio Capabilities , Create a new BusinessWorks Application Module ,

Create a new BusinessWorks Shared Module , Debug , Run , and so on.

3. Perspective: contains an initial set and layout of views that are required to perform a certain task.TIBCO Business Studio launches the Modeling perspective by default. You can change theperspective from the menu Window > Open Perspective > Perspective_Name.

4. View: displays resources. For example, the Project Explorer view displays the ActiveMatrixBusinessWorks applications, modules, and other resources in your workspace, and the Propertiesview displays the properties for the selected resource. You can open a view from the menu Window> Show View > View_Name.

5. Editor: provides a canvas to configure, edit, or browse a resource. Double-click a resource in a viewto open the appropriate editor for the selected resource. For example, double-click an ActiveMatrixBusinessWorks process (MortgageAppConsumer.bwp) in the Project Explorer view to open theprocess in the editor.

6. Palette: contains a set of widgets and a palette library. A palette groups activities that performsimilar tasks, and provides quick access to activities when configuring a process.

11


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

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.

If you want to use SSL to secure the message exchange between the plug-in and theMicrosoft Dynamics CRM server, ensure that you select the Confidentiality check box inthe 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 certificatepairs and 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● Configuring Two-Way SSL Authentication

12


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 or an identity store.

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 of 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.In the one-way SSL authentication mode, the Microsoft Dynamics CRM server authenticates theconnected plug-in.

In the one-way SSL authentication mode, the plug-in passes its identity to the Microsoft DynamicsCRM server. You can use a Keystore Provider resource as the trust store to authenticate the connectedplug-in.

Procedure


2. Right-click the Resources folder and click New > SSL Server Configuration to open the SSL ServerConfiguration wizard, and 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.

13


● Identity Store Provider: a Keystore Provider resource that provides access to the keystore of theclient. The plug-in accesses the keystore to verify the identity of the Microsoft Dynamics CRMserver.

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 JKS format contains avalid certification that must be authorized by a third-party.

If you want to use a two-way SSL authentication to secure the message exchange betweenthe plug-in and Microsoft Dynamics CRM server, ensure that you select the EnableMutual Authentication check box in the Basic SSL Server Configuration panel. See Configuring Two-Way SSL Authentication for more details.

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.

Procedure

1. Generate a keystore file in the PKCS12 format that contains a valid certification for the embeddedHTTPS listener.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 > Customizethe system > 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 certification, and save it in the .cer format, and then import the .cer file to Trust

Store.b) Select the Enable Mutual Authentication check box in the created SSL Server Configuration

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

14


Importing Dynamics CRM Solution to Microsoft Dynamics CRM ServerThe Dynamics CRM solution named TibcoBWEventListenerSolution is used to send events triggeredon a 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 then click Import onthe Import 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 setting:a) On the All Solutions page, double-click TibcoBWEventListenerSolution to open the

Configuration page.b) Configure the settings for the log level and plug-in listener, and then click Save and Publish to

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

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

15


Field Description

Server URL Specify the URL for the HTTP Connector. 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.

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

Password Specify the password for the Entity Event Source activity.

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.

CertificationPassword Specify the password for the certification.

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

Enable Specify whether the listener configuration is enabled.

Registering Specific MessagesThe Plug-in Registration tool is used to register specific messages for the plug-in. After registeringspecific messages for the plug-in, the events triggered on a specified entity can be sent by the DynamicsCRM solution.

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

16


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:

Field Value

Message Create, Update, or Delete

Event Handler Tibco.BW.DynamicsCRM.Plugin.EventListenerPlugin

Eventing Pipeline Stage of Execution Post-operation

Execution Mode Synchronous or Asynchronous

Deployment Server

c) Click Register New Step.

4. Register an image with the Delete step:a) Right-click the Delete 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 PreImage

Name PreImageEntityAlias

Entity Alias PreImageEntityAlias

c) Click Register Image.

17


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 .

18


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 the different conditions.

Setting Timeout in TIBCO Business Studio at Run Time

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

2. In the Run Configurations dialog, click BusinessWorks Application > BWApplication in the leftpanel, and then click Arguments tab in the right panel, add the -Dcom.tibco.bw.palette.dynamicscrm.waitTime=600 parameter in the VM arguments field.

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

Set Timeout in TIBCO Enterprise Administrator at Run Time

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

2. Add the -Dcom.tibco.bw.palette.dynamicscrm.waitTime=600 parameter to thejava.extended.properties property.

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

19


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, you can provide the information related to the Microsoft DynamicsCRM server that the plug-in connects to.

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.

20



AuthenticationType

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

● If you select the Online deployment, the plug-in only supportsthe OnlineFederation 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

Yes Click 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 Yes Click 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 can bemanually obtained from the Web Services Description Language(WSDL) file.

21


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 then clickOk. 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 incorrect key size is prompted when testing the connection to the Microsoft Dynamics CRM serverwith the Kerberos authentication, you have to 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 http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html.

22


http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html

http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html

Dynamics CRM Palette

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

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.

23



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

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

24



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, you can enter a short description for the Entity Event Source activity.

Advanced

In the Advanced tab, you can specify the running sequence of processes and the custom job ID for theprocess instance.

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.

When listening to the Update events, the output only returns the attributes that have been updated.

Fault

In the Fault tab, you can find the error code and error message of the Entity Event Source activity. See Error Codes for a more details.

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.

25


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, you can use the For-Each statement to map the data collection to the elements in the Input field in the Create Entity activity.

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 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, you can enter a short description for the Create Entity activity.

Input

In the Input tab, the input of this activity varies depending on the entity and attributes selected whenconfiguring the General tab. See the Microsoft Dynamics CRM documentation for more details.

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 .

26


Fault

In the Fault tab, you can find the error code and error message of the Create 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 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, you can usethe For-Each statement to map the data collection to the elements in the Input field in the UpdateEntity activity.

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

27


Description

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

Input

In the Input tab, the input of this activity varies depending on the entity and attributes selected whenconfiguring the General tab.

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

In the Fault tab, you can find the error code and error message of the Update 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 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:






28



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 thetype of deleted created entity record.

Fault

In the Fault tab, you can find the error code and error message of the Delete Entity activity. 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, you canuse the For-Each statement to map the data collection to the elements in the Input field in the RetrieveEntity activity.

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:

29







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, you can enter a short description for the Retrieve Entity activity.

Input

In the Input tab, the ID of entity record to be retrieved 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 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.

Fault

In the Fault tab, you can find the error code and error message of the Retrieve 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 Entity activity:




30


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

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 Multiple Entities activity:






Dynamics CRMEntity

No Specify the type of the entity record 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 Inputtab or Output tab.

Retrieve Mode No Specify the retrieve mode. Select Simple or FetchXML.

● In simple mode, you can specify Searchoperator and selectattributes to be displayed in both the Input and Output tab.

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

Description

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

Input

In the Input tab, the input of this activity varies depending on the entity and attributes selected whenconfiguring the General tab.

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

31


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. Specify the value of pagingcookie.

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.

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

In the Output tab, the output of this activity varies depending on the entity and attributes selectedwhen configuring the General 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 in theprocess.

pagesize Integer The maximum number of entity records that are returned oneach page.

pagingcookie String The value of paging cookie.

Paging cookie is only supported in simple mode.

totalcount Integer The total number of entity records that have been retrieved.

Fault

In the Fault tab, you can find the error code and error message of the Retrieve Multiple activity. See Error Codes for a more detailed explanation of errors.

32


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




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

General

In the General tab, you can establish a connection to the Microsoft Dynamics CRM server, 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, if you want to delete the created link of theentity records.

Description

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

Input

In the Input tab, you can specify the entity records and the link that you want to create or delete.

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.

33



EntityId String Specify the ID of the related entity record.

The following elements are included in the Relationship node.

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

You can check the name of the relationship definedin the Microsoft 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

In the Fault tab, you can find the error code and error message of the Associate Entities activity. 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

In the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specifywhether or not to parse the response of the request.

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



34






Parse Result No Select this check box, if you want to parse the response of therequest in the output tab.

Description

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

Input

In the Input tab, you can 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 defined 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 then specify the type.

● Simple Type: if you select this option, click the icon tobrowse the type list, and then 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.

35


Fault

In the Fault tab, you can find the error code and error message of the Execute Request activity. See Error Codes for a more detailed explanation of errors.

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




36


Working with Sample Project

The plug-in packages a sample project with the installer. The sample project shows how TIBCOActiveMatrix BusinessWorks Plug-in for Microsoft Dynamics CRM works.

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

The sample project only supports the Microsoft Dynamics CRM online server. If you want to use theMicrosoft Dynamics CRM On-Premises server, you must do the specific configurations with eachauthentication server.

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

37


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

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 > 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 Sample ProjectYou can run the sample processes to see how TIBCO ActiveMatrix BusinessWorks Plug-in for MicrosoftDynamics CRM works.

If you use the ExecuteRequest_Assign process to assign an entity record in the Microsoft DynamicsCRM server, modify the ID of the user that you want to assign in the Id field.

Prerequisites

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

38


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.

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

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

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

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

7. Click Run to run the process.

8. Click the icon to stop the process.

39


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 plug-in 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.

TRACE Includes all information regarding the running process.

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

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.

40


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.

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 Error, Info, or Debug.

If you set the log level to Debug, the input and output for the plug-in activities are alsodisplayed in the Console view. See Log Levels for more details regarding each log level.

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>

41


</encoder></appender>

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

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.

42


Error Codes

The following table lists error codes, detailed explanation of each error, and where applicable, ways tosolve different errors.

Error Code and ErrorMessage Role Category Description Solution

TIBCO-BW-RUNTIME-DYNAMICSCRM-505001

{0}

error BW-Plug-in

General errorinformation.

No action.


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 exception isthrown when parsingthe AuthorizationHTTP headerinformation.

Specify the correctuser name andpassword.


Error encountered

when processing {0}

activity,details:{1}

error BW-Plug-in

An error occurredwhen processing anactivity.

No action.


Exception

encountered when

executing entity

event source,

details :{0}

error BW-Plug-in

An error occurredwhen executing anentity.

Specify validconfigurationvalues for theactivity.

43


Error Code and ErrorMessage Role Category Description Solution


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.


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.

44


Date post:	28-Jul-2020
Category:	Documents
Upload:	others
View:	0 times
Download:	0 times

TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · Creating an HTTP Connector...

Documents