SmartRecruiters connection

Introduction

A SmartRecruiters connection, created using the SmartRecruiters connector, establishes access to SmartRecruiters. Once a connection is configured, you can create instances of SmartRecruiters activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit a SmartRecruiters connection

A new SmartRecruiters connection is created using the SmartRecruiters connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Connections page (see Create a global endpoint in Global Connections).

An existing SmartRecruiters connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Connections page (see Edit a global endpoint in Global Connections).

Configure a SmartRecruiters connection

Each user interface element of the SmartRecruiters connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each SmartRecruiters connection and must not contain forward slashes / or colons :. This name is also used to identify the SmartRecruiters endpoint, which refers to both a specific connection and its activities.

• Authentication Type: Select the authentication type.

  • API Key: Click to authenticate using an API Key. When selected, the API Key field becomes visible.

    • API Key: Enter your API key, which you can obtain from SmartRecruiters Credential Manager following the steps described in the SmartRecruiters documentation.

  • OAuth: Click to authenticate using OAuth. In order to use this authentication method, you will need to register your application following the steps described in the SmartRecruiters documentation. Doing so will provide you with the credentials you need for the two fields that become visible when choosing this option:

    • Client ID: Enter your client ID, which you obtain after registering your application in SmartRecruiters.

    • Client Secret: Enter your client secret, which you obtain after registering your application in SmartRecruiters.

• Environment: Select the SmartRecruiters environment, either Production or Sandbox. By default, the Production environment is selected. When your integration goes live, a copy of your Production environment is automatically made available in the Sandbox environment.

• Optional Settings: Click to expand additional optional settings:

  • Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.

• Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a SmartRecruiters connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

• Query: Retrieves object data from SmartRecruiters and is intended to be used as a source in an operation.

• Create: Creates object data in SmartRecruiters and is intended to be used as a target in an operation.

• Update: Updates object data in SmartRecruiters and is intended to be used as a target in an operation.

• Delete: Deletes object data from SmartRecruiters and is intended to be used as a target in an operation.