Active Directory Import

For Alloy Navigator Cloud (SaaS)

Updated in 8.7.2

The Active Directory Import is a tool that runs Active Directory Synchronization jobs to import user data from the Active Directory into Alloy Navigator. Typically, the synchronization is run automatically by the Automation Server, in accordance with the schedule you specify for Active Directory Synchronization jobs.

You can also run Active Directory Synchronization from the command line. This scenario can be useful for our cloud customers who use an on-premise Active Directory and do not want our cloud application to access their on-premise domains.

To set up Active Directory Synchronization from the command line:

  1. In the Settings App, create an Active Directory Synchronization job or make sure that the job already exists (Services > Active Directory Integration > Synchronization). See Creating or modifying Active Directory Synchronization jobs.

    TIP: Since your job will not be run on the Automation Server, leave the Enabled check box clear and keep the defaults for the Connect as settings and the job schedule.

  2. Review available command-line parameters for the Active Directory Import tool. See Command-line parameters for the Active Directory Import tool.

  3. Use the Windows Task Scheduler to schedule your Active Directory Synchronization job to run automatically. See Using the Task Scheduler to automate Active Directory Synchronization.

Command-line parameters for the Active Directory Import tool

The executable program that Active Directory Synchronization uses is ImportContacts.exe. The executable file is located in the /Bin sub-folder of your Alloy Navigator installation folder.

TIP: The Active Directory Import command-line tool is part of the Alloy Administrative Tools package for SaaS Alloy Navigator. If you cannot locate your ImportContacts.exe, please contact our Support Team for assistance.

The following table lists all the command-line parameters for ImportContacts.exe. Command-line parameters are case insensitive.

Parameter Description

/?

Displays the full list of command-line parameters and a usage example.

/AccessKey="Key_Name"

The name of the Database Access Key for the Alloy Navigator database to import data into.

You can view this key name in Automation Server Manager (see the Key field) or in the Connection Manager window (see the Key Name field).

/RunID="Job_GUID"

The ID (GUID) of the Active Directory Synchronization job to run.

TIP: You can easily copy the job GUID from the Settings App. Navigate to your Active Directory Synchronization job (Services > Active Directory Integration > Synchronization, right-click the job, and select Copy Item ID (GUID) to Clipboard from the pop-up menu.

/Log="File_Name"

The name of the temporary log file (no extension is needed). This parameter is optional.

If the /Log="File_Name" parameter is not specified, a log file with a random file name is created.

After every successful import, the log data is uploaded to Active Directory Synchronization Log and the log file is purged from the hard disk. Log files for failed jobs remain on the hard disk.

Temporary log files are created in this folder:

%ALLUSERSPROFILE%\Alloy Software\Alloy Navigator\8.0\Logs\Services\

For example, the following command runs the Active Directory Synchronization job {4253CC46-9DCF-4E6C-9C0B-C05E59ABD6AB} to import user data to the database using the Database Access Key SERVER_001 : DB_001. The progress data will be saved to the file %ALLUSERSPROFILE%\Alloy Software\Alloy Navigator\8.0\Logs\Services\ImportContacts.log.

ImportContacts.exe /AccessKey="SERVER_001 : DB_001" /RunID={4253CC46-9DCF-4E6C-9C0B-C05E59ABD6AB} /Log="ImportContacts"

Using the Task Scheduler to automate Active Directory Synchronization

You can use the Windows Task Scheduler to automate Active Directory Synchronization. Create this task on a server computer in your network that has access to the SQL Server hosting your Alloy Navigator database and the Active Directory domain controller.

NOTE: The steps below show how to create a scheduled task on a computer running Windows 10. For other Windows versions, refer to your Windows documentation.

To automate the Active Directory Import tool using the Task Scheduler:

  1. Open the Windows Task Scheduler. For example, type Task Scheduler in the Windows search box, and click the top result to open the Task Scheduler. If you are prompted for an administrator password or confirmation, type the password or provide confirmation.

  2. If you want to place the new task to a new folder, right-click the Task Scheduler Library branch, select the New Folder option, and create a new folder.

  3. Click the Actions menu, and then click Create Basic Task.

  4. Type a name for the task and an optional description, and then click Next.

  5. To select a schedule based on the calendar, click Daily, Weekly, Monthly, or One time, click Next; specify the schedule you want to use, and then click Next.

  6. Click Start a program, and then click Next.

  7. Click Browse to navigate to the executable program (ImportContacts.exe), specify the command-line parameters as arguments, and then click Next.

  8. Click Finish.

IMPORTANT: The account that will run the task must have sufficient rights to access the Active Directory. If needed, you can specify a dedicated account on the General tab of the task, by clicking Change User or Group under Security options.