Introduction

When you install the Peoplevox connector from the Patchworks marketplace, pre and post authentication scripts are included.

Typically, you don't need to do anything with these scripts - they do what they need to do 'out of the box'. However, if you are connecting to a US region, you might need to update the pre-auth script.

What needs to be changed?

The pre-authentication script encodes passwords as Base64, which is required by most PVX regions. However, the US region requires this in plain text.

If you experience issues with authentication - usually a message like 'System : Security - Invalid Session', then you should update the pre-authentication script to remove Base64 encoding. This is a simple change, summarised below.

The Steps

Required steps are detailed in the following sections:

• Stage 1: Update the Peoplevox pre-auth script

• Stage 2: Apply the Peoplevox pre-auth script to your connector

Stage 1: Update the Peoplevox pre-auth script

Step 1 From the Patchworks dashboard, select process flows | scripts from the left-hand navigation menu.

Step 2 From the installed section, click the pre-auth Base64 encode script name:

Step 3 Once the script is open in edit mode, move down to the code editor and change:

base64_encode($matches[1]) 

to:

$matches[1] 

Step 4 Save and deploy the script:

Stage 2: Apply the Peoplevox pre-auth script to your connector

Step 1 From the Patchworks dashboard, select process flows | connectors & instances from the left-hand navigation menu.

Step 2 Click the settings icon associated with the Descartes Peoplevox connector:

Step 3 Select the authentication option:

Step 4 Click the SOAP Authentication method:

Step 5 Select the pre-request script tab:

Step 6 Select the latest version of the script:

Step 7 Save changes.

Introduction

If you are pulling data from Peoplevox (i.e. your includes a configured with a Peoplevox GET endpoint), a search option is available. For example:

Using the search field

You can use this field to filter data via the API, using syntax detailed in the Peoplevox API documentation.

Description

Descartes Peoplevox is the Warehouse Management System for eCommerce businesses, online retailers and direct to consumer brands.

API documentation

API documentation for Peoplevox (used to build this connector) can be found via the link below:

Authentication

When adding connector instances for Peoplevox, the following authentication methods are supported:

• SOAP request authentication method

SOAP request authentication

Required Additional setup

SetData script

Before this connector can be used as a target connection in process flows, you must create a setData script.

Having completed this setup, the Peoplevox connector is ready to use.

Pre-authentication script

If you are connecting to a US region, you might need to update the default pre-authentication script for the installed connector. For information, please see Peoplevox pre & post authentication scripts page.

Using the Peoplevox connector in process flows

The Peoplevox connector is like any other Patchworks connector - it gets added to process flows via a connection shape.

However, if you build a process flow with Peoplevox as a target connection, you must add a custom script shape and apply the setData script immediately before the target connection shape. For more information please see: Using the Peoplevox setData script in process flows.

Introduction

If you're building a process flow with Peoplevox as a target connection, you must create a setData script and then - in your process flow - apply this script immediately before the target connection.

Creating a setData script

Step 1 From the Patchworks dashboard, select scripts from the left-hand navigation menu.

Step 2 Click the create script button:

Step 3 In the name field, type the following:

PVX SetData

Step 4 In the description field, type the following:

Convert flat Json payload to csv SetData format

Step 5 Click in the language field and select PHP 8.1:

Step 6 Click the create button:

Step 7 The script is created and opened in edit mode - select and remove the placeholder code:

Step 8 Paste in the code below.

Step 9 Click the save and deploy button:

Introduction

If you are pulling data from Peoplevox (i.e. your process flow includes a connection shape configured with a Peoplevox GET endpoint), the payload is generated as XML data.

If required, you can convert the XML payload to JSON by adding the script below to a script shape immediately after the Peoplevox connection shape. For example:

Custom script - XML to JSON

The script below will convert any Peoplevox XML payload, irrespective of the entity type being pulled.

<?php

/**
 * Handler function.
 *
 * @param array $data [
 *      'payload'   => (string|null) the payload as a string|null
 *      'variables' => (array[string]string) any variables as key/value
 *      'meta'      => (array[string]string) any meta as key/value
 *    ]
 */

function handle($data)
{
    $xml = simplexml_load_string($data['payload']);

    $body = $xml->xpath("//*[local-name()='Detail']");
    $jsonData = [];

    if (count($body) === 1) {
        $doc = dom_import_simplexml($body[0]);
        $content = $doc->nodeValue;

        $rows = explode("\n", $content);
        $headers = array_shift($rows);
        $headers = str_getcsv($headers);

        foreach ($rows as $row) {
            if (strlen($row)) {
                $jsonData[] = array_combine(
                    $headers,
                    str_getcsv($row)
                );
            }
        }
    }

    $data['payload'] = json_encode($jsonData);

    return $data;
}

Introduction

Having installed the Peoplevox connector and applied pre and post request scripts, you're ready start using the connector in process flows.

If you build a process flow with Peoplevox defined as a target connection shape, you must always include a script shape immediately before the connection shape, and associate this with the setData custom script. This script takes care of data conversions that are required before sending data into Peoplevox.

The steps

Step 1 Build your process flow in the usual way, including a connection shape configured for Peoplevox as a target.

Step 2 Immediately before the Peoplevox connection, add a script shape - for example:

Step 3 In custom script settings, select the PVX setData script:

Step 4 Save the shape - the script is added to you flow: