These import parameters are used to query the database on the source CMS to retrieve matching events.
A SQL snippet is a segment of SQL code that can be incorporated into a full SQL query. Example snippets are provided below.
For full details of database tables, indexes and datatypes, see the CA DataMinder Database Schema, available from CA Technical Support.
The parameter has no default value. You can use this parameter to filter import operations by event attributes. The syntax is:
SQL.AttributeFilter=<SQL snippet>
For example, smart tags are stored in the CMS database as event attributes. To filter import operations by event attributes, you must set this parameter to an appropriate SQL snippet that queries the AttrType and AttrValue columns in the Wgn3EA database table.
Important! You must use ea. as the column prefix. For example, you cannot use extendedattribute. as the column prefix because this is not supported!
Important! This parameter is mandatory for remote CMS import operations!
The parameter has no default value. It specifies whether to import emails or files. The syntax is:
SQL.EventType=File or EMail
A Remote CMS import job can import either emails or file events; a single job cannot import both. If this parameter is set to:
The import job only imports email events (and attachments, if present).
The import job only imports file events.
Be aware that if you configure the Remote CMS Import job to import files, you must also include the ImpFile.PolicyParticipant parameter. This parameter, mandatory for file import jobs, identifies which user policy to apply to imported files.
This parameter provides additional flexibility to filter import operations by querying the Wgn3Event database table. The syntax is:
SQL.EventFilter=<SQL snippet>
The Wgn3Event table contains all events for all users. For example, to import IM conversations embedded in emails (see the note below), set this parameter to an appropriate SQL snippet that references such events in the EventMinorType column:
SQL.EventFilter=e.EventMinorType=32
Where 32 identifies emails that contain embedded IM conversations. You must use e. as the column prefix; do not use event. as the column prefix because this is not supported!
Important! This parameter must be consistent with the SQL.EventType parameter (see above). If that parameter specifies an email import operation, then SQL.EventFilter must also specify a type of email event as the import filter.
Note: CA utilities such as Cnv2email.exe or BB2email.exe can convert various types of message data, including IM dump files, into EML files (that is, Internet emails) that can be subsequently processed by policy engines and imported into a CMS.
This parameter has no default value. You use this parameter in combination with SQL.UserFilter to filter import operations by user or group. The syntax is:
SQL.UserFilterMode=<Number>
This parameter defines the filtering mode. That is, it specifies whether the import operation will filter by names, account IDs, or email addresses, and whether to import from subgroups. It can take one of the following values:
0 No filtering
1 User ID
2 Group ID
3 Group ID, plus subgroups
4 User name
5 Group name
6 Group name, plus subgroups
7 Email address
This parameter is used in combination with SQL.UserFilterMode to filter import operations by user or group. The syntax is:
SQL.UserFilter=<List of names, addresses or IDs>
Set this parameter to a comma-separated list of user names, group names or email addresses to filter import operations:
SQL.UserFilter=unipraxis%,fschaeffer
SQL.UserFilter=Equity Research,Sales
This parameter queries the Wgn3Address database table. This table contains all addresses associated with CA DataMinder users. These addresses can be in any format, such as SMTP, EX or Bloomberg alias addresses. This example filters on two specific SMTP addresses:
SQL.UserFilter=srimmel@ unipraxis.com,fschaeffer@unipraxis.com
Alternatively, you can specify ‘universal’ addresses by enclosing users’ names in wildcards and omitting protocol-specific elements such as @ characters. This example filters on any emails sent to or from Spencer Rimmel or Frank Schaeffer, regardless of address format:
SQL.UserFilter=%rimmel%,%schaeffer%
For maximum flexibility, you can also filter import operations by unique user or group ID. Note that these account IDs can only be viewed in the CMS database; they are not displayed in the Administration console.
SQL.UserFilter=<IDM>,<ID>|<IDM>,<ID>|<IDM>,<ID>
Where <IDM> and <ID> are part-keys stored in the UserIDM and UserID columns (Wgn3User table) or the GroupIDM and GroupID columns (Wgn3UserGroup table), that together uniquely identify an individual user or group. For example:
SQL.UserFilter=1,2054|1,3397
The parameter has no default value. You use this parameter to filter import operations by policy trigger. The syntax is:
SQL.TriggerFilter=<SQL snippet>
That is, only events captured by specific triggers are imported. To filter import operations by trigger, you must set this parameter to an appropriate SQL snippet that (typically) queries the TriggerType or TriggerName columns in the Wgn3Trigger database table.
For example, to query the CMS database for events associated with a trigger named ‘Custodian Responses’, set this parameter to:
SQL.TriggerFilter=t.TriggerName='Custodian Responses'
Where Custodian Responses is a user-defined trigger name—see below. You must use t. as the column prefix; do not use trigger. as the column prefix because this is not supported!
Similarly, to query the CMS database for events associated with a specific trigger type (in this case, triggers to detect outgoing emails that match a specific document classification), set this parameter to the appropriate number:
SQL.TriggerFilter=t.TriggerType=34144258
Where 34144258 identifies ‘document classifier’ trigger types. For more on trigger types, see below.
Trigger names
Be aware that the TriggerName database column contains names defined by the policy administrator using the Trigger Name policy setting. It does not contain the non-editable trigger identifiers shown in the left-hand pane of the User Policy editor, such as ‘Document Classifier 1’ or ‘Search Text 2’.
Trigger types
A full list of trigger types is available in the CA DataMinder Database Schema. However, that document lists the hexadecimal value of each trigger type, but you must use the equivalent decimal values when you specify the SQL.TriggerFilter import parameter. For example, ‘document classifier’ trigger types have a hexadecimal value of 0x02090002; this converts to 34144258 in decimal.
|
Copyright © 2014 CA.
All rights reserved.
|
|