Prev |  | Next

## Artifact Administration

This topic describes:

- Supported artifact types

- Artifact review and approval process

- Artifact deployment process

## Supported Artifact Types

AMS supports the following management of the following artifact types.

Artifact Type Code | Supported User Operations | Description
--- | --- | ---
DECISION_TABLE | read, create, edit, deploy | Decision table in TIBCO Business Events format
SB_DECISION_TABLE | read, create, edit, deploy | StreamBase decision table format
EXCEL | read, deploy | Microsoft Excel file containing a decision table
R_SCRIPT | read, create, edit, deploy | R Script file for TERR
R_OBJECT | read, deploy | R Object file for TERR
H2O_POJO | read, create, edit, deploy | H2O Plain Old Java Object (numerical model)
PREDICTIVE_MODEL | read, create, edit, deploy | Predictive model from PMML (Predictive Model Markup Language)
COMPRESSED_SPARK_MODEL | read, deploy | Compressed Apache Spark model
SCALA | read, create, edit, deploy | Scala file. Used in Spark and is the code used to produce a model. Deployment to StreamBase not recommended. It is intended to be kept as an artifact for users to possible download the code and then (in Spark), compile it into a model, and then compress that into a COMPRESSED_SPARK_MODEL. The compiled model can then be used in StreamBase via the TIBCO SparkMLlib operator.
OTHER | read, deploy | Catch-all for artifact types AMS does not recognize

## Artifact Review and Approval Workflow

As a user assigned the reviewer role, you have the ability to approve or reject artifact changes that users commit to the AMS repository. AMS notifies you when artifact changes committed (including your own commits, if applicable) require action.

Click the Notifications button and click the notification itself when it appears. Clicking the link takes you to the selected artifact in the In Progress view.

The following describes the artifact status and actions available for the selected artifact.

Commit

  When a user commits one or more artifacts for approval, the status of the request is set to Committed. A user assigned the reviewer role then has the ability to Approve or Reject the committed artifact changes.

Approve

  If the artifact change was to add or modify the file, that artifact is added to the AMS repository when approved. If a requested artifact deletion is approved, the artifact is deleted from the AMS repository. If the artifact is also in a SCM system, the approved changes also propagate to the SCM's repository.

Reject

  If the commit request was to add or modify an artifact, that artifact is not copied to the AMS repository and modifications remain local to the user requesting the commit. If the commit request was to delete an approved artifact, the rejected commit means that the artifact is deleted locally and not from the AMS repository.

For reviewers, committed artifacts pending approval appear in the In Progress view Work List. In the following example, the artifact `Applicant_Simple.sbdt` was committed by a user named `Admin`.

When the reviewer approves or rejects the artifact's commit, AMS notifies the committing user about the artifact status change. All users whose roles include reviewer privileges for the artifact are also notified.

## Deploying Decision Table Artifacts

AMS supports the deployment and execution of a decision table artifact's rules using the following methods:

From StreamBase Studio

  Using StreamBase Studio, pull a decision table artifact from AMS into a running EventFlow module. The module must contain a running Decision Table operator. See the Decision Table operator page in the StreamBase Authoring Guide, in the TIBCO StreamBase® documentation for more information.

From AMS

  Deploy (push) a decision table artifact's rules from AMS to a running decision table EventFlow module in StreamBase Studio. See below.

Deploying artifacts from AMS requires:

- Your user role must have the artifact-deploy privileges.

- Any StreamBase Server hosting the target EventFlow module(s) must be running.

1. From the web client, right-click on the desired artifact and select Deployment > Deploy.

2. In the dialog that appears, select the Target Type:

   StreamBase Service Name

     For deployment to StreamBase 10.0 and higher. Enter one or more StreamBase service names using the format shown in the dialog. Depending on the StreamBase configuration, a service name can be a node service, cluster service or both service names, depending on where you are deploying the artifact.

         [service-name1],[service-nameN...]

     For example:

         decision_tableA,decision_tableB,decision_tableC

     AMS 1.2.0 and above supports multiple service name deployment options. Any EventFlow modules in the cluster or node registered to accept the artifact will receive it upon deployment.

     - Enter n number of service names to deploy to different target EventFlow modules.

     - To deploy an artifact across a cluster, enter the cluster name as part of the service name but leave the Target StreamBase Operator field blank.

     - To deploy an artifact across multiple nodes, enter the cluster and node name as part of the service name but leave the Target StreamBase Operator field blank.

   StreamBase URI

     For deployment to StreamBase 7.6.6 and higher. Enter a StreamBase Server URI (or multiple URIs if you are deploying the artifact to multiple running decision table EventFlow operators). When deploying to a StreamBase server over a TLS connection, instead of `sb://` use the `sbs://` protocol, which requires authentication using certificates.

         sb[s]://host-name[:port-number]

     For example:

         sb://host1:10000

     For more information regarding StreamBase URIs, see the StreamBase Command Reference Guide in the TIBCO StreamBase® documentation for more information.

3. Depending on your selections in the previous step, enter information about the StreamBase Decision Table operator's location in the same-named field, using the format provided.

       [container.][module1.][...][moduleN.]operator-name

   For example:

       YourContainer.DT_module.your_decision_table

   See the container page in the StreamBase Administration Guide, in the TIBCO StreamBase® documentation for more information.

4. Select the artifact revision to export (default is Latest). Optionally, click View Content as to verify the artifact's rules are configured as intended.

5. In the Description box, enter any string for the deployment descriptor and click Next. Deployment descriptors can be reused in subsequent deployments.

6. In the next dialog that appears, schedule the deployment as follows: by selecting a time and date from the calendar (entering a time in the displayed example format is also supported).

   - To deploy the artifact now, set the slider to OFF (default).

   - To schedule the deployment, set the slider to ON. Accept the Deploy Time or click in the field to display an editable calendar.

7. Click Deploy. AMS displays a status message for the deployment operation.

   To view artifact deployment history, see Viewing History and Notifications.

## Deploying Model File Artifacts

AMS supports the deployment and execution of model file artifacts using the following methods:

From StreamBase Studio

  Using StreamBase Studio, pull a model file artifact from AMS into a running EventFlow module. The module must contain a running model operator. To perform this action from Studio, see the JPMML sample page in the StreamBase Samples Guide, in the TIBCO StreamBase® documentation.

From AMS

  Deploy (push) a model file artifact from AMS to a running model EventFlow module in StreamBase Studio.

Deploying artifacts from AMS requires:

- Your user role must have the artifact-deploy privileges.

- The target EventFlow module(s) must be running.

1. From the web client, right-click on the desired artifact and select Deployment > Deploy.

2. In the dialog that appears, select the Target Type:

   StreamBase Service Name

     For deployment to StreamBase 10.2.0 and higher. Enter one or more StreamBase service names using the format shown in the dialog. Depending on the StreamBase configuration, a service name can be a node service, cluster service or both service names, depending on where you are deploying the artifact.

         [service-name1],[service-nameN...]

     For example:

         modelA,modelB,ModelC

     AMS 1.2.0 and above supports multiple service name deployment options. Any EventFlow modules registered to accept the artifact will receive it upon deployment.

     - Enter n number of service names to deploy to different target EventFlow modules

     - To deploy an artifact across a cluster, enter the cluster name as part of the service name but leave the Target StreamBase Operator field blank.

     - To deploy an artifact across multiple nodes, enter the cluster and node name as part of the service name but leave the Target StreamBase Operator field blank.

   StreamBase URI

     For deployment to StreamBase 7.7.1 and above. Enter a StreamBase Server URI (or multiple URIs if you are deploying the artifact to multiple running model EventFlow operators). When deploying to a StreamBase over a TLS connection, instead of `sb://` use the `sbs://` protocol, which requires authentication using certificates.

         sb[s]://host-name[:port-number]

     For example:

         sb://host1:10000

     For more information regarding StreamBase URIs, see the sburi command in the StreamBase Command Reference Guide, in the TIBCO StreamBase® documentation for more information.

3. Enter information about the StreamBase Model operator's location in the same-named field, using the format provided.

       [container.][module1.][...][moduleN.]operator-name

   For example:

       YourContainer.module_module.your_model_file

   See the container page in the StreamBase Administration Guide, in the TIBCO StreamBase® documentation for more information.

4. Select the artifact revision to export (default is Latest). Optionally, click View Content as to verify the artifact's rules are configured as intended.

5. In the Description box, enter any string for the deployment descriptor and click Next. Deployment descriptors can be reused in subsequent deployments.

6. In the next dialog that appears, schedule the deployment as follows: by selecting a time and date from the calendar (entering a time in the displayed example format is also supported).

   - To deploy the artifact now, set the slider to OFF (default).

   - To schedule the deployment, set the slider to ON. Accept the Deploy Time or click in the field to display an editable calendar.

7. Click Deploy. AMS displays a status message for the deployment operation.

   To view artifact deployment history, see Viewing History and Notifications.

## Canceling Artifact Deployments

To cancel an artifact deployment from AMS to StreamBase Studio:

1. From the web client, right-click the artifact and select Deployment > Deployment History.

2. In the dialog that appears, select the scheduled deployment record on the left and click Cancel Deployment.

3. Click Confirm when prompted.

Prev | Up | Next
| Home |