OSPROV Documentation

website·Indexed 31 days ago

https://wiki.osprov.com

Documentation for OSPROV, featuring guides on the Workflow Builder (including Form, Condition, Transform, Hook, and Notification tasks), Form Builder (PDF and Spreadsheet forms), Query Builder with JSON API endpoints, and system settings for organizational branding, announcements, and running numbers.

Tokens
81.1K
Snippets
155
Records
665
Agent score
50%

What's inside OSPROV

  1. Overview of OSPROV System Settings

    OSPROV provides a centralized set of system-wide settings to manage global behavior, branding, and administrative workflows. The available configuration areas include:

    • Announcements: Manage system-wide notifications.
    • Running Numbers: Configure sequential numbering for forms and documents.
    • General Configuration: General system-level options.
    • Master Template: Standardize branding and layout across forms.
    • Organizational Branding: Customize visual identity elements.
    • Workflow Approval: Configure review settings and approval processes.
  2. Overview of OSPROV Query Builder

    The OSPROV Query Builder is a reporting and integration tool that allows users to create reusable queries for workflow submission data without writing code. It generates secure API endpoints that return JSON data based on a selected published workflow. Queries include submissions from all versions of the target workflow but exclude draft submissions.
  3. Overview of Collaborative Forms in OSPROV

    Collaborative Forms allow a form owner to invite colleagues to contribute to a single form submission in real-time. This eliminates the need for email chains or document forwarding. Key characteristics include:

    • Ownership: Only the original form owner can perform the final submission.
    • Permissions: Invitations are filtered by existing role-based security permissions.
    • Auditability: All edits are logged, providing a full history of who changed what and when.
    • Workflow: Collaborators can edit and save drafts, but the owner maintains final control.
  4. Overview of the Transform task

    The Transform task is a built-in calculation and data manipulation engine that runs silently without requiring user action or creating task list entries. It reads values from a submission, performs an operation, and writes the result back to the submission for downstream tasks to use.

    Key behaviors:

    • All transform results are stored as strings, regardless of whether they are numeric. OSPROV typically casts these to numbers automatically if required by subsequent tasks or form fields.
    • If a transform fails, it is marked as invalid, but the workflow continues and is not blocked.
  5. Overview of the Output task in OSPROV Workflow Builder

    The Output task is a specialized, automatic component that extracts specific data from workflow submissions and stores it in master data tables. This allows developers to create interconnected workflows where the output of one process (e.g., an approved vendor) becomes a selectable option in another process's form. Unlike action tasks, Output tasks do not appear in user task lists, require no user interaction, and execute immediately.
  6. Overview of OSPROV API Workflows

    API Workflows allow external systems to programmatically submit data to OSPROV workflows using RESTful API endpoints, removing the need for manual data entry via the web interface. Any OSPROV workflow can be configured for API access, provided the following conditions are met:

    1. The request is made by a valid API User.
    2. The user has the appropriate permissions for that specific workflow.
    3. The workflow is currently active and has not expired.
  7. Overview of the Calculation tab

    The Calculation tab allows you to react to conditions and change component properties (such as required, disabled, or labels) and values dynamically. Unlike the Conditional tab, which primarily handles visibility (show/hide), the Calculation tab can modify almost any aspect of a component.

    Availability: Available on all standard input components. It is NOT available on:

    • Layout containers (Panel, Columns, Fieldset, Table, Tabs, Well)
    • Display-only components (HTML Element, Signature)
    • Textarea and File components.
  8. Overview of OSPROV Form Builder

    The OSPROV Form Builder is a tool for creating custom workflow forms using a drag-and-drop interface. It supports various field types, validation rules, and formatting options. Key capabilities include creating standard forms, multi-step wizard-style forms, interactive PDF forms (by adding fields to uploaded PDFs), and spreadsheet-style forms featuring cells, sheets, formulas, and XLSX exports.
  9. Overview of OSPROV Spreadsheet Forms

    Spreadsheet Forms allow users to build forms using a spreadsheet-style grid (rows, columns, cells, and multiple sheets) instead of standard OSPROV or PDF forms. They are specifically designed for tabular layouts, calculation-driven forms, or templates that mirror existing spreadsheets. Key capabilities include binding selected cells as named form fields, adding formulas and static labels, and exporting submitted snapshots as .xlsx files.
  10. Overview of OSPROV Select component data source types

    OSPROV Select components support five data source types to determine how options are populated:

    • Values: Short, stable lists typed manually.
    • Raw JSON: Hardcoded lists defined as JSON arrays.
    • Custom: Dynamic options generated via JavaScript, capable of reacting to other field values.
    • URL: Live data from external APIs or OSPROV MasterData endpoints.
    • Resource: Not applicable in OSPROV; ignore this option.
  11. Overview of Bulk Approval feature

    The Bulk Approval feature allows users to process multiple pending workflow submissions (of type Approve, Review, or Process) at once using a single form submission. The same decision and form data are applied uniformly across all selected submissions. Processing occurs in the background, allowing users to continue other work while a real-time progress bar tracks completion. This feature is available to any user with pending action queue items of the supported types.
  12. Overview of OSPROV Workflow Action Tasks

    OSPROV's workflow builder utilizes three primary action tasks to manage decision-making and processing:

    1. Approve Task: Used for formal approval decisions with explicit approve/reject options.
    2. Review Task: Used for collecting feedback and input without a formal binary approval/rejection decision.
    3. Process Task: Used for operational processing actions to record that a specific procedure (e.g., payment, fulfillment) has been completed.

    All three task types share the following common features:

    • Role Assignment: Tasks are assigned to specific roles.
    • Form Selection: Forms are used to collect information and decisions.
    • Authorization Channel Filtering: Tasks are visible only to users with matching authorization channels (unless the 'Ignore authorization channel' option is enabled).
    • Notification Options: Ability to send notifications upon assignment.
    • Reminder Settings: Support for automated reminders.