Skip to content

TAMULib/fw-cli

Repository files navigation

fw-cli

FOLIO Workflow CLI

Getting Started

git submodule update --init --recursive

yarn install
yarn build
yarn link

fw

Running mock FOLIO

Provides mock /authn/login and /user-import.

yarn okapi

Running FOLIO Locally

vagrant up release

Running Workflow Modules Locally

cd mod-workflow

cd components
mvn clean install

cd ..
cd service
mvn clean spring-boot:run

In another terminal from fw-cli.

cd mod-camunda
mvn clean spring-boot:run

remember to update your config working directory and configuration, fw -c

Running Workflows in Production

Set the appropriate configurations.

Abbreviated config:

fw -c
{
  "wd": "./fw-registry",
  "okapi": "https://folio-okapi-r1.library.tamu.edu",
  "tenant": "tamu",
  "username": "tamu_admin",
  "password": "***",
  "mod-camunda": "https://folio-edge.library.tamu.edu/mod-camunda",
  "mod-workflow": "https://folio-edge.library.tamu.edu/mod-workflow"
}

e.g.

fw config set tenant tamu

Login to get a Okapi token.

fw login

Lookup user.

fw user tamu_admin

Follow configuration, build, activate and run commands for workflows.

Cron triggered workflow to import create/update patrons from central IT database.

Manual triggered workflow to build orcid report for Scholars.

Cron triggered workflow to build ISBN report for GOBI.

Manual triggered workflow to build e-resource views in central IT database.

Manual triggered workflow to create composite purchase orders and the inventory from MARC records.

Cron triggered workflow to build and email circulation fees/fines paid daily report.

Cron triggered workflow to build and gzip Rapid ILS monthly print serials report.

Cron triggered workflow to build and gzip Rapid ILS monthly print monos report.

Cron triggered workflow to copy SFX Utility output and gzip Rapid ILS monthly electronic serials report.

Cron triggered workflow to run coral extract to create/update instances and holdings in FOLIO.

Manual triggered workflow to build multiple reports for HathiTrust upload.

Manual triggered workflow to create Notes within FOLIO.

Manual triggered workflow to create Tags within FOLIO.

Manual triggered workflow to build, zip, and email shelflist (holdings level) report.

Cron triggered workflow to run update item history.

Cron triggered workflow to run adding a special Note to New Bookshelf Items.

Manual triggered workflow to build, zip, and email list of checked out books by call number.

Manual triggered workflow with CSV of call numbers input that updates corresponding items temporary location and temporary loan type effectively removing them from the new bookshelf.

Cron triggered workflow to send monthly report to email specified by 'evansPresReprFrom' variable. The report includes items having 'temporary location' set to "Eva Pres Repr".

Cron triggered workflow to email quarterly instance duplication report.