Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Use Updategrams with Adobe Analytics Data
You can use updategrams to insert, update, and delete Adobe Analytics data. This guide shows how to use the CData BizTalk Adapter for Adobe Analytics to generate updategram schemas and instances.
In this article, you will create updategrams that can be executed by the CData BizTalk Adapter for Adobe Analytics. You will design a schema and use it as a template for generating insert, update, and delete updategrams.
Add the Adapter for Adobe Analytics to Your Project
Use the Add Adapter wizard to add the adapter to a BizTalk Server project in Visual Studio. You will use the adapter to query Adobe Analytics for metadata about the table you want to modify.
- Right-click on the project in the Solution Explorer and click Add -> Add Generated Items.
- Select Add Adapter Metadata in the resulting dialog box.
- In the resulting Add Adapter Wizard, select the CData BizTalk Adapter for Adobe Analytics from the list view.
- In the Port menu, leave the selection blank. Or, select a receive location or send port that has been configured to use the adapter.
- When you click Next, the Schema Wizard is displayed.
Generate a Schema for an Updategram
Follow the steps below to create a schema in a BizTalk Server project in Visual Studio.
- If you have not already done so, add the Adobe Analytics adapter to your project.
- On the Connection String page of the Add Adapter wizard, enter authentication credentials and other connection properties, if they were not already configured in the send port or receive location. Below is a typical connection string:
GlobalCompanyId=myGlobalCompanyId; RSID=myRSID; OAuthClientId=myOauthClientId; OauthClientSecret=myOAuthClientSecret; CallbackURL=myCallbackURL;
Adobe Analytics uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the "Getting Started" section of the help documentation for a guide.
Retrieving GlobalCompanyId
GlobalCompanyId is a required connection property. If you do not know your Global Company ID, you can find it in the request URL for the users/me endpoint on the Swagger UI. After logging into the Swagger UI Url, expand the users endpoint and then click the GET users/me button. Click the Try it out and Execute buttons. Note your Global Company ID shown in the Request URL immediately preceding the users/me endpoint.
Retrieving Report Suite Id
Report Suite ID (RSID) is also a required connection property. In the Adobe Analytics UI, navigate to Admin -> Report Suites and you will get a list of your report suites along with their identifiers next to the name.
After setting the GlobalCompanyId, RSID and OAuth connection properties, you are ready to connect to Adobe Analytics.
See the "BizTalk Configuration" chapter in the help documentation for more information on the required connection properties.
- On the Schema Information page, click Send Port in the General Options section. Select Updategram from the CommandType menu. If you are using the adapter in a solicit-response send port, disable the One-Way option.
On the next page, Statement Information, select the type of the updategram: Insert, Update, or Delete. Select the Table name and the columns you want to include in the schema. If you want to update or delete, the Id column is required.
Note: When you create the updategram, you are limited to modifying the columns you include in the schema.
- Click Next to view a summary of the schema and finish the wizard to create the schema. The resulting .xsd file is added to your project.
Generate Insert, Update, and Delete Instance Messages
After you create the updategram schema, you can use the .xsd file to generate the updategram: Right-click the .xsd file and select Generate Instance. You can also use this file as a template to manually create updategrams. Below are example generated updategram instances for inserts, updates, and deletes:
Insert
An example of INSERT is below. In this instance, there is only an after block, which specifies how the data will change.
<ns0:parameters xmlns:ns0="http://www.cdata.com/AdobeAnalyticsProvider">
<ns0:sync>
<ns0:before></ns0:before>
<ns0:after>
<ns0:AdsReport Page="Page_0" PageViews="PageViews_1" />
</ns0:after>
</ns0:sync>
</ns0:parameters>
Update
An example of UPDATE is below. In this instance, there is both a before block (how the data currently exists in the table) and an after block (how the data will change).
<ns0:parameters xmlns:ns0="http://www.cdata.com/AdobeAnalyticsProvider">
<ns0:sync>
<ns0:before>
<ns0:AdsReport Id=001d000000YBRseAAH></ns0:AdsReport>
</ns0:before>
<ns0:after>
<ns0:AdsReport Page="Page_0" PageViews="PageViews_1" ></ns0:AdsReport>
</ns0:after>
</ns0:sync>
</ns0:parameters>
Delete
An example for DELETE is below. The after block will be empty to show that it is removing the item.
<ns0:parameters xmlns:ns0="http://www.cdata.com/AdobeAnalyticsProvider">
<ns0:sync>
<ns0:before>
<ns0:AdsReport Id=001d000000YBRseAAH></ns0:AdsReport>
</ns0:before>
<ns0:after></ns0:after>
</ns0:sync>
</ns0:parameters>
Processing Schemas
To use updategrams to insert, update, or delete Adobe Analytics records, see the tutorial.