Skip to end of metadata
Go to start of metadata

Introduction

An Amazon S3 Get Object activity retrieves an object from an Amazon S3 connection and is used as a source in an operation. After configuring an Amazon S3 connection, you can configure as many Amazon S3 activities as you like for each Amazon S3 connection.

Creating an Amazon S3 Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Within the Endpoints filter, click the Amazon S3 connection block to display activities that are available to be used with an Amazon S3 connection:

Amazon S3 activities

To create an activity that can be configured, the activity must first be added to an operation on the design canvas. To add an activity to an operation, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After an Amazon S3 activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: This opens the activity configuration screen for you to configure the activity. For details, see Configuring an Amazon S3 Get Object Activity later on this page.

  • Delete: This is used to permanently delete the activity.

  • Rename: This positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: This changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Available only from the actions menu on the design canvas, this removes the activity as a step in the operation without deleting it from the project. When you remove an activity that is adjacent to a transformation, if schemas are provided within that activity, they will no longer be referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: This deploys the activity and any components it is dependent on.

  • Configurable Deploy: This opens the deployment screen, where you can select project components to deploy.

  • Add to group: This opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: This creates a copy of the activity as a new, unreferenced component. Upon creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring an Amazon S3 Get Object Activity

Follow these steps to configure an Amazon S3 Get Object activity:

  • Step 1 – Enter Basic Information
  • Step 2 – Review Data Schema

Step 1 – Enter Basic Information

Amazon S3 Get Object activity configuration step 1

TIP: Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin typing an open square bracket [ into the field or click the variable icon to display existing variables to choose from.

  • Name: Enter a name to use to identify the Amazon S3 Get Object activity. The name must be unique for each get object activity and must not contain forward slashes (/) or colons (:).

  • Bucket: Enter a valid bucket name for an existing bucket on the Amazon S3 server. This will be ignored if either the bucketName or objectId are specified in the data schema GetObjectRequest.

  • Key: Enter the key of the object that you want to get from the bucket. This will be ignored if either bucketName or objectId is specified in the data schema GetObjectRequest.

  • 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 Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 2 – Review Data Schema

Amazon S3 Get Object activity configuration step 2

  • Data Schema: The request and response data schemas for Amazon S3 will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    • The Amazon S3 connector uses the Amazon AWS SDK v1.

    • The Data field must be converted from Base64 using either a project component script or a transformation mapping script such as:

      $myData = HexToString(BinaryToHex(Base64Decode($amazonData)));

    • If either bucketName or objectId is specified in the data schema GetObjectRequest, the configuration values are ignored in the connector.

    • Request:

      Request Schema FieldAmazon S3 API Field/MethodNotes
      GetObjectRequestGetObjectRequestRequest to retrieve content from a bucket
      requestn/aNode representing the request
      bucketNamebucketNameString with the name of the bucket containing the desired object
      objectIdkeyString with the key in the specified bucket under which the object is stored
    • Response:

      Response Schema Field/NodeAmazon S3 API Field/MethodNotes
      GetObjectResponseGetObjectContentResponse from retrieving content from a bucket
      LastModifiedgetLastModifiedDatetime value of the Last-Modified header, indicating the date and time at which Amazon S3 last recorded a modification to the associated object.
      MetadatagetObjectMetadataGets the metadata stored by Amazon S3 for this object.
      Namen/aString set to the constant ContentType
      ValuegetContentTypeString set to the Content-Type HTTP header, which indicates the type of content stored in the associated object. The value of this header is a standard MIME type.
      DatagetObjectContentBase64binary containing the contents of this object
  • Add Plugin(s): Plugins are Jitterbit- or user-provided applications that extend Harmony's native capabilities. To apply a plugin to the activity, click to expand this section and select the checkbox next to the plugin to be used. For additional instructions on using plugins, including details on setting any required variables used by the plugin, see Plugins Added to an Activity.

  • 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 Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Next Steps

After configuring an Amazon S3 Get Object activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

Amazon S3 Get Object activities can be used as a source with these operation patterns:

Other patterns are not valid using Amazon S3 Get Object activities. See the validation patterns on the Operation Validity page.

An example of using the activity in an operation:

Amazon S3 Get Object operation

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.

On This Page

Last updated:  Jan 29, 2020

  • No labels