Overview

The Remote Python Script Snap is a Transform type Snap that enables you to execute a Python script on a Remote Python Executor (RPE). The RPE can be installed on the same node as the JCC or elsewhere. The location of the RPE is specified in the account. See Remote Python Executor Installation for steps on installing the RPE.

The Snap has an additional Input and Output view. You can use the second Input view to pass a script to the Snap, in which case the default script within the Snap is ignored. This is useful in case the script is stored in external locations such as GitHub or SFTP server. The second Output view shows the standard output (STDOUT) redirected from the RPE. 

Input and Output

Expected input: 

• First input view: The document upon which the Python script is to be executed. 
• Second input view: The Python script to be executed. 

Expected output:

• First output view: The output from the Python script's execution. 
• Second output view: The STDOUT redirected from the RPE.

Expected upstream Snaps: 

• First input view: Any Snap that has a document output view. For example, CSV Generator, or a combination of File Reader and CSV Parser.
• Second input view: You can use Snaps that read script files from the SLDB or external locations such as GitHub. For example, a combination of File Reader and Binary to Document.

Expected downstream Snaps:

• First output view: Any Snap that accepts a document input. For example, Mapper, or a combination of JSON Formatter and File Writer.
• Second output view: Any Snap that accepts a document input. For example, Mapper, or a combination of Document to Binary and File Writer.

Prerequisites

The RPE should be installed and running before using this Snap. See Remote Python Executor Installation for steps to install the RPE.

Configuring Accounts

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Remote Python Executor Account for information on setting up this type of account.

Configuring Views

Troubleshooting

None.

Limitations and Known Issues

None.

Modes

• Ultra Pipelines: Works in Ultra Pipelines.

Snap Settings

#Imports

#Global Variables

#This function will be executed once before consuming the data.
def snaplogic_init():
    return None

#This function will be executed on each document from the upstream snap.
def snaplogic_process(row):
    output = {}
    output["original"] = row
    return output

#This function will be executed after consuming all documents from the upstream snap.
def snaplogic_final():
    return None

Examples

Using Pipeline Parameters to Append Values

Prerequisites:

Remote Executor Account.

This example pipeline demonstrates how to use the pipeline parameters to execute the Python Script remotely to get the desired output.

Download this pipeline.

Step 1: Configure the pipeline parameters as follows:

Step 2: In the Remote Python Script Snap, update the script as follows to use or access pipeline parameters. In the below code, we have captured the parameter keys num1 and num2 values to return the appended value of parameters.

Step 3: Validate the pipeline. The script is run using the pipeline parameters on the Remote Python Executor. You can view the output of the Python script in the output preview.

Case Conversion

This example demonstrates using a Python script to convert all lower-case characters in an incoming document to upper-case characters.

Image Modified

Download this pipeline.

#Imports

#Global Variables

#This function will be executed once before consuming the data.
def snaplogic_init():
    return None

#This function will be executed on each document from the upstream snap.
def snaplogic_process(row):
    return {"text": row["text"].upper()}

#This function will be executed after consuming all documents from the upstream snap.
def snaplogic_final():
    return None

Additional Examples

The following use cases demonstrate a few real-world scenarios for using this Snap:

Downloads