Keywords: InterAction marketing lists; reduce lists; reduce access to InterAction; working lists, information lists
Downloadable document below explaining IA lists and folders, anti-lists and suppressions
Overview
Vuture can use contacts from any folder (Contact Types, Additional Information Folders, Marketing Lists or Working Lists) in InterAction as a source of contacts, as long as the integration InterAction user account has the appropriate permissions and access to these folders.
This article describes how to restrict the folders returned within Vuture to specific folder types or to exclude certain folders using the XPATH filter functionality.
Please note that Working Lists within InterAction are intended to be created, managed and used by individuals and or small teams for specific tasks and, as a best practice, are not recommended to be used as a direct source for marketing activities, because it is not required that the Marketing and Communications team have visibility of, access to, or control of the contacts or the quality of data on those lists.
InterAction Windows Client searches are not available within the Web client, and as a result are not available from the Web API that Vuture uses. If you find that you need to regularly use the contacts returned by a Windows client-based search to communicate to contacts, we recommend that you create a set of FDAs (folder dependency analyser rules) to populate and depopulate a Marketing list as required.
InterAction Web Client searches are based on a web page or form that a user completes prior to running the search. As such the parameter (field) values entered on the search page can vary every single time the search is run, which would result in the data being returned varying as well. If you find that your users are running exactly the same search in the web client frequently, then we would recommend creating FDAs to auto-populate lists as an option, which would allow Vuture to access contacts based on a fixed criteria.
Contents
There are three ways to filter the InterAction folders that are displayed by Vuture:
- Only display InterAction Marketing Folders
- Only display InterAction folders the user has access to in InterAction
- Create a more complex filter on the folders to be displayed using XPath expressions
Information on each option is provided below.
1. Only display InterAction Marketing Folders to improve performance and find email lists more easily
When folders are pulled back from InterAction you can choose for only Marketing Folders to be returned rather than all of your folders such as Working Lists and other folders.
This can greatly improve performance and make it easier to find the email list you are looking for.
It works by filtering folders based on Folder Class and defaults to the Folder Class of "Marketing List" but this can be changed.
Please contact Vuture to enable this configuration.
Vuture administrator guide to only showing marketing lists:
- Enable the configuration setting "Admin.System.Interaction.OnlyShowMarketingLists"
This checkbox will send a "folderClass" parameter to the "findFolders" InterAction Application Server Method so that Vuture only receives Marketing Lists. This will exclude all Administrative, Information, Working List, etc… folders. The default for this setting is disabled.
- Set the configuration setting "Admin.System.Interaction.MarketingListClassName " to the name of the Folder Class that should be returned.
This determines what "folderClass" Vuture will request from InterAction when the checkbox in 1 is selected. The default is "Marketing List" as this is the standard Folder Class for Marketing Lists in InterAction. This can be changed in InterAction so rename this to the required Folder Class you wish to return.
2. Only display InterAction folders that the user has access to in InterAction
It is possible to display only the InterAction folders that the user has access to, on the email Send, Filters and Triggers screens. To enable this, two things are required:
- On the User Settings screen, the user should have their own InterAction account name entered against the required InterAction instance, rather than the Vuture system InterAction account - Note that each user account should also give the Vuture system account proxy access
- "Admin.Roles.Email Campaigns.Access to all InterAction Lists" should be unticked for that user's role - this is the default setting.
3. Use an XPath expression to create a more complex filter that returns specific InterAction folders
If the first option does not provide the required filter then a custom XPath expression can be created to filter the folders according to your requirements. This configuration setting is "Admin.System.InterAction.XPath expression to filter lists" and the XPath expression entered here is used to filter the folder list coming back. See http://en.wikipedia.org/wiki/XPath for more information on XPath expressions.
For example the Xpath expression:
//result[folderClassId=2 or folderId=858994900 or folderId=858994999]
[not(folderId=858995000 or folderTypeId=10050)]
[not(starts-with(folderName, 'Anti - '))]
would return the following folders:
- all folders of FolderClassId = 2
- the folder with FolderId 858994900
- the folder with FolderId 858994999
- not the folder 8589950000
- not the folders with TypeId 10050
- not any folder that begins with 'Anti '
It is not currently possible to not display the "My contacts" folder
To see the XML that you are filtering on you can use the Vuture API to get back the folders returned e.g. https://{mycompany}.vuturevx.com/api/interaction/1/folders.xml will return the XML folder list for all folders for InterAction instance 1
If you wish to see the Global additional fields folder, they are in a special folder with id = 0. Make sure to add "or folderId=0" to your XPath expression. See below for an example:
//result[folderClassId=2 or folderClassId=5 or folderId=0]
To restrict by Folder Class, Folder Type and Folder Name use:
//result[folderClassId=4 and folderType='FolderTypeInTextGoesHere'][not(starts-with(folderName, '*'))]
Please contact Vuture for help with configuring this.
There is a downloadable document attached below which explains the difference between different InterAction folders and how they are used.
