https://github.com/changhuixu/uiowa-universal-workflow

Components for UIowa Universal Workflow routing history and widget
https://github.com/changhuixu/uiowa-universal-workflow

angular component uiowa universal-workflow workflow

Last synced: 8 months ago
JSON representation

Components for UIowa Universal Workflow routing history and widget

• Host: GitHub
• URL: https://github.com/changhuixu/uiowa-universal-workflow
• Owner: changhuixu
• License: mit
• Created: 2023-05-05T18:45:12.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-09T18:56:28.000Z (9 months ago)
• Last Synced: 2025-01-09T18:58:17.710Z (9 months ago)
• Topics: angular, component, uiowa, universal-workflow, workflow
• Language: TypeScript
• Homepage: https://changhuixu.github.io/uiowa-universal-workflow/
• Size: 350 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# UIOWA Universal Workflow

[![npm](https://img.shields.io/npm/v/@uiowa/universal-workflow.svg?style=flat-square)](https://www.npmjs.com/package/@uiowa/universal-workflow)

This NPM package `@uiowa/universal-workflow` serves as the standard way to display Universal Workflow widget and routing history in Angular. The package contains two components, `workflow-widget` and `uw-routing-history`, and a service `WorkflowService`.

This package depends on `@uiowa/spinner` which shows a loading placeholder while the Universal Workflow data is loading.

[Demo](https://changhuixu.github.io/uiowa-universal-workflow/)

## Usage

- The Widget Component

  ```html

  

    

  

  

    

  

  ```

  ```ts

    ngOnInit(): void {

    this.route.queryParamMap

      .pipe(

        switchMap((params: ParamMap) => {

          if (!params) {

            return of(null);

          }

          this.formId = params.get('formId') || '';

          this.packageId = +(params.get('packageId') || '');

          this.signatureId = params.get('signatureId') || '';

          if (!this.packageId) {

            return of(null);

          }

          this.loading = true;

          return this.svc

            .getMyForm(this.packageId)

            .pipe(finalize(() => (this.loading = false)));

        })

      )

      .subscribe((x) => {

        if (x) {

          this.dataRows = x.data;

          this.uwPermissions = x.permissions;

        }

      });

  }

  ```

- The Routing History Component

  ```html

  

  ```

- The Workflow Service

  By default, you don't need to touch the `WorkflowService`. The service has two methods: `getWorkflowWidgetConfig()` and `getPackageRoutingHistory(packageId: number): Observable`, which call backend API endpoints `${this.api}/widget-config` and `${this.api}/packages/${packageId}/routing-history` where `protected readonly api: string = 'api/workflow'`.

  If you decide to choose a different implementation, then you can follow the demo app in this solution to provide another service.