refiroo documentation

refiroo is where a team keeps the shared lists, codes, names and connections that other systems depend on. A model shapes the applications and rules; people maintain the data in the browser, and other systems read or change it through APIs.

A few ideas to begin with

• A model defines record types, fields, relationships and views. An application groups them into a working area.
• A workspace holds data under one model release. Different workspaces can use different models.
• Live is the current data. A change set prepares changes separately; publishing applies them and creates a read-only publication.
• Roles and grants decide what each person or integration may read and change.

Read How refiroo works for these ideas and Three kinds of change to distinguish editing records, publishing data and releasing a model.

Evaluate refiroo

Begin with What refiroo is to decide whether it fits your shared reference data. Then explore:

• How refiroo works — models, records, connections and workspaces.
• The example data — public transport stops showing the capabilities together.
• Sharing data with other systems — how integrations read, supply and follow data.
• How refiroo protects data — model rules, concurrent saves and reviewed changes.
• Who can do what — responsibilities, grants and sign-in.
• Security and trust — access, protection and operational responsibilities.
• How refiroo is built — technology, deployment and recovery.
• Versions, compatibility and licence — stable contracts and the running source offer.
• Accessibility and devices — keyboard and phone use, display choices and evidence limits.

Look after data

As a data steward, begin with Home to find the workspaces and work available to you. Then use:

• Workspaces — choose where you are working.
• Find records — search, filter and open the records you need.
• Records — read and correct fields and understand refused saves.
• Change sets — prepare, review and publish coordinated changes.
• Importing and exporting — exchange files and repeat a checked load.
• Copying and moving — prepare records in another workspace.
• AI and your data — decide whether to use optional proposals or an assistant.
• Notification settings — follow publications and choose immediate email or digests.

Shape a model

As a model administrator, begin with Models to understand drafts, releases and activation. Then read:

• The model editor — find and change the model’s definitions.
• Types, attributes and relations — define records, reusable fields and connections.
• Applications and views — arrange navigation and the screens people use.
• Record pages and tables — choose panels, columns and filters.
• Workbook onboarding — turn an existing file into a reviewed model and loading profile.
• Releases — check, install and activate a model release.

Administer access

As an access administrator, begin with Roles and grants to understand what access allows and where it applies. Then use:

• People and groups — manage accounts and shared membership.
• Sign-in — manage how people authenticate.
• Clients — give another system its own identity and access.
• Audit — inspect administrative changes.

Run the service

As an operator, begin with What you run to understand the services and storage. Then follow:

• Install with Compose — install and start refiroo.
• Configure the installation — choose the settings for your deployment.
• Back up and restore — protect data and rehearse recovery.
• Production checklist — check the deployment before use.

Connect another system

As an integrator, begin with Integrating with refiroo to choose an interface and sequence. Then read:

• Signing in and tokens — authenticate the integration’s client.
• Identifiers, paging and errors — traverse data and handle refusals.
• Consumer APIs — read the business contract declared by the model.
• Load, then follow changes — keep another system in step.

Tasks and reference

Choose a task in User journeys for a path through the relevant explanations and guides. Open the API reference for the operations, request fields and response schemas served by your instance.

To find a particular topic, choose Search at the top of the documentation, or press Ctrl+K (Command+K on a Mac).