Use Updategrams with Google Cloud Storage Data

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Google Cloud Storage BizTalk Adapter

Powerful BizTalk Adapters that allow you to easily connect BizTalk Server with live Google Cloud Storage data through standard orchestrations.

Use the Google Cloud Storage Adapters to synchronize with Google Cloud Storage Buckets, Objects, etc. Perfect for data synchronization, local back-ups, workflow automation, and more!



You can use updategrams to insert, update, and delete Google Cloud Storage data. This guide shows how to use the CData BizTalk Adapter for Google Cloud Storage to generate updategram schemas and instances.

In this article, you will create updategrams that can be executed by the CData BizTalk Adapter for Google Cloud Storage. You will design a schema and use it as a template for generating insert, update, and delete updategrams.

Add the Adapter for Google Cloud Storage 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 Google Cloud Storage for metadata about the table you want to modify.

  1. Right-click on the project in the Solution Explorer and click Add -> Add Generated Items.
  2. Select Add Adapter Metadata in the resulting dialog box.
  3. In the resulting Add Adapter Wizard, select the CData BizTalk Adapter for Google Cloud Storage from the list view.
  4. In the Port menu, leave the selection blank. Or, select a receive location or send port that has been configured to use the adapter.
  5. 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.

  1. If you have not already done so, add the Google Cloud Storage adapter to your project.
  2. 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: ProjectId='project1';InitiateOAuth=GETANDREFRESH

    Authenticate with a User Account

    You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect.

    When you connect, the Google Cloud Storage OAuth endpoint opens in your default browser. Log in and grant permissions, then the OAuth process completes

    Authenticate with a Service Account

    Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes.

    You need to create an OAuth application in this flow. See the Help documentation for more information. After setting the following connection properties, you are ready to connect:

    • InitiateOAuth: Set this to GETANDREFRESH.
    • OAuthJWTCertType: Set this to "PFXFILE".
    • OAuthJWTCert: Set this to the path to the .p12 file you generated.
    • OAuthJWTCertPassword: Set this to the password of the .p12 file.
    • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
    • OAuthJWTIssuer: In the service accounts section, click Manage Service Accounts and set this field to the email address displayed in the service account Id field.
    • OAuthJWTSubject: Set this to your enterprise Id if your subject type is set to "enterprise" or your app user Id if your subject type is set to "user".
    • ProjectId: Set this to the Id of the project you want to connect to.

    The OAuth flow for a service account then completes.

    See the "BizTalk Configuration" chapter in the help documentation for more information on the required connection properties.

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

  5. 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/GoogleCloudStorageProvider"> <ns0:sync> <ns0:before></ns0:before> <ns0:after> <ns0:Buckets Name="Name_0" OwnerId="OwnerId_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/GoogleCloudStorageProvider"> <ns0:sync> <ns0:before> <ns0:Buckets Id=001d000000YBRseAAH></ns0:Buckets> </ns0:before> <ns0:after> <ns0:Buckets Name="Name_0" OwnerId="OwnerId_1" ></ns0:Buckets> </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/GoogleCloudStorageProvider"> <ns0:sync> <ns0:before> <ns0:Buckets Id=001d000000YBRseAAH></ns0:Buckets> </ns0:before> <ns0:after></ns0:after> </ns0:sync> </ns0:parameters>

Processing Schemas

To use updategrams to insert, update, or delete Google Cloud Storage records, see the tutorial.