Welcome
Developing
Learn how to develop schemas by using the DevOps Plan Designer.
Developing Schemas
You can develop or modify schemas with the DevOps Plan Designer.
DevOps Plan schemas
This topic explains the concept of a DevOps Plan schema.
Applying schema changes to user databases
After you check in a schema, you can upgrade the user databases that used an earlier version of it. You do not have to upgrade these databases immediately, but the changes to the schema are not available until you do.

Overview
Learn general information about the product.
Install and deploy DevOps Plan
Find information about installing and deploying DevOps Plan.
Developing
Learn how to develop schemas by using the DevOps Plan Designer.
- Developing Schemas
  You can develop or modify schemas with the DevOps Plan Designer.
  - Understanding the functions of the DevOps Plan schema developer
    This topic provides an overview of the tasks typically performed by a schema developer.
  - Overview of the DevOps Plan Designer interface
    The DevOps Plan Designer includes several different windows, or views, that you will use to perform your schema development tasks.
  - DevOps Plan schemas
    This topic explains the concept of a DevOps Plan schema.
    - Naming restrictions
      The naming restrictions that apply to a DevOps Plan schema prevent naming conflicts.
    - Viewing the schema history
      You can view the history of changes that were made to a schema.
    - Modifying schemas
      When you modify a schema you must complete several tasks to ensure that your changes are validated, saved, and applied to user databases.
    - Creating a test database
      A test database is a temporary database that you create when developing a new schema or a new version of an existing schema. You use the test database to verify that the new schema performs as expected, without risking damage to production data.
    - Checking out schemas
      To customize a schema, you must first check it out from the schema repository. When you check out a schema, a copy of the schema is created for you to edit. The new version of the schema is created when you check in this modified copy.
    - Creating schemas from the Blank schema
      If you want to create a schema that differs substantially from the predefined schemas, start by checking out and editing the Blank schema.
    - Scripting languages
      This topic provides information about the available scripting languages that you can use to write hooks.
    - Validating schemas
      When you check in a schema, DevOps Plan software validates it and prevents the checkin if the schema has any validation errors.
    - Setting the test database
      You must associate a test database with a schema.
    - Setting test preferences
      You can use the Designer Preferences window to customize the default behavior of your test configurations.
    - Testing schemas
      You must test schema changes with the supported clients in your DevOps Plan environment.
    - Checking in schemas
      After editing and testing a schema, you must check it in. When you check in a schema, the new version is saved in the schema repository.
    - Updating properties of user databases
      You can update the properties of a user database to include changes made for vendor database properties that map to the user database.
    - Applying schema changes to user databases
      After you check in a schema, you can upgrade the user databases that used an earlier version of it. You do not have to upgrade these databases immediately, but the changes to the schema are not available until you do.
    - Deleting schemas or schema versions
      You can delete a single version of a schema or all versions of a schema. Deleted schemas and schema versions cannot be restored.
    - Changing a database association to a different schema
      After a user database is associated with a schema, you cannot apply a new schema to the database. You can upgrade a database only with newer versions of the same schema.
  - Customizing a schema
    To modify how change requests are handled, you need to use the Designer to customize the records and fields of a schema.
  - Schemas and packages
    This topic explains the concept of using schemas and packages in DevOps Plan.
  - Packages and integrations
    This topic explains the concepts of DevOps Plan packages and integrations.
  - Test Management and Requests
    You can use the DevOps Plan TestManagement and Requests feature to create and track test plans and add approval processes to the record.
  - User privileges
    This topic describes the privileges that are available for DevOps Plan users and user groups.
  - Working with users
  - Working with user groups
  - Working with Forms
    You must create a record form for each record type in your schema. You can also define a submit form for each record type.
  - Working with charts
    Charts are essential tools for visualizing data and managing projects. You can use Gantt and timeline charts for project management based on availability in different schemas.
  - Working with approvals
    Users can use Approvals to view and manage approval requests that are either pending or completed using the Pending Requests and Completed Requests tabs.
  - Creating a security model
    This topic provides an overview of the process to create a security model.
  - Using hooks to customize your workflow
    This topic provides guidelines for using hooks to implement your workflow.
  - Record locking
    When multiple users attempt to simultaneously update a record, the database locking model ensures that the update from each user succeeds as a unit, but each update overwrites the previous update.
  - Customizing the Web
    The Designer provides many ways to customize the underlying schema and functionality that the DevOps Plan accesses.
  - DevOps Plan email
    This topic provides a description of the supported DevOps Plan email features.
  - Importing data into DevOps Plan using Import feature
    The Configuration > Import feature allows teamspace admins or userdb super-users to add data to the DevOps Plan application. There are two primary methods for bulk data import: using sample data and uploading a zip file.
  - Enhancing the Export to JSON feature
    You can use the Export to JSON feature to export detailed information related to a record into a JSON format.
  - Enhanced Subscribe feature
    You can now use the Subscribe toggle-button in a work item to subscribe yourself in one-click.
  - Cloning existing records
    By cloning existing records you can create an exact copy of an existing record. This ability is useful when you have to create similar records frequently, ensuring consistency and saving time.
Integrating
You can integrate DevOps Plan with other software by adding packages to existing schema.
Extending product function
Learn how to extend the product.
Reference
Review reference information for the product.

Applying schema changes to user databases

After you check in a schema, you can upgrade the user databases that used an earlier version of it. You do not have to upgrade these databases immediately, but the changes to the schema are not available until you do.

Before you begin

Upgrading the user database is an irreversible process. Before applying schema changes, back up the user database. Also, immediately before you apply schema changes, verify that no users are logged in to the database. The upgrade operation fails if users are connected to the user database. Users cannot log in during the upgrade process, but they cannot be disconnected.

About this task

When a user database is associated with a specific schema version, you can apply only newer versions of the same schema to that database. You cannot apply earlier versions or a different schema.

For more information about databases, see the online help for the DevOps Plan Administrator.

To apply schema changes to a user database:

Procedure

Start the Designer.
Click Database > Upgrade Database.
In the Upgrade Database Step - 1 of 2 dialog, select the database that you want to upgrade and click Next.
In the Upgrade Database Step - 2 of 2 dialog, select a schema version and click Finish.