importSelectionFileName properties file

The importSelectionFileName file is a properties file that contains a list of the resource instances, such as mailboxes, virtual roots, and event rules to be imported with the importUtility script. For mailbox permissions, virtual roots and event rules, the importSelectionFileName file can include mapping to specific applications.

File location

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

Usage

Use the importSelectionFileName to specify a list of the resource instances to be imported with the importUtility script and the set of applications.

Environments

  • Linux® or UNIX
  • Windows

Authorization

Only users with administrative permissions can edit the importSelectionFileName file.

Syntax

option=value

Option descriptions

mailboxes
A comma separated list of absolute mailbox paths to be imported. Each mailbox must be included in the file being imported. 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> imports all available mailboxes. If the file does not contain a mailboxes property, then no mailboxes are imported.
Examples:

To import two mailboxes named /home/bill and /home/sue, ignoring any other mailboxes in the import file:

mailboxes=/home/bill,/home/sue
To import all the mailboxes in the import file:
mailboxes=<ALL>
virtualroots.source_app_name
A comma separated list of user ids indicating the virtual roots to be imported. 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. Because user ids are relative to an application and an import file may contain virtual roots for multiple applications, the property name must include the source application name (the application name contained in the import file itself). For import formats that do not include application references, source_app_name must be set to the value passed in for the --defaultAppName option. A value of <ALL> causes all available virtual roots to be imported. If the file does not contain a virtualroots property, then no virtual roots are imported.
Examples:
To import the virtual roots for users bill and sue of the source application named B2Bi, ignoring any other virtual roots in the import file:
virtualroots.B2Bi=bill,sue
To import all virtual roots in the import file, regardless of the application. Any source_app_name value can be used here and it selects virtual roots for all applications in the import file.
virtualroots.B2Bi=<ALL>
eventrules.source_app_name
A comma separated list of event rule names to be imported. 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. Because event rule names are relative to an application and an import file may contain event rules for multiple applications, the property name must include the source application name (the application name contained in the import file itself). For import formats that do not include application references, source_app_name must be set to the value passed in for the --defaultAppName option. A value of <ALL> causes all available event rules to be imported. If the file does not contain an eventrules property, then no event rules are imported.
Examples:
To import the event rules named RuleOne and RuleTwo of the source application named B2Bi, ignoring any other event rules in the import file:
eventrules.B2Bi=RuleOne,RuleTwo
To import all event rules in the import file, regardless of the application. Any source_app_name value can be used here and it selects all event rules for all applications in the import file.
eventrules.B2Bi=<ALL>
appMap.source_app_name
A single target application name, depending on the actual application name.
Example:
Source system application Target system application appMap value in the selection file
GENTRAN B2Bi appMap.GENTRAN=B2Bi
SI WTX appMap.SI=WTX
GIS AC appMap.GIS=AC
Example:
To map references in the import file to application names SterlingIntegrator1: or AdvanceComms to the application ids associated with the target system applications B2Bi and AC:
appMap.SterlingIntegrator1=B2Bi
appMap.AdvancedComms=AC
Results:
  • If a mailbox was exported containing permissions for a Principal of application SterlingIntegrator1, the import operation creates the equivalent permissions for a Principal of application B2Bi.
  • If a virtual root for a Principal of application AdvancedComms was exported, the import operation creates a virtual root for a Principal of application AC.
  • If an event rule was exported with an application of SterlingIntegrator1, the import operation creates an event rule for the application B2Bi.

Example importSelectionFileName.properties file

The following example importSelectionFileName.properties file selects mailboxes, event rules, and applications:
mailboxes=/home/joe_employee,/home/joe_manager,/home/joe_supplier
eventrules.B2Bi=MANAGER,SUPPLIER,ALL_MBX
virtualroots.B2Bi=joe_employee,joe_manager,joe_supplier
Remember: The application is not specified for mailboxes, but must be specified for event rules (eventrules.B2Bi) and virtual roots (virtualroots.B2Bi).