Skip to main content

Configuring Microsoft Entra HR Roster Data Collector

Open iT collects Microsoft Entra HR roster data and sends it over to the server. This allows cloud-based server installation to integrate the Active Directory to its reports.

Requirements​

Configuring Microsoft Entra HR Roster Data Collection​

Step 1: Open Command Prompt​

  1. Open a command prompt with Administrator level privileges.

Step 2: Navigate to the bin Directory​

  1. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
    cd <bin_dir>
    Example
    cd C:\Program Files\OpeniT\Core\bin

Step 3: Activate Microsoft Entra HR Roster Data Collection​

  1. Run the following command to enable Microsoft Entra HR roster data collection:

    Command Syntax
    openit_oconfinit -u "collect_azuread.root.scheduler.jobs.collect_azuread.general.active=true"

Step 4: (Optional) Activate Collection for a Specific Microsoft Entra ID Account​

If you configured multiple Microsoft Entra ID accounts and want to collect HR roster data from a specific account, include the --name argument followed by the configured account name.

Run the following command:

Command Syntax
openit_oconfinit -u "collect_azuread.root.scheduler.jobs.collect_azuread.operations.arguments=azure collect hrroster --output \"${OpeniT.directories.temp}/IdpConnector/Azure/HRRoster/azuread.tsv\" --fields userPrincipalName displayName onPremisesSamAccountName department division employeeType city mail officeLocation jobTitle --name <name>"

where <name> is the name of the account you want to use for data collection.

Example
openit_oconfinit -u "collect_azuread.root.scheduler.jobs.collect_azuread.operations.arguments=azure collect hrroster --output \"${OpeniT.directories.temp}/IdpConnector/Azure/HRRoster/azuread.tsv\" --fields userPrincipalName displayName onPremisesSamAccountName department division employeeType city mail officeLocation jobTitle --name azure1"

Verifying Data Collection​

After configuration, you can verify that the Microsoft Entra HR roster data is collected by following these steps:

Step 1: Open Command Prompt​

  1. Open a command prompt with Administrator level privileges.

Step 2: Navigate to the bin Directory​

  1. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
    cd <bin_dir>
    Example
    cd C:\Program Files\OpeniT\Core\bin

Step 3: Run the HR Roster Collection Command​

  1. Execute the following command:

    Command Syntax
    openit_idpconnectorconsole azure collect hrroster --output "C:\ProgramData\OpeniT\data\temp\IdpConnector\Azure\HRRoster\azuread.tsv" --fields userPrincipalName displayName onPremisesSamAccountName department division employeeType city mail officeLocation jobTitle

Step 4: Verify the Output File​

  1. Navigate to C:\ProgramData\OpeniT\data\temp\IdpConnector\Azure\HRRoster.

  2. Verify that the file azuread.tsv is created.

    Sample File Content
    #userPrincipalName	displayName	onPremisesSamAccountName	department	division	employeeType	city	mail	officeLocation	jobTitle
    john_doe_domain_example_test#EXT#@corp.example.test	John Doe						john_doe@example.com		
    jane_doe_corp_example_test#EXT#@demo.example.test	Jane Doe						jane_doe@example.com		
    juan_delacruz_demo_example_test#EXT#@domain.example.test	Juan Dela Cruz						juan_delacruz@example.com		
    maria_delacruz_domain_example_test#EXT#@corp.example.test	Maria Dela Cruz						maria_delacruz@example.com			
    juan_delacruz@domain.example.test	Juan Dela Cruz	user_zeta	Department01				user_mu@example.com	Office01	Role01
    maria_delacruz_corp_example_test#EXT#@demo.example.test	Maria Dela Cruz						user_nu@example.com		
    user_alpha_demo_example_test#EXT#@domain.example.test	User Alpha						user_xi@example.com		
    user_beta@domain.example.test	User Beta	user_eta	Department02			City01	user_omicron@example.com	Office01	Role02
    user_gamma@corp.example.test	User Gamma	user_theta	Department03				user_pi@example.com	Office02	Role03
    user_delta_demo_example_test#EXT#@domain.example.test	User Delta						user_rho@example.com