Draft for the next release
Next (0.1 RC1 Preview)
Product revision: 25748655d6befa9eb11356075f2ca5f909edc4b3.
These pages are being written for the next Pūnaha release. They may still change.
217 pages
Choose a guide
Showing all 217 guides.
- Reference Check the RC1 documentation scope Find RC1 downloads, understand registration availability, and check the review scope and platform limits.
- Get started Welcome to Pūnaha Docs Learn what Pūnaha does and find the right guide for your work.
- Get started Choose your starting point Follow a short documentation path for the work you need to do.
- Get started Complete a common Pūnaha journey Choose a complete guide for one of the most common Pūnaha goals.
- Get started One Pūnaha Product Understand how Product versions, licences, and optional support relate.
- Get started Install and run Pūnaha Install Pūnaha, prepare its databases, and start its services.
- Get started Install Pūnaha on Windows Use the Windows MSI to install a Primary or an additional Node and open browser setup.
- Get started Install a Linux RC1 package Choose the supplied Linux package, complete licence acceptance, and start the correct setup journey.
- Get started Choose and prepare the databases Select one database provider for Control, Workflow, and AI during the first browser setup.
- Get started Set up Pūnaha for the first time Prepare the databases and create the first System Owner.
- Get started Sign in and accept an invitation Sign in, use MFA, and join a tenant from an invitation.
- Get started Browsers and accessibility See which browsers and accessibility settings Pūnaha supports.
- Use Pūnaha Find your way around Pūnaha Learn how to move between the platform and a tenant.
- Use Pūnaha Change your personal settings Choose the colours and display settings that work best for you.
- Use Pūnaha Create and search knowledge Create a knowledge database, add files, and search their content.
- Use Pūnaha Use Chat Start a chat that uses an approved workflow and approved resources.
- Use Pūnaha Find and run workflows Open a workflow, start it, and follow its progress.
- Use Pūnaha Work with cases Find your case work and complete the steps that are assigned to you.
- Administer Register and renew an installation Register the Product, review renewal terms, and understand the powered hour allowance.
- Administer Register or renew without a Product internet connection Transfer an encrypted request and approved activation between an isolated installation and Support.
- Administer Configure public addresses and organisation sign in Map frontend and API origins, register OIDC callbacks, and allow intended browser integrations.
- Administer Manage tenants Create a tenant, open it, and manage its main settings.
- Administer Manage people and groups Invite people, manage groups, and keep membership details up to date.
- Administer Invite a person and give access Invite one person, give the required access, and check the final result.
- Administer Manage access Give people and services the exact access they need.
- Administer Fix an access problem Find out why a person cannot see or use an item.
- Administer Prepare a model and knowledge database Prepare a model, create a knowledge database, and test a simple search.
- Administer Manage Connections Add and test the connections used by workflows and cases.
- Administer Manage settings Change platform or tenant settings and check the final value.
- Administer Understand administration responsibilities Separate platform, tenant, access, solution, and operating responsibilities.
- Administer Review access Review direct access and record whether each item should stay, change, or be removed.
- Operate Choose how to run the services Run all services together or place Control, Workflow, and AI on separate servers.
- Operate Run Pūnaha on several servers Set up private databases, service groups, and a secure web address.
- Operate Add and manage cluster nodes Prepare an installation for additional nodes, approve their identities, and check service readiness.
- Operate Prepare shared storage Separate private node state from shared documents, indexes, logs, and model files.
- Operate Check service health Use the health checks to decide when a server can receive work.
- Operate Check operations, logs, and audit records Follow one failed or waiting item from Operations into logs and audit records.
- Operate Use the Operations pages Check active, waiting, and failed work for the platform or a tenant.
- Operate Control document processing Read processing stages, stop work safely, assign an eligible node, and resume a document.
- Operate Manage model capacity and GPU policy Choose processing policy and distinguish document slots, model requests, and section concurrency.
- Operate Use logs and audit records Search logs for a problem and use audit records to see important changes.
- Operate Run local AI models Install the local AI runtime, add GGUF models, and manage their memory use.
- Operate Plan storage and backups Choose storage, back up the full installation, and test a restore.
- Operate Make a safe production change Prepare, apply, check, and if needed reverse an approved production change.
- Operate Upgrade or remove Pūnaha Prepare a version specific upgrade or an ordered removal while protecting installation identity and data.
- Operate Recover solution configuration Use retained versions and encrypted configuration backups without confusing them with business data recovery.
- Operate Verify a backup and restore Check that a complete Pūnaha backup can restore consistent services and data.
- Build solutions Build, publish, and run a workflow Create a workflow, test its draft, publish a version, and check a run.
- Build solutions Build a workflow Create a workflow with clear inputs, steps, and outputs.
- Build solutions Choose workflow steps Choose the right step for input, AI, rules, connections, approval, and output.
- Build solutions Check, publish, and run a workflow Move a workflow from a draft to a published version and test its runs.
- Build solutions Import or export BPMN and DMN Import a BPMN or DMN file, check it, and test it before you publish.
- Build solutions Add safety checks and approvals Check unsafe content and ask a person before an important action.
- Build solutions Build a case type and work with a case Create a case type, publish it, open a case, and complete its work.
- Build solutions Build a case type Create the stages, tasks, requirements, and files for a type of case.
- Build solutions Install and activate a solution package Import a protected solution, check its requirements, obtain approval, and activate the intended version.
- API Start a supported API integration Choose the customer contract, confirm access, and make a safe first request.
- API Use tenant and access context Select the tenant and confirm the exact resource action before API work.
- API Create and monitor a workflow run Find a workflow, check access, start it, and monitor the resulting run.
- API Pūnaha API overview Read every current API request, or use Swagger and the OpenAPI file.
- API Upload and search a knowledge document Find a knowledge database, upload a safe document, monitor ingestion, and search it.
- API Sign in to the API Understand API sessions, access checks, and safe error handling.
- API Work with a case through the API Choose a case type, create a case, perform authorised work, and read the result.
- API Handle API errors and background work Use status, error code, request ID, retries, polling, and streams safely.
- API Protect the private Workflow to AI API Connect Workflow servers to AI servers without making the private API public.
- API API reference Choose a Product API category, then open the operation needed for your task.
- API Access and identity API Browse the Access and identity operations in the current Pūnaha customer contract.
- API Workflows and runs API Browse the Workflows and runs operations in the current Pūnaha customer contract.
- API Cases and case types API Browse the Cases and case types operations in the current Pūnaha customer contract.
- API Models and inference API Browse the Models and inference operations in the current Pūnaha customer contract.
- API Knowledge and documents API Browse the Knowledge and documents operations in the current Pūnaha customer contract.
- API Connections and storage API Browse the Connections and storage operations in the current Pūnaha customer contract.
- API Health and observability API Browse the Health and observability operations in the current Pūnaha customer contract.
- Reference Pūnaha glossary Find simple meanings for the main words used in Pūnaha and its guides.
- Reference Tenants, people, groups, roles, and permissions Understand how Pūnaha groups people and decides what each person can do.
- Reference Workflows, versions, and runs Understand the workflow draft, published versions, and individual runs.
- Reference Cases and case types Understand the case type definition, published version, and each case created from it.
- Reference Connections Understand how a Connection lets approved work reach another system safely.
- Reference Models, knowledge, and vector databases Understand models, embeddings, documents, and searchable knowledge in Pūnaha.
- Reference Operational logs and audit records Understand the different questions answered by logs and audit records.
- Reference Command list Find the commands for starting, updating, repairing, and checking Pūnaha.
- Reference Services and ports Find the normal ports and see which service owns each group of requests.
- Reference Start troubleshooting Choose a safe guide for a sign in, access, work, service, storage, log, or backup problem.
- Reference Fix registration and renewal problems Recover from expired allowances, rejected activation files, or an unverifiable powered clock.
- Reference Fix sign in, invitation, and access problems Understand a failed sign in, unavailable invitation, missing area, or forbidden action.
- Reference Fix model, upload, and knowledge search problems Check an unavailable model, rejected document, failed processing job, or weak knowledge result.
- Reference Fix workflow and Connection problems Check a workflow that is not ready, a failed run, or a Connection test that does not pass.
- Reference Fix service readiness and storage problems Understand a running service that is not ready or data that is unavailable after a storage change.
- Reference Fix log, backup, and restore problems Find missing investigation records and check an incomplete backup or restore.
- Reference Server setting names Find the main environment setting names and what each group controls.
- Reference Document types and upload limits Check which document types Pūnaha can read and how many files you can upload.
- Reference Understand security and data handling Find the current guides for sign in, access, tenant separation, data movement, audit, and secrets.
- Reference Authentication and access overview Understand sessions, membership, exact actions, groups, Deny rules, and service access.
- Reference Tenant separation Understand how the current build keeps tenant requests and records in the selected tenant scope.
- Reference Data locations and movement See the main places where product data is stored and when configured work can send data elsewhere.
- Reference Audit and sensitive information Use audit and operational records without exposing personal information or secrets.
- Reference How access works Understand who gets access, which item it covers, and which actions it allows.
- Reference Secrets and safe configuration Enter, store, test, change, and report configuration without exposing passwords, keys, or tokens.
- Reference Important defaults and limits Find the main default values that affect server size and performance.
- Reference Understand documentation versions and releases Know when to use Next, the current product version, or an older documentation version.
- Reference Keep documentation current Find pages and screenshots that need review when the Pūnaha product changes.
- Reference What this local release covers See what was checked for this local documentation release and what was left out.
- API Cases and case work data models Read the shared cases and case work fields used by the customer API.
- Learn Practise with Pūnaha Choose a safe exercise and practise one Pūnaha task in a local test tenant.
- API Common HTTP models data models Read the shared common http models fields used by the customer API.
- API Identity and access data models Read the shared identity and access fields used by the customer API.
- API Knowledge and documents data models Read the shared knowledge and documents fields used by the customer API.
- API Models, inference and Connections data models Read the shared models, inference and connections fields used by the customer API.
- API Other shared models data models Read the shared other shared models fields used by the customer API.
- API Workflows and runs data models Read the shared workflows and runs fields used by the customer API.
- Learn Exercise: Check why an action is allowed Use Check access to read one allowed result and one restricted result without changing access.
- Learn Exercise: Upload and find practice knowledge Upload a small made up text file and confirm that a knowledge search finds the right passage.
- Learn Exercise: Build and test a workflow draft Create a small workflow draft, check it, and use a safe draft test without publishing it.
- Learn Exercise: Design a case type draft Create a small case type draft and check its information, stage, and work without publishing it.
- Learn Exercise: Check services and recent records Read service health, server details, logs, and audit records without changing the local installation.
- API API changes See the lifecycle and baseline history of every operation in the current customer contract.
- Quick guides Printable quick guides Choose a short checklist to print and use beside a local Pūnaha installation.
- Quick guides Quick guide: Start and check an installation Use a short checklist to start Pūnaha and confirm that its required services are ready.
- Quick guides Quick guide: Check an access result Use a short checklist to confirm why one person or group can or cannot complete an action.
- Quick guides Quick guide: Start an operational investigation Use a short checklist to follow a problem from the visible symptom to operations, logs, and audit records.
- Quick guides Quick guide: Verify a backup and restore Use a short checklist to confirm that a complete Pūnaha backup restores consistent services and data.
- API Check Access authorization Check Access authorization. This applies the validated business action to the selected tenant or platform resource.
- API Effective Access authorization Effective Access authorization. This applies the validated business action to the selected tenant or platform resource.
- API List workflows List workflows. This reads the current tenant or platform state without changing the resource.
- API Create workflows Create workflows. This applies the validated business action to the selected tenant or platform resource.
- API List workflows conformance (GET /api/workflows/bpmn/conformance) List workflows conformance. This reads the current tenant or platform state without changing the resource.
- API List workflows report (GET /api/workflows/bpmn/conformance/report) List workflows report. This reads the current tenant or platform state without changing the resource.
- API List workflows common executable List workflows common executable. This reads the current tenant or platform state without changing the resource.
- API List workflows conformance (GET /api/workflows/dmn/conformance) List workflows conformance. This reads the current tenant or platform state without changing the resource.
- API List workflows report (GET /api/workflows/dmn/conformance/report) List workflows report. This reads the current tenant or platform state without changing the resource.
- API List workflows catalog List workflows catalog. This reads the current tenant or platform state without changing the resource.
- API Preview workflows Preview workflows. This applies the validated business action to the selected tenant or platform resource.
- API Delete workflows (DELETE /api/workflows/{workflowId}) Delete workflows. This removes or retires the selected resource according to its lifecycle rules.
- API Get workflows Get workflows. This reads the current tenant or platform state without changing the resource.
- API Update workflows Update workflows. This applies only the supplied changes.
- API Get workflows dmn Get workflows dmn. This reads the current tenant or platform state without changing the resource.
- API Dmn workflows Dmn workflows. This replaces or sets the selected state using the full supplied value.
- API Draft workflows Draft workflows. This replaces or sets the selected state using the full supplied value.
- API Get workflows export (GET /api/workflows/{workflowId}/export/bpel) Get workflows export. This reads the current tenant or platform state without changing the resource.
- API Get workflows export (GET /api/workflows/{workflowId}/export/bpmn) Get workflows export. This reads the current tenant or platform state without changing the resource.
- API Get workflows export (GET /api/workflows/{workflowId}/export/dmn) Get workflows export. This reads the current tenant or platform state without changing the resource.
- API Get workflows import source Get workflows import source. This reads the current tenant or platform state without changing the resource.
- API Publish workflows Publish workflows. This applies the validated business action to the selected tenant or platform resource.
- API Get workflows runs (GET /api/workflows/{workflowId}/runs) Get workflows runs. This reads the current tenant or platform state without changing the resource.
- API Runs workflows Runs workflows. This applies the validated business action to the selected tenant or platform resource.
- API Delete workflows (DELETE /api/workflows/{workflowId}/runs/{runId}) Delete workflows. This removes or retires the selected resource according to its lifecycle rules.
- API Get workflows runs (GET /api/workflows/{workflowId}/runs/{runId}) Get workflows runs. This reads the current tenant or platform state without changing the resource.
- API Decision workflows Decision workflows. This applies the validated business action to the selected tenant or platform resource.
- API Get workflows events (GET /api/workflows/{workflowId}/runs/{runId}/events) Get workflows events. This reads the current tenant or platform state without changing the resource.
- API Get workflows events (GET /api/workflows/{workflowId}/runs/{runId}/events/stream) Get workflows events. This reads the current tenant or platform state without changing the resource.
- API Complete workflows Complete workflows. This applies the validated business action to the selected tenant or platform resource.
- API Delete workflows (DELETE /api/workflows/{workflowId}/star) Delete workflows. This removes or retires the selected resource according to its lifecycle rules.
- API Star workflows Star workflows. This replaces or sets the selected state using the full supplied value.
- API Validate workflows Validate workflows. This applies the validated business action to the selected tenant or platform resource.
- API Get workflows versions Get workflows versions. This reads the current tenant or platform state without changing the resource.
- API Create case events Create case events. This applies the validated business action to the selected tenant or platform resource.
- API List case types List case types. This reads the current tenant or platform state without changing the resource.
- API Create case types Create case types. This applies the validated business action to the selected tenant or platform resource.
- API Cmmn case types Cmmn case types. This applies the validated business action to the selected tenant or platform resource.
- API Preview case types Preview case types. This applies the validated business action to the selected tenant or platform resource.
- API Delete case types Delete case types. This removes or retires the selected resource according to its lifecycle rules.
- API Get case types Get case types. This reads the current tenant or platform state without changing the resource.
- API Update case types Update case types. This applies only the supplied changes.
- API Draft case types Draft case types. This replaces or sets the selected state using the full supplied value.
- API Get case types export Get case types export. This reads the current tenant or platform state without changing the resource.
- API Publish case types Publish case types. This applies the validated business action to the selected tenant or platform resource.
- API Validate case types Validate case types. This applies the validated business action to the selected tenant or platform resource.
- API Get case types versions Get case types versions. This reads the current tenant or platform state without changing the resource.
- API Create chat Create chat. This applies the validated business action to the selected tenant or platform resource.
- API Create embeddings Create embeddings. This applies the validated business action to the selected tenant or platform resource.
- API List model providers connections List model providers connections. This reads the current tenant or platform state without changing the resource.
- API Connections model providers Connections model providers. This applies the validated business action to the selected tenant or platform resource.
- API Delete model providers (DELETE /api/model providers/connections/{connectionId}) Delete model providers. This removes or retires the selected resource according to its lifecycle rules.
- API Get model providers (GET /api/model providers/connections/{connectionId}) Get model providers. This reads the current tenant or platform state without changing the resource.
- API Update model providers (PATCH /api/model providers/connections/{connectionId}) Update model providers. This applies only the supplied changes.
- API Deployments model providers Deployments model providers. This applies the validated business action to the selected tenant or platform resource.
- API Get model providers models Get model providers models. This reads the current tenant or platform state without changing the resource.
- API Models model providers (POST /api/model providers/connections/{connectionId}/models/discover) Models model providers. This applies the validated business action to the selected tenant or platform resource.
- API Models model providers (POST /api/model providers/connections/{connectionId}/models/import) Models model providers. This applies the validated business action to the selected tenant or platform resource.
- API Test model providers Test model providers. This applies the validated business action to the selected tenant or platform resource.
- API List model providers deployments List model providers deployments. This reads the current tenant or platform state without changing the resource.
- API Sync Local model providers Sync Local model providers. This applies the validated business action to the selected tenant or platform resource.
- API Delete model providers (DELETE /api/model providers/deployments/{deploymentId}) Delete model providers. This removes or retires the selected resource according to its lifecycle rules.
- API Get model providers (GET /api/model providers/deployments/{deploymentId}) Get model providers. This reads the current tenant or platform state without changing the resource.
- API Update model providers (PATCH /api/model providers/deployments/{deploymentId}) Update model providers. This applies only the supplied changes.
- API Memory model providers Memory model providers. This replaces or sets the selected state using the full supplied value.
- API Preload model providers Preload model providers. This replaces or sets the selected state using the full supplied value.
- API Refresh Revision model providers Refresh Revision model providers. This applies the validated business action to the selected tenant or platform resource.
- API List model providers types List model providers types. This reads the current tenant or platform state without changing the resource.
- API List models List models. This reads the current tenant or platform state without changing the resource.
- API List vector databases List vector databases. This reads the current tenant or platform state without changing the resource.
- API Create vector databases Create vector databases. This applies the validated business action to the selected tenant or platform resource.
- API List vector databases address availability List vector databases address availability. This reads the current tenant or platform state without changing the resource.
- API List vector databases embedding models List vector databases embedding models. This reads the current tenant or platform state without changing the resource.
- API List vector databases ingestion jobs List vector databases ingestion jobs. This reads the current tenant or platform state without changing the resource.
- API Delete vector databases (DELETE /api/vector databases/ingestion jobs/{jobId}) Delete vector databases. This removes or retires the selected resource according to its lifecycle rules.
- API Get vector databases Get vector databases. This reads the current tenant or platform state without changing the resource.
- API Get vector databases servers Get vector databases servers. This reads the current tenant or platform state without changing the resource.
- API List vector databases methodologies List vector databases methodologies. This reads the current tenant or platform state without changing the resource.
- API List vector databases upload policy List vector databases upload policy. This reads the current tenant or platform state without changing the resource.
- API Delete vector databases (DELETE /api/vector databases/{name}) Delete vector databases. This removes or retires the selected resource according to its lifecycle rules.
- API Update vector databases Update vector databases. This applies only the supplied changes.
- API Get vector databases files Get vector databases files. This reads the current tenant or platform state without changing the resource.
- API Files vector databases (POST /api/vector databases/{name}/files) Files vector databases. This applies the validated business action to the selected tenant or platform resource.
- API Delete vector databases (DELETE /api/vector databases/{name}/files/{fileId}) Delete vector databases. This removes or retires the selected resource according to its lifecycle rules.
- API Files vector databases (PATCH /api/vector databases/{name}/files/{fileId}) Files vector databases. This applies only the supplied changes.
- API Query vector databases Query vector databases. This applies the validated business action to the selected tenant or platform resource.
- API List connections List connections. This reads the current tenant or platform state without changing the resource.
- API Create connections Create connections. This applies the validated business action to the selected tenant or platform resource.
- API List connections options List connections options. This reads the current tenant or platform state without changing the resource.
- API Delete connections Delete connections. This removes or retires the selected resource according to its lifecycle rules.
- API Get connections Get connections. This reads the current tenant or platform state without changing the resource.
- API Update connections Update connections. This applies only the supplied changes.
- API Test connections Test connections. This applies the validated business action to the selected tenant or platform resource.
- API List health Reports the installation health state used by operators and automated probes.
- API List health live Reports the installation health state used by operators and automated probes.
- API List health ready Reports the installation health state used by operators and automated probes.