NICE inContact

tap-nice-incontact (singer-io variant)

NICE Systems provides intent-based solutions that capture and analyze client interactions and transactions for businesses.

The tap-nice-incontact extractor pulls data from NICE inContact that can then be sent to a destination using a loader.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-nice-incontact extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-nice-incontact
  3. Configure the tap-nice-incontact settings using
    meltano config
    :
  4. meltano config tap-nice-incontact set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-nice-incontact test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-nice-incontact may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-nice-incontact settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using

meltano config
with the list subcommand:

meltano config tap-nice-incontact list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Api Version (api_version)

  • Environment variable: TAP_NICE_INCONTACT_API_VERSION

NICE inContact API version. Default is "21.0"


Configure this setting directly using the following Meltano command:

meltano config tap-nice-incontact set api_version [value]

User Agent (user_agent)

  • Environment variable: TAP_NICE_INCONTACT_USER_AGENT

Process and email for API logging purposes. Example: tap-nice-incontact <api_user_email@your_company.com>


Configure this setting directly using the following Meltano command:

meltano config tap-nice-incontact set user_agent [value]

API Key (api_key)

  • Environment variable: TAP_NICE_INCONTACT_API_KEY

NICE inContact API key (see Authentication in usage section for more details)


Configure this setting directly using the following Meltano command:

meltano config tap-nice-incontact set api_key [value]

API Cluster (api_cluster)

  • Environment variable: TAP_NICE_INCONTACT_API_CLUSTER

NICE inContact instance cluster. Example: "c42"


Configure this setting directly using the following Meltano command:

meltano config tap-nice-incontact set api_cluster [value]

Auth Domain (auth_domain)

  • Environment variable: TAP_NICE_INCONTACT_AUTH_DOMAIN

The NICE inContact auth domain/region to use. Default is "na1". See Authentication for more.


Configure this setting directly using the following Meltano command:

meltano config tap-nice-incontact set auth_domain [value]

API Secret (api_secret)

  • Environment variable: TAP_NICE_INCONTACT_API_SECRET

NICE inContact API secret (see Authentication in usage section for more details)


Configure this setting directly using the following Meltano command:

meltano config tap-nice-incontact set api_secret [value]

Start Date (start_date)

  • Environment variable: TAP_NICE_INCONTACT_START_DATE

RFC3339 date string "2017-01-01T00:00:00Z"


Configure this setting directly using the following Meltano command:

meltano config tap-nice-incontact set start_date [value]

Periods (periods)

  • Environment variable: TAP_NICE_INCONTACT_PERIODS

Stream specific reporting periods. The config is a mapping of stream name to reporting period, the options are: days, hours, and minutes. Default days. The days/hours are in increments of 1 and minutes are in increments of 5 minutes.

  periods
    - skills_summary: days
    - skills_sla_summary: days
    - teams_performance_total: days
    - wfm_skills_agent_performance: days
    - wfm_agents: days
    - wfm_agents_scorecards: days

or using dot notation:

  periods.skills_summary: days
  periods.skills_sla_summary: days
  periods.teams_performance_total: days
  periods.wfm_skills_agent_performance: days
  periods.wfm_agents: days
  periods.wfm_agents_scorecards: days

Configure this setting directly using the following Meltano command:

meltano config tap-nice-incontact set periods [value]

Authentication

The tap is built around the NICE inContact UserHub authentication process. This guide will show the steps required to get an api_key and api_secret.

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-nice-incontact extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-nice-incontact

Maintenance Status

  • Maintenance Status

Repo

https://github.com/singer-io/tap-nice-incontact
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • api