Search Knowledge Base by Keyword

Overview

< Back

ReadyWorks Connectors allow you to connect to your data sources and synchronize your data into the ETL where you can then aggregate your data sources into a consolidated view in ReadyWorks, and orchestrate outbound actions. The following sections detail the functionality of Connectors.

Key Concepts

Connectors A collection of authentication methods, fields, job fields, and job templates (inbound, outbound, or both) that when instantiated as connections are used to interact with APIs or data sources
Authentication Methods A collection of fields (e.g., username, password, source server, source server port) and authentication parameters that a connector uses to authentication with APIs or data sources
Fields Attributes (e.g., username, password, source server, source server port) associated with authentication methods
Inbound Job Fields Attributes (e.g., job description, job schedule, data selection, destination table) associated with inbound job templates
Outbound Job Fields Attributes (e.g., job description, job schedule, outbound fields, return data fields) associated with outbound job templates
Inbound Job Templates A collection of inbound job fields with defined configuration settings that are used to perform specific operations with APIs or data sources (e.g., pull the ALM Hardware table from ServiceNow)
Outbound Job Templates A collection of outbound job fields with defined configuration settings that are used to perform specific operations with APIs or data sources (e.g., create a ticket in ServiceNow)
Connections Instantiation of connectors that are used to interact with APIs or data sources
Inbound Jobs Instantiation of inbound job templates (that have the specific data modified slightly or even completely customized) that are used to perform specific operations with APIs or data sources (e.g., pull the ALM Hardware table from ServiceNow)
Outbound Jobs Instantiation of outbound job templates (that have the specific data modified slightly or even completely customized) that are used to perform specific operations with APIs or data sources (e.g., create a ticket in ServiceNow)
Job Schedules Available schedules (e.g., daily, weekly, monthly, custom) for executing jobs at a designated frequency

Connector Diagram

The diagram below illustrates a connector and its components. A connector may include one or more authentication method, each of which contains a set of fields required for secure access. In addition, a connector can define one or more job templates—either inbound, outbound, or both. Each job template is composed of multiple job fields that specify how data is transferred and managed.

Connection Diagram

The diagram below illustrates a connection and its components. A connection may include one or more authentication method, each of which contains a set of fields required for secure access. In addition, a connector can define one or more jobs—either inbound, outbound, or both. Each job is composed of multiple job fields that specify how data is transferred and managed.

Job Diagram

The diagram below illustrates how a job interacts with an API, database, or file directory. To establish a secure connection, the job uses an authentication method that contains the necessary credential fields. Each job consists of multiple job fields that define how data is transferred and managed. When executed, the job sends an authentication request to the target system. If authorization fails, an error is returned to ReadyWorks. If authorization succeeds, the job proceeds and either returns the requested data or reports an error back to ReadyWorks.

Tags: