Help for Kofax TotalAgility
  • Welcome
  • Get started
    • Log on to TotalAgility
    • Home
    • Recent items
    • Edit profile
    • List pages
    • Rule editor
    • Common procedures
      • Log out of TotalAgility
      • Lock or unlock an item
      • Open and modify an item
      • Delete an item
      • Locate an item
      • Undo/redo updates
      • Create metadata
      • Stop and start the Kofax TotalAgility services
    • Common icons
    • Name conventions
  • Workflow
    • Business processes
      • Process Designer
        • Modeling bar
        • Action toolbar
        • Process elements
          • Work with process elements
        • Satellite
      • Design a basic process
        • Start node
        • Activity
          • Add an activity
          • Activity properties
            • Configuration
              • Partial completion
            • Resource assignment
              • Assign resources manually
              • Assign resources by applying rules
              • Reuse resources
              • Set up a notification email
            • Execution
            • Inputs and outputs
            • Time and cost
              • Service level agreement
                • Define the SLA status indicator
              • Activity triggers
                • Create an activity trigger
            • Dependents
              • Add dependents
              • Preconditions
                • Add preconditions
            • Advanced
              • Associate states
            • After processing
              • Associate a business event
              • Branching rules
                • Configure branching rules
            • Info
          • Activity types
            • Common activities
              • Ordinary activity
                • Configure an ordinary activity
              • Embedded process activity
                • Configure an Embedded process activity
              • .Net activity
                • Configure a .Net activity
              • Web service activity
                • Configure a Web service activity
              • Business rule activity
                • Configure a Business rule activity
              • Create subjob activity
                • Configure a Create subjob activity
                • Add a Create subjob activity with advanced workflow rules
              • Data access activity
                • Configure a Data access activity
                • Get records from a database table
                • Add records to a database table
                • Update database records
                • Delete database records
                • Get data from a database view
                • Get data from stored procedures of a database
                • Insert multiple records into a database
              • Synchronization activity
                • Configure a Synchronization activity
              • Expression activity
                • Configure an Expression activity
                  • Math function
                  • Text function
                  • Date function
              • Create new job activity
                • Configure a Create new job activity
              • Loop activity
                • Configure a Loop activity
              • Email activity
                • Configure an Email activity
                • Create an inline template for email
            • Capture activities
              • Classification activity
                • Configure a Classification activity
              • Extraction activity
                • Configure an Extraction activity
              • Validation activity
                • Configure a Validation activity
              • Document review activity
                • Configure a Document review activity
              • Delete activity
                • Configure a Delete activity
              • Composite activity
                • Configure a Composite activity
              • Export activity
                • Configure an Export activity
              • PDF generation activity
                • Configure a PDF generation activity
              • Document conversion activity
                • Configure a Document conversion activity
              • Image processing activity
                • Configure an Image processing activity
              • Image quality analysis activity
                • Configure an Image quality analysis activity
              • Scan activity
                • Configure a Scan activity
              • Verification Activity
                • Configure a Verification activity
              • Transfer activity
                • Configure a Transfer activity
            • Kofax activities
              • RPA activity
                • Configure an RPA activity
              • SignDoc activity
                • Configure a SignDoc activity
              • KCM compose activity
                • Configure a KCM compose activity
              • KCM distribute activity
                • Configure a KCM distribute activity
                • Configure the Output management distribution mechanism
              • KCM pack activity
                • Configure a KCM pack activity
            • Microsoft activities
              • SharePoint create site activity
                • Configure a SharePoint create site activity
              • SharePoint create folder activity
                • Configure a SharePoint create folder activity
              • SharePoint add item activity
                • Configure a SharePoint add item activity
              • SharePoint delete item activity
                • Configure a SharePoint delete item activity
              • SharePoint uploader activity
                • Configure a SharePoint uploader activity
              • SharePoint move item activity
                • Configure a SharePoint move item activity
              • SharePoint get document activity
                • Configure a SharePoint get document activity
              • Dynamics CRM activity
                • Create an entity instance in Dynamics CRM
                • Delete an entity instance from Dynamics CRM
                • Retrieve an entity instance details from Dynamics CRM
                • Update an entity instance in Dynamics CRM
              • Exchange server get attachments activity
                • Configure the Exchange server get attachments activity
            • CMIS activities
              • CMIS get document activity
                • Configure a CMIS get document activity
              • CMIS add document activity
                • Configure a CMIS add document activity
              • CMIS update document activity
                • Configure a CMIS update document activity
              • CMIS create folder activity
                • Configure a CMIS create folder activity
              • CMIS check in document activity
                • Configure a CMIS check in document activity
              • CMIS cancel checkout document activity
                • Configure a CMIS cancel check out activity
              • CMIS find document activity
                • Configure a CMIS find document activity
            • Micro Focus activities
              • Content Manager create folder activity
                • Configure Content Manager create folder activity
              • Content Manager add document activity
                • Configure the Content Manager add document activity
              • Content Manager get document activity
                • Configure a Content Manager get document activity
            • Script activities
              • Script activity
                • Configure a Script activity
              • C# activity
                • Configure a C# activity
              • VB.Net activity
                • Configure a VB.Net script activity
            • Document set activities
              • Document received activity
                • Configure a Document received activity
              • Document state activity
                • Configure a Document state activity
              • Evaluate document set activity
                • Configure an Evaluate document set activity
              • Add document type activity
                • Configure an Add document type activity
            • Other activities
              • RESTful service activity
                • Configure a RESTful service activity
              • Sleep activity
                • Configure a Sleep activity
              • Job owner activity
                • Configure a Job owner activity
              • Job variable activity
                • Configure a Job variable activity
              • XML activity
                • Configure an XML activity
              • Resource info activity
                • Configure a Resource info activity
              • Supporting info activity
                • Configure a Supporting info activity
              • Document creation activity
                • Configure a Document creation activity
                • Create a Placeholder in a Microsoft Word document
              • Ready for review activity
                • Configure a Ready for review activity
          • Mime types
          • Cut, copy and paste nodes
        • Decision
          • Add a decision
          • Decision properties
        • Annotation
          • Add an annotation
        • Attachment
          • Add an attachment
        • End node
          • Add an end node
          • Properties of an end node
          • Event types for an end node
      • Design a process map on the Integration Server
      • Process properties
        • General
          • Case completion
        • Capture
        • Time and cost
          • Service Level Agreement
          • Process triggers
            • Triggers
            • Triggers and escalation map initialization parameters
            • Create a process trigger
            • Create an alert
        • Access
          • Functional access
        • History, reporting and execution
        • Exceptions
          • Configure exceptions for a process
          • Exception maps and initialization parameters
        • Maintenance access
        • Predictive model
          • Manage a predictive model
        • Default settings
      • System processes
        • SYSTEM Active Directory synchronization
        • Synchronize Active Directory with TotalAgility
      • Split process map
      • Work with processes
        • Open a process version
        • Unlock a process
        • Delete a process
        • Copy a process
        • Open and modify a process
        • Process associations
          • View associations
      • Process debugging
        • Debug a process
    • Case definitions
      • Design a case
      • Create a case fragment
      • Work with cases
        • Modify a case
        • Copy a case
        • Delete a case
        • Unlock a case
        • Debug a case
        • Open a case version
    • Business rules
      • Create a business rule
      • Properties of a business rule
      • Work with business rules
        • Modify a business rule
        • Copy a business rule
        • Delete a business rule
        • Unlock a business rule
        • Open a business rule version
    • Skins
      • Process template
      • Create a skin
      • Manage skins
      • Skin versions
    • Variables
      • Variable types
      • Create process variables
        • Create a checklist variable
        • Create a complex and a dynamic complex variable
        • Create a data backbone variable
        • Create a document variable
        • Create a folder variable
        • Create a JSON expression variable
        • Add a system variable to a process
        • Create an XML variable
        • Create an XML expression variable
        • Use document or folder variables
      • Manage process variables
    • States
      • Create a state
    • Milestones
      • Create a milestone
      • Milestone triggers
        • Create a milestone trigger
    • Roles
      • Types of roles
      • Create a role
      • Manage roles
    • Notes
      • Update notes
    • Process events
      • Create a process event
    • Document set
      • Configure a document set
  • User interface
    • Forms
      • Form Designer
        • Modeling bar
        • Action Toolbar
      • Form elements
        • General controls
          • Properties of Label control
          • Properties of a Textbox control
          • Properties of a Button control
            • Text appearing off center for Button control
          • Properties of a Checkbox control
          • Properties of a Table control
            • Add columns to a table
            • Add a Text box to a table column
            • Add a Drop-down list to a table column
            • Add a Check box to a table column
            • Add a Calendar to a table column
            • Add a Hyperlink to a table column
            • Add an Image to a table column
            • Add an Action list to a table column
          • Properties of a Dropdown list control
            • Add data to a dropdown list
          • Properties of a Calendar control
          • Properties of a Radio button list control
            • Configure the data for a Radio button list control
          • Properties of a Tab control
            • Add tabs to a Tab control
          • Properties of Hyperlink control
          • Properties of an Image control
            • Add images to a form
          • Properties of a Chart control
          • Horizontal rule control
          • Properties of a List control
            • Configure the data store
            • Configure the swipe buttons
            • Configure a row
          • Capture controls
            • Add a Mini-viewer
          • Design properties of a control
          • Configure a label for a control
          • Configure actions for a form control event
          • Move, cut, copy and paste controls
          • Set common properties of controls
        • Layout
        • Advanced controls
          • Job list control
            • Properties of a Job list control
              • Configuration of a Job list control
              • Search properties
              • Edit Job list actions
          • Work queue control
            • Properties of a Work queue control
              • Configuration of a Work queue control
              • Search properties
          • Workload control
            • Properties of a Workload control
              • Search properties
              • Configuration of a Workload control
          • Document set control
            • Properties of a Document set control
          • File upload control
            • Properties of a File upload control
            • Change the size limit for uploaded files
          • Resource tree control
            • Properties of a Resource tree control
              • Configuration of a Resource tree control
          • Embedded page control
            • Properties of an Embedded page control
          • Process viewer control
            • Properties of a Process viewer control
          • Web capture control
            • Properties of a Web capture control
              • Configure a Web capture control
              • Configure buttons for a Web capture control toolbar
          • Thumbnail viewer control
            • Properties of a Thumbnail viewer control
          • KCM control
            • Properties of a KCM control
            • Configure a KCM control
              • Compose mode
              • Rerun mode
          • Case health control
            • Properties of a Case health control
          • Checklist control
            • Properties of a Checklist control
            • Use a Checklist
          • Language selector control
            • Properties of a Language selector control
          • Custom action button control
            • Properties of Custom action button control
            • Configure a Custom action button control
          • Toolbar control
            • Properties of a Toolbar control
            • Configure items for a Toolbar control
          • Create new associated job control
            • Properties of a Create new associated job control
          • Summary control
            • Properties of a Summary control
          • Job action button control
            • Properties of a Job action button control
            • Configure a Job action button control
          • Activity action button control
            • Properties of an Activity action button control
            • Configure an Activity action button control
          • Capture Composite control
            • Properties of a Capture Composite control
          • Mobile capture control
            • Properties of a Mobile capture control
          • Mobile capture barcode control
            • Properties of a Mobile capture barcode control
            • Configuration of a Mobile capture barcode control
      • Form templates
        • Create a form template
        • Manage form templates
        • Use a form template
      • Manually create forms
        • Create a form
      • Build forms
        • Build a Create new job form
        • Build a Device create new job form
          • Additional information on Device create new job form
        • Build a Document form
        • Build a Folder form
        • Build a Logon form
        • Build a Multiview form
        • Build a Multiview activity form
        • Build a Scan create new job form
        • Build an Activity form
        • Build an MFP scan create new job form
        • Build an MFP form
        • Build an MFP work queue form
        • Build an MFP activity forms
      • Form properties
        • General
        • Initialization and events
        • Settings
        • Access
        • Properties specific to a touch-enhanced form
          • Define action menus for a touch-enhanced form
          • Configure header/footer toolbar buttons
      • Form events and actions
        • Form actions
          • .Net method action
          • Add row action
          • Alternative extraction search action
          • Apply form variant action
          • Apply validation action
          • Business rule action
          • Calculation rule action
          • Change stack order action
          • Clear action
          • Clear selection action
          • Close action
          • Composite action
          • Condition action
            • Begin condition action
            • Else condition action
            • End condition action
          • DB query action
            • Create a DB query
              • DB query to get records from a database table
              • DB query to add records to a table
              • DB query to update database records
              • DB query to delete database records
              • DB query to use stored procedures of a database
              • DB query to use the database views
              • Insert multiple records into a database
          • Delete row action
          • Display rule action
            • Use a display rule to collapse or expand a cell
          • File upload action
          • Fuzzy search action
          • Hide action menu action
          • JavaScript action
          • MFP print action
          • MFP Scan action
          • MFP scan settings action
          • Redirect action
          • Refresh capture action
          • Refresh page rendition action
          • Reset form variables action
          • RESTful service action
          • RPA action
          • Same page action
          • Set device action
          • Set focus action
          • Set language from job action
          • Show action menu action
          • Show message action
          • Show navigation action
          • Update control action
            • Enumerations
          • Update row action
          • Web capture action
          • Web service action
        • Configure multilingual actions
        • Work with an action
        • Form events
          • Events and actions supported by form and basic controls
          • Events and actions supported by advanced controls
          • Events and actions supported by the capture forms and composite controls
          • Events and actions supported by the tablet and phone forms
          • Events and actions supported by an MFP form
          • Events and actions supported by the Capture Client controls
      • Form variables
        • Manage form variables
      • Form debugging
        • Debug a form
        • Debug an activity within a form
        • Debug a form - example
      • Work with forms
        • Open and modify a form
        • Copy a form
        • Delete a form
        • Unlock a form
        • Open a form version
        • Regenerate a form
        • Customize the capture forms
        • View associations in a form
    • Navigation
      • Create a navigation
      • Maintain a navigation
    • Global variables
      • Create a global variable
      • Maintain a global variable
    • Themes
      • Create a theme
      • Maintain a theme
    • Style sheets
      • Upload a style sheet
      • Manage style sheets
    • Images
      • Upload an image
      • Manage images
    • Form variants
      • Create a form variant
      • Maintain a form variant
    • Sites
      • Create a site
      • Maintain a site
    • Custom pages
      • Upload a custom page
      • Manage custom pages
    • Security tokens
      • Manage a security token
      • Associate a security token with a control
  • Capture
    • Extraction groups
      • Extraction groups designer
        • Modeling bar
        • Design elements
      • Create an extraction group
      • Properties of an extraction group
      • Work with extraction groups
      • Document type
        • Add a document type
        • Properties of a document type
          • General
          • Validation
          • Field validation
            • Post validation handling
          • PDF generation
          • Forms
        • Validation methods
          • Business rule validation method
          • Date validation method
          • Regular expression validation method
          • Standard validation method
      • Field groups
        • Add field groups to a document type
        • System field group
      • Fields
        • Add fields to a field group
        • Properties of a field in a document type
          • General
            • Configure the verification settings for a document field
          • Validation
          • Add a table field to a field group
        • Macros for devices
        • Set and update document field properties
          • Set field properties in a single document
          • Set field properties in multiple documents
          • Update document field properties
    • Classification groups
      • Create a classification group
      • Properties of a classification group
      • Work with classification groups
    • Folders
      • Add a folder type
      • Maintain a folder
      • Properties of a folder
        • General
        • Resources
        • Validation
        • Field validation
        • Forms
      • Add a field group
      • Add fields to a field group
        • Properties of a folder type field
    • Document / Activity variants
      • Create a document variant
      • Maintain a document variant
      • Create an activity variant
      • Maintain an activity variant
    • Field formatters
      • Manage a field formatter
        • Date formatter
        • Amount formatter
        • Percentage formatter
        • Business rule formatter
    • Field validators
      • Add a field validator
    • Field zoom settings
      • Configure field zoom settings
    • Document conversion profiles
      • Add document conversion profiles
    • PDF profiles
      • Manage a PDF profile
    • Scan/VRS profiles
      • Manage a Scan/VRS profile
      • Properties of a Scan/VRS profile
      • eVRS command string modules
        • Properties of specific image processing settings
        • Resolution of inconsistencies
        • Minimum image size
        • eVRS strings examples
      • MFP scan handling with or without image processing
    • Separation profiles
      • Manage a separation profile
        • Configure a separation profile for a document
        • Configure a separation profile for a folder
      • Bar code and patch code types supported by TotalAgility
      • Additional information about folder and document separation
    • Control layouts
      • Create a capture control layout
  • Resources
    • Individuals
      • Create an individual resource
      • Maintain an individual resource
    • Groups
      • Create a group resource
      • Maintain a group resource
    • External resources
      • Create an external resource
      • Maintain an external resource
    • Personas
      • Manage a persona
      • Associate a persona with group members
  • Import
    • Import a process
    • Import a form
    • Import languages
    • Map between XPDL notation and TotalAgility
    • Import a package
  • Export
    • Export a process
    • Export a form
    • Export languages
    • Export a package
  • Translation
    • Translate the elements into supported languages
  • Queries
    • Create a Job query
    • Create a Work queue query
    • Create a System query
    • Manage columns in queries
    • Manage queries
  • Monitoring
    • Business events
      • Manage Business events
    • Business alerts
      • Manage a business alert
    • Business targets
      • Manage Business targets
  • System data
    • Server variables
      • Create a server variable
      • View associations for a server variable
    • Regular expressions
      • Manage regular expressions
    • Lookups
      • Manage a lookup
      • Create a multilingual lookup
      • Translate a lookup
    • Document templates
      • Upload a document template
      • Maintain a document template
    • Currency codes
      • Manage a currency code
    • Checklist templates
      • Create a checklist template
      • Maintain a checklist template
    • Checklist items
      • Manage a Checklist item
    • Work types
      • Create a work type
      • Associate a work type with a map
      • Maintain a work type
  • Integration
    • Web service references
      • Create a Web service reference
      • Web services supported by TotalAgility
      • Use a web service
    • .Net assemblies
      • Add a .Net assembly
      • Use a .Net assembly in a store
      • Maintain a .Net assembly
    • RPA
      • Integrate TotalAgility with RPA
    • Insight
      • Integrate TotalAgility with Insight
    • SignDoc
      • Integrate TotalAgility with SignDoc
    • KCM
      • Integrate TotalAgility with KCM
    • Import settings
      • Configure the import connection settings
        • FOIP server settings
        • SMTP server settings
        • Import sources
          • POP3
          • IMAP
          • MS graph
          • EWS
          • External fax server
          • FoIP
          • SMTP
          • FILE
      • Kofax XML format
    • Linked servers
      • Link the TotalAgility servers
    • Micro Focus Content Manager
      • Link TotalAgility to Micro Focus Content Manager system
      • Configure TotalAgility actions resulting from Micro Focus Content Manager events
        • Change state action
        • Create job in case action
        • Create new case action
        • Create new job action
        • Raise event action
      • Search for documents in a Content Manager system
    • CMIS
      • Add a CMIS compliant site
    • SharePoint
      • Create a Microsoft SharePoint integration site
      • Configure TotalAgility actions resulting from SharePoint events
        • Change state action
        • Create a Job in case action
        • Configure a create new case action
        • Create new job action
        • Raise event action
      • Work with SharePoint web parts
        • Define columns in a work queue web part
        • View all case jobs using the case reference
    • Dynamics CRM
      • Link TotalAgility to Microsoft Dynamics CRM
      • Configure TotalAgility actions resulting from Microsoft Dynamics CRM events
        • Change state action
        • Create job in case action
        • Create new case action
        • Create new job action
        • Raise event action
    • Dynamics AX
      • Link TotalAgility to Microsoft Dynamics AX
      • Configure the TotalAgility actions resulting from Microsoft Dynamics AX events
        • Change state action
        • Create job in case action
        • Create new case action
        • Create new job action
        • Raise event action
    • Exchange
      • Link TotalAgility with Microsoft Exchange
      • Configure TotalAgility actions resulting from Microsoft Exchange events
        • Change state action
        • Create job in case action
        • Create new case action
        • Create new job action
        • Raise event action
    • Microsoft Outlook
      • Configure Microsoft Outlook settings for TotalAgility
      • Configure the task display settings
      • Take and complete the TotalAgility tasks from Outlook
    • Microsoft Visio
      • Add the TotalAgility Microsoft Visio Add-On to Microsoft Visio
      • Convert Microsoft Visio drawing to TotalAgility XML file
      • Microsoft Visio drawings supported by TotalAgility
        • Flowchart diagrams
        • Business process diagrams
  • Packages
    • Modeling bar
    • Create a package
      • Properties of package
      • Add items to a package
    • Add a deployment configuration to a package
    • Package export options
    • Miscellaneous files
      • Upload a miscellaneous file
      • Maintain a miscellaneous file
    • Work with packages
    • Compare packages
  • System
    • Categories
      • Manage a category
    • Job schedules
      • Manage a job schedule
    • System settings
      • Database settings
      • Retention policy
        • Configure the retention policy
      • Reporting server
      • Reporting tags
      • Archive finished jobs
      • Job clear down
      • Protected items search
      • Lock status search
      • Exceptions
        • Configure exception handling at the server level
        • Exception maps and initialization parameters
      • Process node colors
        • Configure the process node colors
      • Scripting
      • SLA and work assignment
      • System tasks
        • Manage system tasks
      • Passwords and logon
      • Multifactor authentication
      • Resource extensions
      • User sessions
        • Change the session IDs
      • Federated security
        • Scenario 1
        • Scenario 2
        • Scenario 3
        • Scenario 4
        • Scenario 5
        • Scenario 6
        • Scenario 7
        • Scenario 8
        • Scenario 9
        • Support for authentication without federated security
        • Configure the federated security
      • General
      • Forms
      • Email server (SMTP)
      • Thread pools
        • Add a thread pool
      • Whitelist
      • Scan forms
      • Activity forms
      • Capture configurable keys
        • Manage capture configurable keys
        • Excluded shortcut keys
          • Key combination with a modifier key
          • Cannot be overridden
          • Already in use by Capture Client
      • Capture operations
        • Manage capture operations
      • License servers
      • Reactivate license on primary
      • Reactivate license on backup
      • Primary server statistics
        • License types
        • Additional information about decrementing volume
      • Backup server statistics
      • Page renditions
        • Manage page renditions
      • Capture groups
        • Configure the capture groups
      • Devices
      • Access control list
        • Assign access permissions to different areas of TotalAgility
        • Assign access permissions for TotalAgility Designer
        • Assign access permissions for Transformation Designer
        • Assign access permissions for devices
  • References
  • Getting help with Kofax products
  • Access related documentation
  • Glossary

Your search for {searchVal} returned {total} results.

The search returns topics that contain every term you enter. If you type more than one term, an "and" is assumed. The results appear in order of relevance, based on how many search terms occur per topic.

  • If a search returns too many topics, add more search terms or search for an exact phrase. To search for an exact phrase, enclose it in double quotation marks (for example, “batch class”).
  • If a search returns too few topics, reduce the number of terms entered or use a partial term. If an exact match cannot be found, the search uses “fuzzy” matching to find similar terms. Only terms with exact matches are highlighted in the search results.
Welcome > User interface > Forms > Form events and actions > Form actions > DB query action > Create a DB query

Create a DB query

Create a DB query to:

  • Get records from a database table

  • Add records to a database table

  • Update records in a database table

  • Delete records to a database table

  • Use the database stored procedures

  • View records in a selected view

Database can be configured in the following:

  • Data access activity on a process map.

  • DB query action on a form.