REST

Setup on the application server

• Download the whole repository
  
  
• Put the scripts that you need to a directory on the application server
• Depending on your Windows security settings you maybe are not allowed to execute the downloaded PowerShell scripts. If this is the case, please go to the Properties of the files and unblock the scripts to allow the usage
• Execute optilyz__00__create_settings.ps1 and enter your token from Optilyz
• If you want to test the communication, open optilyz__10__getmailings.ps1, set the debug mode to $true and execute it
  
  

Setup in PeopleStage

• Create a new channel with a name like Print - Optilyz
  
  
  
  
• Choose PowerShell as the integration, username and password filled with dummy values, the email variable (the variable is not used for the print) and the message Content type like in the screenshot
  
  
  
  
• Make sure the Export is in utf-8 and uses double quotes for string values
  
  
  
  
• Setup your parameters like in the screenshot and make sure you refer to the correct files
  
  
  
  
• Setup the variables and change the descriptions in the second column so they fit to the ones from Optilyz
  
  
  
  See the chapter Field Mapping for more information
  
  
• The first campaign then can look like this
  
  
  
  
• In the content step you can use individualisation1, individualisation2, etc. as many times as you want; use variation to choose the variation of the Optilyz automation (e.g. 1 for the female variation, 2 for the male variation)
  
  
  
  
• Then you can choose the Optilyz automation where the data should be uploaded to
  
  
  
  

Field Mapping

The information here is referring to the api documentation of Optilyz: https://www.optilyz.com/doc/api/#api-Recipients-EnqueueMultipleRecipient

Following fields are can be used in PeopleStage in connection with Optilyz:

Field	Optional
title	x
otherTitles	x
jobTitle	x
gender	x
companyName1	x
companyName2	x
companyName3	x
individualisation1	x
individualisation2	x
individualisation3	x
careOf	x
firstName	x
lastName
fullName
houseNumber
street
address1
address2	x
zipCode
city
country	x

Notes:

• Individualisation appended with a number can be used infinitely
• You have to define
  • fullName OR
    firstName and lastName
  • address1 OR
    street and houseNumber
• If no variation is provided in the campaign, then the variation will be chosen by random