Connector GUI

FAQs

Q:What ports does the connector access?

A: We connect on port 443 via SSL

 

Q: I want Oomnitza to host the connector, what do we need to do? (on-prem only)

A: You need to whitelist the IP of your Oomnitza instance (customer.oomnitza.com) and follow up with your Oomnitza rep to find out what other credentials needed for the connector being set up

 

Q: If Oomnitza hosts the connector, what kind of permissions do they need to access our server

A: Read only access 

Installing the Connector (Mac)

  1. Download the Mac stand-alone application directly from your system

  1. Extract the file app to the desired installation path (i.e. /srv/oomnitza/...)
  2. Double-click app to launch the Connector GUI (this may take a few seconds to display)
  3. When the connector appears, three files will be generated within the .app file

 

 

Filename

Purpose

connector.app/Contents/MacOS/config.ini

Contains the connector-specific settings defined in the GUI

connector.app/Contents/MacOS/error.log

Errors and exceptions will be logged here

connector.app/Contents/MacOS/info.log

General status updates will be logged here

connector.app/Contents/MacOS/*.log

Integration-specific logging

 

 

Installing the Connector (Windows)

  1. Download the Windows stand-alone binary directly from your system

 

  1. Place the EXE in the desired installation path (i.e. C:\oomnitza\...)
  2. Double-click oomnitza-connector-win.exe to launch the Connector GUI (this may take a few seconds to display)
  3. When the connector appears, three files will be generated in the same directory as the EXE

Filename

Purpose

config.ini

Contains the connector-specific settings defined in the GUI.

errors.log

Errors and exceptions will be logged here

info.log

General status updates will be logged here

*.log

Integration-specific logging

 

 

Configuring the Connector

  1. Oomnitza Connection - In order to synchronize data sources to Oomnitza, the section titled “Oomnitza Connection” must be properly filled out.

 

Setting Name

Description

URL

The full system URL. For example: https://customer.oomnitza.com

User Name

The username of a valid user in Oomnitza

Password

The password of a valid user in Oomnitza (not needed when using an API token)

API Token

Use API token instead of username and password

 

 

How to Create an API Token in Oomnitza

  1. Supported Third-Party Solutions

Integration Partner

Functionality

AirWatch

Sync mobile devices

BambooHR

Sync user records

Casper

Sync computer and mobile devices

Jasper

Sync mobile devices

LDAP

Sync user records

MobileIron

Sync mobile devices

Okta

Sync user records

OneLogin

Sync user records

Zendesk

Sync user records

SCCM

Sync computer records

Note: When a connector has been configured and enabled, its status icon will indicate orange. If however the connector is disabled, the status icon will be gray.

 

Map Fields to sync from connector

 

Connector Mapping Examples

https://wiki.oomnitza.com/index.php?title=Connector_Config_Examples

Mapping Custom Fields to Sync from Connector

 

(1) Go to system settings, select connectors, select LDAP from the dropdown, then select "Add FIeld"

 

(2) Enter field information from third party source

 

Testing Connection Settings

To test a connection, fill out all necessary settings (including the Oomnitza Connection section), ensure Enable Connector is checked, Apply has occurred, and click Test Connection. The connector will attempt to authenticate with both systems to ensure a connection can be established (and will NOT sync data at this time).

 

  1. Jump into each connector setting tab page
  2. Fill out the necessary information
  3. Click the “Test Connection” button

 

Manually Running a Specific Connector

To manually run an individual connector, fill out all necessary settings (including the Oomnitza Connection section), ensure Enable Connector is checked and Apply has occurred, and click Run Connector. The connector will run and all activity will be logged accordingly. To view this activity, simply click into the tab titled “Logs”.

 

  1. Jump into each connector setting tab page
  2. Fill out the necessary information
  3. Click the “Run Connector” button

 

Manually Running All Enabled Connectors

To manually run all of the enabled connectors, click Run. The GUI will identify each of the configured connectors, perform each sync, and log all activity accordingly. To view this activity, simply click into a connector and switch to the tab titled “Logs”.

 

  1. Click the “Run” button

 

Scheduling the Sync Jobs (Mac)

To enable daily or weekly sync tasks, open the desired integration and click into the Scheduler tab. This will allow you to define the frequency of the connector. (Note: clicking “Set” will create a launchd plist file in /Library/LaunchDaemons/… for the connector).

 

Note: If you move the core application after scheduling the connector to run, the launchd tasks will no longer trigger as expected (and the jobs will need to be rescheduled).

 

Scheduling the Sync Jobs (Windows)

To enable daily or weekly sync tasks, open the desired integration and click into the Task Scheduler tab. This will allow you to define the frequency of the connector. (Note: clicking “Set” will create a scheduled task for the connector).

 

Allowed Values:

            Minute: 0-59

            Hour: 0-23

            Day of Month: 1-31

            Month: 1-12

            Day of Week: 0-7 (0 and 7 being Sunday)

 

Special Character:

Format of example: * * * * * (Minute, Hour, Day of Month, Month, Day of Week)

 

            *: Every

                        e.g. 0 0 1 1 * Run once a year at midnight of January 1 (yearly)

                        e.g. 0 0 1 * * Run once a month at midnight of the first day of the month (Monthly)

                        e.g. 0 0 * * 0 Run once a week at midnight on Sunday morning (weekly)

                        e.g. 0 0 * * * Run once a day at midnight (daily)

                        e.g. 0 * * * * Run once an hour at the beginning of the hour (hourly)

 

            ?: Start-up time

                        e.g. ? ? * * * would be updated to 25 8 * * * if cron started-up on 8:25am

 

            ,: Separator

                        e.g. "MON,WED,FRI" in "Day of Week" means Monday, Wednesday, and Friday

 

            /: Step value combined with range

                        e.g. */5 means every 5 minutes in "Minute"

 

            -: Define ranges

                        e.g. 0-3 means from Sunday to Wednesday in "Day of Week"

 

            L: Last

                        e.g. 5L means last Friday of month in "Day of Month"

 

 

 

Note: If you move the core application files after scheduling the connector to run, the Task Scheduler entries will no longer trigger as expected (and the tasks will need to be rescheduled).

 

Customer Support

If you have any questions or feedback, please do not hesitate to contact support@oomnitza.com!

Creating a Windows Task / Cron Job

Windows 7  More

You must be logged on as an administrator to perform these steps. If you aren't logged on as an administrator, you can only change settings that apply to your user account.

 

If you use a specific program on a regular basis, you can use the Task Scheduler wizard to create a task that opens the program for you automatically according to the schedule you choose. For example, if you use a financial program on a certain day each month, you can schedule a task that opens the program automatically to avoid the risk of forgetting to open it yourself.

 

Open Task Scheduler by clicking the Start button Picture of the Start button, clicking Control Panel, clicking System and Security, clicking Administrative Tools, and then double-clicking Task Scheduler.‌  Administrator permission required If you're prompted for an administrator password or confirmation, type the password or provide confirmation.

 

Click the Action menu, and then click Create Basic Task.

 

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

 

Do one of the following:

 

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.

 

To select a schedule based on common recurring events, click When the computer starts or When I log on, and then click Next.

 

To select a schedule based on specific events, click When a specific event is logged, click Next; specify the event log and other information using the drop-down lists, and then click Next.

 

To schedule a program to start automatically, click Start a program, and then click Next.

 

Click Browse to find the program you want to start, and then click Next.

 

Click Finish.

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk