Cloud Datastore (Beta) Query Items activity

Introduction

A Cloud Datastore (Beta) Query Items activity, using its Cloud Datastore (Beta) connection, reads data from a status storage or key storage within Cloud Datastore and is intended to be used as a source to provide data in an operation.

Data returned by this activity can be used in a transformation to map data to the request schema of another Cloud Datastore activity. For example, the Query Items activity returns the id of the storage and storage items, which is needed to interact with items in an Update Items activity.

Create a Cloud Datastore (Beta) Query Items activity

An instance of a Cloud Datastore (Beta) Query Items activity is created from a Cloud Datastore (Beta) connection using its Query Items activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing Cloud Datastore (Beta) Query Items activity can be edited from these locations:

• The design canvas (see Component actions menu in Design canvas).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a Cloud Datastore (Beta) Query Items activity

Follow these steps to configure a Cloud Datastore (Beta) Query Items activity:

• Step 1: Enter a Name and Specify Settings
  Provide a name for the activity and specify the Cloud Datastore storage to interact with.

• Step 2: Review the data schemas
  Any request or response schemas are displayed.

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify the storage. Each user interface element of this step is described below.

The interface used in this step of the configuration of a Query Items activity depends on the Select storage option selected:

• Select existent storage: Select from a list of existing Cloud Datastore storages.
• Enter storage name manually: Manually enter the name of the Cloud Datastore storage.

Select existent storage

If Select existent storage is selected for Select storage, this user interface is presented:

• Name: Enter a name to identify the activity. The name must be unique for each Cloud Datastore (Beta) Query Items activity and must not contain forward slashes / or colons :.

• Select storage: Select the option Select existent storage to choose an existing storage from a populated list.

• Select a storage: This section displays Cloud Datastore storages available for the environment.

  • Selected storage: After a storage is selected, it is listed here.

  • Search: Enter any column's value into the search box to filter the list of storages. The search is not case-sensitive. If storages are already displayed within the table, the table results are filtered in real time with each keystroke. To reload storages from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh: Click the refresh icon or the word Refresh to reload items from the Cloud Datastore endpoint. This may be useful if storages have been added or edited in Cloud Datastore. This action refreshes all metadata used to build the table of storages displayed in the configuration.

  • Selecting a storage: Within the table, click anywhere on a row to select a storage. Only one storage can be selected. The information available for each storage is fetched from the Cloud Datastore endpoint:

    • Name: The name of the storage.

    • Type: The type of storage, either Lookup by Key (key storage) or Lookup by Status (status storage).

    • Description: The description of the storage provided during storage creation.

• Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Enter storage name manually

If Enter storage name manually is selected for Select storage, this user interface is presented:

• Name: Enter a name to identify the activity. The name must be unique for each Cloud Datastore (Beta) Query Items activity and must not contain forward slashes / or colons :.

• Storage: Enter the name of the storage to interact with.

• Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

• Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

  Note

  Data supplied in a transformation takes precedence over the activity configuration.

  The request and response data schemas consist of these nodes and fields:

  Key storage request node or field	Description
  json	Node containing the JSON request schema
  page	The number of pages to be returned
  limit	The number of items returned per page
  sortBy	The field to be sorted
  sortDir	The sort direction, either asc (ascending) or desc (descending)
  fields	Node containing fields
  item	Node for register within storage

  Status storage request node or field	Description
  json	Node containing the JSON request schema
  page	The number of pages to be returned
  limit	The number of items returned per page

  Key and status storage response node or field	Description
  json	Node containing the JSON request schema
  pagination	Node containing information on the response's pagination
  totalItems	The number of items deleted
  limit	The number of items returned per page
  totalPages	The number of pages returned
  sortBy	The sorted field
  page	The number of pages returned
  sortDir	The sort direction, either asc (ascending) or desc (descending)
  data	Node contain information on the storage
  item	Node containing a storage
  createdDate	The date the storage was created
  expiresDate	The date the storage will expire (status stores expire 90 days after creation)
  id	The ID of the storage
  updatedDate	The date the storage was last updated
  fields	Node containing fields (varies depending on storage type and settings)
  default	Node containing default fields (varies depending on storage type)
  custom	Node containing any custom fields (varies depending on the storage's settings)
  errors	Node containing any errors
  item	Node containing data for a storage item
  context	Any relevant context for the error
  id	The ID of the storage item
  message	The error message

  Important

  Data returned by this activity can be used in a transformation to map data to the request schema of another operation's Cloud Datastore activity. For example, the Query Items activity returns the id of the storage and storage items, which is needed to interact with items in an Update Items activity.

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Cloud Datastore (Beta) endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Finished: Click to save the configuration for all steps and close the activity configuration.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring a Cloud Datastore (Beta) Query Items activity, complete the configuration of the operation by adding and configuring other activities or tools as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Cloud Datastore (Beta) Query Items activities can be used as a source with these operation patterns:

• Transformation Pattern
• Two-target Archive Pattern (as the first source only)
• Two-target HTTP Archive Pattern (as the first source only)
• Two-transformation Pattern (as the first or second source)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.