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.
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.
Actions and action types
Actions are the mechanism for submitting new records to the database, moving records from one state to another, and modifying or deleting records.
Defining action hooks
You can define hooks for an action in a record type. You can customize action hooks by including scripts that use the DevOps Plan Schema API.

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.
  - 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.
    - Record types
      This topic explains the concept of a DevOps Plan record type.
    - Working with fields
      You use fields to control the type of data that users can add to a user database.
    - State models
      This topic explains the concept of DevOps Plan state models.
    - Actions and action types
      Actions are the mechanism for submitting new records to the database, moving records from one state to another, and modifying or deleting records.
      - Displaying the Actions grid
        The Record Actions grid displays all of the actions that are defined in a schema. You can use the Record Actions grid to add, delete, and rename actions and to modify properties of an action. You can also set the access control and other policies for each action in the Record Actions grid.
      - Adding actions
        You can add new actions as the state transitions between existing states in the State model for a schema.
      - Creating state transitions
        You create state transitions when defining the state model of a schema. To create a state transition, you define an action of the type CHANGE_STATE and then select the source states and a destination state for that action.
      - Modifying actions
        You can modify action properties in from the Actions grid.
      - Defining action hooks
        You can define hooks for an action in a record type. You can customize action hooks by including scripts that use the DevOps Plan Schema API.
      - Defining the default action of states
        You can define the default action for a state in a record type so that it is highlighted in the list of all actions for a DevOps Plan application user.
      - Deleting actions
        You can delete actions for a record type, but the change might require other changes to a schema such as modifying the state transition matrix or hooks that include the action name.
  - 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.

Defining action hooks

You can define hooks for an action in a record type. You can customize action hooks by including scripts that use the DevOps Plan Schema API.

About this task

To define an action hook, use the Actions grid.

Procedure

Start the Designer.
In the Workspace, expand the Record Types folder or the Record Types - Stateless folder.
Select and expand the record type.
For state-based record types, expand the States and Actions folder. Double-click Actions.
For an action in the Actions grid, select a hook type by right-clicking in one of the columns in the grid for the action and selecting Scripts.
Select a scripting language.
The Scripts editor starts.
Define the hook using the DevOps Plan Schema API.
When you finish editing a scripted hook, click Hooks > Compile to check the syntax of your code.