Summary:
Learn how Mapping connects source data to target data in a BrynQ interface, why mappings are needed, and how to create, import, edit, export, and maintain them.
Requirements:
- You need an interface with source and target apps.
- You need an editable draft to change mappings. Published, old, deactivated, or read-only versions can be viewed but not edited.
Use Mapping in an Interface
Mapping tells BrynQ how values from a source app should become values for a target app.
Understand what mapping is
- A source app is the system BrynQ reads data from.
- A target app is the system BrynQ writes data to.
- A mapping is a table of rules between source values and target values. Each row says: when BrynQ receives this source value, send this target value.
- An input column contains values from the source side.
- An output column contains values for the target side.
- A mapping row is one conversion rule in the table.
- Set all unmapped values as is a fallback value. BrynQ uses it when a source value is not listed in the mapping table.
Why mapping is needed
- Different apps often use different names or codes for the same business meaning.
- Mapping prevents BrynQ from sending a source value that the target app does not understand.
- Mapping also makes data rules visible, so users and implementers can review which values are allowed before an interface runs.
- Without a correct mapping, the interface can send the wrong value, skip values, or need extra correction during implementation.
Example
- A source HR app sends employment type as
Full-time, Part-time, and Contractor.
- The target payroll app expects
FT, PT, and EXT.
- In Mapping, create an input column for the source employment type and an output column for the target payroll code.
- Add one mapping row for each conversion:
Full-time becomes FT.
Part-time becomes PT.
Contractor becomes EXT.
- When the interface runs, BrynQ reads the source value and sends the matching target value.
Open the Mapping tab
- Open the interface you want to work on.
- In the interface header or version selector, select the correct editable draft.
- In the interface menu, go to Mapping.
- Check the page header to confirm you are mapping the correct source and target apps.
Create or Import a Mapping
You can create a mapping manually in BrynQ or import one from a file when you already have the values in a spreadsheet.
Create a new mapping manually
- In the empty state, click New Mapping.
- If the interface already has mappings, use the left sidebar and click New Mapping at the bottom.
- At the top of the mapping editor, click the mapping name if you need to rename it. Use a name that explains the business value, such as
Employment type to payroll code.
- In the table header, use Add column on the source side when the conversion needs another input value.
- In the table header, use Add column on the target side when the conversion needs another output value.
- Fill in the table rows. Each row should contain one complete source-to-target conversion.
Import a mapping from a file
- On the Mapping page, click Import mapping.
- In the Import data for mapping window, use File to upload a
.csv or .xlsx file.
- If you upload an Excel file, select the correct Sheet.
- If you upload a CSV file, choose the correct Delimiter. This tells BrynQ how the file separates columns, such as comma, semicolon, pipe, or tab.
- Fill in Mapping name.
- Use Input range to select the file columns that contain source values.
- Use Output range to select the file columns that contain target values.
- Turn on Set first row as column name when the first row contains column names instead of mapping values.
- Check Sheet preview to confirm BrynQ reads the file correctly.
- In the bottom-right of the window, click Apply and import.
Choose between manual and imported mapping
- Use New Mapping when the table is small or when you want to build the rules directly in BrynQ.
- Use Import mapping when the mapping has many rows, already exists in Excel or CSV, or needs to be reviewed outside BrynQ first.
- After importing, still review the rows in BrynQ. A wrong delimiter, wrong sheet, or wrong first-row setting can place values in the wrong columns.
Edit and Maintain Mappings
Mapping changes are saved automatically while you work in an editable draft.
Edit an existing mapping
- In the left Mappings sidebar, select the mapping you want to edit.
- At the top of the editor, click the mapping name to rename it.
- Use Add column only when one conversion needs more than one input value or more than one output value.
- Update table cells when source or target values change.
- Use Set all unmapped values as only when all missing source values should become the same target value. Leave it empty when unmapped values should stay visible for review.
Export or remove a mapping
- In the left Mappings sidebar, select the mapping you want to use.
- In the top-right action area of the mapping editor, click the export icon to download the current mapping as a CSV file.
- To remove a mapping, use the trash icon next to the mapping in the left sidebar.
Keep mappings clean
- Use clear mapping names that describe the source value and target value.
- Keep one business meaning per mapping. For example, keep employment type mapping separate from department mapping.
- Review imported files before and after import.
- Remove old mappings that are no longer used.
- Check mappings again when a source app or target app changes its allowed values.
More Information
Mapping on the Mapping tab is different from choosing fields in Scenarios. Scenarios decide which data belongs in a flow. Mapping decides how one set of values should be converted into another set of values. Both parts help BrynQ move data from the source app to the target app correctly.
Related Articles
Map Fields Between Source and Target
Summary: Map source values to target values so BrynQ can send the right data to the target app when the two apps use different field values. Requirements: - You need access to the interface you want to configure. - The interface must include a ...
Set Up Scenarios in a Template Interface
Summary: Set up Scenarios in an interface template so BrynQ knows which business flow the template supports, which source data belongs to which target data, and which value mappings users must complete. Requirements: - You need access to Admin portal ...
Complete Template Configuration
Summary: Complete the setup of a BrynQ template interface by filling in the required tabs, checking the draft, and publishing it when it is ready. Requirements: - You need access to Interfaces. - You need permission to edit and publish the interface. ...
Interface Concepts and Lifecycle
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 ...
Create an Interface from a Template
Summary: Create a new BrynQ interface by selecting a ready-made template and, when needed, activating the apps used by that template. Requirements: - You need the Create interfaces permission. - Your plan must have space for another interface. - If ...