Developers Guide
Workflow Overview
Workflow Steps
Create a DeliveryPreferenceQueryContainer XML with the appropriate fields for the desired action.
Save the DeliveryPreferenceQueryContainer XML file with as [UniqueFileName.XML] in the folder specified under DocuTransfer ConnectSuite Settings. The file must have a .XML extension and must be unique.
The processing engine with rename the .XML to ._ML and start processing
Once processing is complete the ._ML file will be deleted and a new file will be created in the output folder specified under DocuTransfer ConnectSuite Settings.
The caller will pick up the same file [UniqueFileName.XML]
It is the responsibility of the caller to delete the output file once it has been processed.
Delivery Preference Query XML Fields
version
Description: processing version engine
Data type: string
Values: 1.00
action
Description: action for the processing engine to perform
Data type: string
Values: See Upload Action Notes below
jobdescription
Description: description of job, used for upload action
Data type: string
Values: alphanumeric
campaignkey
Description: unique key of the campaign to modify, used for campaign_modify
Data type: string
Values: alphanumeric
deliverypreferenceitemquerylist
Description: list of deliverypreferenceitem nodes to be processed/returned
Data type: list of deliverypreferenceitem nodes
Values: structure
errors
Description: errors that occurred during processing Data type: alphanumeric Values:
Delivery Preference Item XML Fields
customer
Description: customer information
Data type: customer XML
Values: structure
documentkey
Description: Connect-Suite document type key
Data type: string
Values: alphanumeric
documentpath
Description: local path of document to be uploaded to Connect-Suite
Data type: string
Values: alphanumeric
Description: returned value if customer prefers print
Data type: integer
Values: 0=no, 1=yes
Description: returned value if customer prefers email
Data type: integer
Values: 0=no, 1=yes
errors
Description: errors that occurred for current item
Data type: alphanumeric
Customer XML Fields
customerid
Description: unique customer id
Data type: long
Values: system variable
guid
Description: unique customer guid
Data type: string
Values: system variable
companyid
Description: unique company id Data type: log Values: system variable
customerkey
Description: unique key used to drive paper suppression adoption Data type: log Values: system variable
accountnumber
Description: unique account number that identified customer
Data type: string
Values:
Required: yes
name
Description: customer name
Data type: string
Values:
Required: yes
name2
Description: customer name
Data type: string
Values: Required: no
name3
Description: customer name
Data type: string
Values:
Required: no
street1
Description: customer street
Data type: string
Values:
Required: yes
street2
Description: customer street
Data type: string
Values:
Required: no
citytown
Description: customer city town
Data type: string
Values:
Required: no
stateprov
Description: customer state prov
Data type: string
Values:
Required: no
postalcode
Description: customer postal code
Data type: string
Values:
Required: no
country
Description: customer country
Data type: string
Values:
Required: no
phone
Description: customer phone
Data type: string
Values:
Required: no
mobilephone
Description: customer mobile phone
Data type: string
Values:
Required: no
Upload Action Notes
Delivery_Preference
Account number and name are required
Reads customer info
Updates customer record only when Delivery Preference Customer Update Method is set to Update Customer in web portal configuration.
No customer record fields will be deleted unless asterisk (*) is inputted
Does not update document preference
Upload - Creates job
Account number and name are required
Stops after first failure
Creates customer record if not already created
Campaign_Modify - Add or remove customer from external campaign
Account number and name are required
Detects invalid campaign key
Choose external campaign using <campaignkey/> node
Add customer to campaign: <customeractive>1</customeractive>
Remove customer from campaign: <customeractive>2</customeractive>
Creates customer record if not already created
No customer record fields will be deleted unless asterisk (*) is inputted
Update_Customer - Update customer record with new information
Account number and name are required
Action will fail if name is not present
No customer record fields will be deleted unless asterisk (*) is inputted
Delivery Preference Customer Update Method must be set to Update Customer in web portal configuration.
Does not set changed flag (see Get_Customer_Changed)
Creates customer record if not already created
Campaign_Modify_Update_Customer - Combination of both upload actions (Update_Customer and Campaign_Modify)
Detects invalid campaign key
Account number and name are required
Campaign must be external
Add customer to campaign: <customeractive>1</customeractive>
Remove customer from campaign: <customeractive>2</customeractive>
Creates customer record if not already created. Delivery Preference Customer Update Method must be set to Update Customer in web portal configuration.
Get_Customer_Changed - Pulls back an XML with all customer who have changed flag set.
Get_Reprints - Pulls all company reprints to Output/Reprints, Stops after first failure