/sas-report-package-app

Primary LanguageHTML

SAS Report Package App

SAS Report Package App is a web application built to demonstrate the end-to-end workflow of delivering SAS Visual Analytics insights to the web through a custom web application. This is the companion repository for the SAS Innovate 2024 super demo breakout session Unlocking Actionable Intelligence at Scale: Automating Delivery of SAS® Visual Analytics Insights. This is the evolution of the content delivered at SAS Explore 2023, in a breakout session by the same name.

Getting Started

Install the project

git clone git@github.com:brmorr/sas-explore-app.git
cd sas-explore-app
npm install

Build and run

npm start

Building a SAS Viya CLI container

The SAS Viya CLI is used by the Github Action CI/CD workflow to automatically update our report package. In order to use the CLI in that environment, you need to build it into a docker container.

Download the CLI (Linux version)

The SAS Viya CLI can be downloaded from support.sas.com. Note that you need a SAS profile account in order to access the CLI download. The container uses Linux base image, so make sure that you download the Linux version of the CLI.

Build the docker container

  1. Move the CLI zip package into the sas-viya-cli-container folder inside this project.
  2. Build the container

This step builds a Docker container named sas-viya-cli which has the CLI installed, accessible with the sas-viya command.

# From project root
npm run build-cli-container

Test the containerized SAS Viya CLI

Start the Container

# Start the container
npm run viya-cli

# Show CLI help
> sas-viya -h

# Login (follow prompts)
> sas-viya -k auth loginCode

# Exit the container
> exit

Publish sas-auth-container image to docker registry

In order to use the container from a Github Actions workflow it must first be published to a registry. If you are using Github's Action runners then using a public registry like Docker Hub is required.

# Tag the image to reflect org/name of published image.
# Publish to docker hub under your personal repository
docker tag sas-viya-cli:latest ${USERNAME}/sas-viya-cli:latest
docker push ${USERNAME}/sas-viya-cli:latest

Generate an authentication token

The SAS Viya CLI needs to authenticate to SAS Viya in order to function. When using the CLI interactively you can login with credentials or an auth code, but in CI it needs to use an auth token that you will store as a Github Secret. This is achieved by creating a new oAuth client scoped specifically for this task, and then generating an authentication token for that client.

Register a new oAuth client

npm run register-client-id

The register-client-id script will prompt you to login to SAS Viya and then ask for the desired client id, client secret, and token expiration.

On success it will print out the new environment variables needed for the next step. Copy those values into your .env file.

Generate an authentication token

npm run generate-client-token

The generate-client-token script will prompt you to login to SAS Viya and then ask for the client id and client secret. If those values are defined in your .env file then you will not be prompted.

On success it will print the name and value for the authentication token environment variable. Copy this to your .env file.

Add Actions secrets/variables

The following secrets and variables are used by this project's Github Actions workflows.

Secrets

PAT

A GitHub personal access token. This is used to automatically merge report package updates into the repository.

SAS_VIYA_CLI_AUTH_TOKEN

The generatd client authentication token from this step, used to authenticate the SAS Viya CLI from the Github Actions workflow.

Variables

CLI_CONTAINER_NAME

The name of the CLI container that was published in this step.

REPORT_UID

The UID of the SAS Visual Analytics report that is being used to generate an update report package.

SAS_SERVICES_ENDPOINT

The URL of the SAS Viya deployment

Environment Variables

The projects scripts each utilize various environment variables to pass necessary settings. The following variables should be set in a .env file, which will then be used when executing the scripts.

.env

# The SAS Viya URL (no trailing /)
SAS_SERVICES_ENDPOINT=
# The oAuth client created to run the CLI from Github
SAS_VIYA_CLI_CLIENT_ID=
# The secret associated with the oAuth client
SAS_VIYA_CLI_CLIENT_SECRET=
# The authentication token for the oAuth client
SAS_VIYA_CLI_AUTH_TOKEN=

References