The ININ.IceLib.Tracker namespace contains classes for manipulating and managing Interaction Tracker data. The Interaction Tracker system consists of many entities such as Interactions, Organizations, Individuals, AddressTypes, and InteractionAddressTypes. Together, these entities provide Interaction Center users with a robust means of managing contact information, tracking interactions, and retrieving information pertaining to these different entities from the Tracker database. A valid Tracker Access license is required for any user running an application that makes use of the Tracker classes.

The three main classes in the ININ.IceLib.Tracker namespace are:

- Contains methods that perform administrative tasks.
Contains methods that perform typical user tasks.
Contains methods that perform search operations.

Each of the above classes takes a Session type as an input paramater to its constructor. Thus, a session must already be established before instantiating any of the above types. Each of the above classes contains a TransactionClient type. This is accesable via the public getter, and can be used to modify settings used during the communication with the underlying TransactionBuilder system. (In most cases you will not need to modify any of these settings.) For more information, please see the documentation for TransactionClient and ININ.IceLib.Data.TransactionBuilder.

If a user is not licensed for Tracker, eny attempt to call any methods in these classes will result in an IceLibLicenseException being thrown.

There are also a number of classes within the ININ.IceLib.Tracker namespace that provide support to the classes mentioned in the preceding summary. Examples of the supporting classes are enumerations, event argument classes, and delegates used by events within classes.

TrackerAdmin

The TrackerAdmin class consists of a set of methods that allow you to add, delete, update and retrieve Tracker types. The Tracker types are:

- Used to classify addresses within Tracker.
Used to classify interaction addresses within Tracker.
Used to further classify interaction addresses within Tracker.
Used to classify Individuals within Tracker.
Used to classify Organizations within Tracker.
Used to classify Attributes within Tracker.
Represent titles that can be assigned to individuals (Mr., Miss, Dr., etc.)

You will be familiar with these types if you have ever performed a Tracker administrative task in Interaction Administrator. The Tracker node in Interaction Administrator allows admins to add, delete, and update AddressTypes, IndividualTypes, OrganizationTypes, etc. If you want to create a .Net application that provides administrative capabilites for Tracker, you would use the TrackerAdmin class.

Examples

The following example retrieves the list of AddressTypes from Tracker. The returned Collection of AddressTypes is iterated over while each AddressType is added to a ListView.

CopyC#

...
if (_TrackerAdmin != null)
{
   // Get the address types from Tracker.
   Collection<AddressType> addressTypes = _TrackerAdmin.GetAddressTypes();
   foreach (AddressType addressType in addressTypes)
    {
        ListViewItem item = new ListViewItem(addressType.Name);
        item.ImageIndex = GetSelectedTreeNodeImageUnselected();
        item.Tag = addressType;
        _MainListView.Items.Add(item);
    }
}

TrackerUser

The TrackerUser class consists of a set of methods that allow you to add, delete, update and retrieve Tracker data that relates to Individuals, Organizations, and Locations. The main classes used here are:

Represents an Individual within Tracker.
Represents an Organization within Tracker.
Represents a Location within Tracker.
Represents an Annotation within Tracker.
Represents an address for an Individual within Tracker.
Represents an interaction address for an Individual within Tracker.
Represents an address for an Organization within Tracker.
Represents an interaction address for an Organization within Tracker.
Represents an address for a Location within Tracker.
Represents an interaction address for a Location within Tracker.

You will be familiar with these Tracker entities if you have ever used the Win32 TrackerClient application. The TrackerClient allows you to manage Tracker Contacts. You can add an address for an Individual. You can associate an Individual with a particular Organization. You can add a new Organization or Location. If you want to create a .Net application that provides these user level capabilites for Tracker, you would use the TrackerUser class.

Examples

The following example creates a new Organization.

CopyC#

...
if (_TrackerUser != null)
{
   // Instantiate the Organization.
   Organization organization = new Organization();
   annotation.Name = "My Company";
   string newID = _TrackerUser.AddOrganization(organization);
}

TrackerSearch

The TrackerSearch class consists of a set of methods that allow you to search the Tracker database for Individuals, Organizations, Locations, and Interactions. The main classes used here are:

Contains information about an Individual within Tracker.
Contains information about an Organization within Tracker.
Contains information about a Location within Tracker.
Contains information about an Interaction within Tracker.

The above classes are designed to contain a subset of information that lies within their associated non-view classes (e.g. Individual vs. IndividualView). Note: There is no Interaction class. Interactions are stored as InteractionSegments in Tracker. The above "View" classes are used to hold the search results when searching for about Tracker entities. If you want to create a .Net application that provides search capabilities, you would use the TrackerSearch class.

Examples

The following example searches for Individuals with a last name of "Smith." The results are then displayed in a ListView.

CopyC#

...
if (_TrackerSearch != null)
{
   // Create the input filter..

   SearchIndividualsFilter filter = new SearchIndividualsFilter();
   filter.FirstName = "Joe";
   filter.LastName = "Smith";
   // Create an IndividualView to hold the result..
   Collection<IndividualView> individualViewResults;
   // Perform the search..
   individualViewResults = _TrackerSearch.SearchIndividuals(filter);
   // Display the results of the search in a ListView..
   foreach (IndividualView individualView in individualViewResults)
    {
        ListViewItem item = new ListViewItem(individualView.FirstName + individualView.LastName);
        item.Tag = individualView;
        _MainListView.Items.Add(item);
    }
}

Classes

	Class	Description
	AddressType	Represents an address type within Tracker.
	AddUpdateCompletedEventArgs	Provides data for asynchronously completed events of a TrackerUser.
	Annotation	Represents an annotation within Tracker.
	AnnotationView	Represents an annotation view within Tracker.
	CanViewInteractionCompletedEventArgs	Provides data for the CanViewInteractionCompleted event of a TrackerUser.
	GetCurrentSegmentOrganizationIndividualCompletedEventArgs	Provides data for the GetCurrentSegmentOrganizationIndividualCompleted event of a TrackerUser.
	GetICUserIndividualInformationCompletedEventArgs	Provides data for the GetICUserIndividualInformation event of a TrackerUser.
	GetIndividualDetailsCompletedEventArgs	Provides data for the GetIndividualDetailsCompleted event of a TrackerUser.
	GetInteractionDetailsCompletedEventArgs	Provides data for the GetInteractionDetailsCompleted event of a TrackerUser.
	GetLocationDetailsCompletedEventArgs	Provides data for the GetLocationDetailsCompleted event of a TrackerUser.
	GetOrganizationDetailsCompletedEventArgs	Provides data for the GetOrganizationDetailsCompleted event of a TrackerUser.
	GetPossibleDuplicateIndividualCompletedEventArgs	Provides data for the GetPossibleDuplicateIndividualCompleted event of a TrackerUser.
	ICUserId	Represents an IC user ID within Tracker.
	ICUserIndividualInformation	Helper class to contain the results of the GetICUserIndividualInformation(String) methods.
	Individual	Represents an individual within Tracker.
	IndividualAddress	Represents an individual address within Tracker.
	IndividualDetails	Helper class to contain the results of the GetIndividualDetails(String) methods.
	IndividualInteractionAddress	Represents an individual interaction address within Tracker.
	IndividualType	Represents an individual type within Tracker.
	IndividualView	Represents an individual view within Tracker.
	InteractionAddressSubtype	Represents an interaction address subtype within Tracker.
	InteractionAddressType	Represents an interaction address type within Tracker.
	InteractionDetails	Helper class to contain the results from the GetInteractionDetails(String, String) methods.
	InteractionParticipantView	Represents an interaction participant view within Tracker.
	InteractionSegment	Represents an interaction segment within Tracker.
	InteractionView	Represents an interaction view within Tracker.
	IsUnknownOrSystemIndividualCompletedEventArgs	Provides data for the IsUnknownOrSystemIndividualCompleted event of a TrackerUser.
	Location	Represents a location within Tracker.
	LocationAddress	Represents a location address within Tracker.
	LocationDetails	Helper class to contain the return parameters for the GetLocationDetails(String) methods.
	LocationInteractionAddress	Represents a location InteractionAddress within Tracker.
	LocationName	Represents a location name within Tracker.
	LocationView	Represents a location view within Tracker.
	MultipartAccountCode	Represents a multipart account code within Tracker.
	MultipartAccountCodeExtended	Represents an extended multipart account code within Tracker.
	NewIdCompletedEventArgs<(Of <(<'TId>)>)>	Provides data for asynchronous completed events of a TrackerUser.
	Organization	Represents an organization within Tracker.
	OrganizationAddress	Represents an organization address within Tracker.
	OrganizationDetails	Helper class to contain the return parameters for the GetOrganizationDetails(String) methods.
	OrganizationInteractionAddress	Represents an organization InteractionAddress within Tracker.
	OrganizationName	Represents an organization name within Tracker.
	OrganizationType	Represents an organization type within Tracker.
	OrganizationView	Represents an organization view within Tracker.
	QueryCollectionResultCompletedEventArgs<(Of <(<'TResult>)>)>	Provides a collection of data for asynchronously completed events of a TrackerAdmin.
	QueryResultCompletedEventArgs<(Of <(<'TResult>)>)>	Provides data for asynchronously completed events of a TrackerAdmin.
	ReverseInteractionAddressLookupInformation	Represents reverse InteractionAddress lookup information within Tracker.
	ReverseWhitepagesCommonInfo	Holds common information used during reverse whitepage operations.
	ReverseWhitepagesGeneralInfo	Holds general information used during reverse whitepage operations.
	ReverseWhitepagesIndividualInfo	Holds information about an individual that is used during reverse whitepage operations.
	ReverseWhitepagesInfo	Holds reverse whitepages lookup information that Tracker Server sends or receives.
	ReverseWhitepagesLocationInfo	Holds information about a location that is used during reverse whitepage operations.
	ReverseWhitepagesOrganizationInfo	Holds information about an organization that is used during reverse whitepage operations.
	SearchForResolutionCandidatesCompletedEventArgs	Provides data for the SearchForResolutionCandidatesCompleted event of a TrackerSearch.
	SearchIndividualsFilter	This class represents a filter that is used to search Individuals.
	SearchInteractionsFilter	This class represents a filter that is used to search Interactions.
	SearchLocationsFilter	This class represents a filter that is used to search Locations.
	SearchOrganizationsFilter	This class represents a filter that is used to search Organizations.
	SegmentOrganizationIndividualDetails	Helper class to contain the return values for the GetCurrentSegmentOrganizationIndividual(String, String) methods.
	Title	Represents a title within Tracker.
	TrackerAdmin	Contains methods necessary to perform typical Tracker admin related operations.
	TrackerAttribute	Represents an attribute within Tracker.
	TrackerAttributeType	Represents a Tracker attribute type within Tracker.
	TrackerAttributeView	Represents an attribute view within Tracker.
	TrackerContactEntry	Provides extended Tracker information for a ContactEntry in a Tracker Directory.
	TrackerInteraction	Provides access to Tracker information for an interaction within the Interaction Center system.
	TrackerInteractionAttributeName	Specifies attribute names that can be used with TrackerInteractions.
	TrackerSearch	Contains methods necessary to perform typical Tracker search-related operations.
	TrackerUser	Contains methods necessary to perform typical Tracker user related operations.
	UserTrackerRightsAttributes	Attribute strings for the UserTrackerRightsSettings watched class.
	UserTrackerRightsSettings	Represents the basic user rights settings for an IC user. User rights are set in Interaction Administrator at the Default User, User or Workgroup level.

Enumerations

	Enumeration	Description
	ActiveType	This enum is used to distinguish between active entities and inactive entities.
	AdminType	This enumeration is used to distinguish between tracker admin users and non tracker admin users.
	AppliesToTypes	This enum consists of a set of Tracker types that certain methods use to limit their result set. For instance, the method GetTrackerAttributeTypes(AppliesToTypes) uses this enum to determine which TrackerAttributeTypes to fetch. An input value of AppliesToTypes.Individuals would cause the Tracker subsystem to return only TrackerAttributeTypes that are used for Individuals.
	DirectionType	The direction types that an interaction can have.
	HowEnded	This enum consists of a set of Tracker types that describe a given Segment.
	InteractionType	Represents the various interaction types within Interaction Center.
	PrivateType	This enum is used to distinguish between public interactions and private interactions.
	RoleType	This enum consists of a set of Tracker types that describe the various roles that an Individual can play in an interaction.
	SegmentTypes	This enum consists of a set of Tracker types that describe a given Segment.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.