Logo

Documentation home for Transend tools

Export-DOMInventory

SYNOPSIS

Exports user inventory data from a Domino tenant.

DESCRIPTION

Use the Export-DOMInventory agent to export user inventory data from a Domino tenant.

See the Notes section for agent requirements.

EXAMPLES

Example 1: Export from local TMCTools.nsf

  1. Copy Person docs from Domino Directory and paste into TMCTools.nsf

  2. Copy the Inventory\EncryptedDocs and Inventory\LargeDocs views from TMCTools.ntf and paste into the mail template(s)

  3. Run the Design task to propagate the views to user mail files

  4. Set the following parameters in config.ini:
    • LICENSE=xxxxxxxxxxxxxxxxxxxxxxxx
    • SERVER=Local
    • DATABASE=TMCTools.nsf
    • INTERNAL_NOTES_ORGANIZATIONS=Example,Sample
    • INTERNAL_SMTP_DOMAINS=example.org,sample.org
  5. Run Actions -> Export-DOMInventory from TMCTools.nsf

Example 2: Export from server names.nsf

  1. Copy the Inventory\EncryptedDocs and Inventory\LargeDocs views from TMCTools.ntf and paste into the mail template(s)

  2. Run the Design task to propagate the views to user mail files

  3. Set the following parameters in config.ini:
    • LICENSE=xxxxxxxxxxxxxxxxxxxxxxxx
    • SERVER=Domino/Example
    • DATABASE=names.nsf
    • INTERNAL_NOTES_ORGANIZATIONS=Example,Sample
    • INTERNAL_SMTP_DOMAINS=example.org,sample.org
  4. Run Actions -> Export-DOMInventory from TMCTools.nsf

PARAMETERS

DATABASE

The database from which Person docs will be retrieved.

Type: String
Accepted values: TMCTools.nsf, names.nsf, pubnames.nsf

Required: True
Default value: None

INTERNAL_NOTES_ORGANIZATIONS

A comma-separated list of Notes organizations considered internal to the current environment.

Note that you must omit the leading slash character. For example, use Example,Sample instead of /Example,/Sample.

Type: String

Required: True
Default value: None

INTERNAL_SMTP_DOMAINS

A comma-separated list of SMTP domains considered internal to the current environment.

LICENSE

Your TMCTools license key.

Type: String

Required: True
Default value: None

MESSAGE_SIZE_LIMIT

The value in bytes used to identify large files.

Type: String

Required: False
Default value: 25000000

SCAN_ALL_DOCUMENTS

By default, Export-DOMInventory gets encrypted and large document counts from views shipped with TMCTools and copied into mail templates. Use SCAN_ALL_DOCUMENTS=True to get this information from inspecting each document in the database if the views are not available.

Note that this parameter can decrease performance significantly.

Type: String

Required: False
Default value: 25000000

SERVER

The location of the database specified in the DATABASE parameter.

For a server location, use the server’s hierarchical name. For example, Domino/Example.

For a local location, use Local.

Type: String

Required: True
Default value: None

INPUTS

None

OUTPUTS

CSV

NOTES

  • Output is written to inventory.csv in the invocation directory in C:\ProgramData\Transend\tools\logs.

  • Review warnings.log for non-fatal problems that may impact the data.

TMCTools configuration options