IM Import supports the following parameters in the configuration file IMFrontEnd.ini.
The parameters above have no default value. At least one must exist and all can co-exist in any order. They can specify either shortcuts, or fully-qualified paths to the folders containing the data files for each source. In each case, the syntax follows this pattern:
DirIBXML=<unique file path>
You can do one of the following:
DirFaceTime=C:\IM Import\Source data\FaceTime
DirIMlogic=C:\IM Import\Source data\June_2009.lnk
Where June_2009.lnk is a shortcut to a source data file stored elsewhere. This means that you can reconfigure the setup without editing the ini file.
Each parameter specified must contain a unique directory name. We recommend that you name these source folders so the respective client types can be easily identified. For example:
DirFaceTime=C:\IM Import\Source data\FaceTime DirIBXML=C:\IM Import\Source data\DirIBXML DirIMlogic=C:\IM Import\Source data\IMlogic
Note: Do not use quote marks around paths, even if they contain spaces.
Note: Despite the name change from FaceTime to Actiance, the corresponding IM Import data source parameter is still DirFaceTime.
Defaults to Yes. This parameter determines whether to write progress messages to the command window. The syntax is:
ConsoleOutput=Yes or No
If set to Yes, progress messages are written to the command window; if set to No, they are not. This parameter can operate concurrently with the LogFile parameter (see below).
Defaults to No. This parameter specifies whether to delete email attachments from the source folder after they have been imported. The syntax is:
DeleteAttachments=Yes or No
If set to Yes, attachments are deleted; if set to No, they are not deleted.
Note: Attachment source folders are defined by the DirAttachment parameter.
This parameter has no default value. It can specify either a shortcut, or a fully-qualified path to a folder containing attachments. The syntax is:
DirAttachment=<file path>
This parameter can specify:
DirAttachment=c:\im import\source data
DirAttachment=c:\im import\source data\June_2009.lnk
Where June_2009.lnk is a shortcut to a completely different source data file stored elsewhere. This means that you can reconfigure the setup without editing the ini file.
Note: Do not use quote marks around pathnames, even if they contain spaces.
This parameter has no default value. It specifies the final destination folder for the .CNV files; from here, Event Import imports them into CA DataMinder. The syntax is:
DirFinalDest=<file path>
Where <file path> specifies the path and name of the final destination folder. For example:
DirFinalDest=C:\CA\IM Import\conversation\complete
Note: The .CNV files are created in a subfolder under the DirFinalDest folder.
Note: To allow automated and unattended import operations, the DirFinalDest parameter must match a location specified by the Event Import parameter File.Pathspec.
These parameters convert a participant’s internal ID (that is, the ID used by the source IM system) into an ID that is guaranteed to be unique. In each case, the syntax follows this pattern:
FaceTimeIDConversionExpression=<expression>
Where <expression> specifies an ID conversion expression. Typically, you use these parameters if no email address is available for a participant in an imported conversation. For example, the following expression prefixes each extracted participant ID with ‘unipraxis:’
FaceTimeIDConversionExpression=unipraxis:["?%untilEnd%"]
In this case, the participant ID lyndasteel is converted to unipraxis:lyndasteel. The conversion expressions use the same syntax as the conversion expressions used by Account Import when importing LDAP attributes. They can parse, extract and (if necessary) remove or substitute any characters in the participant ID.
Note: Despite the name change from FaceTime to Actiance, the corresponding IM Import data source parameter is still FaceTimeIDConversionExpression.
(Applies to Instant Bloomberg DirIBXML messages only)
Defaults to No. This parameter specifies whether to use the conversationID as the conversation title. The syntax is:
IBXML.UseConversationIDAsSubject=<Yes or No>
Note: CNV2email.exe uses the conversation title as the email subject.
(Applies to Instant Bloomberg DirIBXML messages only)
Defaults to No. This parameter specifies whether to use corporate email addresses for participants instead of Bloomberg addresses. The syntax is:
IBXML.UseCorporateAddresses=<Yes or No>
If set to Yes, IM Import uses corporate addresses, if available. If set to No, IM Import uses Bloomberg addresses.
If set to Yes but a corporate address is not present, IM Import uses the Bloomberg address.
Defaults to No. This parameter determines whether a failed IMFrontEnd.exe extraction keeps the intermediate files created before the extraction failed. The syntax is:
KeepIntermediatesOnFailure=<Yes or No>
This parameter can be useful when looking into why the extraction failed. These intermediate files are left in subfolders of the final destination folder (specified by the DirFinalDest parameter) and have an extension of .incomplete on the subfolder name. For example:
DirFinalDest=C:\CA\IM Import\conversation\July.incomplete
Note: Do not use this parameter if the Event Import parameters include File.IncludeSubDirs=Yes and File.ContinuousInput=No.
This optional parameter has no default value. It appends progress messages to a specified log file. The syntax is:
LogFile=<file path>
Where <file path> specifies the path and name of the log file. For example:
LogFile=C:\CA\IM Import\Logs\IMFrontEnd.log
Note: Do not use quote marks around pathnames, even if they contain spaces.
Defaults to 102400 bytes. This optional parameter specifies a threshold size (in bytes) for log files. When this threshold is exceeded, IM Import automatically creates a new log file. The syntax is:
LogFileThreshold=<number of bytes>
Note: The default log file size (equivalent to 100KB) also represents the minimum log file size. If this parameter specifies a threshold size smaller than the default, IM Import disregards the specified threshold and instead uses the default threshold.
Defaults to 200. This parameter specifies the maximum number of .CNV output files that can be kept open simultaneously. In effect, it specifies the size of the .CNV file cache. The syntax is:
MaxFiles=<number of files>
When IM Import extracts IM conversations from dump files, it saves individual conversations to separate .CNV files. For performance purposes, this parameter prevents an unlimited number of .CNV files being open at one time. If this limit has already been reached, but IM Import needs to write details to a further .CNV file, it closes an open .CNV file and opens the required one.
Note: If IMFrontEnd.exe performance seems slow when processing large IM dump files, you may need to increase the size of the .CNV file cache, say, to MaxFiles=1000. This because the internal structure of some dump files means that IMFrontEnd.exe needs to continually access a very large number of separate .CNV files.
Defaults to No. This parameter determines whether subfolders below the specified DirAttachment folder are included when IMFrontEnd.exe is searching for attachment data files. The syntax is:
RecurseDirAttachment=<Yes or No>
Defaults to No. This parameter specifies whether IMFrontEnd.exe ignores missing attachments and continues with the import process. The syntax is:
RejectOnAttachmentFailure=<Yes or No>
An attachment file can sometimes fail to be added to a conversation. For example, IMFrontEnd.exe may not be able to find an attachment referenced in the log file being imported. This parameter specifies whether the IMFrontEnd.exe process ignores the missing attachment and continues with the import process, or fails this log file and moves on to the next. If set to:
IMFrontEnd.exe fails the attachment’s log file and moves it to the \Failed subfolder.
IMFrontEnd.exe ignores the failed attachment and continues to import the current log file.
This optional parameter has no default value. It specifies whether the IM Import process runs continuously or just once. The syntax is:
RunOnce=<Yes or No>
If set to Yes, the import process terminates after processing the import files. If set to No, the import process runs continuously.
Note: If IM Import does not find this parameter in IMFrontEnd.ini, the import process runs continuously.
Defaults to Yes. This parameter provides progress feedback during conversation extraction. The syntax is:
ShowMessageProgress=<Yes or No>
If set to Yes, a time-stamped progress message is written to the log file and command window, as configured, every two minutes. If set to No, progress messages are not written to the log file or command window.
Defaults to 250 KB (256000 bytes). This parameter specifies a maximum size for a single ‘event’ in an IM Import file. The syntax is:
ViewSize=<number of bytes>
In an XML import file, an ‘event’ is a single posting on a channel. If the data relating to that ‘event’ exceeds the specified view size (this includes any metadata, including participants, group name and date), the import file will fail.
Note: The minimum event size is also 250 KB. You cannot set this parameter to a size less then 250 KB.
Important! Do not confuse these ‘events’ with events in the CA DataMinder database.
|
Copyright © 2014 CA.
All rights reserved.
|
|