Table of Contents

• Title and Copyright Information
• Preface
  • Audience
  • Documentation Accessibility
    • Keyboard Shortcuts
    • Keyboard Shortcuts for Code Editors
  • Diversity and Inclusion
  • Related Resources
  • Conventions
  • Information About Cookies
• Part I Get Started
  • 1 Welcome to Oracle Visual Builder
    • What is Oracle Visual Builder?
    • How to Begin with Oracle Visual Builder Subscriptions
    • Access Oracle Visual Builder
  • 2 Create Visual Applications
    • Typical Visual Application Workflow
    • Create a Visual Application
      • Create a New Visual Application
      • Create a Copy of an Application
    • Export and Import Visual Applications
      • Export a Visual Application
      • Import a Visual Application
      • About Classic Applications
      • Import Classic Applications
    • Add Web (and Mobile) Apps to Your Visual Application
      • Create a New Web Application
      • Import an Existing Mobile Application
    • Tour the Designer
    • Common Tasks for Visual Applications
      • Manage Visual Application Settings
      • Add Team Members
      • Export and Import Application Resources
        • Export Application Resources
        • Import Application Resources
  • 3 Anatomy of Visual Applications
    • Understand Variables
      • Variables and Parameter Passing
      • Expressions
      • Variables and Lifecycles
      • Variables and Events
    • Understand Actions and Action Chains
      • Action Chain Context and Contract
      • Built-in Actions
      • Event Handling for Action Chains
    • Understand Page Flows and Lifecycles
      • The Lifecycle of a Page
      • Page Navigation
    • Understand UI Components
      • The Component Contract
      • Properties
      • Events
      • Child Slots
      • Methods
      • Component IDs and Styles
    • Understand Data Access Through REST
      • Data Binding
      • Mapping to and from REST
• Part II Connect Applications to Data
  • 4 Work with Business Objects
    • About Working with Business Objects
    • Create and Edit Business Objects
      • Create a Business Object
      • Add Fields to Business Objects
      • Edit Business Object Fields
        • Change a Field's Data Type
        • Set a Default Value for a Field
        • Add a Formula to a Field
        • Add a Field for Aggregating Data
        • Index a Field
      • View, Create, and Edit Business Object Relationships
        • Create a Business Object Relationship
        • Edit a Business Object Relationship
    • Secure Business Objects
    • Create Rules for Business Objects
      • About Adding Business Rules
      • Access the Current User's Details in Your Groovy Script
      • Triggers for Business Objects
        • Object Triggers
        • Field Triggers
        • Add an Action to Send Email Notifications
        • Convert a Trigger to Editable Code
        • Build Conditions for Triggers
      • Object Validators for Business Objects
      • Field Validators for Business Objects
      • Object Functions for Business Objects
      • Log Diagnostic Messages From Your Scripts
    • Work with Endpoints to Access Business Objects
      • View a Business Object's Endpoints
      • About the Endpoints Tab
      • Add or Remove Exposed Endpoints
    • View and Edit Data in Business Objects
      • Edit the Data in Business Objects
      • Import Data to a Business Object
      • Reload Data from Application Sources
    • Work with the Data Manager
      • Manage Data During the Development Lifecycle
      • Import Data From a File Using the Data Manager
      • Import Data From a Database
      • Export the Data to a File from the Data Manager
      • Resolve Problems When Importing Data
      • Import and Export Data From the Command Line
        • Import Data from the Command Line
        • Export Data from the Command Line
      • Create Business Objects From a File
      • Set Your Own Audit Fields For Imported Business Objects
    • Optimize Business Object Performance
      • Override Default Timeout for Groovy Scripts
      • Enable Polling for Endpoint Requests
      • Control Data Caching for Business Objects
        • Data Caching Options
        • Define a Data Caching Strategy
    • Work with the Business Object Diagrammer
      • Create Business Objects with the Diagrammer
      • Create Relationships with the Diagrammer
    • Switch to Your Own Database Schema for Business Objects
      • Create a Business Object Based on a DB Table or View
      • Add Fields to a Business Object
      • Change a Field's Data Type
      • Create Calculated Fields for a Business Object
      • Set a Field for Auditing
      • Use a Sequence for a Primary Key Field
      • Switch Schemas Used During an App's Lifecycle
  • 5 Work with Services
    • What Are Service Connections?
      • What Are Backends?
      • Service Connections: Static Versus Dynamic
      • What Are Application Profiles?
    • Manage Backends in Your Visual Application
      • Create a Backend
        • Create a Custom Backend
        • Create a Child Backend
      • Edit a Backend
        • Add Server Variables for Backends
        • Edit a Backend Server's Authentication Details
    • Create a Service Connection
      • Create a Service Connection from the Catalog
      • Create a Service Connection from a Service Specification
      • Create a Service Connection from an Endpoint
    • Edit a Service Connection
      • Add a Server to a Service Connection
      • Edit Service Endpoints for a Static Service Connection
      • Retrieve Service Metadata for a Dynamic Service Connection
      • Add Server Variables for Service Connections
      • Add More Endpoints to a Service Connection
      • Edit a Server's Authentication Details
      • Add Transforms
      • Convert a Service Connection
      • Test Service Connection Responses
      • Update Schema of the Request or Response
    • Configure Authentication and Connection Types for Service Connections and Backends
      • About Authentication and Connection Type
        • How Does Authentication with Identity Propagation Work?
        • How Does Authentication with Fixed Credentials Work?
        • What is CORS?
        • Use an Appropriate Connection Type to Handle CORS for REST Services
        • Work with HTTP-based Endpoints
        • Allow Anonymous Access to the Service Data
      • Connect to Oracle Cloud Applications APIs
        • Connect to Oracle Cloud Applications APIs With User Propagation for Authenticated Flows
        • Connect to Oracle Cloud Applications APIs Not in the Catalog Using Fixed Credentials
      • Connect to Oracle Integration APIs
        • Connect to Oracle Integration APIs Using Identity Propagation
        • Connect to Oracle Integration APIs Using Fixed Credentials
      • Connect to Process Cloud APIs
        • Connect to Process APIs Using Identity Propagation
        • Connect to Process APIs Using Fixed Credentials
      • Connect to Oracle Content Management REST APIs
        • Connect to Oracle Content Management REST APIs Using Identity Propagation
        • Connect to Oracle Content Management REST APIs Using Fixed Credentials
      • Connect to ORDS APIs Using Fixed Credentials
• Part III Develop Applications
  • 6 Develop Your Application
    • How Are Applications Structured?
    • Which Editor Do I Use?
    • What Are Scopes?
    • Manage App Settings
  • 7 Work with Pages and Flows
    • Use the Page Designer
      • The Components Palette
      • The Structure View
      • The Data Palette
      • The Properties Pane
    • Create and Manage Pages
      • Manage Page Settings
      • Set a Page's Layout
    • Create Pages From Templates
      • Create Pages From Patterns
      • Create Pages From Fragments
      • Change Page Templates
    • Add Components to Pages
      • How Do Quick Starts Work?
        • Add Data to a Table or List
          • Use the Add Data Quick Start
        • Add a Create Page With a Quick Start
          • Use the Create Page Quick Start
        • Add an Edit Page With the Quick Start
          • Use the Add Edit Page Quick Start
        • Add a Details Page With the Quick Start
          • Use the Add Detail Page Quick Start
        • Quick Starts for Dynamic Forms and Tables
      • Add an Image to a Page
      • Add an Icon Component to a Page
      • Add a Camera Component to a Page
      • Filter Data Displayed in a Component
        • Filter Data by Filter Criteria
        • Filter Component Data by Text
        • Filter Component Data by URL
      • Use Conditions to Show or Hide Components
    • Add Dynamic Components to Pages
      • What are Dynamic Components?
      • How to Create Layouts With Dynamic Components
      • Add a Dynamic Table to a Page
      • Add a Dynamic Form to a Page
      • Add Display Logic to Determine What's Displayed at Runtime
        • Responsive App Display Logic Example
        • Define Custom Contexts for Components in a Layout
      • Create a Layout for a Dynamic Table or Form
      • Preview Different Layouts
      • Use Field and Form Templates
        • Control How a Field is Rendered with Field Templates
        • Apply a Template to a Field
        • Start an Action Chain from a Field
        • Control How a Form Layout is Rendered
        • Apply a Template to a Form
        • Add and Group Fields in Dynamic Form Layouts
      • Edit a Field's Properties
        • Set a Field to be Read Only
        • Set How User Assistance is Rendered in a Layout
        • Set a Field as Required
        • Use Conditions to Show or Hide Fields in a Layout
        • Configure How Columns Render in a Dynamic Table's Layout
        • Set a Field to Display as a Text Area in a Form
        • Add Converters and Validators to a Field
      • Add a Dynamic Container to a Page
        • Re-Order a Dynamic Container's Content
        • Guidelines for Working with Sections
        • Change a Dynamic Container's Layout
      • Create Fields For a Layout
        • Create a Calculated Field
        • Create a Virtual Field
    • Create and Manage Flows
      • Manage Flow Settings
      • Embed a Flow Within a Page
    • Customize Your App's Root Page
      • Edit an App's Header, Footer, and Navigation Items
      • Add a Navigation Item for Navigation Drawer Apps
    • Work With Custom Web Components
      • Work with the Component Exchange
        • Get Components From the Component Exchange
        • Update a Component from the Component Exchange
        • Uninstall a Component
      • Import a Web Component Archive
      • Create a Web Component
    • Navigate Between Pages and Flows
      • Navigate Between Pages in the Same Flow
      • Navigate Between Pages in Different Flows
      • Navigate Between Flows in the Root Page
    • Work With Code Editors
      • Work in Code View
      • Work with the JSON Editor
      • Work with the JavaScript Editor
        • Add a Custom JavaScript Function
        • Use RequireJS to Reference External JavaScript Files
        • Use Variables with a JavaScript Module
      • Trigger Code Insight
      • Manage Code Editor Settings
    • Use the Diagram View
      • View a Flow's Navigation in Diagram View
      • Add Pages and Action Chains to a Flow in Diagram View
        • Add a Page in the Flow Diagram
        • Create an Action Chain in the Flow Diagram
        • Bind an Action Chain in the Flow Diagram to an Existing Event Listener
        • Show or Hide an Action Chain in the Flow Diagram
  • 8 Work with Variables and Types
    • What are Variables and Types?
    • Create Variables in Artifacts
      • Enable Variables as Input Parameters
      • Track Variables to Detect Unsaved Changes
        • Enable a Variable for Tracking
        • Query Tracked Variables for Changed State
        • Reset State for Tracked Variables
    • Create Types
      • Create a Custom Type
        • Create a Custom Object or Array
        • Create a Custom Enumeration
      • Create a Type From an Endpoint
      • Create a Type From Code
    • Service Data Provider
      • Creating a Custom Fetch Action Chain - An Example
  • 9 Work with JavaScript Action Chains
    • About Action Chains
    • About the Action Chain Editor
      • Design Editor
      • Code Editor
    • About the Action Chain Code
    • Visually Create an Action Chain
    • Built-In Actions
      • Add an Assign Variable Action
        • Use Filter Builder to Create Filter Criteria for an SDP
        • Filter Builder's Code Editor
      • Add a Call Action Chain Action
      • Add a Call Component Action
      • Add a Call Function Action
      • Add a Call REST Action
        • Service Definitions
        • Transform Functions
      • Add a Call Variable Action
      • Add a Code Action
      • Add a Fire Data Provider Event Action
      • Add a Fire Event Action
      • Add a Fire Notification Action
      • Add a For Each Action
      • Add a Get Dirty Data Status Action
      • Add a Get Location Action
      • Add an If Action
      • Add a Login Action
      • Add a Logout Action
      • Add a Navigate Back Action
      • Add a Navigate To Flow Action
      • Add a Navigate To Page Action
      • Add an Open URL Action
      • Add a Process Action
      • Add a Reset Dirty Data Status Action
      • Add a Reset Variables Action
      • Add a Return Action
      • Add a Run In Parallel Action
      • Add a Scan Barcode Action
      • Add a Share Action
      • Add a Switch Action
      • Add a Try-Catch-Finally Action
    • Custom Actions
      • Create a Custom Action
        • Create the Action Files
        • Add the Metadata
          • Define the Custom Action's Properties
          • Define Input Parameters for a Custom Action
        • Add the Code
          • How Are Input Parameters Passed?
          • How are Values Returned?
        • Specify Path to Code
    • Start an Action Chain
      • Start an Action Chain From a Component
      • Start an Action Chain When a Variable Changes
      • Start an Action Chain From a Lifecycle Event
      • By Firing a Custom Event
    • Test Action Chains
      • Create a Test for a Test Case
      • Run the Tests
      • Use the Tests Footer in a Visual Application
      • Test Action Chains Using the vb-test Grunt Task
  • 10 Work with JSON Action Chains
    • About Action Chains
    • Create an Action Chain
    • Built-in Actions
      • Add an Assign Variables Action
        • Filter Builder's Code Editor
      • Add a Call Action Chain Action
      • Add a Call Component Action
      • Add a Call Function Action
      • Add a Call REST Action
      • Add a Call Variable Action
      • Add a Fire Data Provider Event Action
      • Add a Fire Event Action
      • Add a Fire Notification Action
      • Add a Get Location Action
      • Add a Reset Variables Action
      • Add a Login Action
      • Add a Logout Action
      • Add a Scan Barcode Action
      • Add a Take Photo Action
      • Add a Share Action
      • Add a For Each Action
      • Add an If Action
      • Add a Return Action
      • Add a Run In Parallel Action
      • Add a Switch Action
      • Add a Navigate Action
      • Add a Navigate Back Action
      • Add an Open URL Action
    • Custom Actions
      • Create a Custom Action
        • Create the Action Files
        • Add the Metadata
          • Define the Custom Action's Properties
          • Define Input Parameters for a Custom Action
        • Add the Code
          • How Are Input Parameters Passed?
          • How are Values Returned?
        • Specify Path to Code
    • Test Action Chains
      • Manage All Tests in a Visual Application
      • Test Action Chains Using the vb-test Grunt Task
    • Start an Action Chain
      • Start an Action Chain From a Component
      • Start an Action Chain When a Variable Changes
      • Start an Action Chain From a Lifecycle Event
      • Start an Action Chain By Firing a Custom Event
  • 11 Work with Events and Event Listeners
    • Define Events in Your Application
    • Create Event Listeners for Events
    • Choose How Custom Events Call Event Listeners
    • Raise Fragment or Layout Events that Emit to the Parent Container
  • 12 Work With Application Resources
    • Import Resources
    • Manage Custom Component, CSS, and Module Imports
    • Work with the Image Gallery
    • Add a Sitemap to a Web Application's Resources
  • 13 Work with Fragments
    • Create and Add a Fragment to a Page
    • Manage Fragment Settings
    • Reuse a Fragment
    • Pass Data Between a Fragment and Its Parent Container
      • Enable Fragment Variables as Input Parameters
      • Enable Page Variables to Provide Initial Values for a Fragment's Input Parameters
      • Automatically Write Back a Fragment Variable's Value to Its Container Variable
      • Automatically Create and Wire a Fragment Variable on Its Container
      • Sample Scenario: Create a Fragment and Pass Values
      • Create Custom Events that Emit to a Fragment's Parent Container
      • Set the Binding Type for Variables in Dynamic Components
      • Pass a Fragment's Context to VDOM or Custom Web Components
    • Defer Rendering of a Fragment's Content
    • Add Slots to a Fragment
      • Add Default Content to a Fragment Slot
      • Set Data Context for a Fragment Slot
    • Customize How Fragment Properties Display in the Properties Pane
      • Customize How a Fragment Variable is Displayed in the Properties Pane
      • Section Fragment Properties for Display in the Properties Pane
• Part IV Augment Applications
  • 14 Enable Progressive Web App Support
    • Guidelines for Using PWA Support
    • Configure Progressive Web App Support
    • Deep Linking on Android
    • Run Mobile Applications as PWAs
      • Configure Mobile Application Settings
      • Build a Mobile Application as a PWA
      • Convert a Mobile PWA to a Web PWA
  • 15 Secure the Application
    • Security for Web Apps
    • Authentication Roles Versus User Roles
    • Manage User Roles and Access
    • Test Role-Based Access
    • Access and Secure Business Objects
      • Secure Business Objects
      • Allow External Access to Your Business Objects
        • Get an Access Token for Authentication
    • Allow Anonymous Access
    • Embed a Web Application
  • 16 Add Offline Capabilities to Your Application
    • Add Offline Support Using the Oracle Offline Persistence Kit
  • 17 Work with Business Processes
    • About Using Processes in Your Application
    • Add a Business Process to an Application
    • Modify a Business Process Alias
    • Navigate to Your Process Instance
    • Add a Process to a Page
    • Add a Process to an Action Chain
    • Start and Complete Processes from Visual Builder
    • Configure the Connection to a Process Server
    • Process Server Authentication Options
    • Add the Oracle Process Cloud Service URL
  • 18 Work with Translations
    • About Translation Resources
    • Understand the Structure of Translation Bundles
    • Understand Translation Keys for Display Texts
      • Generate Translation Keys for Display Texts
    • Download Bundles for Translation
    • Use Translation Strings in JavaScript Files
    • Upload Translated Files
    • Create Translation Bundles
• Part V Manage Applications
  • 19 Manage Your Visual Application
    • View an Application's Status
    • Create a New Version of an Application
    • Delete a Visual Application
    • Restore a Deleted Application
    • Manage Applications Created in Visual Builder Studio
  • 20 Integrate Your Visual Application With a Git Repository
    • Add Credentials for Your Oracle Visual Builder Studio Account
    • Link Your Visual Application to a Git Repository
    • Pull Files From Your Git Repository
    • Push Your Changes to Your Git Repository
    • Change the Local Branch HEAD in a Linked Git Repository
  • 21 Test and Debug Applications
    • Audit Application Code
    • Preview an App in Debug Mode
    • Change an Application's Log Level
    • Debug Business Objects
      • Enable Tracing to Monitor Endpoint Calls
        • View Trace Details
        • Manage Tracing to Control Disk Usage
        • Export and Import a Trace File
      • Enable Logging for Scripting Events
  • 22 Stage and Publish Visual Applications
    • What Happens When You Stage and Publish Visual Applications?
    • Stage a Visual Application
    • Publish a Visual Application
    • View Database Schemas Used During an App's Lifecycle
    • Specify a Custom App URL
    • Update a Published Visual Application
    • Roll Back Application to the Previously Published Version
  • 23 Manage Runtime Dependencies for Visual Applications
    • Upgrade Your App
      • After Upgrading
      • Set a Custom Version
      • Understand What’s Happening in visual-application.json
    • Resolve Upgrade Issues
    • What Happens During Software Maintenance?
  • 24 Optimize Your Builds and Audit Your Code Using Grunt
    • Overview
    • Build Your Application Using Oracle Visual Builder Studio
    • Build Your Application Locally
      • Build and Deploy Your Application
      • Authentication
    • Grunt Tasks to Build Your Visual Application
      • About Visual Builder Grunt Build Tasks
      • vb-clean
      • vb-process-local
      • vb-deploy
      • vb-optimize-cdn
      • vb-optimize
      • vb-prepare
      • vb-test
      • vb-require-bundle
      • vb-require-bundle-clean
      • vb-css-minify
      • vb-image-minify
      • vb-json-minify
      • vb-export
      • vb-manifest
      • vb-package
      • vb-archive
      • vb-process-raw
      • vb-process-raw-index-html
      • vb-application
      • vb-serve
      • vb-pwa
      • vb-fa-generate-base-app-config
      • vb-pwa-splashscreen
      • vb-watch
    • Customize Your Grunt Build Process
      • Add Custom Functionality to Existing Tasks
      • Override Existing Grunt Tasks
      • Optimize a Specific Web Application
      • Host an Application on a Content Delivery Network (CDN)
      • Run and Configure a Multitask
      • Customize Bundle Modules
      • Specify Options of Non-multitasks
      • Specify Options for All Tasks
      • Move a Sitemap Resource to a Visual Application's Root Directory
    • Audit Your Application Using the vb-audit Grunt Task
      • Configure Audit Options in Gruntfile.js
      • Override Configuration Options in Gruntfile.js
• Part VI Use Cases & Troubleshooting
  • 25 Common Use Cases
    • Work With Code Samples
    • Change an Application's Logo
    • Style and Theme Visual Builder Applications
      • Transition a Web (or Mobile) App's Theme to Redwood
      • Customize the Redwood Theme for a Web Application
      • Override the Redwood Theme for a Mobile Application
      • Add a Custom Style to a Component
    • Add Login and Logout Capabilities to an Application
    • Create a Custom Lock Page
      • Apply a Custom Lock Page to a Visual Application
      • Apply a Custom Lock Page to a Web Application
    • Use a SOAP Web Service With Visual Builder
    • Run Visual Builder Applications On Other Servers
    • Embed a Web App in an Oracle Cloud Application
      • Make Your Web App Ready for Embedding
      • Embed a Web App Using Page Composer
      • Embed a Web App Using Application Composer
    • Call Server-side Functionality from Visual Builder
    • Add the Oracle Digital Assistant to Your Web App
    • Abort Pending REST Calls in Visual Builder
    • Forms
      • Enable Client-Side Validation for a Form
      • Validate Dates in Forms
      • Validate the Length of an Entry in an Input Text Field
    • Tables
      • Format Row Values in a Table Conditionally
      • Create a Search Filter for a Table
      • Wrap Table Header Text
      • Create an Editable Table
      • Update Pagination Behavior for a Table
    • Pages and Flows
      • Restrict User Access to an Application, Flow, or Page
      • Print Multiple Pages
    • Components
      • Conditionally Show or Hide UI Components
      • Enable Time Zone Specification
      • Filter Multiple Attributes in a Search
      • Set an Initial Value for the Select (Single) Component
    • Business Objects
      • Format a Date Field
      • Apply an Aggregate Function to a Calculated Field From a Child Business Object
      • Access Data in an Existing Oracle Database Using ORDS
      • Delay Display of SDP Data
  • 26 Troubleshooting & FAQs
    • How Do I Find the URL of My Visual Builder Instance?
    • How Do I Find My Application's Runtime Version?
    • How Do I View Details of Client Apps in IDCS?
    • How Do I Write Expressions If a Referenced Field Might Not Be Available Or Its Value Could Be Null?
    • How Do I Resolve Web Component Loader Issues?
    • How Do I Resolve a 'Method Not Allowed' Error?
    • How Do I Resolve a 'No Such File' Error for the URI.js File?
    • How Do I Fix a Missing Scroll Bar in a Table?
    • How Do I Access Components After Upgrading?
    • How Do I Set a Custom Content-Security-Policy Header?
    • Troubleshooting Access Issues
      • Why Does a Live App That Allowed Anonymous Access Prompt for Login?
      • How Can I Recover Apps Linked to a Deleted User Account?
    • Troubleshooting Service Connections
      • Why Was a Certificate in the Remote Path Reported as Invalid?
      • How Do I Resolve an 'Unknown Host' Error?
      • How Do I Resolve a 'Cannot Process Service Scope' Error?
    • Troubleshooting Business Objects
      • What Is The Maximum Data Limit for Business Objects?
      • How Do I Resolve Database Connection Problems?
      • How Do I Resolve a "Failed to verify the target database" Error When Switching the Tenant's Database
      • How Can I Access Business Object Data?