User Tools

Site Tools


en:dataexchange:import_which_properties_has_batchprocess

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
en:dataexchange:import_which_properties_has_batchprocess [2019/06/04 16:44] – [Standard field structure (internal)] fwen:dataexchange:import_which_properties_has_batchprocess [2025/04/02 16:39] (current) fw
Line 5: Line 5:
  
 Please upload csv-files with addresses or target group definitions (with customer IDs or eMail addresses) to /upload/manual.  Please upload csv-files with addresses or target group definitions (with customer IDs or eMail addresses) to /upload/manual. 
-Click on //Adresses > Lists//, choose action //Import addresses// and follow the given instructions. +Click on //Adresses > Lists//, choose action //Import addresses// and follow the given instructions.  You can find a manual in article //"[[en:how_to_upload_addresses]]"//.
  
  
Line 42: Line 42:
 |**Time of import**|Process is checking whether a file has been uploaded: daily at x o'clock OR every 5 minutes.| |**Time of import**|Process is checking whether a file has been uploaded: daily at x o'clock OR every 5 minutes.|
 |**Creating a new target group**|Per import OR adding to a auto target group.| |**Creating a new target group**|Per import OR adding to a auto target group.|
-|**If auto target group**|1) Adding OR replacing of the auto target group - possible methods: \\ - replace \\ - replaceNoResubscribes \\ - add \\ - addNoResubscribes \\ \\ 2) if auto target group is replaced: \\ Unsubscribing of all users that are not included in the current file?* \\ \\ <wrap lo>*critical feature; only possible if user data are synchronized completely and every night because users will be added to the blacklist.</wrap>|+|**If auto target group**|1) Adding OR replacing of the auto target group - possible methods: \\ - replace \\ - replaceNoResubscribes \\ - add \\ - addNoResubscribes \\ \\ 2) if auto target group is replaced: \\ Unsubscribing of all users that are not included in the current file?* \\ * Please note: this is not recommended and only possible if user data are synchronized completely and every night because users will be added to the blacklist.|
  
  
Line 132: Line 132:
 |reg_ip|varchar(255)| |Registration IP| |reg_ip|varchar(255)| |Registration IP|
 |agr|tinyint(3)|0|Advertisement agreement (1=given)| |agr|tinyint(3)|0|Advertisement agreement (1=given)|
-|tel|varchar(255)| | |  +|tel|varchar(255)| |phone number |  
-|birthday|date|0000-00-00| |  +|birthday|date|0000-00-00|birthday|  
 |special_1|varchar(255)| |Free variable for future use| |special_1|varchar(255)| |Free variable for future use|
 |special_2|varchar(255)| |Free variable for future use| |special_2|varchar(255)| |Free variable for future use|
  
-===== Automatic dispatch after importing a target group =====+===== Automatic delivery after importing a target group =====
  
-After the automatic import of a target group, you can carry out additional tasks by invoking an API call. A common application is the automatic set-up of an email with subsequent dispatch+After the automatic import of a target group, you can trigger additional tasks by invoking an API call. A common application is the automatic set-up of an e-mail with subsequent delivery
  
 This requires configuring an automatic import process through promio.net support.  This requires configuring an automatic import process through promio.net support. 
  
-To do so, you must provide two files in a ZIP archive +To do so, you must provide the two files //user.csv// und //action.json// in a ZIP archive. \\  
 +This ZIP file must be named according to the agreed upon naming scheme and provided in the SFTP folder /upload/auto for automatic processing. 
  
 ==== user.csv ==== ==== user.csv ====
Line 156: Line 156:
  
  
-==== action.xml ====+==== action.json ====
  
-Contains the SOAP API call to be invoked after the automatic import. %CHECKSUM%, %REQUEST_ID% and %TARGETGROUP_ID% must remain unchanged; these placeholders are replaced automatically after import+Contains campaign and target group information in JSON format. \\ 
 +These are used after the automatic import for the execution of REST API calls.
  
-The other values must be filled out correctly. Be certain to ensure that all text uses HTML entities throughout.  
  
-<code> +=== Maximum specification with all necessary and optional properties === 
- < =&lt; +<code JavaScript
- =&gt; +
-etc.+ "clientId": 10105, 
 + "campaign": {  
 +   "name": "My campaign",  
 +   "code": "ABC-123-DEF", 
 +   "clientId": 12125, 
 +   "newsletterId": 82384 
 + }, 
 + "message": {  
 +     "templateId": 2861485,  
 +     "format": "html", 
 +     "name": "My message",  
 +     "sendFromId": 12944, 
 +     "sendFromName": "promio.net newsletter", 
 +     "locale": "de_DE", 
 +     "creative":
 +       "content": "<html>\n <head>\n   <title>My first message</title>\n </head>\n <body>\n   <p>Hello World!</p>\n </body>\n</html>\n", 
 +       "subject": "My subject" 
 +     }, 
 +     "text":
 +       "content": "Hello World.\n" 
 +     } 
 + }, 
 + "targetGroup":
 +   "filter":
 +     "includes":
 +       315089 
 +     ], 
 +     "excludes":
 +       { 
 +         "type": "list", 
 +         "id": 100898 
 +       } 
 +     ] 
 +   }, 
 +   "limit":
 +     "amount": 50000, 
 +     "type": "mostActive" 
 +   } 
 + }, 
 + "delivery":
 +   "schedule":
 +     "scheduledForDeliveryAt": "2025-03-01 12:00"  
 +   }, 
 +   "start":
 +     "mailsPerHourLimit": 5000, 
 +     "resetStatistics": true, 
 +     "refreshAutoTargetGroup": true 
 +   }, 
 +   "sendTest":
 +     "recipients":
 +       { 
 +         "custId": "abc-1234", 
 +         "mail": "max.mustermann@musterdomain.de", 
 +         "lastName": "Mustermann", 
 +         "firstName": "Max", 
 +         "gender": 1, 
 +         "street": "Musterstraße 4", 
 +         "city": "Musterstadt", 
 +         "countryCode": "DE", 
 +         "postcode": "12345", 
 +         "birthday": "1986-02-12", 
 +         "phoneNumber": 4912345678 
 +       } 
 +     ] 
 +   } 
 + } 
 +}
 </code> </code>
  
-<code xml> +=== Required fields and instructions ===
-<?xml version="1.0" encoding="UTF-8"?> +
-<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://api.promio-mail.com/1.4/soap/" +
-                   xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +
-                   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" +
-                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> +
-    <SOAP-ENV:Body> +
-        <ns1:createDelivery> +
-            <authentification xsi:type="ns1:authentification"> +
-                <checksum xsi:type="xsd:string">%CHECKSUM%</checksum> +
-                <requestId xsi:type="xsd:string">%REQUEST_ID%</requestId> +
-                <requestIdBlockedMinutes xsi:type="xsd:integer">0</requestIdBlockedMinutes> +
-            </authentification> +
-            <delivery xsi:type="ns1:delivery"> +
-                <format xsi:type="ns1:contentType">html</format> +
-                <clientId xsi:type="xsd:integer">$CLIENTID$</clientId> +
-                <deliveryReceiver xsi:type="ns1:deliveryReceiver"> +
-                    <targetGroupAndSendFromId xsi:type="ns1:targetGroupAndSendFromId"> +
-                        <targetGroupId xsi:type="xsd:integer">%TARGETGROUP_ID%</targetGroupId> +
-                        <sendFromId xsi:type="xsd:integer">$SEND_FROM_ID$</sendFromId> +
-                    </targetGroupAndSendFromId> +
-                </deliveryReceiver> +
-                <deliverySendTime xsi:type="ns1:deliverySendTime"> +
-                    <sendDelayMinutes xsi:type="xsd:integer">$SEND_DELAY_MINUTES$</sendDelayMinutes> +
-                </deliverySendTime> +
-                <sendTestMail xsi:type="xsd:boolean">false</sendTestMail> +
-                <delivery xsi:type="xsd:boolean">false</delivery> +
-                <subject xsi:type="xsd:string">Betreffzeile</subject> +
-                <description xsi:type="xsd:string">Testcampaign</description> +
-                <campaignCode xsi:type="xsd:string">test</campaignCode> +
-                <contentHtml xsi:type="xsd:string"> +
-                    &lt;h1&gt;Content&lt;/h2&gt;&lt;p&gt; some escaped HTML &lt;/p&gt; +
-                </contentHtml> +
-                <contentText xsi:type="xsd:string">Content text as text/plain</contentText> +
-            </delivery> +
-        </ns1:createDelivery> +
-    </SOAP-ENV:Body> +
-</SOAP-ENV:Envelope>+
  
-</code> +  * //clientId//: 
- +    * necessary. Enter ID of the client. 
-This ZIP file must be named according to the agreed upon naming scheme and saved in the SFTP folder /upload/auto for automatic processing+  * //campaign//: 
 +    * required. Required field within: //name// 
 +    * Docs: [[https://api.promio-connect.com/docs/3.1/#tag/campaign-write/operation/createCampaign|REST API - create campaign]] 
 +  * //message//: 
 +    * required 
 +    * if //templateId// exists 
 +      * message is built from a template 
 +      * required: //name// 
 +    * if //templateId// not exists 
 +      * required: //name// 
 +      * Docs: [[https://api.promio-connect.com/docs/3.1/#tag/Create-or-update-messages/operation/createMessage|REST API - create message]] 
 +    * //creative//: 
 +      * required for messages that are not created by a template 
 +      * required fields: //content//, //subject// 
 +    * //text//: 
 +      * optional. Only necessary for a different text part. If //text// is not specified, the text part is automatically generated from the HTML of the multipart e-mail.  
 +  * //targetGroup// 
 +      * optional. Only necessary for setting //filter// and //limit//. 
 +      * Target group ID is assigned automatically. 
 +      * Docs: [[https://api.promio-connect.com/docs/3.1/#tag/Target-message-audience/operation/assignTargetGroupToMessage|REST API - assign target group]] 
 +  * //delivery// 
 +      * optional.  Only necessary if delivery is to be scheduled or started. 
 +      * settings for delivery 
 +      * //schedule// 
 +        * for scheduling the campaign 
 +        * required: //scheduledForDeliveryAt// 
 +        * Docs: [[https://api.promio-connect.com/docs/3.1/#tag/Manage-campaign-delivery/operation/scheduleCampaign|REST API - schedule delivery]] 
 +      * //start// 
 +        * delivery is only started if //start// is set. 
 +        * no required fields 
 +        * Docs: [[https://api.promio-connect.com/docs/3.1/#tag/Manage-campaign-delivery/operation/sendCampaign|REST API - start delivery]] 
 +      * //sendTest// 
 +        * optional. Send a test mail. 
 +        * Docs: [[https://api.promio-connect.com/docs/3.1/#tag/Testing-messages/operation/sendTestMail|REST API - send test mail]]
  
 +**Important:** \\
 +The source code in //creative// and //text// must be "prepared" for json. 
 +The following (external) website provides information on how to escape, as well as an option to have source text escaped automatically: https://www.freeformatter.com/json-escape.html
  
 +=== Examples ===
  
 +Example of creating a message via HTML source code (incl. start delivery):
 +<code JavaScript>
 +{
 + "clientId": 10105,
 +  "campaign": {
 +    "name": "My campaign"
 +  },
 +  "message": {
 +    "format": "html",
 +    "name": "My message",
 +    "sendFromId": 12944,
 +    "sendFromName": "promio.net newsletter",
 +    "creative": {
 +      "content": "<html>\n  <head>\n    <title>My first message</title>\n </head>\n <body>\n   <p>Hello World!</p>\n </body>\n</html>\n",
 +      "subject": "My subject"
 +    }
 +  },
 +  "delivery": {
 +    "schedule": {
 +      "scheduledForDeliveryAt": "2025-03-01 12:00"
 +    },
 +    "start": {
 +    }
 +  }
 +}
 +</code>
  
 +Example of creating a message via template (without start delivery):
 +<code JavaScript>
 +{
 + "clientId": 10105,
 +  "campaign": {
 +    "name": "My campaign"
 +  },
 +  "message": {
 +    "name": "My message",
 +    "templateId": 2861485
 +  }
 +}
 +</code>
  
  
-{{tag>Import batch process automatic specification nomenclature}} +{{tag>imports batch processes automatical specifications nomenclature record_descriptions }} 
en/dataexchange/import_which_properties_has_batchprocess.1559659478.txt.gz · Last modified: 2019/06/04 16:44 by fw