Summary: Learn what a BrynQ interface is, which states it can have, and how it moves from setup to live use.

Requirements: - You need access to Interfaces to view interfaces. - You need the correct permissions to create, edit, publish, or run an interface. - The source and target apps must be active before an interface can be activated and used.

Interface Concepts and Lifecycle

An interface connects a source app with a target app so data can move between them in a controlled way.

What an interface is

• An interface defines which data is exchanged, where it comes from, where it goes, and how BrynQ should process it.
• A source app is the app where the data comes from.
• A target app is the app where the data is sent.
• A schedule controls when the interface runs. It can be manual, time-based, or started after another interface.
• Variables are values that can be used when the interface runs.

Interface types

• Use Use our templates when you want to start from a standard BrynQ template.
• Use Build together with us when you need a custom solution with BrynQ support.
• A template interface can include Configuration, Scenarios, Data filters, Authorization, Mapping, Variables, and Schedule.
• A custom interface can include Scoping, Authorization, Mapping, Variables, and Schedule.

Active and inactive interfaces

• Active interfaces can run when the required setup is complete.
• Inactive interfaces are disabled and cannot run.
• When you deactivate an interface, BrynQ also disables its schedule.
• You cannot deactivate an interface while it is running.
• If an interface needs apps that are not active, BrynQ asks you to activate those apps first.

How an Interface Moves Through Its Lifecycle

An interface usually moves from creation, to draft setup, to live use, and then to later changes when needed.

Create the interface

• Open Interfaces.
• Select New interface.
• Choose Use our templates or Build together with us.
• For a template, choose the template that matches your source and target apps.
• For a custom interface, enter a clear interface name.
• Select Finish or Confirm and start to create the first draft.

Complete the draft

• A draft is the editable version of the interface.
• BrynQ saves changes while you work.
• Complete all required tabs that are visible for your interface type.
• If a warning appears on a tab, open that tab and complete the missing information.
• Select Continue later if you want to leave the draft without publishing it.

Publish the draft

• Select Publish when all required parts are complete.
• BrynQ checks the draft before publishing.
• Publishing is blocked when required authorization, configuration, scenarios, mapping, or other required data is missing.
• After publishing, the version becomes Live.
• If the interface has an active schedule, publishing a new draft can affect the next run.

Use the live interface

• A Live interface is the published version that BrynQ uses for runs.
• Use Run to start a manual run when the interface allows manual runs.
• Use Schedule to run the interface automatically.
• Use View logs to review past runs, errors, and messages.
• If the interface is active and has a valid schedule, BrynQ can run it without manual action.

Change a live interface

• Select Create draft to start a new editable version from the live version.
• Select Show draft when a draft already exists.
• Edit the draft and publish it when it is ready.
• Publishing the draft makes it the new live version.
• Older live versions can be viewed. Restoring an older version can remove later version data, so only do this when you are sure.

Interface Statuses

Statuses help you understand whether an interface can run, is being edited, or needs attention.

Version statuses

• Draft means the version is still being prepared.
• Live means the version is published and used for runs.
• Old version means the version was live before but is no longer the latest live version.
• In development means BrynQ is still working on the interface. You can view it and may be able to prepare authorization or mapping, but some changes may require support.

Run statuses

• Idle means the interface is not running.
• Queued means the run is waiting to start.
• Running means the interface is processing data.
• Stopping means BrynQ is stopping the run.
• Unknown means BrynQ cannot show a clear run state.

Last run results

• Successful means the run finished without errors.
• Completed means the run finished but had errors or warnings.
• Failed means the run did not finish successfully.
• Stopped means the run was stopped by a user.
• Never run means there is no run history yet.

Good Practices

Use these checks before you publish or run an interface.

Before publishing

• Check that Authorization is complete for the live environment.
• Check that required Configuration fields are filled in.
• Check that required Scenarios and Mapping are complete.
• Check that each active scenario has a Unique key when required.
• Check the Schedule before publishing if the interface already runs automatically.

Before running

• Make sure the interface is Active.
• Make sure the source and target apps are active.
• Check whether the interface uses manual runs, a schedule, or another interface as its trigger.
• Review Variables if the run needs values that can change per run.
• Open View logs after a run if the result is failed or completed with errors.

More Information Use Interfaces for live and inactive interfaces. Use Setups to find interfaces that still have a draft or setup in progress.