Import Sales Orders into Peoplevox
This task will import sales order information to Peoplevox in XML format, for detailed information see Peoplevox XML Sales Orders. The information is imported using the standard fields under Integration Templates that can be configured through your Peoplevox web application.
Please note, the fields must use the default names, you can import the correct configuration using the file below.
Integration Templates
Sales Order
SalesOrderNumber,Customer,CustomerPurchaseOrderReferenceNumber,ShippingAddressLine1,ShippingAddressLine2,ShippingAddressCity,ShippingAddressRegion,ShippingAddressPostcode,ShippingAddressCountry,ShippingAddressReference,InvoiceAddressLine1,InvoiceAddressLine2,InvoiceAddressCity,InvoiceAddressRegion,InvoiceAddressPostcode,InvoiceAddressCountry,InvoiceAddressReference,IsPartialShipment,Status,RequestedDeliveryDate,ShippingCost,Email,ContactName,TotalSale,Discount,TaxPaid,CreatedDate,PaymentMethod,ServiceType,ChannelName
Sales Order Item
Connection Settings
Peoplevox Connection
Required
The connection to the Peoplevox instance to use. See the Connecting to Peoplevox if you require more information on how to create/manage connections.
Customer Settings
Auto Create Customer
Required
Set to true to create customer records based on your match field task settings and the CustomerData in the XML you provide.
Match Customers On
Optional
If Auto Create Customers is set to true, optionally match existing customers based on one or many of the following field(s):
- Name
- FirstName
- LastName
- Phone
- Mobile
File Settings
Fail File
Required
The name or full path to the file failed records will be saved to.
Defaults to peoplevox_import_sales_orders_fail.xml
Input File
Required
The name or full path to the file the data to be imported will be read from.
Defaults to peoplevox_import_sales_orders.xml
Success File
Required
The name or full path to the file successfully imported records will be saved to.
Defaults to peoplevox_import_sales_orders_success.xml
Import Settings
Prevent Reprocessing
Required
Set to True if you only want to process a record once, or False to update every time. Defaults to False.
For Prevent Reprocessing to work, ExternalId must be specified in the XML
Timeout (In Minutes)
Required
Maximum amount of time in minutes that Zynk will wait for a response per call made. Defaults to 10.
Validate Templates
Required
Optionally valid the template configured in Peoplevox against the Zynk object. Any fields that are not set up on the template or that do not match the Zynk object will be logged out as a warning.
Item Type Settings
Auto Create Item Types
Required
Set to true to automatically create item types if they do not exist in Peoplevox.
Default Item Type Code
Optional
Optionally set the item code to this value when the item type does not exist
Item Type Name
Required
When automatically creating item type records, use the value of this field to set the item type name.
Match Item Types On
Required
Match the item code value from your item to one of these fields
Retry Settings
Optional
You can configure the retry settings on each Peoplevox import task to optionally retry records until they are successfully imported into Peoplevox. This is useful when faced with intermittent connectivity problems with Peoplevox.
Any records that fail for reasons given in the Errors collection will be written to a file and placed in a directory of your choice. Every time that import task runs the files from that folder will be retried until they are successful. You can also optionally choose to clean the retry folder if a record is still unsuccessful after a certain number of days.
Archive
Optional
Optionally archive the files stored in the retry folder.
Archive Days
Optional
If Archive is set to true, then archive the files stored in the retry folder after this many days.
Errors
Optional
Attempt to import sales orders again that have for the errors listed here. Please note, you don't have to give the full error, if you provide an excerpt from the error that is sufficient.
Folder
Optional
The folder to place your the files to retry.
Retry
Optional
Set the Retry task setting to true to enable the settings you have configured.
Sales Order Settings
Site
Optional
You can optionally select the site to import orders into, if not set the Site set for each Order in the Input File will be used. Use the dropdown menu to pick from the sites you have setup on your Peoplevox instance.
Zynk Settings
Example XML
Example input file, for detailed information see Peoplevox XML Sales Orders.
<?xml version="1.0" encoding="utf-8"?>
<SalesOrders>
<SalesOrder>
<ExternalId>1</ExternalId>
<SalesOrderNumber>SO-123456</SalesOrderNumber>
<Customer>Andrew Snape</Customer>
<CustomerPurchaseOrderReferenceNumber>SO-ABCDEF</CustomerPurchaseOrderReferenceNumber>
<ShippingAddressLine1>i6</ShippingAddressLine1>
<ShippingAddressLine2>6 - 8 Charlotte Square</ShippingAddressLine2>
<ShippingAddressCity>Newcastle</ShippingAddressCity>
<ShippingAddressRegion>Tyne and Wear</ShippingAddressRegion>
<ShippingAddressPostcode>NE1 4XF</ShippingAddressPostcode>
<ShippingAddressCountry>United Kingdom</ShippingAddressCountry>
<ShippingAddressReference>WORK</ShippingAddressReference>
<InvoiceAddressLine1>i6</InvoiceAddressLine1>
<InvoiceAddressLine2>6 - 8 Charlotte Square</InvoiceAddressLine2>
<InvoiceAddressCity>Newcastle</InvoiceAddressCity>
<InvoiceAddressRegion>Tyne and Wear</InvoiceAddressRegion>
<InvoiceAddressPostcode>NE1 4XF</InvoiceAddressPostcode>
<InvoiceAddressCountry>United Kingdom</InvoiceAddressCountry>
<InvoiceAddressReference>WORK</InvoiceAddressReference>
<IsPartialShipment>true</IsPartialShipment>
<Status>New</Status>
<RequestedDeliveryDate>2017-07-20 00:00:00</RequestedDeliveryDate>
<ShippingCost>5</ShippingCost>
<Email>[email protected]</Email>
<ContactName>Andrew Snape</ContactName>
<TotalSale>18</TotalSale>
<Discount>0</Discount>
<TaxPaid>3</TaxPaid>
<CreatedDate>2017-07-11 00:00:00</CreatedDate>
<PaymentMethod>1</PaymentMethod>
<ServiceType></ServiceType>
<ChannelName>Website</ChannelName>
<Site>PrimarySite</Site>
<SalesOrderItems>
<SalesOrderItem>
<ItemCode>PROD001</ItemCode>
<QuantityOrdered>1</QuantityOrdered>
<RequestedDeliveryDate>2017-07-19 00:00:00</RequestedDeliveryDate>
<Line></Line>
<Sequence>1</Sequence>
<SalePrice>10</SalePrice>
</SalesOrderItem>
</SalesOrderItems>
</SalesOrder>
</SalesOrders>