Xactly Search

In this article

Overview

This Snap searches for the Xactly objects matching the given criteria and displays them. This Snap uses an account class called XactlySoapAccount, which stores the WSDL file and the credentials to connect to the Xactly server.  It also caches the Session ID that is required for subsequent CRUD operations.

xactly-search-overview.png

 

Prerequisites

None.

Limitations and Known Issues

None.

Support for Ultra Pipelines

Works in Ultra Task Pipelines.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • CSV Generator

  • File Reader

The name of the Xactly object to be searched for such as PersonWSO or BonusWSO and the property values of the object to be matched.

This Snap has at most one input view that contains properties to be used while performing search operation.

This Snap has at most one output view that contains the xactly objects matching the search criteria.

Output

Document

  • Min: 1

  • Max: 1

  • File Writer

Xactly objects matching the given property values.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Field

Field Type

Description

Field

Field Type

Description

Label*

 

Default Value: Xactly Search
Example: Xactly Search

String

Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.



Xactly object

 

Default Value: PersonWSO
Example: CustomerWSO

Dropdown list

Choose the object to be used for searching records. Once defined, the input view will provide the schema of the object so that field values can be defined for the search request.

 

Snap Execution

 

Default Value: Validate & Execute
Example: Execute only

Dropdown list

Select one of the following three modes in which the Snap executes:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Troubleshooting


Snap Pack History