On this page:

Establishing scheduled import of data or metadata from Aderant Expert

Prerequisite for Aderant Expert client and matter import

Aderant Expert must be at version 8.2.2 or later.

Aderant Expert client and matter import

Install and configure Aderant Expert client and matter import tools:

  1. From the latest iManage SPM Cloud Service Update, download the iManage Security Policy Manager Cloud Import ZIP package.

  2. Extract the ZIP.

  3. Open the Import>Client and Matters>Aderant Expert folder.

  4. You can optionally import the custom properties of clients and matters from Aderant Expert. SQL Scripts are provided in the Scripts folder to facilitate this. See the README file in the Client and Matters folder for more information on how to use these scripts.

  5. Review the settings in the iManage SPM Scheduled Client and Matter Import.cfg and adjust where necessary. See the following section Configuration for import of Aderant Expert clients and matters for information on applicable settings in the configuration file and how to adjust them.

  6. Right-click the setup EXE, and select Run as Administrator.

  7. Follow the instructions provided in the setup wizard.

On completion of these steps a task is added to Windows Task Scheduler, with a name reflecting that of the corresponding CFG file. This task can be adjusted as required. Information on how to do this is provided in the Task Scheduler settings section of Verify data import.

Note also that metadata can also be imported from other sources: see Establishing scheduled import of metadata from any other source.

Configuration for import of Aderant Expert clients and matters

The following section includes all of the applicable settings in the CFG file you are modifying. Any settings not documented here should be left at default values, or left commented out, under normal circumstances.

Import Schedule

  • Schedule Task Name: By default, it is set to iManage SPM Scheduled Client & Matter Import.

  • Schedule Type: You can configure any of the following values: monthly, weekly, daily, hourly, minutes. The default value is hourly.

  • Schedule Start Time: Based on the previous configuration, you can modify the value here. By default, it is set to 00:00. When scheduling a monthly, weekly or daily task, you can specify a start time as a 24-hour clock time in the form of HH:MM. This value is ignored for hourly or minutes scheduling types.

  • Schedule Interval: When you schedule the import task in hours or minutes, set this value to be the interval between executions in hours or minutes, as applicable. By default, it is set to 1.

  • Schedule User: The task executes using the account specified. If the account is not specified, the currently active account of the installing user is used.

Importer Security Policy Manager login

These are the settings that the importer uses to connect to the SPM server.

  • In the spm.server field, enter the hostname component of your iManage Security Policy Manager URL (as supplied by iManage).
    For example, for URL https://<OrganizationID>-spm.imanage.work/, where “<OrganizationID>” is your customer ID or the vanity URL of your organization, as supplied by iManage, enter <OrganizationID>-spm.imanage.work

  • In the spm.port field, enter port 443.

  • In the spm.useSSL field, the default value of yes indicates that import will use SSL when communicating with SPM Server.  When yes, ensure that a certificate is available.

  • In the spm.username field, enter the iManage SPM server account that the importer should use to connect to the server. The default value is SPMAdmin.

  • The spm.password field is set to <passwordprompt> by default and this is recommended. The system will request the password (of the account specified in the spm.username field) when running the installer.

  • In the spm.certificate field, the default value is '..\..\spm-demo.crt'. Uncomment this field if you are using a self-signed certificate and want to override server certificate (not recommended).

Synchronization type (import type)

For odbc.syncType, you can set one of the following values: full, incremental, or incrementalMigration. iManage recommends that this is kept at incrementalMigration, the default value.

ODBC Connection to target database 

  • ODBC ConnectionString: Specify connection credentials for the ODBC data source.

    • Example of non-integrated security connection string:

      # odbc.connectionString=DRIVER={SQL Server};SERVER=localhost,1433;DATABASE=Aderant;Integrated Security=true;

  • ODBC Batchsize: Specify the number of items to batch.  By default, XML files for clients and matters contains a maximum of 1000 clients and/or matters.

  • ODBC ConnectionTimeout: Specify the duration after which the connection will timeout if there is no response from the source system. By default, it is set to 60 (seconds).

  • ODBC SyncTag: The default value is AderantImport.

Import Queries 

  • If syncType is Incremental, then ODBC Import will track the last time it successfully executed. By default, this uses the date and time of the target database.  
    fetch.currentTime=select GETUTCDATE()

  • You can use the tracking information in subsequent queries by referencing the token ${LASTRUNDATE}.

  • Import can be configured to import users, groups, clients and matters into iManage Security Policy Manager. Query configurations for each object are already provided in the CFG file, and these are recommended for use.

Configure client and matter query and custom property mappings

To perform import of custom properties, you need to provide query configuration for client and matter custom properties.

For clients

  • fetch.clients.enabled: Leave at true (default value) to enable Aderant Expert client import.

  • fetch.clients: The the file used for loading clients is client.sql.

The SQL in client.sql must be reviewed and modified to ensure that the desired custom properties information will be mapped as intended to iManage Security Policy Manager.See README.txt in the same folder for additional information.

For matters

  • fetch.matters.enabled: Leave at true (default value) to enable Aderant Expert matter import.

  • fetch.matters: The the file used for loading clients is matter.sql.

The SQL in matter.sql must be reviewed and modified to ensure that the desired custom properties information will be mapped as intended to iManage Security Policy Manager.See README.txt in the same folder for additional information.

Establishing scheduled import of data or metadata from Elite Enterprise

Elite Enterprise client and matter import

  1. From the latest iManage SPM Cloud Service Update, download the iManage Security Policy Manager Cloud Import ZIP package.

  2. Extract the ZIP.

  3. Open the Import>Client and Matters>Elite Enterprise folder.

  4. You can optionally import the custom properties of clients and matters from Elite. SQL Scripts are provided in the Scripts folder to facilitate this. See the README file in the Clients and Matters folder for more information on how to use these scripts.

  5. Review the settings in the iManage SPM Scheduled Client and Matter Import.cfg and adjust where necessary. See the following section Configuration settings for client and matter import for information on applicable settings in the configuration file and how to adjust them.

    If you wish to use settings from an older, previously configured iManage SPM Scheduled ODBC Import.cfg file (or if from SPM 10.1.x, iManage SPM Scheduled Client and Matter Import .cfg file), you should open both files to compare settings and adjust (but not replace) the relevant settings in the up-to-date iManage SPM Scheduled Client and Matter Import.cfg file so that the older settings, where applicable, are reflected therein.

  6. Right-click the setup EXE in the folder you are using, and select Run as Administrator.

  7. Follow the instructions provided in the setup wizard.

On completion of these steps a task is added to Windows Task Scheduler, with a name reflecting that of the corresponding CFG file. This task can be adjusted as required. Information on how to do this is provided in the Task Scheduler settings section of  Verify data import.

Note also that metadata can also be imported from other sources: see Establishing scheduled import of metadata from any other source.

Configuration settings for client and matter import

The following section includes all of the applicable settings in the CFG file you are modifying. Any settings not documented here should be left at default values, or left commented out, under normal circumstances.

Import Schedule

  • Schedule Task Name: By default, it is set to iManage SPM Scheduled Client & Matter Import.

  • Schedule Type: You can configure any of the following values: monthly, weekly, daily, hourly, minutes. The default value is hourly.

  • Schedule Start Time: Based on the previous configuration, you can modify the value here. By default, it is set to 00:00. When scheduling a monthly, weekly or daily task, you can specify a start time as a 24-hour clock time in the form of HH:MM. This value is ignored for hourly or minutes scheduling types.

  • Schedule Interval: When you schedule the import task in hours or minutes, set this value to be the interval between executions in hours or minutes, as applicable. By default, it is set to 1.

  • Schedule User: The task executes using the account specified. If the account is not specified, the currently active account of the installing user is used.

Importer Security Policy Manager login

These are the settings that the importer uses to connect to the SPM server.

  • In the spm.server field, enter the hostname component of your iManage Security Policy Manager URL (as supplied by iManage).
    For example, for URL https://<OrganizationID>-spm.imanage.work/, where “<OrganizationID>” is your customer ID or the vanity URL of your organization, as supplied by iManage, enter <OrganizationID>-spm.imanage.work

  • In the spm.port field, enter port 443.

  • In the spm.useSSL field, the default value of yes indicates that import will use SSL when communicating with SPM Server.  When yes, ensure that a certificate is available.

  • In the spm.username field, enter the iManage SPM server account that the importer should use to connect to the server. The default value is SPMAdmin.

  • The spm.password field is set to <passwordprompt> by default and this is recommended. The system will request the password (of the account specified in the spm.username field) when running the installer.

  • In the spm.certificate field, the default value is '..\..\spm-demo.crt'. Uncomment this field if you are using a self-signed certificate and want to override server certificate (not recommended).

Synchronization type (import type)

  • SyncType: You can set one of the following values: full, incremental or incrementalMigration. iManage recommends that this is kept at incrementalMigration, the default value.

Certificate options

  • spm.certificate – Set the path to the SPM certificate. Note that the default is the spm-demo.crt, which is not suitable for production use.

ODBC Connection to target database

  • ODBC ConnectionString: Specify connection credentials for the ODBC data source.

  • ODBC Batchsize: Specify the number of items to batch. By default, XML files for clients and matters contains a maximum of 1000 clients and/or matters.

  • ODBC ConnectionTimeout: Specify the duration after which the connection will timeout if there is no response from the source system. By default, it is set to 60 (seconds).

  • ODBC SyncTag: By default, it is set to ODBC.

An example of non-integrated security connection string:

# odbc.connectionString=Driver={SQL Server};Server=<OrganizationID>-spm.imanage.work;Database=Elite;Uid=sa;Pwd=<passwordprompt>

Import queries

  • If syncType is Incremental, then ODBC Import will track the last time it successfully executed. By default, this will use the date and time of the target database.
    fetch.currentTime=select GETUTCDATE()

  • You can use the tracking information in subsequent queries by referencing the token ${LASTRUNDATE}.

  • Import can be configured to import users, groups, clients and matters into iManage Security Policy Manager. Query configurations for each object are already provided in the CFG file, and these are recommended for use.

Configure client and matter query and custom property mappings

To perform import of custom properties, you need to provide query configuration for client and matter custom properties.

For clients

  • fetch.clients.enabled: Leave at true (default value) to enable Aderant Expert client import.

  • fetch.clients: The the file used for loading clients is client.sql.

The SQL in client.sql must be reviewed and modified to ensure that the desired custom properties information will be mapped as intended to iManage Security Policy Manager.See README.txt in the Clients and Matters folder for additional information.

For matters

  • fetch.matters.enabled: Leave at true (default value) to enable Aderant Expert matter import.

  • fetch.matters: The the file used for loading clients is matter.sql.

The SQL in matter.sql must be reviewed and modified to ensure that the desired custom properties information will be mapped as intended to iManage Security Policy Manager.See README.txt in the Clients and Matters folder for additional information.

Establishing scheduled import of data or metadata from Elite 3E

Prerequisites for Elite 3E client and matter import

  1. The account defined as schedule.user in the Elite 3E configuration files must have full administrative permissions (including "Can Edit Global Models" permission) in Elite 3E.

  2. SPMTimeview customization has been deployed. This is deployed using the Elite 3E integrated development environment (IDE). For more information on using the IDE, refer to the relevant Elite 3E documentation.

    1. Create a folder called "Custom" - this will be used to extract the SPM Elite 3E Integration package into.

    2. Extract the contents of the iManage Security Policy Manager Elite 3E Custom Integrations {version}.zip file to the "Custom" folder created in the previous step.

    3. Using the "Extract" function of the 3E Utilities tool, extract the "Custom" folder into the Elite 3E IDE.

    4. Save and publish the project in Elite 3E.

Elite 3E client and matter import

When prerequisites are fulfilled, install and configure Elite 3E client and matter import tools:

  1. From the latest iManage SPM Cloud Service Update, download the iManage Security Policy Manager Cloud Import ZIP package.

  2. Extract the ZIP.

  3. Open the Import>Client and Matters>Elite 3E folder.

  4. Open iManage SPM Scheduled Elite 3E Client and Matter Import.cfg

  5. Configure the settings as described in Configuration for import of Elite 3E clients and matters.

  6. In the Client and Matters folder, right-click the iManage SPM Scheduled Elite 3E Client and Matter Import Setup.exe, and select Run as Administrator.

  7. Follow the instructions provided in the setup wizard.

On completion of these steps a task is added to Windows Task Scheduler, with a name reflecting that of the corresponding CFG file. This task can be adjusted as required. Information on how to do this is provided in the Task Scheduler settings section of Verify data import.

Note also that metadata can also be imported from other sources: see Establishing scheduled import of metadata from any other source.

Configuration for import of Elite 3E clients and matters

This section details the parameters to be specified in the iManage SPM Scheduled Elite 3E Client and Matter Import Setup.cfg. Any settings not documented must be left at the default values. 

The XML files in the Scripts folder are used by the importer in the import of clients, matters, and their custom properties. 

Import schedule

  • Schedule Task Name: By default, this is set to iManage SPM Scheduled Elite 3E Client & Matter Import

  • Schedule Type: You can configure any of the following values: monthly, weekly, daily, hourly, minutes. The default value is hourly.

  • Schedule Start Time: Based on the previous configuration, you can modify the value here. By default, it is set to 00:00. When scheduling a monthly, weekly or daily task you can specify a start time as a 24-hour clock time in the form of HH:MM. This value is ignored for hourly or minutes scheduling types.

  • Schedule Interval: When you schedule the import task in hours or minutes, set this value to be the interval between executions in hours or minutes, as applicable. By default, it is set to 1.

  • Schedule User: The task executes using the account specified. If the account is not specified, the currently active account of the installing user is used. Note that, per prerequisites, this account used must have full administrative permissions, including "Can Edit Global Models" permission, in Elite 3E.

Importer SPM login

  • In the spm.server field, enter the relevant hostname component of the URL (as supplied by iManage).
    For example, for URL https://<OrganizationID>-spm.imanage.work/, where “<OrganizationID>” is your customer ID or the vanity URL of your organization, as supplied by iManage, enter <OrganizationID>-spm.imanage.work .

  • In the spm.port field, enter port 443.

  • In the spm.useSSL field, the default value of yes indicates that import will use SSL when communicating with SPM Server. When yes, ensure that a certificate is available.

  • In the spm.username field, enter the iManage SPM server account that the importer should use to connect to the server. The default value is SPMAdmin.

  • The spm.password field is set to <passwordprompt> by default and this is recommended. The system will request the password (of the account specified in the spm.username field) when running the installer.

  • In the spm.certificate field, the default value is '..\..\spm-demo.crt'. Uncomment this field if you are using a self-signed certificate and want to override server certificate (not recommended).

Synchronization type (import type)

The synchronization type setting for Elite 3E is as follows:

  • For webservice.syncType, you can set one of the following values: full, incremental, or IncrementalMigration. iManage recommends that this is kept at incremental, the default value.

Web service connection

  • webservice.batchSize: Specify the number of items to batch. By default, XML files for clients and matters contain a maximum of 1000 clients and/or matters.

  • webservice.connectionTimeout: Specify the duration in seconds after which the connection will timeout if there is no response from the source system. By default, this is set to 300.

  • webservice.syncTag: By default, this is set to EliteImport.

  • webservice.url: Specify the web service WSDL endpoint.

  • webservice.certificate: Uncomment this parameter if the web service is not using SSL with a trusted certificate, and provide the path to the certificate bundle.

Date format

  • webservice.dateFormat: Optionally specify the date format, as MDY or DMY. Default value is MDY.

Client and matter query and custom property (metadata) mappings

To perform import of custom properties metadata, you need to provide query configuration for client and matter custom properties.

For clients

  • fetch.clients.enabled: Set to true (default value) to enable Elite 3E client import.

  • fetch.clients: Set the file to be used for loading clients. The two files provided are client-query.xml and client-query-extra-properties.xml. The latter is provided as an example to retrieve additional information that can be used as custom properties in SPM.
    Specify the file to be used, as follows:

    • fetch.clients=load_file('client-query.xml')
      OR

    • fetch.clients=load_file('client-query-extra-properties.xml')

If you specify fetch.clients=load_file('client-query-extra-properties.xml'), then you must also uncomment and, as required, edit the following parameters:

  • fetch.clients.properties.from=Status,BillTkprDispName,RespTkprDispName: This defines which fields from client query results will be mapped to custom properties as defined in the "fetch.clients.properties.to.names" parameter described below. The names of the "from" properties in this parameter are mapped to the property in the same order position in the "to" parameter (described below)—for example, with default values in place, "Status" is mapped to "Status", "BillTkprDispName" is mapped to "Billing Lawyer", and so on.

  • fetch.clients.properties.to.names="Status","Billing Lawyer","Responsible Lawyer": This defines the SPM custom property names to which the "from" properties in "fetch.clients.properties.from" parameter, described above, are mapped to.

In addition, (when configuring import of custom properties), if there is more than one property of the same name in Elite 3E, use the following parameters to specify the location of the custom property to be used:

  • fetch.client.properties.to.sectiontypes: By default, all available section types are included ("GeneralDetails", "GeneralDetails", "GeneralDetails").

  • fetch.client.properties.to.propertysetnames: By default, all available property set names are included ("Contact information", "Contact information", "Contact information").

For matters

  • fetch.matters.enabled: This must be set to true (default value) to enable Elite 3E matter import.

  • fetch.matters: Set the file to be used for loading matters. The two files provided are matter-query.xml and matter-query-extra-properties.xml. The latter allows for the import of matter custom property mappings. Specify the file to be used, as follows:

    • fetch.matters=load_file('matter-query.xml')
      OR

    • fetch.matters=load_file('matter-query-extra-properties.xml')

If you specify fetch.matters=load_file('matter-query-extra-properties.xml'), then you must also uncomment the following parameters:

fetch.matters.properties.from=Status,BillTkprDispName,RespTkprDispName

fetch.matters.properties.to.names="Status","Billing Lawyer","Responsible Lawyer"

In addition, (when configuring import of custom properties), if there is more than one property of the same name in Elite 3E, use the following parameters to specify the location of the custom property to be used:

fetch.matter.properties.to.sectiontypes: By default, all available section types are included ("GeneralDetails", "GeneralDetails", "GeneralDetails").

fetch.matter.properties.to.propertysetnames: By default, all available property set names are included ("Additional Information", "Additional Information", "Additional Information").

  • fetch.timeAndBilling.clientMatterSeparator: Specify the separator used between client and matter identifiers; this identifies the client identifier prefix for removal. Use an empty string to disable.

Establishing scheduled import of metadata from any other source

If you require additional metadata to be imported from any other source (excluding iManage Work in the Cloud), you must use SPM Generic Migration to stage data from your source repository and process XML load files into SPM.

For information about how to do this, refer to iManage SPM: Migrating to iManage SPM in the Cloud using Generic Migration.