Managing Data Stores

The content on this page explains how to maintain a data store after you've created it.

For information on creating one, see: Data Stores

Editing a Data Store

All data store attributes can be edited by users with editor or administrator rights. The following list details how to edit each attribute:

  • Click on the name or description to edit them in place.
  • Update the data source by selecting one from the list of available data sources.
  • Check the Automatically update database schema checkbox to allow Appian to execute DDL SQL statements when dependent data types are updated or when this data store is imported. Changes to this attribute do not take effect in the environment if the auto-update feature has been disabled from the admin console.
  • Click an entity to modify its name or its data type.
  • Click Add Entity to configure a new data store entity.

After making any of the above edits, you may either save a draft or publish a new version of the data store. To save a draft, click "Save Draft." Saving a draft does not affect the environment or execute SQL DDL statements, but you may come back to the data store at any time to view and publish the changes. To publish a new version of the data store, follow these steps:

  1. Click Verify to validate your data store edits.
    • When the tables needed for your entity must be modified (expected) the following message is displayed: No matching tables found!
  2. Select Create tables automatically to have the system execute the SQL commands needed to configure your data store entity - OR - Select Create tables manually if you want or need to have the necessary SQL commands executed using a process that you perform outside the system. See Running DDL Scripts for additional details.
  3. Click Save & Publish.

See also: Editing a Custom Data Type

Importing and Exporting Data Stores

Deleting a Data Store

Take care when deleting a data store not to disrupt any active processes that query or write to the data store.

  1. Go to an application that contains the data store.
  2. Select it in the grid and then click the Delete button in the grid toolbar.

System Administrators have the ability to delete data stores (and other objects) in bulk by selecting them and clicking Delete in the toolbar.

A user must have at least Viewer permissions to a data store in order to use its entities to query, write, or delete data.

The security role map of a data store controls which users can see or modify it and its properties. By default, only the data store creator and system administrators have access to the data store. See Editing Object Security to modify a data store's security.

The following table outlines the actions that can be completed for each permission level in a data store's security role map:

Actions Administrator Editor Viewer
Retrieve entity to read/write at runtime* Yes Yes Yes
View the data store definition Yes Yes Yes
Update the data store definition Yes Yes No
View the security Yes Yes No
Update the security Yes No No
Delete the data store Yes No No
Save & Publish the data store Yes No No

*Users must have at least Viewer permissions to the data store in order to read or write data using the Write to Data Store smart service.

Open in Github Built: Fri, Jun 03, 2022 (01:08:29 PM)

On This Page