Skip to end of metadata
Go to start of metadata

Introduction

Jitterbit's OASIS Web Service Security plugin is used to append an OASIS Web Services Security (WSS) security header to a web service request. The header includes a UserNameToken element. Optionally, the header can include a Timestamp element.

This page details the steps to use the OASIS Web Service Security plugin:

  1. Associate the Plugin with an Agent Group
  2. Assign the Plugin
    The plugin can be assigned to any of these Design Studio project items or Cloud Studio project components:
  3. Set Global Variables for the Plugin
  4. Complete Operation Setup

Versions and Upgrading

There are three versions of this plugin available:

  • OASIS Web Service Security 1.0.0.0
    This version is deprecated and shouldn't be used.
  • OASIS Web Service Security 1.2.0.0
    This version contains basic functionality, but does not include support for Web Services Addressing.
  • OASIS Web Service Security 1.3.0.0
    This version contains all the same functionality as version 1.2.0.0, and also includes partial support for Web Services Addressing, with the addition of these global variables: WSA.Action, WSA.To, and WSA.ToMustUnderstand. This is the current recommended version.

If you are currently using a lower plugin version and want to upgrade to a higher version, the upgrade process is manual. That is, you must unassign the older plugin from any project items you have it assigned to, and then assign the newer plugin. Each plugin version is independent.

Associate the Plugin with an Agent Group

If using a Cloud Agent Group, you can skip this step, as all versions of the OASIS Web Service Security plugin are already associated with Jitterbit's Cloud Agent Groups by default. We recommend using version 1.3.0.0.

If using a Private Agent Group, you must associate this Jitterbit-provided plugin with a Private Agent Group. This will make the plugin available on all Private Agents within the Private Agent Group. To associate the plugin:

  1. Log in to the Harmony Portal and go to the Management Console. Then use the menu in the top left to navigate to Customizations > Plug-ins.
  2. In the table, locate the row "OASIS Web Service Security," with attention to the version number. The highest version is recommended. On the far right, use the Action dropdown to select Associate Agent Group.
  3. In the popup, select a Private Agent Group and click Save.
TIP: Detailed documentation on associating plugins is available in Customizations > Plug-ins.

Assign the Plugin

This plugin can be assigned to any of these Design Studio project items or Cloud Studio project components:

NOTE: When connecting to Workday, the OASIS plugin is required using the Design Studio Workday Connector only. The Cloud Studio Workday Connector has built-in functionality for OASIS headers using the username and password provided during configuration of the connection.

To assign this plugin in Design Studio:

  1. Create a web service call operation.
  2. Within the operation, right-click on the web service call and select Plugin. In the popup, under Available plugins, select "OASIS Web Service Security" and click Assign. Then click OK.

To assign this plugin in Cloud Studio:

  1. Add a SOAP activity to an operation.
  2. Configure the SOAP activity. On the last step of configuration, below the display of data schemas, click Add Plugin(s) to expand this section and select the checkbox next to "OASIS Web Service Security." Then click Finished.
TIP: Detailed documentation on assigning plugins is available in Applying Pipeline Plug-ins (Design Studio) or Plugins Added to an Activity (Cloud Studio).

Set Global Variables for the Plugin

In order for a plugin assigned to a web service call or SOAP activity to be functional, any global variables required by the plugin must be set. These variables are set in a script, which should be placed before the web service call or SOAP activity in the operation so that the variables can be initialized.

TIP: For more information, see these pages:

A script template is provided below, followed by documentation on the variables that can be used with this plugin:

AWS S3 Get Script
<trans>
$WSS.User = "user@example.com";
$WSS.Password = "mypassword";
$WSS.IncludeTimestamp = true;
$WSS.TimeToLive = 10;
$WSS.UsePasswordDigest = true;
$WSS.IncludeNonce = false;
$WSS.IncludeCreated = false;
$WSS.UseMilliSecondPrecision = false;
$WSS.MustUnderstand = false;
$WSA.Action = "http://example.com/examples-apply/ExampleRequest";
$WSA.To = "http://www.example.com/sys2/example-apply-v2-0";
$WSA.ToMustUnderstand = false;
</trans>
NameTypeRequiredDescription
WSS.UserStringRequiredThe username that will allow access to the web service.
WSS.PasswordStringRequiredThe password associated with the username that will allow access to the web service.
WSS.IncludeTimestampBooleanRequired

If set to true or not set, the created header will include a wsu:Timestamp element. If set to false, the Timestamp element will not be included.

WSS.TimeToLiveIntegerRequiredThe lifetime of the request, in seconds. This value is ignored if the IncludeTimestamp element is false.
WSS.UsePasswordDigestBooleanRequired

If set to false or not set, #PasswordText is used as the value of the Type attribute in the Password element by default. Set to true to use #PasswordDigest.

WSS.IncludeNonceBooleanOptional

If set to true or not set, the UserNameToken element contains a Nonce element by default. Set to false to suppress the Nonce element.

WSS.IncludeCreatedBooleanOptional

If set to true or not set, the UserNameToken element contains a Created element by default. Set to false to suppress the Created element.

WSS.UseMilliSecondPrecisionBooleanOptional

If set to false or not set, the generated timestamp in the Created element will use a precision of 10-2 (0.01) seconds. Set to true to use millisecond precision (Some web service implementations do not accept this.).

WSS.MustUnderstandBooleanOptional

If set to true or not set, the value of the mustUnderstand attribute in the WSS security header that is inserted into the SOAP envelope is set to trueSet to false to suppress this element.

WSA.ActionStringOptional

The wsa:Action element value in the header.

NOTE: This variable is supported only in plugin version 1.3.0.0 or higher.
WSA.ToStringOptional

The wsa:To element value in the header.

NOTE: This variable is supported only in plugin version 1.3.0.0 or higher.
WSA.ToMustUnderstandBooleanOptional

If set to false or not set, the value of the wsa:To element mustUnderstand attribute in the header that is inserted into the SOAP envelope is set to false. Set to true to require the recipient to process the wsa:To header entry.

NOTE: This variable is supported only in plugin version 1.3.0.0 or higher.

Complete Operation Setup

The plugin portion of the operation setup is complete after you have (1) the script defining the variables to be used with the plugin and (2) the plugin assigned to a web service call (Design Studio) or SOAP activity (Cloud Studio) in the operation.

To complete the operation setup, configure the web service request and response transformations, along with any additional sources or targets for the operation.

A complete operation in Design Studio:

A complete operation in Cloud Studio:

TIP: For details about completing the operation, see the pages under Operations (Design Studio) or Operations (Cloud Studio).
On This Page

Last updated:  Jan 31, 2020