This task will export activities from ConnectWise in an XML format. The results can be filtered if required. See below for a sample output file.
Settings
Connection
Required
The ConnectWise REST Interface connection to use. See the Connecting to ConnectWise REST Interface article if you require more information on how to create/manage connections.
Export Settings > Date Created
Required
When the ‘Export Modified, New or All Records’ setting is set to ‘New’, only activities created after this date will be exported. This date will update automatically each time the task runs, to ensure only new activities are exported each time.
Export Settings > Date Modified
Required
When the ‘Export Modified, New or All Records’ setting is set to ‘Modified’, only activities updated after this date will be downloaded. This date will update automatically each time the task runs, to ensure only modified activities are exported each time.
Export Settings > Export Modified, New or All Records
Required
Choose which records should be downloaded. The available options are:
- Modified - Only records updated after the date shown in the ‘Date Modified’ setting will be downloaded.
- New - Only records created after the date shown in the ‘Date Created’ setting will be downloaded.
- All - All records will be downloaded, regardless of when they were created or updated.
Export Settings > Page Size
Required
The number of records to include in each page of results. Defaults to 100. Increasing this value will reduce the number of requests made to the API. The maximum value is 1000.
Output File
Required
The name of the file to export the activities to.
References To Fetch
Optional
The exported data may include fields which reference other records in ConnectWise. If you specify the reference field names here, and the task will fetch the related records and include them in the exported data. The supported fields are listed below:
- type
- company
- contact
- status
- assignedBy
- assignTo
- currency
Where Settings > Child Conditions
Optional
Use this setting to specify where clauses to filter the records returned. This setting is used to specify conditions surrounding standard fields which are part of an array.
Where Settings > Conditions
Optional
Use this setting to specify where clauses to filter the records returned. This setting is used to specify conditions surrounding standard fields.
Where Settings > Custom Field Conditions
Optional
Use this setting to specify where clauses to filter the records returned. This setting is used to specify conditions surrounding custom fields.
Where Settings > Condition > Comparison
Required
The following types of filter are available:
- Contains - Returns records where the field contains the specified value.
- Equal - Returns records where the field matches the specified value.
- GreaterThan - Returns records where the field is greater than the specified value.
- GreaterThanOrEqual - Returns records where the field is greater than or equal to the specified value.
- In - Returns records where the field matches one of the specified values.
- Like - Returns records where the field contains the specified value.
- LessThan - Returns records where the field is less than the specified value.
- LessThanOrEqual - Returns records where the field is less than or equal to the specified value.
- NotContains - Returns records where the field does not contain the specified value.
- NotEqual - Returns records where the field does not match the specified value.
- NotIn - Returns records where the field does not match one of the specified values.
- NotLike - Returns records where the field does not contain the specified value.
Where Settings > Condition > Field
Required
The name of the field the condition is to be based upon. The name should match the API field name, as seen in the output file. If using a reference field, include the name of the reference field followed by a slash, then the field to filter on. e.g. defaultContact/name
Filter Groups > Condition > Logic Operator
Optional
The logic operator to use with the next condition when building the where clause. Choose from:
- And - Will return records which meet all of the conditions specified.
- Or - Will return records which meet at least one of the conditions specified.
Filter Groups > Condition > Value
Optional
The value the filter is to be based upon.
- String values should be surrounded by quotes. e.g.
"John"
- Boolean values should be specified as either
True
orFalse
, with no quotes. - Datetime values should be specified in ISO8601 format, surrounded by square brackets. e.g.
[2000-01-31T14:51:00Z]
- Null is specified as
null
. - When using the In or NotIn comparison, specify a comma separated list of values surrounded by brackets. e.g.
("John", "Ben")
Zynk Settings
See Common Task Settings.
Examples
A sample output file is shown below.
<?xml version="1.0" encoding="utf-8"?>
<Activities xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Activity>
<id>79</id>
<externalId />
<_info>
<lastUpdated>2018-08-15T13:26:13Z</lastUpdated>
<updatedBy>zynk</updatedBy>
</_info>
<name>Test Activity</name>
<company>
<id>2</id>
<name>Your Company</name>
<identifier>YourCompany</identifier>
</company>
<contact>
<id>84</id>
<name>Marc Mosiman</name>
</contact>
<phoneNumber>76342155</phoneNumber>
<email>[email protected]</email>
<status>
<id>1</id>
<name>Open</name>
</status>
<dateStart>2018-08-15T00:00:00</dateStart>
<dateEnd xsi:nil="true" />
<assignedBy>
<id>176</id>
<name>Training Admin1</name>
<identifier>Admin1</identifier>
</assignedBy>
<assignTo>
<id>176</id>
<name>Training Admin1</name>
<identifier>Admin1</identifier>
</assignTo>
<scheduleStatus>
<id>2</id>
<name>Firm</name>
</scheduleStatus>
<where>
<id>1</id>
<name>On-Site</name>
</where>
<notifyFlag>false</notifyFlag>
<mobileGuid>5f2d2ef3-eccb-44d9-b889-e6ba798e2fff</mobileGuid>
<currency>
<id>3</id>
<name>Euro</name>
<symbol>€</symbol>
<isoCode>EUR</isoCode>
</currency>
</Activity>
</Activities>
Back | Edit on Github