ListManager Object

Use this object to create and manage lists of users for the User Profile Management system, lists of e-mail addresses for the Direct Mailer, lists of segment members for the Predictor resource, lists generated from Analysis reports, and lists created from files and SQL queries.

ProgID:	Commerce.ListManager (Externally creatable)
COM Class Name:	ListManager
COM Interface Name:	IListManager
Interface ID Constant:	None
Header File:	None
Type Library Name:	Microsoft Commerce 2000 ListManager Type Library
EXE Name:	listmanager.exe
Threading Model:	Both

The properties of the ListManager object are shown in the following table.

Property	Type	Description
ConnectionString	BSTR	Stores the connection string to the database used by the ListManager object to store lists. This value is set when passing the ConnectionString parameter to the Initialize method. This property is read-only.
Status	long	Stores the current status of the ListManager object. This property is read-only.

The methods of the ListManager object are shown in the following table.

Method	Description
AddUserToMailingList	Adds a user to a mailing list.
CancelOperation	Cancels a currently running asynchronous operation.
Copy	Makes a copy of a list.
CreateEmpty	Creates an empty list for subsequent operations.
CreateFromDWCalc	Creates a list from an Analysis report.
CreateFromFile	Creates a list from a file.
CreateFromSegment	Creates a list from a Predictor resource segment.
CreateFromSql	Creates a list from an SQL query.
Delete	Deletes a list.
ExportToFile	Exports a list to a file.
ExportToSql	Exports a list to a database table.
ExtractMailingList	Creates a new mailing list from a generic list that contains an rcp_email column.
GetListFlags	Retrieves the Flags bitmask for a list.
GetListId	Retrieves the list ID.
GetListName	Retrieves the list name.
GetListProperty	Retrieves a list property.
GetLists	Enumerates all known lists at the time of the call.
GetListUserFlags	Retrieves the UserFlags bitmask for a list.
GetOperationInfo	Retrieves information on a list operation.
GetOperations	Enumerates all operations running at the time of the call.
Initialize	Initializes the ListManager object.
RemoveUserFromMailingList	Removes a user from a mailing list.
Rename	Renames a list.
SetDesc	Assigns a description to a list.
SetListProperty	Sets a list property.
Subtract	Subtracts one list from another list, and stores the results in a third list.
Union	Produces a union of two lists (combines the lists and eliminates duplicates), and stores the results in a third list.
WaitOnOperation	Waits for an operation to complete or a timeout to occur, then returns.

Remarks

List Manager has functionality to manipulate two types of lists, Generic and Mailing. Each type may also have User and Mailable attributes. Lists are designated as static or dynamic depending on when the data is imported.

A Generic list may have any set of column names and types - it essentially maps to a SQL table.

A Mailing list is a list for use with Direct Mailer. It contains a list of recipients to receive mail or a list of recipients who should be opted out of a mailing. Each mailing list has its own table.

The following table describes the columns of a Mailing list table.

Field	Type	Description
rcp_email	NVARCHAR [256]	E-mail address of the recipient.
rcp_guid	NVARCHAR [64]	(Optional) User ID. Usually a GUID which is a key to the profile of the user.
rcp_fmt	smallint	(Optional) Message format flag. Legal values are: 1 - TEXT 2 - MIME 3 - MHTML
rcp_locale	NVARCHAR[20]	(Optional) Preferred character set of the recipient. See DirectMailer specifications for details.
rcp_url	NVARCHAR[2084]	(Optional) URL used for retrieving personalized content for the user.

A Mailable list is any list with an rcp_email column.

A User list is any list with an rcp_guid column.

In a static list, records are imported at the time the list is created.

A dynamic list imports records on demand when referenced by another operation.

List Manager can import lists from the following sources:

• An SQL query run against an ODBC data source

• An Analysis report run from the Business Desk

• A Predictor Resource segment

• A text file (CSV format)

List Manager can export lists to the following destinations:

• A SQL Server 2000 table in an external database

• A text file (CSV format)

List Manager allows time consuming operations to run in an asynchronous manner wherein the operation returns immediately after the process has started and assigns an operation ID that can be used to access the operation.

List Manager stores information about lists and operations in the lm_master and lm_master_operations tables, respectively.

See Also

List Management Objects

All rights reserved.