Netwrix Directory Manager v11.1.25162.02 - Script Utility Documentation

Products Directory Manager Show & Tell
, , ,
1

Netwrix Directory Manager Script Utility v1.0

This document serves as a guide for using the Netwrix Directory Manager Script Utility. It provides details on how to export existing scripts used in Smart Group and Dynasty queries, as well as scripts used in Synchronize jobs.

The exported scripts remain associated with the Smart Groups, Dynasties, and Synchronize jobs. You can choose to continue using the same scripts or associate new ones from the folder.

Important: You must run the utility before configuring the latest Netwrix Directory Manager build (11.1.25162.02).

Download the Utility

You can download the Netwrix Directory Manager Script utility v1.0 from the following URL:
Download Netwrix Directory Manager Script Utility v1.0
The file is downloaded into a folder as per your browser’s download settings. Unzip the file into a folder.

Run the Utility

Follow the steps to run the utility.

  • At the Windows Command prompt, go to the folder where you have placed the utility.
  • On the command prompt, execute the following cmdlet.

NetwrixScriptUtility.exe -s <SQLServerName> -u <SQLUsername> -d <DatabaseName> -l <ElasticsearchURL> -a <ElasticsearchUsername> -i

The cmdlet supports the following parameters.

  • -s, SqlServerName The name of SQL Server where your database exists
  • -i, IsSqlAuthentication If you are using SQL authentication or not
  • -u, SqlUsername Username of account used to connect to SQL Server
  • -d, DatabaseName Name of the database
  • -l, ElasticSearchUrl Elasticsearch URL
  • -a, ElasticSearchUsername Username of the Elasticsearch service
  • –help Displays the list of supported parameters
  • –version Displays the version number of the utility

The utility will prompt you to enter the passwords for the SQL Server and Elasticsearch.

All Synchronize scripts are read from a database table named sync.jobsettings. After the utility is run, all jobs, including their associated scripts, are saved in this table in encrypted form, and will be saved in a folder named PortalScripts at the following path.

C:\Program Files\Imanami\GroupID11.0\PortalScripts\

The utility then exports scripts from existing Smart Groups, Dynasties (both managerial and non-managerial), and Synchronize jobs into this folder as Visual Basic .NET files. The exported files are named as follows:

Scripts from Smart Groups/Dynasty Query Designer

<Smart Group/Dynasty name>_imsgscript_D

Where:

  • imsgscript is a Directory Manager’s pseudo-attribute
  • ID is a unique identifier of the Smart Group/Dynasty

Managerial Dynasty

<Dynasty name>_imsgdynastytoplevelscript_ID
Where:

  • imsgdynastytoplevelscript indicates that the script is applied at the top manager of the dynasty
  • ID is a unique identifier of the managerial dynasty

Non-managerial (Organizational/Geographical/Custom) Dynasty

<Dynasty name>__imsgdynastylevelattributes_<attributename>_ID

Where

  • imsgdynastylevelattributes indicates that the script is applied at the attribute level
  • attributename indicates the name of the attribute to which the script is applied, for example, Company, Department or Title
  • ID is a unique identifier of the non-managerial dynasty

Synchronize Jobs

<JobName>_<script type>_ID

Where:

  • script type indicates the level at which the script is applied. The levels can be:
    • Global
    • Transform
    • Container
  • ID is a unique identifier that helps in locating the global, transform, and container scripts in Directory Manager database.

Example of exported Synchronize script files:

  • VB folder_GlobalScript_53
  • Transform Python_TransformScript_73
  • container python_ContainerScript_1 0

Note: You can create new scripts with a filename of your choice in the same folder, i.e.: (C:\Program Files\Imanami\GroupID11.0\PortalScripts\)
And use them in Smart Group and Dynasty queries, as well as in Synchronize jobs.

The following sections explain how you can access the script from the PortalScripts folder for Smart Groups, Dynasties, and Synchronize jobs.