Skip to end of metadata
Go to start of metadata

Introduction

A ServiceMax connection is configured using the ServiceMax connector, establishing access to the ServiceMax endpoint. Once a connection is established, you can configure one or more ServiceMax activities associated with that connection to be used either as a source to provide data to an operation or as a target to consume data in an operation. In addition, the ServiceMax connection can be used in scripts.

Creating or Editing a ServiceMax Connection

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

To configure a new ServiceMax connection, use the Show dropdown to filter on Connectors, and then click the ServiceMax connector block:

To configure an existing ServiceMax connection, use the Show dropdown to filter on Endpoints, and then double-click the ServiceMax connection block:

These open the configuration screen for the ServiceMax connection, covered next.

Configuring a ServiceMax Connection

Configuration of a ServiceMax connection includes these fields:

TIP: Fields with a variable icon support using global variablesproject variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Endpoint Name: Enter a name to use to identify the ServiceMax connection. The name must be unique for each ServiceMax connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the ServiceMax endpoint, which refers to both a specific connection and its activities.
  • Server Host: Enter the URL of the Salesforce server. If you are using a production instance, leave the default URL as https://login.salesforce.com. If you are using a sandbox instance, select the Sandbox checkbox below.
  • Sandbox: If you are using a Salesforce sandbox instance, select this checkbox to toggle the Server Host field above to https://test.salesforce.com.
  • User Name and Password: Enter the username and password associated with the Salesforce account you want to use.
  • Security Token: If required, enter the security token associated with the Salesforce account. Depending on your Salesforce security configuration, you may be able to clear this field. Check with your Salesforce administrator. For more information, see Salesforce documentation for Reset Your Security Token.

  • Test: Click to verify the connection using the provided credentials.
  • Save Changes: Click to save and close the connection configuration.
  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps

After configuring a ServiceMax connection, you can configure one or more ServiceMax activities associated with that connection to be used either as a source to provide data to an operation or as a target to consume data in an operation, or you can use the ServiceMax connection in a script.

Configuring Activities

ServiceMax activities interact with the ServiceMax connection to act as sources (providing data within an operation) or targets (receiving data within an operation).

After configuring a ServiceMax connection, use the Show dropdown to filter on Endpoints, and then click the ServiceMax connection block to display activities that are available to be used with a ServiceMax connection:

For information, see these activities:

Standard ServiceMax Activities

  • Query: Queries data from a ServiceMax endpoint and is intended to be used as a source in an operation.
  • Insert: Inserts new data in a ServiceMax endpoint and is intended to be used as a target in an operation.
  • Update: Updates existing data in a ServiceMax endpoint and is intended to be used as a target in an operation.
  • Upsert: Both updates existing data and inserts new data in a ServiceMax endpoint and is intended to be used as a target in an operation.
  • Delete: Deletes data in a ServiceMax endpoint and is intended to be used as a target in an operation.

Bulk ServiceMax Activities

ServiceMax bulk activities are faster and scale better than non-bulk ServiceMax activities, but should be used only if you do not need to use a transformation to change data prior to reaching the target.

  • Bulk Query: Queries a large number of records from a ServiceMax endpoint and is intended to be used as a source in an operation.
  • Bulk Insert: Inserts a large number of new records in a ServiceMax endpoint and is intended to be used as a target in an operation.
  • Bulk Update: Updates a large number of existing records in a ServiceMax endpoint and is intended to be used as a target in an operation.
  • Bulk Upsert: Both updates a large number of existing records and inserts a large number of new records in a ServiceMax endpoint and is intended to be used as a target in an operation.
  • Bulk Delete: Deletes a large number of records from a ServiceMax endpoint and is intended to be used as a target in an operation. Deleted records are stored in the Salesforce Recycle Bin prior to being permanently deleted.
  • Bulk Hard Delete: Hard deletes a large number of records from a ServiceMax endpoint and is intended to be used as a target in an operation. Hard deleted records automatically become eligible for deletion.

Using ServiceMax Connections in Scripts

ServiceMax connections can be referenced in a script using script functions that use a salesforceOrg as a parameter. For example:

To add a ServiceMax connection to a script to be referenced by one of these functions, drag the configured endpoint from the Endpoints tab of the script component palette to the script. Or, if you already know the function you want to use, add it from the Functions tab first; then position the cursor after the opening parenthesis of the function and press Control+Space to display a list of autocomplete suggestions. Select a connection to insert the connection reference into the script.

For more details on referencing activities in scripts, see Endpoints on the Jitterbit Script page.

On This Page

Last updated:  Nov 24, 2020

  • No labels