Windows services & registry configuration

Scheduled tasks configuration

All the command line tools (except for the HealthChecker) are scheduled by the Windows Task Scheduler (see chapter Windows services overview). Each of the command line tools uses the registry keys for “ServerSideJobs” (set by the Coordinator installer), where the following keys are of the type String / REG_SZ:

HKEY_LOCAL_MACHINE \Software\T-Systems\ImageMaster\ServersideJobs

  • InstallDirThe install directory for the executables

  • LogDirThe directory for log files

  • TmpDirThe directory for temporarily files

  • OdbcConnectionStringThe ODBC connection string used at installation

    This value is used as default value at runtime if no value is defined in ImaAdminClient (serversideSettings.dbConnectionString).

Additionally, each of these tools will also read the key below if it is set manually:

HKEY_LOCAL_MACHINE\Software\T-Systems\ImageMaster\ServersideJobs

  • UseMapiNewSessions (Type DWORD (32-bit) / REG_DWORD)

    If set to 1, the flag NEW_MAPI_SESSION will be used for opening a MAPI session to avoid shared sessions. The default is 0. Since ImageMaster 9.10.2 only relevant when the key UseMapiProfiles is set (see section below).

  • UseMapiProfiles (Type REG_DWORD)

    If set to a value > 0 then MAPI profiles functionality valid before ImageMAster 9.10.2 will be used. The default is 0.

  • MapiProfileNames (Type REG_SZ)

    Semicolon separated list of MAPI profiles to use when UseMapiProfiles is set

    e.g. “MapiProfile1;MapiProfile2”

  • PowerShellAuthenticationMechanism (Type String / REG_SZ)

    Set to KERBEROS to override the PowerShell authentication mechanism default.

  • MailboxSpiderSelectRestored (Type REG_DWORD)

    If this value is set to TRUE and the archiving logic is set to “Archive new e-mails and those missing in archive” or “Always (re-)archive e-mails”, e-mails are selected based on other rules as normal e-mails.

    If “Only archive e-mails the first time, no availability check for permanent restored e-mails” is used or any other combination, then restored e-mails are NOT selected, to avoid data loss.

  • MailboxSpiderCoordinatorMask (Type QWORD (64-bit) / REG_QWORD)

    If set to a value > 0 then the jobs selected by the Mailbox Spider will only be inserted for the Batch Archivers at the Coordinators according to this bit mask. E.g. 5 (binary: 101) will enable only the Batch Archiver at the 1st and 3rd Coordinator.

  • ComplianceMailboxSpiderCoordinatorMask (Type QWORD (64-bit) / REG_QWORD)

    If set to a value > 0 then the jobs selected by the Compliance Mailbox Spider will only be inserted for the Batch Archivers at the Coordinators according to this bit mask. E.g. 8 (binary: 1000) will enable only the Batch Archiver at the 4th Coordinator.

  • ComplianceMailboxSpiderHardDelete (TypeDWORD (32-bit) / REG_DWORD)

    If set to 1, the flag HardDelete will be used to delete stubs (for compliance policies).

  • BatchArchiverDeleteComplianceStubs (Type DWORD (32 bit) / REG_DWORD)

    If set to 1, the Batch Archiver will (soft) delete the compliance item after stubbing it (only for compliance policies).

    If set to 2, the Batch Archiver will hard delete the compliance item after stubbing it (only for compliance policies).

  • SpiderItemTryCount (Type DWORD (32 bit) / REG_DWORD)

    Maximum tries to continue iteration when processing an item by a Spider failed. If max tries is exceeded, the Spider run will be aborted (see also SpiderItemRetryDelay below).

  • SpiderItemRetryDelay (Type DWORD (32-bit) / REG_DWORD)

    Delay in seconds to wait before next try to continue iteration of a Spider when processing an item failed. The default is 0. Also see SpiderItemTryCount.

  • EwsPageSize (Type DWORD (32-bit) / REG_DWORD)

    Set value to override page size to fetch items from EWS.

  • FinalArchiveMaxItemRetry (Type DWORD (32-bit) / REG_DWORD)

    Set a value to override the maximum item retry for the Final Archive Spider. The default value is 3.

  • CustomMetadata (Type Multi-String / REG_MULTI_SZ)

    Define a list of custom MAPI properties to be archived as additional metadata values (max 100).

    If enabled, then for each e-mail which is archived using given ImaServerSetting the defined additional MAPI properties will be archived to mapped custom metadata attributes. The additional attributes have to be created manually for target Ima4MSX document type:

    • Type: dependent on MAPI property ID suffix:

      • MAPI property ID suffix 0002 or 0003

        --> ImageMaster attribute type “decimal”

      • MAPI property ID suffix 000B

        --> ImageMaster attribute type “boolean”

      • MAPI property ID suffix 001E or 001F

        --> ImageMaster attribute type “string”

      • MAPI property ID suffix 0040

        --> ImageMaster attribute type “dateTime”

    • Single value (MinOccurs=0 and MaxOccurs=1)

    • NOT KeyAttribute, NOT Mandatory and NOT ReadOnly

      It is recommended running the DB optimization script after creating the additional attributes in the document type administration.

    Each custom property consists of three values (XX stands for number suffix 00-99):

    • ImaSettingXX: The name of ImaServerSetting (Name of “ImageMaster Service”)

    • ImaAttributeXX: The name of the ImageMaster attribute.

    • MapiPropertyXX: MAPI property ID (hex format 0x00000000)

    Example:

    ImaSettings00=imaserver
ImaAttribute00=ima4msx.messageClass
MapiProperty00=0x001A001F
ImaSettings01=imaserver
ImaAttribute01=ima4msx.taskState
MapiProperty01=0x80300003
...
ImaSettings99=imaserver
ImaAttribute99=ima4msx.isSigned
MapiProperty99=0x843A000B

HKEY_LOCAL_MACHINE \Software\T-Systems\ImageMaster\WSCoordinator

  • GetMailboxFilter (Type String / REG_SZ)

    Use this PowerShell filter to restrict the mailbox list. E.g. “{CustomAttribute1 -eq 'TestPolicy'}”.

  • RemotePowerShellHostName (Type String / REG_SZ)

    Host name which overwrites Ima4MSX room\MS-Exchange Server Settings\Exchange Server Name

  • skipRegisterAddin (Type DWORD (32-bit) / REG_DWORD)

    If set to 1, registerAddIn requests to ImaAdminsService will be skipped.

  • skipRegisterMailbox (Type DWORD (32-bit) / REG_DWORD)

    If set to 1, registerMailbox requests to ImaAdminsService will be skipped.

  • skipArchiveStatistics (Type DWORD (32-bit) / REG_DWORD)

    If set to 1, archiveStatistics requests to ImaAdminsService will be skipped.

  • skipAddMessageClasses (Type DWORD (32-bit) / REG_DWORD)

    If set to 1, addMessageClasses requests to ImaAdminsService will be skipped.

Each of these services writes a log file “<CommandLineToolName>.log” in LogDir.

All services get their configuration from the message queue Ima4MSXConfig and extract the serversideSetting for the current host name (FQHN). The configuration for each of these services is specified as follows:

Name

Description

actionSettings

The active time interval on each day (outside this interval, the service runs but is inactive)

jobChunkSize

The (maximum) number of jobs that will be fetched from database at once

keepFailedJobs

If set to “true”, all failed jobs (when all retries are already executed) will be kept in the ImageMaster Content Services for E-Mail database and the state will be set to error instead of deleting job from database

loggerSettingsId

The ID of the referenced log settings (the ID is the name of the settings)

maxItems

The maximum items to be processed within one Spider run (cancel run after processing maxItems)

maxTime

The end time of the active time interval on each day

maxTries

The maximum number of tries before accept job as failed

minTime

The start time of the active time interval on each day

parallel

The number of threads

pollIntervallSeconds

The poll interval to look for new jobs if no more jobs are available

pullTimeout

Timeout in seconds the Coordinator waits for a response of ImaAdminService (for getExpiredMailbox or GetComplianceMailbox)

semaphoreTimeout

The timeout for the semaphore (mailbox lock) in hours

tryDelay

The try delay between two attempts to execute a job