Configuring Okta HR Roster Data Collector
Open iT collects Okta 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
- An Open iT Core Client connected to an Open iT Core Server or a coexistent Open iT Core setup
- Configured Okta Credentials
Configuring Okta HR Roster Data Collection
- Windows
- Unix
Step 1: Open Command Prompt
- Open a command prompt with Administrator level privileges.
Step 2: Navigate to the bin Directory
-
Go to the bin directory, which is by default in
C:\Program Files\OpeniT\Core\bin, run the command:Command Syntaxcd <bin_dir>Examplecd C:\Program Files\OpeniT\Core\bin
Step 3: Activate Okta HR Roster Data Collection
-
Run the following command to enable Okta HR roster data collection:
Command Syntaxopenit_oconfinit -u "collect_oktaad.root.scheduler.jobs.collect_oktaad.general.active=true"
Step 4: (Optional) Activate Collection for a Specific Okta ID Account
If you configured multiple Okta 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:
openit_oconfinit -u "collect_oktaad.root.scheduler.jobs.collect_oktaad.operations.arguments=okta collect hrroster --output \"${OpeniT.directories.temp}/IdpConnector/Okta/HRRoster/oktaad.tsv\" --fields email displayName login department division usertype city title --name <name>"
where <name> is the name of the account you want to use for data collection.
openit_oconfinit -u "collect_oktaad.root.scheduler.jobs.collect_oktaad.operations.arguments=okta collect hrroster --output \"${OpeniT.directories.temp}/IdpConnector/okta/HRRoster/oktaad.tsv\" --fields email displayName login department division usertype city title --name okta1"
Step 1: Navigate to the bin Directory
-
Go to the bin directory, which is by default in
/opt/openit/bin, run the command:Command Syntaxcd <bin_dir>Examplecd /opt/openit/bin
Step 2: Activate Okta ID Collection
-
Run the following command to enable Okta HR roster data collection:
Command Syntax./openit_oconfinit -u "collect_oktaad.root.scheduler.jobs.collect_oktaad.general.active=true"
Step 3: (Optional) Activate Collection for a Specific Okta ID Account
If you configured multiple Okta 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:
./openit_oconfinit -u "collect_oktaad.root.scheduler.jobs.collect_oktaad.operations.arguments=okta collect hrroster --output \"${OpeniT.directories.temp}/IdpConnector/Okta/HRRoster/oktaad.tsv\" --fields email displayName login department division usertype city title --name <name>"
where <name> is the name of the account you want to use for data collection.
./openit_oconfinit -u "collect_oktaad.root.scheduler.jobs.collect_oktaad.operations.arguments=okta collect hrroster --output \"${OpeniT.directories.temp}/IdpConnector/Okta/HRRoster/oktaad.tsv\" --fields email displayName login department division usertype city title --name okta1"
Verifying Data Collection
After configuration, you can verify that the Okta HR roster data is collected by following these steps:
- Windows
- Unix
Step 1: Open Command Prompt
- Open a command prompt with Administrator level privileges.
Step 2: Navigate to the bin Directory
-
Go to the bin directory, which is by default in
C:\Program Files\OpeniT\Core\bin, run the command:Command Syntaxcd <bin_dir>Examplecd C:\Program Files\OpeniT\Core\bin
Step 3: Run the HR Roster Collection Command
-
Execute the following command:
Command Syntaxopenit_idpconnectorconsole okta collect hrroster --output "C:\ProgramData\OpeniT\data\temp\IdpConnector\Okta\HRRoster\oktaad.tsv" --fields email displayName login department division usertype city title
Step 4: Verify the Output File
-
Navigate to
C:\ProgramData\OpeniT\data\temp\IdpConnector\Okta\HRRoster. -
Verify that the file
oktaad.tsvis created.Sample File Content
email displayName login department division usertype city title
john_doe@example.com John Doe john_doe@example.com Department01 Division01 Employee Manila Role01
jane_doe@example.com Jane Doe jane_doe@example.com Department01 Division01 Employee Manila Role02
juan_delacruz@example.com Juan Dela Cruz juan_delacruz@example.com Department02 Division01 Employee Manila Role03
maria_delacruz@example.com Maria Dela Cruz maria_delacruz@example.com Department02 Division01 Employee Manila Role04
Step 1: Navigate to the bin Directory
-
Go to the bin directory, which is by default in
/opt/openit/bin, run the command:Command Syntaxcd <bin_dir>Examplecd /opt/openit/bin
Step 2: Run the HR Roster Collection Command
-
Execute the following command:
Command Syntax./openit_idpconnectorconsole okta collect hrroster --output "/var/opt/openit/temp/IdpConnector/Okta/HRRoster/oktaad.tsv" --fields email displayName login department division usertype city title
Step 3: Verify the Output File
-
Navigate to
/var/opt/openit/temp/IdpConnector/Okta/HRRoster. -
Verify that the file
oktaad.tsvis created.Sample File Content
email displayName login department division usertype city title
john_doe@example.com John Doe john_doe@example.com Department01 Division01 Employee Manila Role01
jane_doe@example.com Jane Doe jane_doe@example.com Department01 Division01 Employee Manila Role02
juan_delacruz@example.com Juan Dela Cruz juan_delacruz@example.com Department02 Division01 Employee Manila Role03
maria_delacruz@example.com Maria Dela Cruz maria_delacruz@example.com Department02 Division01 Employee Manila Role04