Browser Storage Component

A Property ID is the unique field ID used by Unqork to track and link components in your module.

The Property ID is how the software identifies your component. Using Property IDs lets you link components, creating logic-based configurations and API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. calls.

Property IDs must use camel case A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. (stylized as camelCase) without spaces or punctuation.

Select this tab to display the component's Notes area. You can use notes to keep your teammates informed.

The Notes editor offers a semi-WYSIWYG (What You See is What You Get) content editor. Built to look like a word processor, this editor lets you create, edit, and format your notes. Notes save when saving the component.

Select this tab to manage your component's display settings.

Select this tab to manage your component's data settings.

Select this tab to manage your component's actions settings.

Select this tab to manage your component's advanced settings.

Assign components one-word labels to help organize, identify, and group the components in your application.

Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panels. The Field Tags identify the data type of parameters included in the API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag.

Field Tags act as a type of Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component.

For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag.

Save your Field Tags by pressing Enter (Return) or adding a comma after each entry.

Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:

• Cmd + S (Mac) / Ctrl + S (PC): Save and close the component settings modal.

• Cmd + G (Mac) / Ctrl + G (PC): Opens a search window to find specific fields and settings in the component settings modal.

• Tab: Tab to the next field or setting in the component settings modal. This keyboard shortcut tabs left to right and top to bottom.

• Shift + Tab: Tab to the previous field or setting in the component settings modal. The keyboard shortcut tabs from right to left and bottom to top.

• Enter (Return): When tabbing to a  (tooltip), press Enter (Return) to display the field or setting tooltip. Press Enter (Return) again to hide the tooltip.

Additional keyboard shortcuts:

• Drop-down menus: When you Tab to a settings drop-down, use the keyboard's  (up)/  (down) arrows to make a selection. Then, press Enter (Return) to confirm the selection.

Select this tab to access the component documentation in Unqork's In-Product Help.

Click this button to undo any unsaved configuration changes and return to the canvas.

The Browser Storage component has the following options:

• Write: This interaction lets you create and update data in the IndexedDB object store. Use the component's Filters table when creating or updating information. If there's information you want updated, enter the Property ID of that information in the Filters table. The component filters on that Property ID and merges or overwrites the information. If there's no match to the Property ID, or the field is blank, the component creates a new submission.

• Read: This interaction views filtered data. It also searches for individual offline submissions. To find offline data, use the suffix: /display/:formId/local/:namespace/:submissionId, like you do when searching for a specific submission ID. The Namespace is the unique identifier you created for your stored information.

• Delete: This interaction deletes locally-stored data from the IndexedDB object.

TIP  To learn more about the IndexedDB API, view the following documentation: https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API

The Browser Storage component's Filters table helps you find information stored in the browser's IndexedDB object store.

This is the Property ID of the stored information. Mapping to this Property ID performs the Write, Read, and Delete operations to that data.

TIP  The Property ID entered must match the Property ID used in the input component. Remember, use camel case (stylized as camelCase) without spaces or punctuation.

This drop-down lets you select how you want to compare the Filter’s Property ID to its Mapping. Your options are: =, <, or >.

Mapping describes where in the stored data you're filtering. This mapping information tells the component what data to push to or call when triggered.

If (checked), the end-user must enter a value in the field of this input component before the logic component fires.

By default, this setting is ☐ (unchecked).

If (checked), the filter operation doesn't run when you trigger the Browser Storage component.

By default, this setting is ☐ (unchecked).

If (checked), or if the field has no value, the operation doesn't run when you trigger the Browser Storage component. By default, all inputs in the request body progress, even if the field is empty (null).

By default, this setting is ☐ (unchecked).

This Property ID refers to your triggering component. Use this field to enter values that you send to the browser’s IndexedDB object store.

API documentation includes mapping information. This mapping information tells the Browser Storage component which information to push or call from the browser's IndexedDB object store.

TIP  You can find the Unqork API documentation here: https://developers.unqork.io/.

If (checked), the end-user must enter a value in the field of this input component before the logic component fires.

By default, this setting is ☐ (unchecked).

If (checked), the component doesn't pass the field as part of the request body of the API call. The component still watches for changes to the value.

By default, this setting is ☐ (unchecked).

This Property ID is where you want the component to send the data retrieved from your browser. For your logic component to recognize an output, you must enter the destination component's Property IDs.

TIP  The Property ID you enter must match the Property ID used in the output component. Remember, use camel case (stylized as camelCase) without spaces or punctuation.

Enter the Property ID of the component that you want to trigger after the Browser Storage component completes the API call. For example, triggering a component to display the data received from the Browser Storage component's API call.

If Disable Execution is set to (ON), the logic tied to this component does not execute. Use this to keep the component's settings, but disable the operations it performs.

By default, this setting is set to (OFF).