Platform Knowledge Base

1.1. Log In to REKA Platform

1. Navigate to https://create.<platform-base-url>/.
2. Select a login option and click it.
3. Complete the login process with your chosen provider.
4. Once successful, you will be redirected to the Creator Home page.

1.2. Manual Signup

1. Navigate to https://create.<platform-base-url>/.
2. Click on the … button.
3. Select Sign Up under the Email and Password option.
4. In the Sign Up form, enter the following details:

   Field	Description
   Name	User full name
   Email	User email address
   Password	User password

5. Once completed, click the Sign Up button.

Upon successful registration, a confirmation message will appear: “User registered successfully”.

1.3. Login Using Manual Account

1. Navigate to https://create.<platform-base-url>/.
2. Click on the … button.
3. In the Login form, enter the following details:

   Field	Description
   Email	Email used during Manual Sign Up.
   Password	Password specified during Manual Sign Up.

4. Then, click the Log In button.

Upon successful login, you will be redirected to the Creator Home page.

1.4. Log Out from REKA Platform

1. Click the Creator Profile link at the top-right corner of the Creator Home page.
2. On the Creator Profile page, click the Logout button (red).
3. You will be redirected to the landing page after a successful logout.

1.5. Remove Creator Profile

1. Click the Creator Profile link at the top-right corner of the Creator Home page.
2. On the Creator Profile page, click the Remove My Account button.
3. You will be logged out and redirected to the landing page.

2.1. Create a New App

1. Click on the Create New App > Blank (Create from Scratch) tile.
2. In the App Properties modal dialog, fill in the App Title.
3. Select your preferred App Layout in Choose Layout.
4. Ensure the App Path is available. If not, edit the path to use an available one.
   Warning

   Each app must have a unique path. If the chosen path conflicts with an existing app, your new app may not be accessible. Always double-check the availability before proceeding.

5. Select the Sign-In Options for your app.
6. If your app is a Satellite App, select the main app under Use local user from other app.
7. In the Advanced Tab, configure or set the following options:

   Setting	Description
   App Status	Define whether the app is Local, Published or set as Template.
   App Behaviour Settings	Adjust specific behaviour rules for the app.
   One-off Screen	Set a one-time display screen if required (ie: PDPA notice).
   Privacy Policy Link	Provide the URL to your app’s privacy policy.
   Forward Domain	Set a custom domain for your app.
   Default Language	Choose between Bahasa Melayu or English.
   Custom Menu Style (CSS)	Add custom CSS for app menu styling.
   App Welcome Text	Text displayed on the login page.
   App Group	Group your app within the My Apps page for easier organization.
   Enable cookie consent banner	Option to enable cookie consent banner when user in the app start page.

8. You can also switch the App Status between Dev and Live at the top-right corner of the dialog.
9. Once all settings are completed, click Create App.
10. You will be redirected to the App Designer page.

2.2. Edit Existing App Properties

1. Navigate to the Creator Home page.
2. Hover over the App Tile of the application you wish to modify, then click the Edit Properties button.
3. In the App Properties dialog, update the desired properties.
4. Once all changes are complete, click Save App to apply the updates.

2.3. Remove an Existing App

1. Navigate to the Creator Home page.
2. Hover over the App Tile of the application you wish to remove, then click the Remove App button.
3. In the Remove App dialog, click the Remove App button again to confirm the removal.

2.4. Clone / Copy an Existing App

1. Navigate to the Creator Home page.
2. Hover over the tile of the application you wish to copy, then click the Copy App button.
3. In the App Properties dialog, provide the new details for the copied app.
4. Ensure that a unique App Path is set for the new app.
5. Once all details are complete, click the Save App button.
6. Upon successful completion, you will be redirected to the Design Page of the newly copied application.

2.5. Preview the App

1. Navigate to the Creator Home page.
2. Hover over the App Tile of the application you wish to preview.
3. Click the Edit App button.
4. In the App Designer page, click the Run button located at the top-right corner.
5. You will be prompted to confirm the email address you want to use for running the preview. Click OK to proceed.
6. The app will run, allowing you to test its functionality as if you were the specified user.
7. To return to the App Designer page, click the Edit button located at the bottom-left corner of the preview page.

2.6. Share App URL

1. Navigate to the Creator Home page.
2. Open the app you wish to share by clicking Edit App.
3. In the App Designer page, click the App URL button located at the top-right corner.
4. In the popup dialog, copy the displayed URL, then click OK to close the prompt.
5. You can now use the copied URL to access the app.

2.7. View App Summary

1. Navigate to the Creator Home page.
2. Hover over the App Tile of the application you wish to review, then click the Edit App button.
3. In the App Designer page, click the App Summary button located at the top-right corner.
4. You will be redirected to the App Summary page, where you can view key information about the app, including:
   • Number of components built
   • Data record counts
   • Number of users
   • File upload storage size
   • Other relevant usage statistics

3.1. Create a New Form

1. Navigate to the App Designer page → UI Editor.
2. Click on the + New Form button located under the Forms section in the side menu.
3. In the Add Form modal dialog, enter the Name of your form.
4. If the new form is an extension of an existing form, select the corresponding form in the Extend From field.
5. Configure additional options in the Options tab as described below:

   Option	Description
   Nav Type	Defines the navigation type (e.g., top-level container).
   Align	Specifies the alignment of the section.
   Single Data	Determines whether the form creates or updates information based on the specified Qualifier, ensuring that only one data record exists per qualifier.
   Disable Server-Side Entry Validation	Disables validation checks performed on the server side.
   Previous Form	Specifies the preceding form, if the current form is intended to follow another form.
   Entry User Specified As	Overrides how the entry owner’s email is captured.
   Start Date	Defines the start date for the form’s active period.
   End Date	Defines the end date for the form’s active period.
   Code Formatter	Formats the $code value using Java String Formatter.
   Counter	Maintains a counter for the number of entries created through this form.
   New Entry Mailer	Email notification triggered when a new entry is created.
   Entry Update Mailer	Email notification triggered when an entry is updated.
   Retract Mailer	Email notification triggered when an entry is retracted.
   List of Facets	Specifies the available facets for the form.

6. Define the Form Lifecycle in the Lifecycle tab:
   • Init Function – Executes when the form is loaded in add/edit mode.
   • On Save – Executes immediately after an entry is saved.
   • On Submit – Executes after an entry is submitted.
   • On View – Executes when the entry is viewed.
   Note

   If you want certain functions to run only for specific facets, create a condition to check the current facet using $action$. For example:

   if ($action$ === 'admin-update') {
       // This code runs only in the 'admin-update' facet
   }

7. When configuration is complete, click on the Save Form button.
8. The system will generate a blank form with a default section named Section 1.

3.2. Add a New Tab (for Forms with Nav Type)

1. Click the + button located above the first section of the form.
2. In the Edit Tab dialog, enter the following details:

   Field	Description
   Tab Name	Enter the name of the tab.
   Pre-requisite (optional)	The tab will only be displayed if the specified condition is met.
   On Tab Activate (optional)	If specified, the function will be triggered when the tab is activated.
   Enable Condition (optional)	The tab will be enabled only when the specified condition is satisfied.
   Facet Mode	Adjusts the state of the tab based on the currently active facet.

3. Specify the tab’s icon in the Icons tab if desired.
4. Once all details are complete, click the Save Tab button to save the changes.

3.3. Edit an Existing Tab (for Forms with Nav Type)

1. Hover over the tab you wish to modify and click the Edit Tab button.
2. In the Edit Tab dialog, update the details as needed, including the tab name, conditions, facet mode, or icon.
3. After completing all changes, click the Save Tab button to apply and save your updates.

3.4. Remove a Tab (for Forms with Nav Type)

1. Hover over the tab you wish to remove and click the Remove Tab button.
2. In the Remove Tab dialog, click the Remove Tab button to confirm the removal.

3.5. Add a New Section

1. In the UI Editor, select the form under the Forms menu.
2. Click on the Add Section button.
3. In the Edit Section dialog, enter the Section Name.
4. Select the Section Type:

   Type	Description
   Section	Normal section for standard form fields.
   Child	Section can contain a list of data, e.g., a One-to-Many relationship.
   Approval	Section used as an Approval Form in Process Tier. This section will not be visible during form execution.

5. If the form uses Nav Type, specify the Parent Tab for the section (see Note below).
6. Adjust section visibility in the Visibility tab:

   Visibility Option	Description
   Pre-requisite	Section appears only if the specified condition is met.
   Facet Mode	Adjusts the state of fields in this section based on the active facet: • Edit: Field is editable. • View: Field is view-only. • Disabled: Field is in edit mode but disabled. • Hidden: Section is hidden but still part of the form; validations still apply. • None: Section is completely removed from the form.

7. Optionally, select an icon for the section in the Icon tab.
8. Click Save Section to save your changes.
9. The newly created section should now appear in your form.

3.6. Edit an Existing Section

1. Hover over the section; in the top-right corner, the Edit and Remove buttons will appear.
2. Click the Edit button.
3. In the Edit Section dialog, update the section configuration as needed, including the name, type, visibility, facet mode, or icon.
4. After completing the changes, click the Save Section button to apply your updates.

3.7. Rearrange Sections

If your form contains multiple sections, you can rearrange them to adjust the order of appearance.

1. Hover over the section; in the top-right corner, the Left Arrow and Right Arrow buttons will appear.
2. Click the Left Arrow to move the section up or left in the form order.
3. Click the Right Arrow to move the section down or right in the form order.

3.8. Add a Form Item into a Section

1. Expand the Palette pane on the right side of the Form Designer page.
2. Select a field from the Palette and drag and drop it into the desired section.
3. In the Add New … dialog, enter the Label for the field.
4. If the Code is unavailable, update it until a unique code is generated.
5. Configure the Field Settings as needed:

   Setting	Description
   Hide Label	Hides the label for the field.
   Read Only	Makes the field read-only.
   Type	Specifies the input type (e.g., text, number, date).
   Element Width	Sets the width of the field. Options: Responsive Size or Fixed Size.
   List Source	Datasource for autocompletion or lookup field types.
   Sub Type	Defines the sub-type for the input field.
   Placeholder	Displays muted text when the field is empty.
   Hide Field	Hides the field from the form.

6. Configure Validation rules in the Validation tab as needed.
7. Configure additional Field Options in the Options tab:

   Option	Description
   Hint	Text displayed below the field to provide guidance to the user.
   Pre-requisite	Field is only shown if the specified condition is met.
   Post-action	Function triggered when the field value is changed.
   Facet Mode	Adjust the field state based on the active facet: • Edit: Field is editable. • View: Field is view-only. • Disabled: Field is in edit mode but disabled. • Hidden: Field is hidden; validations still apply. • None: Field is completely removed from the form.

8. Once all configurations are complete, click the Save Item button.
9. The field should now appear within the section.

3.9. Rearrange Form Items

1. Hover over (or tab to) the Form Item you wish to move.
2. The Grip Icon ☰ will appear on the left side of the Form Item.
3. Click and hold the Grip Icon, then drag the Form Item to the desired position in the section.
4. You can also drag the Form Item to another section if needed.

3.10. Create a Form Process Flow

1. In the Form Designer page, click on the Process tab.
2. Click the Add New Tier button.
3. In the Edit Tier dialog, configure the following details:

   Field	Description
   Tier Name	Name of the tier. This name is displayed on the form’s Submit button. Keep it concise.
   Submission Mailer	Email notification sent when an entry is submitted into the tier.
   Resubmission Mailer	Email notification sent when an entry is resubmitted into the tier.
   Approval Type	Determines how approval is handled: • All: Any user can perform approval; first come, first served. • Dynamic: Approver is dynamically selected based on an endpoint. • Fixed: Set a fixed approver using an email or a variable from the entry (use {{ }}). • Group: Assign a User Group; any member can approve. • Assign: Admin assigns the approver (available only if Admin is enabled for the form).
   Show Approver Email	Displays the approver’s email in the approval section when viewing the entry.
   Always Approve Decision	Automatically sets the status to always_approve without showing tier actions.
   Enable Remark	Shows a remark input for the approver.
   Custom Approval Form	Specify a custom approval form using a designated section.

4. Optionally, configure a callback in the Callback tab to trigger a function after approval.
5. Click the Save Tier button to save the tier.
6. The new tier will now appear in your Process Flow.

3.11. Add a Tier Action to a Tier in Process Flow

1. Click the + button within the desired Tier.
2. In the Edit Tier Action dialog, configure the following details:

   Field	Description
   Label	Text displayed on the Tier Action button.
   Code	Unique identifier for the Tier Action within the Tier.
   Action	Defines the workflow when this Tier Action is selected: • Next Tier: Move to the next Tier in the Process Flow. • Previous Tier: Return to the previous Tier in the Process Flow. • Current Tier: Remain in the current Tier (stop progress). • Go to Tier: Jump to a specific Tier in the Process Flow.
   Mailer	Email notification triggered when this Tier Action is selected.
   Allow User to Edit and Resubmit	Enables the user to edit their entry and resubmit to this Tier.
   Icon	Icon displayed on the Tier Action button.
   Color	Color of the Tier Action button for visual distinction.

3. After configuring all options, click Save Tier Action to apply the changes.

3.12. Resynchronize Tier Approvers

Occasionally, it may be necessary to resynchronize approvers, for example, when the approver list in a User Group has changed.

1. In the Process tab, click the Update Approver for All Tiers button located at the bottom of the process flow.
2. In the confirmation prompt, type update-all-tier and click OK to initiate the process.
3. Once the process completes, a toast notification will appear to confirm that all tier approvers have been updated.

3.13. View Form Entry Trails

1. In the Form Designer page, click the … button located at the top-right corner of the page (next to the Edit Form button).
2. From the dropdown menu, select Form’s Entry Trails.
3. The Form’s Entry Trails dialog will appear, displaying all entry trails for the form.
   • Use the search bar to find specific keywords.
   • Apply filters to narrow results by Form Action Status or Date Range.
4. Select Show Possible Action to display any available actions related to the trail logs (e.g., revert data, undelete, etc.).
5. To export the logs, click the Download Excel button.
6. Click Close to exit the dialog.

3.14. Import Excel Data into a Form

1. In the Form Designer page, click the … button located at the top-right corner of the page (next to the Edit Form button).
2. From the dropdown menu, select Import Excel Data.
3. Configure the import settings as needed:

   Option	Description
   Create Field if Not Exist	Automatically create a form field if a column in the Excel file does not exist in the form.
   Create Dataset Automatically	Automatically create a dataset for the form based on the imported data.
   Create Dashboard Automatically	Automatically generate a dashboard with possible charts derived from Excel columns.
   Import to Live Data	Import the data directly into the live form dataset.

4. Click the Browse and Import button.
5. Select the Excel file to import and click Open.
6. Monitor the Import Progress Log to track the status of the import.
7. Once the import completes, click Done to finish the process.

3.15. Edit Existing Form Properties

1. In the Form Designer page, click the Edit button located at the top-right corner of the page (next to the Run Form button).
2. In the Edit Form dialog, update the settings or configurations as required.
3. Once all changes are complete, click the Save Form button to apply the updates.

3.16. Move Form to Another App

1. In the Form Designer page, click the … button located at the top-right corner of the page (next to the Edit Form button).
2. From the dropdown menu, select Move to Other App.
3. In the Move Form to Other App dialog, choose the destination App where you want to move the form.
4. Optionally, select the related dataset under Include the Following Dataset if you want to move it along with the form.
5. Once all selections are made, click the Move Form button to complete the operation.

3.17. Run / Preview the Form

1. In the Form Designer page, click the Form Run button located at the top-right corner of the form page.
2. You will be redirected to the Form Preview page, where the form is fully functional.
3. To return to the form editor, click the Edit button located at the bottom-left corner of the page.

3.18. Remove an Existing Form

1. In the Form Designer page, click the … button located at the top-right corner of the page (next to the Edit Form button).
2. From the dropdown menu, select Remove Form.
3. In the Remove Form dialog, click the Remove Form button to confirm.

4.1. Create New Dataset

1. Navigate to UI Editor → Datasets.
2. Click on the New Dataset button.
3. In the Add Dataset dialog, provide the following details:

   Field	Description
   List Caption	Enter the name of the dataset.
   Description (optional)	Provide a description of the dataset.
   Select Form	Choose the form from which data will be retrieved.
   List Type	Determine which entries are displayed: • All – Show all entries from the form regardless of data owner. • User – Show only entries created by the currently logged-in user. • Approver – Show only entries requiring approval by the currently logged-in user.
   Included Fields	Select the form fields to display in the dataset.
   List Entry with Status	Select which entry statuses should be included in the dataset.
   Default Sort Field	Choose the field for default sorting.
   Sort Direction	Select the default sort order (ascending or descending).

4. Configure additional options under the Options tab:

   Option	Description
   Show Status	Display the entry approval status.
   Show Index Number	Show index number as the first column.
   Show Dataset Summary	Display total elements, total pages, and other summary information.
   Hide Search Bar	Hide the search bar in the dataset toolbar.
   Turn Row to Card	Convert table rows to a card style when viewed on smaller screens.
   Full Width Table	Make the dataset table span the full available width.
   Public Endpoint	Enable a public endpoint for external access to this dataset.
   Disable Field Mask	Include all entry fields in the dataset, even if they are not selected as dataset fields.
   Allow User to Perform Data Grouping	Allow users to group dataset entries using the grouping dropdown menu.
   Default Data Grouping Field	Set the default field for grouping the data.
   Access Available For	Select the User Groups authorized to access this dataset.
   Export	Specify allowed export formats (Excel, CSV, PDF).
   Enable Email Blast	Enable sending notifications directly from the dataset.
   Enable Add Button	Allow users to add new entries via the dataset interface.
   Show Action	Display an action column on the right-most side of each row. Example: ✏️ Edit / 🗑️ Delete.
   Bulk Action	Enable or disable bulk action checkboxes on the left-most side of each row.
   Additional Initial Parameter	Set additional parameters for the dataset.
   Content Before Dataset	Insert HTML or CSS above the dataset table.
   Row’s Custom Class	Apply a CSS class to the dataset rows for styling purposes.

5. Define dataset filters in the Filters tab:
   • Tick the fields to include them in the dataset filter.
   • Specify default values for preset parameters.
   • For advanced filter conditions, use the Custom Query Builder.
6. Once configuration is complete, click Save List to create the dataset.

4.2. Edit Existing Dataset

1. Navigate to UI Editor → Datasets.
2. Select the dataset you wish to edit.
3. Click on the Edit Dataset button located at the top-right corner of the Dataset editor (next to the Remove Dataset button).
4. In the Edit Dataset dialog, update the properties or settings that require modification.
5. Once all changes are complete, click Save List to apply the updates and close the dialog.

4.3. Edit or Change Dataset Column

1. Hover over the item in the Displayed Columns section.
2. Rearrange Column Position: Click and hold the grip icon to move the column to the desired location.
3. Edit Column Label: Click the Edit button.
   • In the Edit Item dialog, update the label with the desired text.
   • Click Save Item to apply the changes.
4. Remove Column: Click the Delete Item button.
   • A confirmation prompt will appear; click OK to proceed with the removal.

4.4. Add Dataset Action

Dataset Actions allow users to perform specific operations directly on the data displayed in a dataset.

1. In the Dataset Editor, navigate to the Allowed Actions section and click on the New Action button.
2. In the Edit Action dialog, configure the following details:

   Field	Description
   Label	Enter the label for the action button.
   Button Type	Choose either Inline (button displayed in the action column) or Dropdown (menu item in the action dropdown).
   Color	Select the color of the button.
   Button Action	Choose the appropriate action to be performed when the button is clicked.
   Pre-requisite	(Optional) Define a condition; the action button will only appear if this condition is met.

3. To assign or change the action icon, navigate to the Icon tab and select the desired icon.
4. Once all configurations are complete, click Save Action.
5. The newly created action will appear under the Allowed Actions section.

4.5. Edit Dataset Action

Dataset Actions can be updated to modify their behavior, appearance, or conditions for display.

1. In the Allowed Actions section of the Dataset Editor, locate the action you want to modify and click the Edit button.
2. In the Edit Action dialog, update the properties as needed, including:
   • Label
   • Button Type (Inline or Dropdown)
   • Color
   • Button Action
   • Pre-requisite conditions
   • Icon (if applicable)
3. Once all updates are complete, click Save Action to apply the changes.

4.6. Delete Dataset Action

Dataset Actions can be removed when they are no longer needed.

1. In the Allowed Actions section of the Dataset Editor, locate the action you want to remove and click the Delete button.
2. When prompted for confirmation, type or acknowledge as required and click OK to confirm the deletion.
3. The action will be removed from the dataset and will no longer be available to users.

4.7. Clear Dataset Entries

Clearing dataset entries allows you to remove data that matches the dataset’s filter settings.

1. At the bottom of the Dataset Editor, click the Clear All Entry button.
2. When prompted for confirmation, type clear-dataset-entries and click OK to confirm the action.

4.8. Delete Dataset

Deleting a dataset will remove the dataset configuration permanently.

1. Navigate to UI Editor > Datasets.
2. Select the dataset you wish to delete.
3. At the top right of the Dataset Editor, click the Remove Dataset button (located beside the Run Dataset button).
4. In the Remove List dialog, click Remove Data List to confirm the deletion.

4.9. Copy / Clone Existing Dataset

You can create a duplicate of an existing dataset to use as a template or for modification without affecting the original.

1. Navigate to UI Editor > Datasets.
2. Click the Clone Dataset button in the side menu.
3. In the Duplicate Dataset dialog, select the dataset you wish to copy.
4. Click Start Duplicate Dataset to begin the copy process.
5. Once the copy operation is complete, the Edit Dataset dialog for the newly duplicated dataset will appear.
6. Update any details if necessary.
7. Click Save List to apply changes and dismiss the dialog.
8. You will be redirected to the Dataset Editor for the newly copied dataset.

5.1. Create New Dashboard

1. Navigate to App Designer → UI Editor.
2. Click on the New Dashboard button under the Dashboard submenu.
3. In the modal dialog, enter the following details:

   Field	Description
   Dashboard Name	Enter the name of the dashboard.
   Description	(Optional) Enter a brief description of the dashboard.
   Full width dashboard	Select this option to make the dashboard span the full available width.
   Show Print button	Enable to display a Print button on the dashboard page.
   Access available for	Restrict access to the dashboard by specifying authorized User Groups.

4. Once finished, click Save Dashboard to create the dashboard.

5.2. Edit Existing Dashboard

1. Navigate to App Designer → UI Editor.
2. Select the dashboard you wish to edit from the Dashboards submenu.
3. At the top-right corner of the Dashboard editor, click on the Edit Dashboard button (located beside the Remove Dashboard button).
4. In the Edit Dashboard dialog, update the properties and settings that you wish to modify.
5. Once finished, click Save Dashboard to apply the changes and close the dialog.

5.3. Remove Dashboard

1. Navigate to App Designer → UI Editor.
2. Select the dashboard you wish to remove from the Dashboards submenu.
3. At the top-right corner of the Dashboard editor, click on the Remove Dashboard button (located beside the Run Dashboard button).
4. In the Remove Dashboard dialog, click Remove Dashboard to confirm the deletion.

5.4. Create New Chart in Dashboard

1. Navigate to App Designer → UI Editor.
2. Select the dashboard in which you want to add the chart.
3. Click on the Add Chart button.
4. In the Add Chart modal dialog, configure the following details:

   Field	Description
   Chart Caption	Enter the title or caption for the chart.
   Description	Optional description for the chart.
   Source Type	Specify the source of the statistical data.
   Select Form	Choose the form from which statistical data will be derived.
   Plottable Category	Select the column to be used as the category for plotting.
   Plottable Value	Select the column representing the values for plotting.
   Series Chart	Enable this option if you want to create a series chart.
   Plottable Series	Select the column to define the series (if series chart is enabled).
   Aggregate Type	Specify the aggregation type (e.g., sum, average).
   Width	Set the width of the chart.
   Height	Set the height of the chart.
   Chart Type	Choose the chart type to be plotted (e.g., bar, line, pie).
   Show Tooltip Label	Enable tooltips for data points.
   Show Total in Statistic Table	Display total values in the statistic table.
   Initially Flipped	Show the statistic table first instead of the chart.
   Show Percentage	Display percentages in the statistic table.
   List Entry with Status	Select which entries (by status) will be counted for statistics.

5. Optionally, configure filters in the Filters tab to refine the dataset for the chart.
6. Once all settings are configured, click Save Chart.

5.5. Edit Existing Chart

1. Hover your pointer over the chart in the Dashboard editor.
2. Click on the Edit Chart button located at the top right corner of the chart.
3. In the Edit Chart dialog, update the details or configuration you wish to modify.
4. Once all changes are made, click Save Chart to apply the updates and dismiss the dialog.

5.6. Rearrange Chart in Dashboard

1. Hover your pointer over the chart you wish to rearrange.
2. Click and hold the grip icon located at the top-left corner of the chart.
3. Drag the chart to the desired position within the dashboard layout.

5.7. Remove Chart from Dashboard

1. Hover your pointer over the chart you want to remove in the Dashboard editor.
2. Click on the Remove Chart button located at the top-right corner of the chart.
3. In the Remove Chart dialog, click on the Remove Chart button to confirm the removal and dismiss the dialog.

6.1. Create New Custom Screen

1. Navigate to App Designer page > UI Editor.
2. Click on the New Screen button under the Custom Screen submenu (expand the submenu if needed).
3. In the Add Screen dialog, enter the following details:

   Field	Description
   Title	Title of the screen.
   Description (optional)	Optional description for the screen.
   Show Print button	Enable to show a Print button on the screen.
   Hide Screen Title	Enable to hide the default screen title.
   Full width screen	Enable to make the screen span the full available width.
   Screen Type	Select the type of screen to create: • QR Scanner: Uses device camera to scan QR codes. • Prompt: Simple prompt input screen. • Entry Page: Screen bound to a Form’s data. • Entry List: Screen bound to a Dataset’s data. • Static Page: Build from scratch using HTML and JavaScript. • Calendar: Displays a calendar bound to a dataset list. • Chatbot: Chatbot interface for Cogna. • Bucket: Displays files uploaded to a specified Bucket. • Map: Displays location data from a dataset on a map. • Mailbox: Shows notifications from a Mailer. • Combined: Combines multiple components (Form, Dataset, Custom Screen, Lookup, etc.) into a single screen using tabs or accordion.
   Access Restriction (optional)	Enable to restrict access to specific User Groups.

4. Once all details are entered, click Save Screen to save the screen and dismiss the dialog.

6.2. Add Action in Custom Screen

Screen Actions can be used to trigger functionality within a custom screen. These actions can be executed via:

• Anchor href: $go['actionid']
• Element event listener: $popup['actionid']()

1. In the Screen editor page, click on the Add Action button at the bottom.
2. In the Edit Action dialog, provide the following details:

   Field	Description
   Label	The display label for the action.
   Action Type	Select the type of action to execute (e.g., Navigate, Popup, Custom Script).
   Action Target	Specify the target component or element for this action.
   Parameters (optional)	Enter any parameters to be passed to the action target.

3. Once all details are entered, click Save Action to save the action and dismiss the dialog.

6.3. Edit Existing Screen Action

1. In the Custom Screen editor, locate the action you want to edit and click on the Edit Action button at the right-most end of the action row.
2. In the Edit Action dialog, update the desired details, such as Label, Action Type, Action Target, or Parameters.
3. Once all changes are made, click Save Action at the bottom-left of the dialog to save your updates and dismiss the dialog.

6.4. Remove Screen Action

1. In the Custom Screen editor, locate the action you want to remove and click on the Remove Action button at the right-most end of the action row (next to the Edit Action button).
2. In the Remove Action dialog, click Remove Action to confirm the removal and dismiss the dialog.

6.5. Edit Existing Screen Properties

1. Navigate to App Designer > UI Editor.
2. Select the Screen you wish to update under the Custom Screen submenu.
3. In the top-right corner of the Screen editor, click the Edit Screen button.
4. In the Edit Screen dialog, update the properties and details as required.
5. Once finished, click Save Screen to apply the changes and dismiss the dialog.

6.6. Remove Custom Screen

1. Navigate to App Designer > UI Editor.
2. Select the Screen you wish to remove under the Custom Screen submenu.
3. In the top-right corner of the Screen editor, click the Remove Screen button.
4. In the Remove Screen dialog, click Remove Screen to confirm the removal and dismiss the dialog.

6.7. Copy/Clone Existing Screen

1. Navigate to App Designer > UI Editor.
2. Click on the Clone Screen button under the Custom Screen submenu (expand the submenu if necessary).
3. In the Duplicate Screen dialog, select the screen that you wish to clone or copy.
4. Click on the Start Duplicate Screen button to initiate the copy process.
5. Once the copy is complete, the Edit Screen dialog for the newly cloned screen will appear.
6. Update the screen details in the Edit Screen dialog if necessary.
7. Click Save Screen to apply the changes and dismiss the dialog.

7.1. Create Navigation Group

1. Navigate to App Designer > UI Editor > Structure.
2. Click on the Add Group button to create a new Navigation Group.
3. In the Add Group dialog, provide the following details:

   Field	Description
   Title	The display title of the Navigation Group.
   Access Available For (optional)	If specified, only the selected User Group(s) will be able to view this Navigation Group.
   Pre-requisite (optional)	If defined, the Navigation Group will only be displayed when the specified condition is met.

4. Once all required details are entered, click the Save Group button to confirm and save the new Navigation Group.

7.2. Edit Existing Navigation Group

1. Hover over the navigation group that you wish to edit.
2. Click on the Edit Navigation Group button.
3. In the Edit Group dialog, update the required details as necessary.
4. Once finished, click on the Save Group button to apply the changes.

7.3. Remove Navigation Group

1. Hover over the Navigation Group that you wish to remove.
2. Click on the Remove Navigation Group button.
3. In the Remove Group confirmation dialog, click on the Remove Group button to confirm and dismiss the dialog.

7.4. Rearrange Navigation Group

1. Hover the pointer over the Navigation Group that you wish to rearrange.
2. Use the directional buttons to adjust the order:
   • ⬆️ Arrow Up Button – Moves the Navigation Group upward in the list.
   • ⬇️ Arrow Down Button – Moves the Navigation Group downward in the list.

7.5. Create Navigation Item

1. Click on the Add Item button located at the bottom of the desired Navigation Group.
2. In the Add Item modal dialog, provide the following details:

   Field	Description
   Title	The display title of the Navigation Item.
   Type	The type of component the item should navigate to.
   Skip Location Change (optional)	If enabled, the routing action will not update the browser’s address bar URL.
   Hide Description (optional)	If enabled, the component description will not be shown on the tile page.
   Pre-requisite (optional)	Defines a condition that must be met for the Navigation Item to be visible.

3. Select an appropriate Icon for the Navigation Item under the Icon tab.
   • Example: 🏠 (Home), 📄 (Document), 📊 (Chart).
4. Once finished, click on the Save Item button to confirm and close the dialog.

7.6. Edit Existing Navigation Item

1. Hover the pointer over the Navigation Item you want to edit.
2. Click on the Edit Navi Item button.
3. In the Edit Item dialog, update the necessary details (e.g., Title, Type, Icon, or other settings).
4. Once finished, click on the Save Item button to save the changes and dismiss the dialog.

7.7. Remove Navigation Item

1. Hover the pointer over the Navigation Item you wish to remove.
2. Click on the Remove Navi Item button.
3. In the Remove Item dialog, click on the Remove Item button to confirm and dismiss the dialog.

7.8. Rearrange Navigation Item

1. Hover the pointer over the Navigation Item you wish to rearrange.
2. Click and hold the ☰ grip icon, then drag the item to your desired position within the same Navigation Group.
3. Alternatively, you may also drag the Navigation Item and drop it into a different Navigation Group.

7.9. Edit Navigation Initialization Function

1. Navigate to Designer > UI Editor > Structure.
2. In the Navigation Editor page, click on the Edit Navigation Settings button located at the top-right corner.
3. In the Edit Navigation Settings dialog, specify or update the script in the Init Function field.
4. Once finished, click on the Save Settings button to apply the changes and dismiss the dialog.

8.1. Create a New Lookup

1. Navigate to Lookup Manager.
2. Click the Create Lookup button.
3. In the Lookup Configuration modal dialog, enter the following details:

   Field	Description
   Lookup Name	Name of the lookup.
   Lookup Description	Description for the lookup.
   Source Type	Data source for the lookup.
   Full Width Table	Display the lookup list as a full-width table.
   Auto-sync Lookup on …	Automatically sync this lookup data in entries when the lookup data is updated.
   Disable EXTRA Field	Hide the extra field in the lookup.
   Hide CODE Field	Hide the code field in the lookup.
   Enable Additional Data Field	Enable additional attributes for the lookup. These attributes are accessible via /data field.
   Override Column Label	Override the label shown on the lookup entry form or in the lookup list table. Note: In code, access values using .code, .name, or .extra.
   Access to Edit …	Assign a User Group that has permission to update this lookup.
   Additional Data Field	Define additional data fields in the format: • <field_code>,<field_code> • <field_code>:<type> • <field_code>:<type>@<path-pointer> Where type can be: text, longtext, number, date, options, lookup, multiplelookup, file.

4. Once all configurations are set, click the Save Lookup button to create the lookup.

8.2. Edit an Existing Lookup

1. Navigate to Lookup Manager.
2. Select the lookup you want to edit.
3. Click the Edit button located on the top toolbar of the lookup page.
4. In the Lookup Configuration modal dialog, update the details as required.
5. Once all changes are made, click the Save Lookup button to apply the updates.

8.3. Add a New Lookup Entry

1. In the Lookup page, click the + Add Data button located at the top-right corner.
2. Fill in the required details in the form fields.
3. Once all information is entered, click the Save Lookup button to save the new entry.

8.4. Import Lookup Entries from Excel

1. In the Lookup page, click the … button located at the top-right corner.
2. From the dropdown menu, select Import from Excel.
3. In the Import Lookup from Excel dialog, click the Browse button.
4. Select the Excel file you wish to import and click Open.
5. Monitor the Import Progress Log to track the import status.
6. Once the import completes, click the Close button to exit the dialog.

8.5. Export Lookup Entries to Excel

1. In the Lookup page, click the … button located at the top-right corner.
2. From the dropdown menu, select Export to Excel.
3. The Excel file containing all lookup entries will be downloaded to your browser’s default download directory.

8.6. Resync Lookup

Sometimes it is necessary to resynchronize lookup data manually rather than during the add/edit form actions.

1. In the Lookup page, click the … button located at the top-right corner.
2. From the dropdown menu, select Resync Lookup.
3. In the Resync Lookup dialog, select the Reference Column.
   • The reference column is used to compare common values between the lookup data and the data in form entries.
4. Once the reference column is selected, click Resync Lookup to initiate the synchronization.

8.7. Clear Lookup Entries

1. In the Lookup page, click the … button located at the top-right corner.
2. From the dropdown menu, select Clear Lookup Entries.
3. In the confirmation prompt, type clear lookup entries and click OK to proceed.
4. All entries in the lookup list will be permanently cleared.

8.8. Remove a Lookup

1. In the Lookup page, click the … button located at the top-right corner.
2. From the dropdown menu, select Remove Lookup.
3. In the Remove Lookup modal dialog, click the Remove Lookup button to confirm the removal.

9.1. Create a New Mailer

1. Navigate to Mailer Manager.
2. Click the Create Mailer button.
3. In the Add Mailer modal dialog, enter the following details:

   Field	Description
   Mailer Name	Name of the mailer.
   Subject	Subject line of the notification email.
   Content	Content of the notification. You can use value placeholders to dynamically insert form or entry data.
   Status	Enable or disable the mailer.
   Show this template …	If selected, this mailer will be available for selection in the Mail Blast dialog for datasets.
   Keep Mailing History	If selected, all notifications sent from this mailer will be recorded in the history log.

   Tip

   Select Form from the hint selector (top-right corner of the content editor) to enable placeholder autocomplete and hints.

4. Select the Recipients of the mailer:
   • User: The user who created the entry data.
   • Approver: The approver set in the process Tier.
   • Admin: Admin of the form.
   • Extra: Any additional recipients. You may also use value placeholders.
5. Once all configurations are complete, click the Save Mailer button.
6. You should now see a preview of the mailer along with its details.

9.2. Edit an Existing Mailer

1. In Mailer Manager, select the mailer you wish to edit from the side menu.
2. On the Mailer page, click the Edit button located at the top-right corner.
3. In the Edit Mailer dialog, update the details as required.
4. Once all changes are made, click the Save Mailer button to apply the updates.

9.3. View Mailer History

1. On the Mailer page, click the Notification List button located next to the Edit button in the top toolbar.
2. In the Notification List dialog, you can filter the entries by typing keywords into the search input field.
3. Once you have finished reviewing, click the Close button to dismiss the dialog.

9.4. Schedule a Mailer

1. In Mailer Manager, click the Create Schedule button from the side menu.
2. In the Add Scheduler dialog, enter the following details:

   Field	Description
   Schedule Name	Name of the scheduler.
   Frequency	Choose how often the scheduler should run (e.g., daily, weekly, monthly).
   Hour in Day / Day of Month / Month of Year	Configure the specific time and date for the scheduler to execute.
   Select Dataset	Choose the dataset that will be queried for sending notifications.
   Select Mailer	Select the mailer to be used for sending notifications.
   Status	Enable or disable this scheduled mailer.

3. Once all configurations are complete, click the Save Schedule button.

9.5. Remove a Mailer

1. Navigate to Mailer Manager.
2. Select the mailer you wish to remove from the side menu.
3. On the Mailer page, click the Remove Mailer button located at the top-right corner beside the Edit button.
4. In the Remove Mailer dialog, click the Remove Mailer button to confirm the action.

10.1. Add a New Inbound Endpoint

1. Navigate to Endpoint Manager.
2. Click the Create Endpoint button.
3. In the Add Endpoint modal dialog, enter the following details:

   Field	Description
   Endpoint Name	Name of this endpoint.
   Code	Unique code for the endpoint. Ensure the code is available; if not, modify it accordingly.
   Description (optional)	Optional description for the endpoint.
   Request Method Type	HTTP method used by the endpoint (e.g., POST or GET).
   Endpoint URL	URL of the endpoint. You can include parameter placeholders using {param}.
   Authenticate	Select if the endpoint requires authentication. Supports OAuth2 and OIDC protocols. Provide required credentials (e.g., client ID, client secret).
   Response Type	Select the expected response type: JSON, As-is, or Byte Array.
   HTTP Headers	Optional custom headers required by the endpoint.
   Creator	Email(s) of creators authorized to edit or run this endpoint. Separate multiple emails with commas.

4. Once all details are configured, click the Save Endpoint button.

10.2. Testing Endpoint Request/Response

1. To test the endpoint, click the Run button located at the top of the endpoint page.
2. If the endpoint requires parameter values, a dialog will prompt you to enter the parameters. Provide the required values and click Execute Request.
3. The response from the endpoint will be displayed at the bottom of the page.

10.3. Edit Existing Endpoint

1. Navigate to Endpoint Manager.
2. Select the endpoint you wish to edit.
3. Click the Edit Endpoint button located on the top toolbar of the endpoint page.
4. In the Edit Endpoint dialog, update the details as required.
5. Once all changes are made, click the Save Endpoint button to save the updates.

10.4. Remove Endpoint

1. On the endpoint page, click the Delete button located on the top toolbar beside the Edit button.
2. In the Remove Endpoint dialog, click the Remove Endpoint button to confirm the removal.

11.1. Create User Group

1. Navigate to App Designer > Role Manager.
2. Click on the Create Group button.
3. In the Add Group modal dialog, provide the following details:

   Field	Description
   Group Name	The name of the User Group.
   Group Description (optional)	A short description of the group.
   Allow users to register for this role	If enabled, users can select and enroll in this User Group during signup. ⚠️ This option requires the setting App Properties > Advanced > New users must register… to be enabled first.
   Access to edit …	Select the User Group(s) authorized to manage this User Group.

4. Once completed, click the Save Group button to create the group and close the dialog.

11.2. Edit Existing User Group Properties

1. Navigate to App Designer > Role Manager.
2. From the side menu, select the User Group you wish to update.
3. Click on the Edit Group button located in the top-right corner of the group page.
4. In the Edit Group dialog, update the relevant details as needed:

   Field	Description
   Group Name	Update the User Group’s name if necessary.
   Group Description (optional)	Modify the description to reflect updated purpose or scope.
   Allow users to register for this role	Enable/disable user self-enrollment during signup. ⚠️ This requires the App Properties > Advanced > New users must register… option to be enabled.
   Access to edit …	Update which User Groups are authorized to manage this User Group.

5. Once finished, click the Save Group button to apply changes and close the dialog.

11.3. Remove User Group

1. Navigate to App Designer > Role Manager.
2. From the side menu, select the User Group you wish to remove.
3. Click on the Remove Group button, located at the top-right corner of the group page (beside the Edit Group button).
4. In the Remove Group dialog, click on the Remove Group button again to confirm the deletion.

11.4. Add User to a User Group

1. Navigate to App Designer > Role Manager.
2. Select the User Group you want to add the user into.
3. Click on the Add User button located at the top-right corner.
4. In the Add User Access modal dialog, provide the following details:

   Field	Description
   Email	The email address used by the user to access the application.
   Name	The name of the user. This is a temporary value and will be replaced by the information retrieved from the login provider.
   Register many users at once (optional)	Enable this option to add multiple users simultaneously. Enter their email addresses in the Email List field, separated by commas.
   Requested User Group	Select the User Group that will be assigned to the user.

5. Once all details are provided, click on Save User Access to finalize the addition.

11.5. Remove User from a User Group

1. Navigate to App Designer > Role Manager.
2. From the side menu, select the User Group that you wish to manage.
3. In the User List, locate the user you intend to remove. You may also use the Filter toolbar 🔍 to quickly search for the user.
4. Click on the Remove User button corresponding to that user.
5. In the Remove User Access dialog, click on the Remove User button to confirm and finalize the removal.

11.6. Change User’s Login Provider

1. Navigate to App Designer > Role Manager.
2. From the side menu, select the User Group that you want to manage.
3. In the User List, click on the Edit User button in the action column for the user you wish to update.
4. In the Update User Info dialog, update the Provider field with the desired login provider.
5. Once completed, click on the Save User button to apply and confirm the changes.

11.7. User Group Access Request Approval

1. Navigate to App Designer > Role Manager.
2. From the side menu, select the User Group you want to manage.
3. In the User List, locate the pending access request.
   • Pending requests are highlighted with a light blue background for quick identification.
4. In the action column, click the Approve button for the corresponding user.
5. In the Group Request Approval dialog, set the Status field to Approved.
6. Once completed, click on the Save User button to confirm the approval and update the request status.

12.1. Create a New Bucket

1. Navigate to App Designer > Bucket Manager.
2. Click on the Create Bucket button.
3. In the Add Bucket modal dialog, provide the following details:

   Field	Description
   Bucket Name	The name of the Bucket.
   Bucket Description (optional)	A description of the Bucket.
   Anti-virus Scan on Upload (optional)	If enabled, every file uploaded to this Bucket will be scanned immediately for viruses and malware.
   Scheduled Anti-virus Scanning (optional)	Configure a recurring scan for all files stored in the Bucket. Useful for ongoing security checks.

4. Once finished, click on the Save Bucket button to create the Bucket.

12.2. Edit Existing Bucket Details

You can update an existing Bucket’s configuration, such as its name, description, or antivirus scanning settings.

1. Navigate to App Designer > Bucket Manager.
2. From the side menu, select the Bucket you wish to update.
3. On the Bucket page, click the Edit Bucket button located at the top-right corner.
4. In the Edit Bucket dialog, modify the details you want to update (e.g., Bucket Name, Description, Antivirus Scan options).
5. Once finished, click on the Save Bucket button to apply the changes.

12.3. Download Bucket Files as ZIP

This action will compress all files within a selected Bucket into a .zip archive for download.

1. Navigate to App Designer > Bucket Manager.
2. From the side menu, select the Bucket you want to download.
3. Click the More Actions button (⋮) at the top-right corner.
4. From the dropdown menu, select Initialize ZIP.
5. The system will begin archiving the files. This process may take some time depending on the Bucket size.
6. Once the process is complete, the Bucket ZIP dialog will appear.
7. Click the Download ZIP button to save the archive to your browser’s default download directory.

12.4. View Bucket Statistics

This action displays detailed statistics of the selected Bucket, including uploaded files categorized by file types and form fields.

1. Navigate to App Designer > Bucket Manager.
2. From the side menu, select the Bucket you want to analyze.
3. Click the More Actions button (⋮) at the top-right corner.
4. From the dropdown menu, select Bucket Statistics.
5. The In This Bucket dialog will appear, showing the statistical breakdown of files in the Bucket.
6. Click the Close button to dismiss the dialog.

12.5. Reorganize Bucket Files

This action reorganizes previously uploaded files into the selected Bucket if they were uploaded without proper Bucket assignment.

1. Navigate to App Designer > Bucket Manager.
2. From the side menu, select the Bucket you want to reorganize.
3. Click the More Actions button (⋮) at the top-right corner.
4. From the dropdown menu, select Reorganize Bucket Files.
5. A confirmation dialog will appear. Click OK to proceed.
6. The reorganization process may take some time, depending on the number of files. Once completed, a notification will appear as a toaster message.

12.6. Upload a New File into a Bucket

Follow these steps to upload a file into the selected Bucket:

1. Navigate to App Designer > Bucket Manager.
2. Click the Upload File button located at the top-right corner of the page.
3. In the file browser dialog, select the file(s) you want to upload.
4. Click Open to begin the upload process.
5. Once the upload is complete, the file will appear in the Bucket’s file list.

12.7. Remove File from a Bucket

To delete a file from a bucket, follow the steps below:

1. Navigate to App Designer > Bucket Manager.
2. From the side menu, select the Bucket where the file is stored.
3. Locate the file in the Bucket File List.
4. In the corresponding row, click the Remove File button (located in the right-most column).
5. In the Remove File confirmation dialog, click Remove File again to confirm the deletion.

13.1. Create a New Lambda

Follow the steps below to create a new Lambda function:

1. Navigate to App Designer > Lambda Manager.
2. Click the Create Lambda button.
3. In the Add Lambda dialog, provide the following details:

   Field	Description
   Lambda Name	Enter a unique name for the Lambda.
   Description (optional)	Provide a brief description of the Lambda’s purpose.
   Language	Select the scripting language (e.g., JavaScript).
   Bindings (optional)	Specify any bindings to be used by the Lambda.
   Public Lambda (optional)	Enable this option to allow the Lambda to be accessed without authentication.
   Scheduled Run (optional)	Enable this if the Lambda should run automatically via scheduler. Configure Frequency and Time.
   Lambda Path	Define the endpoint path for accessing the Lambda. Ensure the path is unique. If unavailable, provide an alternative path.
   Creator	Enter the email address(es) of authorized users who can edit and run the Lambda (comma-separated).

4. Once all details are completed, click Save Lambda to create the function.

13.2. Test a Lambda Script

1. In the Lambda Editor, enter the following code example:

   print("Hello World");

2. To test the script, click the Run button in the toolbar at the top of the editor.
3. The output result will be displayed in the console area at the bottom of the editor.

13.3. Edit Existing Lambda

1. Navigate to Lambda Manager.
2. Select the Lambda you want to edit from the side menu.
3. Click on the Edit Lambda button in the toolbar at the top of the Lambda editor.
4. In the Edit Lambda modal dialog, update the details that you wish to modify.
5. Once finished, click on the Save Lambda button to save the changes.

13.4. Remove a Lambda

1. Navigate to Lambda Manager.
2. From the side menu, select the Lambda you want to remove.
3. Click the Remove Lambda button in the toolbar above the editor.
4. In the Remove Lambda confirmation dialog, click Remove Lambda again to finalize the deletion.

13.5. Evict Lambda Cache for /cache

1. Navigate to Lambda Manager.
2. From the side menu, select the Lambda whose cache you want to clear.
3. Click on the Link Lambda button in the toolbar.
4. At the bottom of the dropdown menu, click Evict Cache (red button) to clear the cache for /cache.

15.1. Create a New Secret

1. Navigate to App Designer > Lambda Manager.
2. Click on the Manage Secret button from the side menu.
3. Click on the Create New Secret button.
4. In the Add Secret modal dialog, provide the following details:

   Field	Description
   Key	Unique identifier for the secret.
   Value	The confidential value to be stored securely.
   Enabled	Either to enable or disabled this secret.

5. Once finished, click on the Save Secret button.

15.2. Edit a Secret

1. Navigate to App Designer > Lambda Manager.
2. Click on the Manage Secret button from the side menu.
3. From the Secret list, click the Edit button for the secret you want to update.
4. In the Edit Secret modal dialog, update the required fields.
5. Once finished, click on the Save Secret button.

15.3. Remove a Secret

1. Navigate to App Designer > Lambda Manager.
2. Click on the Manage Secret button from the side menu.
3. From the Secret list, click the Remove button for the secret you want to delete.
4. Click Confirm Remove when prompted.

15.4. Use Secret in Lambda

1. Edit the target Lambda.
2. Add Secret in the Bindings section.
3. In the Lambda script, access the secret using the secret object.
   • Autocomplete will list available secret keys when typing secret or the key name.

15.5. Use Secret for API Key in Cogna

1. Edit the target Cogna.
2. In the Inference API Key or Embedding API Key field, enter: {{_secret.<secret-key>}}

15.6. Use Secret for URL (Endpoint or RESTful Lookup)

1. Edit the target Endpoint or Lookup.
2. In the Endpoint URL (for Endpoint) or RESTful Endpoint (for lookup) field, enter the URL. You can use Secret in the URL by using {_secret.<secret-key>}.

15.7. Use Secret for Authentication Client Secret (Endpoint or RESTful Lookup)

1. Edit the target Endpoint or Lookup.
2. In the Client Secret field (for authenticated RESTful request), enter: {{_secret.<secret-key>}}

15.8. Use Secret for Private Key in Krypta

1. Edit the target Wallet in Krypta Manager.
2. In the Private Key field, enter: {{_secret.<secret-key>}}

16.1. Create a New Cogna

1. Navigate to Cogna Manager.
2. In the side menu, click on the Create Cogna button.
3. In the Add Cogna modal dialog, provide the following details:

   Field	Description
   Cogna Name	Enter the name of the Cogna.
   Description (optional)	Provide a concise description of the Cogna.
   Used To	Select the intended purpose of the Cogna: • Generate Text – typically used for standard LLM text generation tasks. • Classify Text – classify text using a Lookup model. • Extract Data – extract structured data from text or uploaded images. • Generate Image – generate images using AI models. • Classify Image – classify uploaded images with an image classification model.
   Public Cogna	Enable this option to make the Cogna endpoint publicly accessible without authentication.
   Cogna Path	Define the URL path for the Cogna. Ensure that the path is unique and available. If the specified path is unavailable, adjust it accordingly.
   Creator	Provide one or more authorized editor email addresses (comma-separated). These users will be permitted to edit and run this Cogna.

4. (Optional) Configure Embedding Settings in the Embedding section.
5. Configure General Inference Settings in the Inference tab.
6. Adjust RAG (Retrieval-Augmented Generation) Settings in the Retrieval Augmentation section.
7. Select and configure the Vector Database in the Vector Dataset section.
8. Once all required details are completed, click on the Save Cogna button.

16.2. Test Cogna Prompt

1. In the Cogna Preview panel, type your desired prompt into the input field.
2. Press Enter ↵ to execute the prompt.
3. The response generated by the Cogna will appear in the Preview Output section.

16.3. Edit Existing Cogna

1. Navigate to App Designer > Cogna Manager.
2. From the side menu, select the Cogna you want to edit.
3. Click the Edit Cogna button in the toolbar at the top of the Cogna panel.
4. In the Edit Cogna modal dialog, update the details you wish to modify.
5. Once completed, click the Save Cogna button to save the changes.

16.4. Add Knowledge Source in Cogna

1. Navigate to App Designer > Cogna Manager.
2. From the side menu, select the Cogna you want to manage.
3. In the Sources panel, click the + Add Source button.
4. In the Add Knowledge Source modal dialog, enter the following details:

   Field	Description
   Source Type	Specify where to retrieve the knowledge source data.
   Dataset > Select Dataset	Choose the dataset from which to query the data.
   Dataset > Sentence Template	Provide a template to construct meaningful sentences from the dataset.
   Bucket > Select Bucket	Select the bucket containing files to be ingested into the vector database.
   Website > Web URL	Enter the URL of the website to retrieve and ingest data from.
   Scheduled Run	Enable this to schedule the ingestion process. Configure frequency and time for the schedule.

5. Once completed, click the Save Source button to confirm.

16.5. Ingest Knowledge Source into Vector DB

1. Navigate to App Designer > Cogna Manager.
2. From the side menu, select the Cogna you want to manage.
3. In the Sources panel, click on the Ingest button at the top right corner.
4. Once completed, a message “Document successfully ingested” will be displayed at the bottom of the Sources panel.

16.6. Add Tools in Cogna

1. Navigate to App Designer > Cogna Manager.
2. From the side menu, select the Cogna you want to edit.
3. Click the + Add Tool button in the Tools panel.
4. In the Add Tool modal dialog, provide the following details:

   Field	Description
   Tool Name	The name of the tool.
   Tool Enabled	Enable or disable this tool.
   Description	Provide a clear description of the tool.
   Select Lambda	Choose the Lambda function that will be triggered when the tool is executed.
   Tool Parameter	Specify the parameters to extract from the prompt and pass to the Lambda. Enter Parameter Key and Parameter Description. Multiple parameters can be defined if needed. These parameters can be accessed in the Lambda via _param.<parameter_key>.

5. Once completed, click + Save Tool to save the tool.

16.7. Register Remote MCP Server

1. Navigate to App Designer > Cogna Manager.
2. From the side menu, select the Cogna you want to edit.
3. Click the + Add MCP Server button in the Model Context Protocol (MCP) panel.
4. In the Add MCP Server modal dialog, provide the following details:

   Field	Description
   Server Name	The name of the MCP server.
   SSE URL	The SSE URL of the MCP server.
   Timeout	MCP request timeout in seconds.

5. Once completed, click + Save MCP Server to save the configuration.

16.8. Clear Vector DB

1. Navigate to App Designer > Cogna Manager.
2. From the side menu, select the Cogna you want to edit.
3. In the Vector Store/DB panel, click the Clear button.
4. In the confirmation prompt, click OK to confirm the removal of all vector data.

16.9. Clear Cogna Memory

1. Navigate to App Designer > Cogna Manager.
2. From the side menu, select the Cogna you want to manage.
3. Click on the Clear Memory button located at the top right corner of the page.
4. In the prompt, choose one of the following options:
   • Clear memory for the current user
   • Clear memory for all users
5. A notification will appear once the memory has been successfully cleared.

16.10. Reinitialize Cogna Model

1. Navigate to App Designer > Cogna Manager.
2. From the side menu, select the Cogna you want to manage.
3. Click on the Reinitialize Model button.

16.11. Open Vector DB Query

1. Navigate to App Designer > Cogna Manager.
2. From the side menu, select the Cogna you want to manage.
3. Click on the Vector DB Query button.
4. In the Vector DB Query modal dialog, specify the following:
   • Max Result: Maximum number of results to retrieve.
   • Min Score: Minimum similarity score threshold for results.
   • Search Text: Enter the text to query the vector database.
5. Click on the Submit button.
6. The query results will be displayed below the parameter input fields.

16.12. View Cogna Chat History

1. Navigate to App Designer > Cogna Manager.
2. From the side menu, select the Cogna you want to view.
3. Click on the Chat History button in the Cogna toolbar.
4. In the View Chat History modal dialog, you can apply filters to refine the chat records.
5. You can also export the chat history to a CSV file for offline analysis.
6. Once finished, click the Close button to dismiss the dialog.

16.13. Remove Cogna

1. Navigate to App Designer > Cogna Manager.
2. From the side menu, select the Cogna you want to remove.
3. Click on the Remove Cogna button.
4. In the Remove Cogna modal dialog, click the Remove Cogna button to confirm the removal.

17.1. Create Smart Contract

1. Navigate to Krypta Manager.
2. Click the + Create Contract button in the Smart Contracts panel.
3. In the Contract Editor modal dialog, provide the following details:

   Field	Description
   Contract Name	The name of the smart contract.
   Description	(Optional) Description of the contract purpose.
   Solidity Code	Paste your Solidity source code into the code editor.

4. Once completed, click + Save Contract to save the contract.

17.2. Compile Smart Contract

1. Navigate to Krypta Manager.
2. Under the Smart Contracts section, click the contract you want to compile.
3. Click the Compile Contract button.
4. Once compilation is complete, the paths to the generated ABI and BIN files will be displayed.

17.3. Register a Wallet

1. Navigate to Krypta Manager.
2. Click the + Create Wallet button in the Wallets panel.
3. In the Add Wallet Info modal dialog, provide the following details:

   Field	Description
   Wallet Name	The name of the wallet.
   Description	(Optional) Description of the wallet usage.
   RPC URL	The RPC endpoint of the EVM-compatible network.
   Chain ID	The unique chain identifier of the target network.
   Private Key	The private key of your wallet account. (Use Secret!)
   Smart Contract	Select the smart contract to interact with.

4. Once completed, click + Save Wallet to save the wallet configuration.

17.4. Deploy Smart Contract

1. Navigate to Krypta Manager.
2. Select the Wallet from the left sidebar.
3. In the Wallet Info section, click Deploy Contract.
4. Once deployment is complete, the Contract Address will appear under the wallet details.

17.5. Test Smart Contract Functions

1. Navigate to Krypta Manager.
2. Select the Wallet from the left sidebar.
3. In the Contract Functions panel, click the function you wish to run.
4. If the function requires input, enter the parameters when prompted.
5. Click Run to execute.
6. Once successful, the result or transaction hash will appear in the Result section.

17.6. Query Smart Contract Event Logs

1. Navigate to Krypta Manager.
2. Select the Wallet from the left sidebar.
3. In the Contract Events panel, click the event you want to view.
4. Once retrieved, the event logs will be displayed in the Result section.

17.7. Verify Transaction Hash

1. Navigate to Krypta Manager.
2. Select the Wallet from the left sidebar.
3. Click Verify Hash under the Wallet Info section.
4. When prompted, enter the Transaction Hash, then click OK.
5. Once successful, the transaction details will appear in the Result section.

18.1. Create a Digital Signature Info

1. Navigate to Signa Manager.
2. Click + Create Signature from the side menu.
3. In the Add Digital Signature dialog, complete the following fields:

   Field	Description
   Signa Name	A descriptive name for the digital signature (e.g., Director’s Signature).
   Reason	Purpose of the signature (e.g., Recruitment Offer Letter).
   Location	Physical or organizational location associated with the signature.
   Subject Distinguished Name (DN)	The certificate subject in standard DN format, e.g., CN=Director, O=Company, C=MY. (Refer to IBM documentation for DN format.)
   Password	Password used to protect and recover the private key.
   Show Signature Stamp	Enable to display a visual signature stamp on the PDF.
   Hash Algorithm	Hash algorithm to be used for signing (e.g., SHA-256, SHA-384, SHA-512).
   Key Algorithm	Key algorithm to be used for signing (e.g., RSA, ECDSA).
   Keystore File Format	Keystore format to store the private key (e.g., JKS, PKCS#12, BKS).

4. If Show Signature Stamp is enabled, configure the coordinates and placement of the signature stamp within the document.
5. Click + Save Signa to save the digital signature profile.

18.2. Generate Keystore (using self-signed certificate)

1. Navigate to Signa Manager.
2. Select the digital signature profile.
3. Click Generate Keystore.
4. Once generated, the keystore file name will be displayed (e.g. director_1767168749083.p12).

18.3. Download Certificate Signing Request (CSR)

1. Navigate to Signa Manager.
2. Select the digital signature profile.
3. Click Download CSR to download the .csr file.

18.4. Upload Keystore File

This step is applicable if the private key is generated externally.

1. Navigate to Signa Manager.
2. Select the digital signature profile.
3. Click Upload Keystore File.
4. Upload the keystore file.
5. Once uploaded, the file name will be displayed, indicating the private key has been successfully uploaded.

18.5. Upload Signature Image

1. Navigate to Signa Manager.
2. Select the digital signature profile.
3. Click Upload Signature Image.
4. Upload the signature image file.
5. The uploaded image will be previewed upon successful upload.

18.6. Assign Digital Signature to Lambda

1. Navigate to Lambda Manager.
2. Select the Lambda function to be signed.
3. Click Edit Lambda.
4. In the Edit Lambda dialog, enable Embed Digital Signature (PDF Output).
5. Select the desired digital signature from the dropdown list.
6. Click + Save Lambda to apply the configuration.

20.1. Create a New Restore Point

1. Navigate to App Designer > UI Editor.
2. In the side menu, click on the Restore Points button.
3. On the Restore Points page, click Create New Restore Point.
4. In the modal dialog, enter a descriptive Restore Point Name.
5. Click on the Create Restore Point button to confirm.
6. The newly created restore point will appear in the Restore Points list.

20.2. Restore an App to a Restore Point

1. Navigate to App Designer > UI Editor.
2. In the side menu, click on the Restore Points button.
3. From the Restore Points list, locate the restore point you want to revert to and click the Restore button next to it.
4. In the Restore to … modal dialog, click Confirm Restore to proceed.