Spotfire AMS Adapter

Contents

Introduction
Adapter Properties
Control Port
Data Output Port
Related Topics

Disclaimer

Artifact Management Server (AMS) is removed in Spotfire® Streaming 11.1.x.

Introduction

The Spotfire Streaming Adapter for Artifact Management Server (AMS) demonstrates the use of the Spotfire Artifact Management Server's REST API. The adapter can be used for enumerating AMS projects and their artifacts, and for fetching, adding, updating, and deleting artifacts.

Adapter Properties

This section describes the properties you can set for this adapter, using the various tabs of the Properties view in StreamBase Studio.

General Tab

Name: Use this required field to specify or change the name of this instance of this component. The name must be unique within the current EventFlow module. The name can contain alphanumeric characters, underscores, and escaped special characters. Special characters can be escaped as described in Identifier Naming Rules. The first character must be alphabetic or an underscore.

Operator: A read-only field that shows the formal name of the operator.

Class name: Shows the fully qualified class name that implements the functionality of this operator. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.

Start options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this operator starts.

Enable Error Output Port: Select this checkbox to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.

Description: Optionally, enter text to briefly describe the purpose and function of the component. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

Operator Properties Tab

Property Type Description
Login at start-up check box Log into the AMS at start-up if checked.
Host Name string When loading from the AMS, the AMS server host name or IP address.
Port Number string When loading from the AMS, the AMS server port number
Secure Channel check box When loading from the AMS, if checked a secure (SSL) channel is used.
Ignore Certificate Errors check box If enabled any errors produced by invalid SSL certificates will be ignored and the website will be processed as normal. Warning! This can lead to man in the middle attacks.
Username string When loading from the AMS, the AMS server username.
Password string When loading from the AMS, the AMS server password.
Auto Commit check box Automatically commit each artifact add, update, and delete operation.
Auto Commit Message string Commit message for auto-committed adds, updates, and deletes.
Connect timeout string Sets a specified timeout value, in milliseconds, to be used when opening. A timeout of zero is interpreted as an infinite timeout.
Read timeout string Sets a specified timeout value, in milliseconds, to be used when reading. A timeout of zero is interpreted as an infinite timeout.
Log Level INFO Controls the level of verbosity the adapter uses to issue informational traces to the console. This setting is independent of the containing application's overall log level. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE.

Proxy Tab

Property Type Description
Use Proxy check box Use a proxy server to access the URL.
Proxy Host string Proxy server host name or IP address.
Proxy Port string Proxy server port number.
Proxy User string The username to use with the proxy if required.
Proxy Password string The password to use with the proxy if required.

Cluster Aware Tab

Use the settings in this tab to enable this operator or adapter for runtime start and stop conditions in a multi-node cluster. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with releases before 10.5.0, leave the Cluster start policy control in its default setting, Start with module.

Cluster awareness is an advanced topic that requires an understanding of StreamBase Runtime architecture features, including clusters, quorums, availability zones, and partitions. See Cluster Awareness Tab Settings on the Using Cluster Awareness page for instructions on configuring this tab.

Concurrency Tab

Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.

Caution

Concurrency settings are not suitable for every application, and using these settings requires a thorough analysis of your application. For details, see Execution Order and Concurrency, which includes important guidelines for using the concurrency options.

Control Port

Description

The control port is used to send action commands to the adapter.

Control Port Commands and Inputs

  • Login. Log into the specified AMS server with the credentials provided.

  • Logout. Log out of the specified AMS server.

  • ListProjects. List all projects on the AMS server.

  • ListProjectArtifacts. List all artifacts of certain project on the AMS server.

    • projectName, string. List all the artifacts under this project name.

  • FetchArtifact. Fetch artifacts of certain project on the AMS server.

    • projectName, string. The project contains the artifact.

    • artifactPath, string. Path to the artifact.

    • version, long. Specific version of the artifact.

  • AddArtifact. Add artifact of certain project on the AMS server.

    • projectName, string. The project contains the artifact.

    • artifactPath, string. Path to the artifact.

    • type, string. Type of the artifact (for, example, POJO, TEXT, and so on).

    • description, string. Description of the artifact.

    • content, string. Content of the artifact.

    • binaryContent, blob (optional). Binary content of the artifact.

    • encoding, string (optional). Encoding of the artifact.

    • metadata, string (optional). Metadata of the artifact.

  • UpdateArtifact. Update artifact of certain project on the AMS server.

    • projectName, string. The project contains the artifact.

    • artifactPath, string. Path to the artifact.

    • type, string. Type of the artifact (for example, POJO, TEXT, and so on).

    • description, string. Description of the artifact.

    • content, string. Content of the artifact.

    • binaryContent, blob (optional). Binary content of the artifact.

    • encoding, string (optional). Encoding of the artifact.

    • metadata, string (optional). Metadata of the artifact.

  • DeleteArtifact. Delete artifact of certain project on the AMS server.

    • projectName, string. The project contains the artifact.

    • artifactPath, string. Path to the artifact.

  • Commit. Commit changes to the artifact of certain project on the AMS server.

    • projectName, string. The project contains the artifact.

    • artifactPath, list of string. Paths of the committing artifacts.

    • message, string. Commit message.

Data Output Port

  • Status

    • success, bool. Returns success or failure of the action.

    • reason, string. Returns reason of the failure.

    • message, string. Returns error message if a failure occurs.

  • inputTuple: Manual input data.

  • loginToken: Returned token when logged in.

  • projects: List of projects.

    • projectName, string.

    • projectID, string.

  • artifacts: list of artifacts.

    • artifactPath, string.

    • artifactID, string.

  • artifact: returned token when logged in.

    • projectName, string. The project contains the artifact.

    • artifactPath, string. Path to the artifact.

    • type, string. Type of the artifact (for example, POJO, TEXT, and so on).

    • artifactID, string.

    • version, long.

    • content, string. Content of the artifact.

    • binaryContent, blob(optional). Binary content of the artifact.

    • encoding, string (optional). Encoding of the artifact.

    • metadata, string (optional). Metadata of the artifact.

Related Topics