exportSelectionFileName properties file

The exportSelectionFileName file is a properties file that contains a list of the resource instances, such as mailboxes, virtual roots, and event rules to be exported with the exportUtility script.

File location

This file is located on your local drive to upload when you run the exportUtility.

Usage

Use the exportSelectionFileName to specify a list of the resource instances to be exported with the exportUtility script. The set of applications specified in the exportSelectionFileName file controls which permissions are exported along with a mailbox. Permissions are only exported along with the mailbox when the permission is held by a user in the set of applications listed in selection file or in the application specified in --appName or --appId command line arguments when you run the script.

Environments

  • Linux® or UNIX
  • Windows

Authorization

Access to the local file system is required to edit the exportSelectionFileName file.

Syntax

option=value

Option descriptions

mailboxes
A comma separated list of absolute mailbox paths. If a mailbox name contains one of the following characters:
, < > |
it must be preceded with a pipe character (|). For example a mailbox named /a,b,c is specified as /a|,b|,c. A value of <ALL> exports all available mailboxes. The appId or appName command line argument controls which user permissions are included when the mailbox is exported.
virtualroots
A comma separated list of user ids of the application identified by the appId or appName command line argument, indicating the virtual roots to be exported. If the user id contains one of the following characters:
, < > |
it must be preceded with a pipe character (|). For example a user id of /a,b,c is specified as /a|,b|,c. If the user id contains a backslash, it must be replaced with two backslashes. A value of <ALL> exports all available virtual roots associated with the application identified by the appId or appName command line argument.
eventrules
A comma separated list of event rule names. All event rules must be associated with the application identified by the appId or appName command line argument. If the event rule name contains one of the following characters:
, < > |
it must be preceded with a pipe character (|). For example an event rule named /a,b,c is specified as /a|,b|,c. If the event rule name contains a backslash, it must be replaced with two backslashes. A value of <ALL> exports all available event rules associated with the application identified by the appId or appName command line argument.
applications
A comma separated list of application names. If the application name contains one of the following characters:
, < > |
it must be preceded with a pipe character (|). When exporting mailboxes, permissions are only included for users associated with the application identified by the appId or appName command line argument or an application listed in this property. A value of <ALL> selects all available applications on the source system.

Example exportSelectionFileName.properties file

The following example exportSelectionFileName.properties file selects mailboxes, event rules, and applications:
mailboxes=/home/joe_employee,/home/joe_manager,/home/joe_supplier
eventrules=MANAGER,SUPPLIER,ALL_MBX
virtualroots=joe_employee,joe_manager,joe_supplier
applications=B2Bi,AC
The following example exportSelectionFileName.properties file selects everything in the source system:
mailboxes=<ALL>
virtualroots=<ALL>
eventrules=<ALL>
applications=<ALL>