DOCUMENTATION
Sign In

Get access to My SAS, trials, communities and more.

Administration Guide
 

Download the General Agent

The general agent is distributed as a ZIP file from SAS Customer Intelligence 360 in the cloud. The downloaded ZIP file contains various agent installation scripts along with the application run-time files. The agent's ZIP file content can be used on UNIX or Windows installations.

Note: If you do not have access to the user interface, use this link to download the General agent: General agent.

To download the agent fron the user interface:

  1. On the navigation bar, click Administration Administrationthen selectData and Integrations. Click Access Points.
  2. Make note of the value of the External gateway host field. This value is used in the agent's configuration. Use this value when you see the variable <external gateway host> in the documentation.

    An example might use the following URL for an endpoint:

    https://<external gateway host>/<endpoint>
  3. Open the access point that is associated with the agent.
  4. Navigate to the Download Framework tab.
  5. Click Download general framework.

Here are the contents of the ZIP file that is downloaded:

bin

contains these files:

  • mkt-agent-sdk contains the agent start-up script for UNIX.
  • mkt-agent-sdk.bat contains the agent start-up script for Windows.
  • mkt-agent-service.bat creates a Windows service to run the agent.
  • mkt-agent-upgrade is used to upgrade the existing agent to the latest version (for UNIX installations).
  • mkt-agent-upgrade.bat is used to upgrade the existing agent to the latest version (for Windows installations).
config

contains these files:

  • agent-endpoints.properties contains the endpoint URLs for SAS Customer Intelligence 360.
  • agent-runtime.properties.
  • agent-shell.properties.

    Here is information about the default properties for the file:

    • agent.shell.enable=true. When set to true (the default), this property controls whether the agent starts up and enables the user to issue commands in the shell. When set to false, the agent starts up with no shell available for user-driven (headless) commands. Setting the property to false enables you to run the access point in background mode on a Linux operating system.
    • agent.shell.defer.logging=true. When set to true (the default) and when agent.shell.enable is set to true, no agent start-up logs are sent to the console during start-up. The logs are deferred to the log file (depending on the logging configuration) or are cached and sent to the console, if possible, at agent shutdown.
  • banner.txt.
  • event-streaming-configuration.properties configures the credentials to connect to the access point in SAS Customer Intelligence 360.
  • logback-spring.xml sets logging levels, log file name, and log location. By default, a log file named sas.mkt.apigw.sdk.log is created in the logs folder of the general agent. You can edit the name and location of this file in the logback-spring.xml file. You can also edit the logging levels such as INFO, DEBUG, and TRACE.
  • logback-upgrade.xml contains the logging configuration for the program that performs the agent upgrade.
doc

contains these files:

  • cms-configuration.json contains code that enables you to integrate SAS Customer Intelligence 360 with a CMS. Information about this file is included in the general agent installation guide.
  • customerIntelligence-to-eventStreamProcessing-event-mappings.json maps SAS Customer Intelligence 360 events to on-premises SAS Event Stream Processing windows.
  • customerIntelligence-to-rtdm-event-mappings.json maps SAS Customer Intelligence 360 events to on-premises SAS Real-Time Decision Manager events.
  • eventStreamProcessing-to-customerIntelligence-event-mappings.json maps on-premises SAS Event Stream Processing windows to SAS Customer Intelligence 360 events.
  • LocalCmsProcessor.java contains an example of how you can write your own CMS integration code.
  • sampleExternalEvent.json contains the configuration information for sending external events to SAS Customer Intelligence 360.
  • SampleExternalEventProcessor.java contains an example for injecting events when building a third-party plug-in.
lib

contains the agent JAR file and all Spring and third-party JAR file dependencies.

libThirdParty

contains the README.txt file.

sdk

contains the following items that can be used to create a custom agent:

  • sample/folder
    • logback.xml defines the logging setting for the sample agent.
    • pom.xml defines Maven dependencies of the sample agent.
    • SampleAgent.java. Use the sample code in this file to create an agent that connects to the SAS Customer Intelligence 360 event stream, prints all events that arrive from SAS Customer Intelligence 360, sends an external event to SAS Customer Intelligence 360, and requests a Signed S3 URL be returned for uploaded events into SAS Customer Intelligence 360.
    • SampleCMSAgent.java. You can use the sample code in this file to create an agent that processes CMS messages from SAS Customer Intelligence 360. You can also connect to the SAS Customer Intelligence 360 event stream and forward messages to the CMS.
    • SampleCMSMessageProcessor.java. You can use the sample code in this file to create an agent to enable SAS Customer Intelligence 360 to process CMS messages.
    • SampleMultiAgent.java. You can use the sample code in this file to create multiple agents that connect to the SAS Customer Intelligence 360 event stream. You can print all events that arrive from SAS Customer Intelligence 360, send an external event to SAS Customer Intelligence 360, and request a Signed S3 URL be returned for uploaded events into SAS Customer Intelligence 360.
  • mkt-agent-sdk-jar-<release>.jar. These Java classes can be used to interact with SAS Customer Intelligence 360.
  • mkt-agent-sdk-jar-<release>-docs.jar. These Java docs are for mkt-agent-sdk-jar-<release>.jar.
  • pom.xml defines Maven dependencies of mkt-agent-sdk-jar-<release>.jar.
  • README_SampleAgent.txt describes how to use the SampleAgents and mkt-agent-sdk-jar-<release>.jar to create an agent that can interact with SAS Customer Intelligence 360.
stage

contains assets for the on-premises SAS Real-Time Decision Manager environment to stage treatments into SAS Customer Intelligence 360. The stage folder contains the lib folder, which consists of the JAR files that are required for staging, plus these files:

  • ci360staging.properties. For information about this file, see README_install.txt.
  • CI360StagingAssets65.spk. For information about this file, see README_install.txt.
  • CI360StagingAssetsPre65.spk. For information about this file, see README_install.txt.
  • README_install.txt contains instructions for setting up the staging feature.
systemd

contains information about running the agent as a service in a Linux environment with systemD.

  • mkt-agent-sdk contains the agent start-up script for UNIX.
  • mkt-agent-sdk.service contains information about running the agent as a service in a Linux environment with systemD.
upstart

contains information about running the agent as a service in a Linux environment with upstart.

  • mkt-agent-sdk.conf contains information about running the agent as a service in a Linux environment with upstart.
README_stage.txt

points to README_install_txt, which contains instructions for setting up the staging feature.

Last updated: October 6, 2026