https://github.com/apteco/customchannels
Custom Channels made for usage in the Apteco Marketing Suite
https://github.com/apteco/customchannels
apteco powershell
Last synced: about 1 year ago
JSON representation
Custom Channels made for usage in the Apteco Marketing Suite
- Host: GitHub
- URL: https://github.com/apteco/customchannels
- Owner: Apteco
- Created: 2019-12-19T17:14:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-23T11:21:58.000Z (about 3 years ago)
- Last Synced: 2025-01-12T20:25:48.345Z (about 1 year ago)
- Topics: apteco, powershell
- Language: PowerShell
- Size: 47.7 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](Dummy/)
## Current Status
Legend:
* The icons mean if functionalities are Available/Implemented
* :heavy_check_mark: = "done"
* :o: = "partially implemented"
* :x: = "not implemented"
* :question: = "not checked yet"
### Email
Integration|API|Type|Functionalities|Link
-|-|-|-|-
**Email**|
Agnitas EMM||REST/SFTP|:heavy_check_mark:/:heavy_check_mark:GetMessages
:heavy_check_mark:/:heavy_check_mark:SendTest
:heavy_check_mark:/:o:PreviewMessage
:heavy_check_mark:/:o:PreviewMessagePersonalised
:heavy_check_mark:/:heavy_check_mark:Upload
:heavy_check_mark:/:heavy_check_mark:Broadcast
:heavy_check_mark:/:heavy_check_mark: Response Download
:heavy_check_mark:/:heavy_check_mark:Trigger FERGE|Currently in the dev-branch
Bertelsmann eLettershop||REST/SFTP|:heavy_check_mark:/:heavy_check_mark:GetMessages
:question:/:x:SendTest
:heavy_check_mark:/:heavy_check_mark:PreviewMessage
:x:/:x:PreviewMessagePersonalised
:heavy_check_mark:/:heavy_check_mark:Upload
:heavy_check_mark:/:heavy_check_mark:Broadcast
:heavy_check_mark:/:heavy_check_mark: Response Download
:heavy_check_mark:/:heavy_check_mark:Trigger FERGE|Code is private
CleverReach|Mailings
Tags
THEA|REST API v3|:heavy_check_mark:/:heavy_check_mark:GetMessages
:heavy_check_mark:/:o:SendTest
:heavy_check_mark:/:o:PreviewMessage
:x:/:x:PreviewMessagePersonalised
:heavy_check_mark:/:heavy_check_mark:Upload
:heavy_check_mark:/:o:Broadcast
:heavy_check_mark:/:o: Response Download
:heavy_check_mark:/:x:Trigger FERGE|[CleverReach Mailing Integration Guideline](CleverReach/Mailing)
[CleverReach Tagging Integration Guideline](CleverReach/Tagging)
ELAINE|Transactional|REST|:heavy_check_mark:/:heavy_check_mark:GetMessages
:heavy_check_mark:/:o:SendTest
:heavy_check_mark:/:o:PreviewMessage
:heavy_check_mark:/:o:PreviewMessagePersonalised
:heavy_check_mark:/:heavy_check_mark:Upload
:heavy_check_mark:/:heavy_check_mark:Broadcast
:heavy_check_mark:/:o: Response Download
:heavy_check_mark:/:o:Trigger FERGE|[ELAINE Transactional Mailing Integration Guideline](ELAINE/Transactional)
Flexmail|ImportRecipients|SOAP|:heavy_check_mark:/:heavy_check_mark:GetMessages
:question:/:x:SendTest
:heavy_check_mark:/:heavy_check_mark:PreviewMessage
:x:/:x:PreviewMessagePersonalised
:heavy_check_mark:/:heavy_check_mark:Upload
:question:/:x:Broadcast
:heavy_check_mark:/:heavy_check_mark: Response Download
:heavy_check_mark:/:x:Trigger FERGE|[Flexmail Integration Guideline](Flexmail)
Inxmail|Professional|REST|:heavy_check_mark:/:heavy_check_mark:GetMessages
:heavy_check_mark:/:heavy_check_mark:SendTest
:heavy_check_mark:/:heavy_check_mark:PreviewMessage
:heavy_check_mark:/:heavy_check_mark:PreviewMessagePersonalised
:heavy_check_mark:/:heavy_check_mark:Upload
:heavy_check_mark:/:heavy_check_mark:Broadcast
:heavy_check_mark:/:heavy_check_mark: Response Download
:heavy_check_mark:/:heavy_check_mark:Trigger FERGE|Currently in the dev-branch
Mailchimp||REST|:heavy_check_mark:/:heavy_check_mark:GetMessages
:heavy_check_mark:/:heavy_check_mark:SendTest
:heavy_check_mark:/:o:PreviewMessage
:x:/:x:PreviewMessagePersonalised
:heavy_check_mark:/:heavy_check_mark:Upload
:heavy_check_mark:/:heavy_check_mark:Broadcast
:x:/:x: Response Download
:x:/:x:Trigger FERGE|Sample implementation demonstrated at Apteco Live 2022. [Mailchimp Integration Guideline](Mailchimp)
Optimizely Campaign|Closed Loop Smart Campaigns|SOAP|:heavy_check_mark:/:heavy_check_mark:GetMessages
:question:/:x:SendTest
:heavy_check_mark:/:o:PreviewMessage
:x:/:x:PreviewMessagePersonalised
:heavy_check_mark:/:heavy_check_mark:Upload
:question:/:x:Broadcast
:heavy_check_mark:/:x: Response Download
:heavy_check_mark:/:x:Trigger FERGE|[EpiServer SC Integration Guideline](OptimizelyCampaign/SmartCampaigns)
Optimizely Campaign|Marketing Automation/
Transactional Mailings|SOAP|:heavy_check_mark:/:heavy_check_mark:GetMessages
:heavy_check_mark:/:x:SendTest
:heavy_check_mark:/:x:PreviewMessage
:x:/:x:PreviewMessagePersonalised
:heavy_check_mark:/:heavy_check_mark:Upload
:heavy_check_mark:/:heavy_check_mark:Broadcast
:heavy_check_mark:/:o: Response Download
:heavy_check_mark:/:x:Trigger FERGE|[EpiServer MA Integration Guideline](OptimizelyCampaign/MarketingAutomation)
**Print**|
Deutsche Post|TriggerDialog|REST|:heavy_check_mark:/:o:Upload
:heavy_check_mark:/:o:Broadcast|[TriggerDialog Integration Guideline](TriggerDialog)
Bertelsmann|Campaign Automation|||Only on request
Optilyz|S3|AWS-S3/REST|:heavy_check_mark:/:heavy_check_mark:ChooseAutomation
:heavy_check_mark:/:heavy_check_mark:Upload|[Optilyz Integration Guideline](Optilyz/AWS)
Optilyz|REST|REST|:heavy_check_mark:/:heavy_check_mark:ChooseAutomation
:heavy_check_mark:/:heavy_check_mark:Upload|[Optilyz Integration Guideline](Optilyz/REST)
**Mobile**|
Syniverse|SMS
WhatsApp Business API|REST|:heavy_check_mark:/:heavy_check_mark:GetMessages
:question:/:x:SendTest
:heavy_check_mark:/:heavy_check_mark:PreviewMessage
:question:/:heavy_check_mark:PreviewMessagePersonalised
:heavy_check_mark:/:heavy_check_mark:Upload
:heavy_check_mark:/:heavy_check_mark:Broadcast
:heavy_check_mark:/:heavy_check_mark: Response Download
:heavy_check_mark:/:o:Trigger FERGE
:heavy_check_mark:/:heavy_check_mark: Webhooks Support|[Syniverse Mobile Integration Guideline](Syniverse/SyniverseSMS)
Syniverse|Number Verification|REST|:heavy_check_mark:/:heavy_check_mark:GetMessages
:heavy_check_mark:/:heavy_check_mark:Upload
:heavy_check_mark:/:heavy_check_mark: Mobile Results Download|[Syniverse Mobile Validation Integration Guideline](Syniverse/SyniverseValidation)
Syniverse|Wallet Download|REST|:heavy_check_mark:/:heavy_check_mark: Webhooks Trigger
:heavy_check_mark:/:heavy_check_mark: Regular Batch Download|[Syniverse Wallet Download Integration Guideline](Syniverse/SyniverseWalletDownload)
Syniverse|Wallet Notification|REST|:heavy_check_mark:/:heavy_check_mark:GetMessages
:x:/:x:SendTest
:heavy_check_mark:/:heavy_check_mark:PreviewMessage
:question:/:x:PreviewMessagePersonalised
:heavy_check_mark:/:heavy_check_mark:Upload
:heavy_check_mark:/:heavy_check_mark:Broadcast
:question:/:x: Response Download
:question:/:x:Trigger FERGE|[Syniverse Wallet Notification Integration Guideline](Syniverse/SyniverseWalletNotification)
Syniverse|Wallet Update|REST|:heavy_check_mark:/:heavy_check_mark: Update wallets|[Syniverse Wallet Update Integration Guideline](Syniverse/SyniverseWalletUpdate)
**Database**|
MSSQL / SQL Server|Local
Domain
PrivateCloud|PowerShell/.NET
Bulk|:heavy_check_mark:/:heavy_check_mark:GetMessages
:heavy_check_mark:/:heavy_check_mark:Upload
:heavy_check_mark:/:heavy_check_mark: Data Results Download|[MSSQL Integration Guideline](MSSQL)
sqlite|Local
Network
In-Memory|PowerShell/.NET/sqliteCLI|
**File Transfer**|
WinSCP|SFTP
FTP
S3
WebDAV
SCP (SSH)|WinSCP .NET assembly|:x:/:x:GetMessages
:heavy_check_mark:/:heavy_check_mark:Upload
:o:/:o: Data Results Download|[WinSCP Integration Guideline](WinSCP)
**Picture Personalisation**|
AlphaPicture||REST|:heavy_check_mark:/:heavy_check_mark: Choose Picture
:heavy_check_mark:/:heavy_check_mark: Personalised Preview
:heavy_check_mark:/:heavy_check_mark: Download personalised links
:heavy_check_mark:/:heavy_check_mark: Single generation
:heavy_check_mark:/:heavy_check_mark: Batch generation
:heavy_check_mark:/:heavy_check_mark: 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.