'Mas-storage' Configuration

enaio® mail-archive-service • 12.0 »

Configuration parameters of the masstorage-prod.yml file for creating e-mails and documents in enaio®.

The configuration parameters for Microsoft Exchange Online and for Microsoft Exchange on-premises are identical.

Configuration values such as user name and password can be specified in the encrypted configuration file.

A customizable configuration file is available to download, which you can use as a basis for the configuration.

Parameter

Type

Description

 For example Default
mas-storage.dms.set-archivable.journaling Boolean 'Approved for archiving' property for journaling e-mails and SMTP e-mails. true false
mas-storage.dms.set-archivable.archiving Boolean Set 'Approved for archiving' property for e-mails for mailbox archiving. true false

mas-storage.dms.journal.folder

String

Entry for the journal folder’s index data field.

 Store Journaling
mas-storage.dms.journal.exclusions String

Exceptions for the entry in the index data fields of the journal folder:

  • subject-keywords

    Keywords in the subject – not case sensitive.

    If the subject contains a key term, the entry assigned under 'folder' is used.

  • mailboxes

    Mailboxes

    If an address is contained in 'To', 'From', or 'CC', the entry assigned under 'Folder' is used.

  • folder

    Entry in the index data fields for exceptions.

'subject-keywords' and 'mailboxes' are combined by the logical AND.

 
journal:
  folder: Journaling # default folder
  exclusions:
    - subject-keywords: [ key1, key2 ] 
      mailboxes: [ test@gmail.com, test1@gmail.com ]
      folder: SubjectException1
    - subject-keywords: [ key3, key4 ]
      folder: SubjectException2
    - mailboxes: [ test3@gmail.com, test4@gmail.com ]
      folder: SubjectException3
 -
mas-storage.dms.journal.journal-folder-max-length

Integer

Maximum field length for the journal folder field.

The value cannot be longer than the field length of the field for the journal folder in the object definition.

 22 19

mas-storage.dms.register.mode

String

New registers for the e-mails are created in the folders at specified intervals, which are indexed with the date in the register field.

Values:

  • NONE

    Registers are not created.

  • PER_DAY

  • PER_WEEK

  • PER_MONTH

 PER_DAY NONE
mas-storage.dms.mailbox-related-storage.use-journaling-cabinet Boolean

Specifies whether the supplied object definition is used.

  • true

    The object definition is used.

  • false

    The object definition is not used, assignments must be created.

 false true

mas-storage.dms.mailbox-related-storage.links.special-addresses

String

Assignments of mailbox addresses for entry for the journal folder’s index data field.

If the mailbox address is included in an e-mail as 'To', 'From' or 'CC' and a separate folder is defined for the mailbox address, then a reference document is created in this folder, which refers to the original one stored in the journal folder.

 "[example@example.de]" : ExampleOnline -

mas-storage.dms.journal.object-types.folder.name

String

Internal name of the journal folder for the e-mails.

 EXCHANGESTORAGE EXCHANGESTORAGE_FOLDER

mas-storage.dms.journal.object-types.folder.fields

String

Specifies assignments between the field name (key) in enaio® mail-archive-service and the folder field name (internal name) in enaio®.

The value from the enaio® mail-archive-service field is used as the value for the corresponding enaio® field.

Only one FOLDER_USER field is enabled and assigned by default. This field is a mandatory field.

 
fields:          
  - key: FOLDER_USER
    internal-name: User
 
fields:          
  - key: FOLDER_USER
    internal-name: Benutzer

mas-storage.dms.journal.object-types.register.name

String

Internal name of the register in the folder for the e-mails.

 Structure_Register StructureRegister

mas-storage.dms.journal.object-types.register.fields

String

Specifies assignments between the field name (key) in enaio® mail-archive-service and the register field name (internal name) in enaio®.

The value from the enaio® mail-archive-service field is used as the value for the corresponding enaio® register field.

This field is a mandatory field.

 
fields:
  - key: NAME
    internal-name: note
 
fields:
  - key: NAME
    internal-name: Feld1

mas-storage.dms.journal.object-types.mail.name

String

Internal name of the document type for the e-mails.

 EMail EMAIL_DOCUMENT

mas-storage.dms.journal.object-types.mail.fields

String

Specifies assignments between the field names (key) in enaio® mail-archive-service and the e-mail document type field names (internal name) in enaio®.

The value from the enaio® mail-archive-service field is used as the value for the corresponding enaio® field for each individual message received.

MAIL_FROM, MAIL_TO, MAIL_SUBJECT, MAIL_MESSAGE_ID, and MAIL_SUBMIT_TIME are mandatory fields..

 
fields:     
  - key: REPORT_INFO
    internal-name: RPRT_INFO
  - key: REPORT_RECIPIENTS
    internal-name: RPRT_RECIPIENTS
  - key: MAIL_FROM
    internal-name: MAIL_FROM
  - key: MAIL_TO
    internal-name: MAIL_TO
  - key: MAIL_CC
    internal-name: MAIL_CC
  - key: MAIL_SUBJECT
    internal-name: SUBJECT
  - key: MAIL_BODY
    internal-name: BODY
  - key: MAIL_MESSAGE_ID
    internal-name: MESSAGE_ID
  - key: MAIL_HAS_ATTACHMENT
    internal-name: MAIL_HAS_ATTACHMENT
  - key: MAIL_SUBMIT_TIME
    internal-name: SUBMIT_TIME
  - key: MAIL_TOS
    internal-name: MAIL_TOS
  - key: MAIL_SIZE
    internal-name: MAIL_SIZE
  - key: MAIL_PRIORITY
    internal-name: MAIL_PRIORIT
  - key: SMTP_HEADER
    internal-name: SMTP_HEADER
  - key: MAIL_RECEIVE_TIME
    internal-name: MAIL_RECEIVE_TIME
 
fields:     
  - key: REPORT_INFO
    internal-name: RPRT_INFO
  - key: REPORT_RECIPIENTS
    internal-name: RPRT_RECIPIENTS
  - key: MAIL_FROM
    internal-name: MAIL_FROM
  - key: MAIL_TO
    internal-name: MAIL_TO
  - key: MAIL_CC
    internal-name: MAIL_CC
  - key: MAIL_SUBJECT
    internal-name: SUBJECT
  - key: MAIL_BODY
    internal-name: BODY
  - key: MAIL_MESSAGE_ID
    internal-name: MESSAGE_ID
  - key: MAIL_HAS_ATTACHMENT
    internal-name: MAIL_HAS_ATTACHMENT
  - key: MAIL_SUBMIT_TIME
    internal-name: SUBMIT_TIME
  - key: MAIL_TOS
    internal-name: MAIL_TOS
  - key: MAIL_SIZE
    internal-name: MAIL_SIZE
  - key: MAIL_PRIORITY
    internal-name: MAIL_PRIORIT
  - key: SMTP_HEADER
    internal-name: SMTP_HEADER
  - key: MAIL_RECEIVE_TIME
    internal-name: MAIL_RECEIVE_TIME

mas-storage.dms.mailbox-related-storage.object-types.folder.name

String

Internal name of a folder type where reference documents to the journal mails are created.

 EXCHANGELINK -

mas-storage.dms.mailbox-related-storage.object-types.folder.fields

String

Specifies assignments between the field name (key) in enaio® mail-archive-service and the folder field name (internal name) in enaio®.

The value from the enaio® mail-archive-service field is used as the value for the corresponding enaio® field of the folder for reference documents.

Only one FOLDER_USER field is enabled and assigned by default. This field is a mandatory field.

 
fields:
  - key: FOLDER_USER
    internal-name: User

-

mas-storage.dms.mailbox-related-storage.object-types.register.name

String

Internal name of the register type in enaio® used for the register objects in the folder for reference documents.

 LinkRegister -

mas-storage.dms.mailbox-related-storage.object-types.register.fields

String

Specifies assignments between the field name (key) in enaio® mail-archive-service and the register field name (internal name) in enaio®.

The value from the enaio® mail-archive-service field is used as the value for the corresponding enaio® register field in the folder for reference documents.

This field is a mandatory field.

 
fields:
  - key: NAME
    internal-name: name

 

mas-storage.dms.mailbox-related-storage.object-types.mail.name

String

Internal name of the e-mail document type in enaio® used for reference documents of the e-mail objects created by enaio® mail-archive-service.

 EMAIL_LINK -

mas-storage.dms.mailbox-related-storage.object-types.mail.fields

String

Specifies assignments between the field name (key) in enaio® mail-archive-service and the e-mail document type field name (internal name) for reference documents in enaio®.

The value from the enaio® mail-archive-service field is used as the value for the corresponding enaio® field for each individual message received.

MAIL_FROM, MAIL_TO, MAIL_SUBJECT, and MAIL_MESSAGE_ID are mandatory fields.

 
fields:     
  - key: REPORT_INFO
    internal-name: RPRT_INFO
  - key: REPORT_RECIPIENTS
    internal-name: RPRT_RECIPIENTS
  - key: MAIL_FROM
    internal-name: MAIL_FROM
  - key: MAIL_TO
    internal-name: MAIL_TO
  - key: MAIL_CC
    internal-name: MAIL_CC
  - key: MAIL_SUBJECT
    internal-name: SUBJECT
  - key: MAIL_BODY
    internal-name: BODY
  - key: MAIL_MESSAGE_ID
    internal-name: MESSAGE_ID
  - key: MAIL_HAS_ATTACHMENT
    internal-name: MAIL_HAS_ATTACHMENT
  - key: MAIL_SUBMIT_TIME
    internal-name: SUBMIT_TIME
  - key: MAIL_TOS
    internal-name: MAIL_TOS
  - key: MAIL_SIZE
    internal-name: MAIL_SIZE
  - key: MAIL_PRIORITY
    internal-name: MAIL_PRIORIT
  - key: SMTP_HEADER
    internal-name: SMTP_HEADER
  - key: MAIL_RECEIVE_TIME
    internal-name: MAIL_RECEIVE_TIME

 

mas-storage.dms.deduplication.mode

String

Specifies the behavior when e-mails are already present.

  • IGNORE

    No check.

  • WARN

    E-mail is created and log entries are written.

  • Update

    The index data of the e-mails that are already present are updated.

 WARN UPDATE
mas-storage.dms.mailbox-related-storage.user-folder-max-length Integer

Maximum field length for the user folder field.

The value cannot be longer than the field length of the field for the user folder in the object definition.

 22 19
mas-storage.dms.mailbox-related-storage.links.create-links String

Specifies whether reference documents should be created.

  • ALL

    Reference documents for configured domains and mailboxes are created.

  • NONE

    Reference documents are not created.

 ALL NONE
mas.mailbox-related-storage.folder-name-config.domains String

Domains that are part of Active Directory are used to retrieve the correct folder for reference documents for each e-mail that belong to the configured domains. There must be configured domains in AD. If not, the health check will return an error.

No reference document assignments will be created without this information.

 ostest.de,opti-syst.com -
mas.mailbox-related-storage.folder-name-config.property String

Specifies which data from the user management of an Office 365 Active Directory is used as the value for folder indexing reference documents.

Values:

  • USERNAME

  • FIRST_NAME

  • LAST_NAME

  • DISPLAY_NAME

  • SAM_ACCOUNT_NAME

An error is logged and the e-mail address is used if the data is not available.

The data can be entered centrally in the 'application-mas.yml' profile file.

 DISPLAY_NAME USERNAME
mas.exchange-online.access.client-id String

Client ID of the Azure portal.

The data can be entered centrally in the 'application-mas.yml' profile file.

 - -
mas.exchange-online.access.tenant-id String

Tenant ID of the Azure portal.

The data can be entered centrally in the 'application-mas.yml' profile file.

 - -
mas.exchange-online.access.secret String

Secret of the Azure portal application.

The data can be entered centrally in the 'application-mas.yml' profile file.

 - -
Creating attachments as a document
mas-storage.dms.journal.object-types.attachment.name String Internal name of the attachment document type in enaio®. Journal attachment ATTACHMENT
mas-storage.dms.journal.object-types.attachment.fields String

Assignments between the field names (key) in enaio® mail-archive-service and the field names (internal name) in enaio® for the indexing of journal attachments.

The default assignments correspond to the fields of the 'ATTACHMENT' document type of the object definition.

 
fields:
  - key: ATTACHMENT_FILENAME
    internal-name: FILENAME
  - key: ATTACHMENT_DATE
    internal-name: FILEDATE
  - key: ATTACHMENT_SIZE
    internal-name: FILESIZE
  - key: ATTACHMENT_MAILBOX
    internal-name: MAIL_MAILBOX
 
fields:
  - key: ATTACHMENT_FILENAME
    internal-name: FILENAME
  - key: ATTACHMENT_DATE
    internal-name: FILEDATE
  - key: ATTACHMENT_SIZE
    internal-name: FILESIZE
  - key: ATTACHMENT_MAILBOX
    internal-name: MAIL_MAILBOX
mas-storage.dms.mailbox-related-storage.object-types.attachment.name String Internal name of the attachment document type in enaio®. Mailbox attachment ATTACHMENT
mas-storage.dms.mailbox-related-storage.object-types.attachment.fields String

Assignments between the field names (key) in enaio® mail-archive-service and the field names (internal name) in enaio® for the indexing of mailbox attachments.

The default assignments correspond to the fields of the 'Attachment' document type of the object definition.

 
fields:
  - key: ATTACHMENT_FILENAME
    internal-name: FILENAME
  - key: ATTACHMENT_DATE
    internal-name: FILEDATE
  - key: ATTACHMENT_SIZE
    internal-name: FILESIZE
  - key: ATTACHMENT_MAILBOX
    internal-name: MAIL_MAILBOX
 
fields:
  - key: ATTACHMENT_FILENAME
    internal-name: FILENAME
  - key: ATTACHMENT_DATE
    internal-name: FILEDATE
  - key: ATTACHMENT_SIZE
    internal-name: FILESIZE
  - key: ATTACHMENT_MAILBOX
    internal-name: MAIL_MAILBOX
mas-storage.enaio-domain String enaio® webclient domain for enaio® webclient links to attachment documents. http://my_webenaio.de http://localhost