AptecoCustomChannels

Custom Channels made for usage in the Apteco Marketing Suite

Dummy Template / Getting started

To start with your very own first custom channel to use in Apteco PeopleStage, you can use the dummy template without external dependencies. It is pure PowerShell (>=5.1). You can find it here: Dummy

Current Status

Legend:

• The icons mean if functionalities are Available/Implemented
• ✔️ = "done"
• ⭕ = "partially implemented"
• ❌ = "not implemented"
• ❓ = "not checked yet"

Email

Integration	API	Type	Functionalities	Link
Email
Agnitas EMM		REST/SFTP	✔️/✔️GetMessages ✔️/✔️SendTest ✔️/⭕PreviewMessage ✔️/⭕PreviewMessagePersonalised ✔️/✔️Upload ✔️/✔️Broadcast ✔️/✔️ Response Download ✔️/✔️Trigger FERGE	Currently in the dev-branch
Bertelsmann eLettershop		REST/SFTP	✔️/✔️GetMessages ❓/❌SendTest ✔️/✔️PreviewMessage ❌/❌PreviewMessagePersonalised ✔️/✔️Upload ✔️/✔️Broadcast ✔️/✔️ Response Download ✔️/✔️Trigger FERGE	Code is private
CleverReach	Mailings Tags THEA	REST API v3	✔️/✔️GetMessages ✔️/⭕SendTest ✔️/⭕PreviewMessage ❌/❌PreviewMessagePersonalised ✔️/✔️Upload ✔️/⭕Broadcast ✔️/⭕ Response Download ✔️/❌Trigger FERGE	CleverReach Mailing Integration Guideline CleverReach Tagging Integration Guideline
ELAINE	Transactional	REST	✔️/✔️GetMessages ✔️/⭕SendTest ✔️/⭕PreviewMessage ✔️/⭕PreviewMessagePersonalised ✔️/✔️Upload ✔️/✔️Broadcast ✔️/⭕ Response Download ✔️/⭕Trigger FERGE	ELAINE Transactional Mailing Integration Guideline
Flexmail	ImportRecipients	SOAP	✔️/✔️GetMessages ❓/❌SendTest ✔️/✔️PreviewMessage ❌/❌PreviewMessagePersonalised ✔️/✔️Upload ❓/❌Broadcast ✔️/✔️ Response Download ✔️/❌Trigger FERGE	Flexmail Integration Guideline
Inxmail	Professional	REST	✔️/✔️GetMessages ✔️/✔️SendTest ✔️/✔️PreviewMessage ✔️/✔️PreviewMessagePersonalised ✔️/✔️Upload ✔️/✔️Broadcast ✔️/✔️ Response Download ✔️/✔️Trigger FERGE	Currently in the dev-branch
Mailchimp		REST	✔️/✔️GetMessages ✔️/✔️SendTest ✔️/⭕PreviewMessage ❌/❌PreviewMessagePersonalised ✔️/✔️Upload ✔️/✔️Broadcast ❌/❌ Response Download ❌/❌Trigger FERGE	Sample implementation demonstrated at Apteco Live 2022. Mailchimp Integration Guideline
Optimizely Campaign	Closed Loop Smart Campaigns	SOAP	✔️/✔️GetMessages ❓/❌SendTest ✔️/⭕PreviewMessage ❌/❌PreviewMessagePersonalised ✔️/✔️Upload ❓/❌Broadcast ✔️/❌ Response Download ✔️/❌Trigger FERGE	EpiServer SC Integration Guideline
Optimizely Campaign	Marketing Automation/ Transactional Mailings	SOAP	✔️/✔️GetMessages ✔️/❌SendTest ✔️/❌PreviewMessage ❌/❌PreviewMessagePersonalised ✔️/✔️Upload ✔️/✔️Broadcast ✔️/⭕ Response Download ✔️/❌Trigger FERGE	EpiServer MA Integration Guideline
Print
Deutsche Post	TriggerDialog	REST	✔️/⭕Upload ✔️/⭕Broadcast	TriggerDialog Integration Guideline
Bertelsmann	Campaign Automation			Only on request
Optilyz	S3	AWS-S3/REST	✔️/✔️ChooseAutomation ✔️/✔️Upload	Optilyz Integration Guideline
Optilyz	REST	REST	✔️/✔️ChooseAutomation ✔️/✔️Upload	Optilyz Integration Guideline
Mobile
Syniverse	SMS WhatsApp Business API	REST	✔️/✔️GetMessages ❓/❌SendTest ✔️/✔️PreviewMessage ❓/✔️PreviewMessagePersonalised ✔️/✔️Upload ✔️/✔️Broadcast ✔️/✔️ Response Download ✔️/⭕Trigger FERGE ✔️/✔️ Webhooks Support	Syniverse Mobile Integration Guideline
Syniverse	Number Verification	REST	✔️/✔️GetMessages ✔️/✔️Upload ✔️/✔️ Mobile Results Download	Syniverse Mobile Validation Integration Guideline
Syniverse	Wallet Download	REST	✔️/✔️ Webhooks Trigger ✔️/✔️ Regular Batch Download	Syniverse Wallet Download Integration Guideline
Syniverse	Wallet Notification	REST	✔️/✔️GetMessages ❌/❌SendTest ✔️/✔️PreviewMessage ❓/❌PreviewMessagePersonalised ✔️/✔️Upload ✔️/✔️Broadcast ❓/❌ Response Download ❓/❌Trigger FERGE	Syniverse Wallet Notification Integration Guideline
Syniverse	Wallet Update	REST	✔️/✔️ Update wallets	Syniverse Wallet Update Integration Guideline
Database
MSSQL / SQL Server	Local Domain PrivateCloud	PowerShell/.NET Bulk	✔️/✔️GetMessages ✔️/✔️Upload ✔️/✔️ Data Results Download	MSSQL Integration Guideline
sqlite	Local Network In-Memory	PowerShell/.NET/sqliteCLI
File Transfer
WinSCP	SFTP FTP S3 WebDAV SCP (SSH)	WinSCP .NET assembly	❌/❌GetMessages ✔️/✔️Upload ⭕/⭕ Data Results Download	WinSCP Integration Guideline
Picture Personalisation
AlphaPicture		REST	✔️/✔️ Choose Picture ✔️/✔️ Personalised Preview ✔️/✔️ Download personalised links ✔️/✔️ Single generation ✔️/✔️ Batch generation ✔️/✔️ Change width/height

Requirements

• An Apteco server with a FastStats Service and 2019-Q3 release or newer. There were some improvements in the 2019-Q4 release.
• Make sure PS Version 5.1 is installed at Minimum (PowerShell Core >=6 is not tested yet)
  • You can see it in Powershell if you type in $PSVersionTable
  • If PSVersion < 5.1, then install this one: https://www.microsoft.com/en-us/download/details.aspx?id=54616
  • And restart the machine

Description

The custom channels can trigger those functionalities

1. GetMessagesScript: used to return an array of string pairs of , of the messages
2. GetListsScript: used to return an array of string pairs of , of the lists
3. TestScript: used to test if the broadcaster api is available
4. SendTestEmailScript: used to send a test send to the broadcaster, given a recipient
5. PreviewMessageScript: used to return a html view of the message given a recipient and content values
6. UploadScript: used to upload a list to the broadcaster, given a tab delimited file
7. BroadcastScript: used to send a list a message

Troubleshooting

• If the files created from PeopleStage and used by the "upload" scripts have the extension .converted then the output encoding in the PeopleStage Channel Editor should be changed to another encoding.
• If some umlauts are not used correctly, then the script is maybe saved in the wrong encoding. It should be UTF-8.

Cloning and get Updates from this Repository

• You can download the whole repository as a zip file, clone it via GitHub Desktop or use a command line interface. All possibilities are shown here:
  
• I can recommend the last two options because then you can "pull" updated code from time to time and can benefit from new features or bugfixes.