Skip to content

Latest commit

 

History

History
123 lines (85 loc) · 9.19 KB

README.md

File metadata and controls

123 lines (85 loc) · 9.19 KB

SAS Customer Intelligence 360 - Extensions

Overview

SAS CI360 Connector Framework and Agent SDK provide infrastructure to integrate SAS Customer Intelligence 360 (CI360) with other applications. This repository contains a number of connectors and agents that are ready to be used to enhance the capabilities of CI360 and connect to 3rd party services. In addition, there are other integration assets included as well. All integration assets included in this repository are listed below, with short description. Details about each are included within specific sub-folders.

Table of Contents

This topic contains the following sections:

Prerequisites

Prerequisites vary between integration assets included here, and are listed in detail for each in the respecitive sub-folders. But some of the prerequisites include:

  • Amazon Web Service account with access to Lambda and API Gateway service
  • Microsoft Azure account with access to Functions and other Azure services
  • Java 8 or newer for 23.07 release or earlier, Java 11 or newer for 23.08 release or later
  • Python 3.7 or newer

Installation

Installation instructions for every extension are included in the project specific sub-folder README file. Installation and deployment instructions are platform specific.

List of Extensions

This is a list of connectors, agents and other related content and utilities included in this repository:

Getting Started

To set up and use the provided extension code you need to perform the following steps :

Download sample code

  1. Download a ci360-extensions project source code into zip/tar.gz/tar.bz2/tar file format on your local machine.
    Note: You can also clone the project on your local machine

  2. The project will be downloaded on your local machine in your specified file format. You need to unzip/untar the downloaded project.

  3. You can see the folder ci360-extensions after unzip/untar the project.

  4. Open the ci360-extensions folder. It will contain multiple sub-folders for various connector and agent integration resources.

Build or Deploy

Build and deployment instructions are included for each of the integration assets in their respoective sub-folders.

Deploying CI360 Connectors

Please refer Set up a Custom Connector section in SAS Customer Intelligence 360 admin guide.

Register your connector into CI360

For most connector or agent integration assets, you need to register the connector and endpoint with these details into the CI360 system to use the connector. Details are included for each connector or agent in their sub-folders. Documentation sections are referenced below for eacy access.

Add and Register a Connector Please refer to Add and Register a Connector in SAS Customer Intelligence 360 admin guide.

Add an Endpoint Please refer to Add an Endpoint in SAS Customer Intelligence 360 admin guide.

Deploying CI360 Agents

For CI360 agent development, agent SDK needs to be downloaded and installed into the local Maven repository. See Download the General Agent in SAS Customer Intelligence 360 admin guide. General Agent includes the SDK.

To install SDK JAR into local Maven repository:

mvn install:install-file -Dfile=<path where CI360 agent was downloaded>/sdk/mkt-agent-sdk-jar-1.current release.jar -DpomFile=path where CI360 agent was downloaded/sdk/pom.xml

Create an Access Point Definition Please refer to Create an Access Point Definition in SAS Customer Intelligence 360 admin guide.

Extension Best Practices

Logging and PII

Many agents and connectors included here log information for debugging purposes, either in local log files or cloud based logging services. While connectors and agents generally won't explicitly log any PII data, some include mechanism for logging complete CI360 event objects, based on logging levels configured, usually controlled using logging specific configuration files. In order to avoid logging or storage of PII data, it is a best practice to either disable logging by setting the logging level, or exclude PII data from being sent by CI360.

Contributing

We welcome your contributions! Please read CONTRIBUTING.md for details on how to submit contributions to this project.

License

This project is licensed under the Apache 2.0 License.

Additional Resources

For more information, see External Data Integration with Connectors.