Skip to main content
Neurons for ITSM Actions

Business Object Metadata

Reference documentation for using the Ivanti Neurons for ITSM Business Object Metadata action

Written By Support Channel

Last updated Over 1 year ago

Overview of the Business Object Metadata action

The Business Object Metadata action allows you to retrieve detailed schema information for any business object in Ivanti Neurons for ITSM using the Metadata API.

Purpose

Retrieve Business Object schema information for selected business object

Parameters

1 Neurons for ISM Instance
1 Business Object

Output

Fields, Searches, Templates, Quick Actions and Relationships

Understanding the Business Object Metadata action

The Business Object Metadata action helps you explore the internal structure of any business object within Ivanti Neurons for ITSM. This action will output the following:

Neurons for ITSM element

Description

Field

Array of field names for the selected business object

Searches

Array of Search JSON Objects:

  • Label - Name of search

  • Value - Unique Key (RecId) of search

Templates

Array of Template JSON Objects

  • Label - Name of Template

  • Value - Unique Key (RecId) of Template

QuickActions

Array of Quick Action JSON Objects

  • Label - Name of Quick Action

  • Value - Unique Key (RecId) of Quick Action

Relationships

Array of relationship names for the selected business object

Neurons for ISM System

Select the Ivanti Neurons for ITSM system that the schema will be retrieved from.

Business Object

Specify the exact name of the business object. For example: Incident

Working with Business Object Metadata action

The action provides comprehensive visibility into the internal data schema of a Business Object, allowing you to fully understand how the object is structured and how it can be used for future workflows or integrations.

Create and manage Business Object Metadata actions

Add a Business Object Metadata action

Add the action

Use the following steps to add the action to a workflow.

  1. Click the ‘plus’ symbol on the workflow path at the point you want to insert the action. This opens the action menu slide-over.

  2. Either:

    • Search for the action using the Search field above the actions in the menu.

    • Locate a Recently Used action in the top section of the menu.

    • Navigate to the action within menu: Core actions are listed under Actions, while Plugin actions are contained within their associated integration.

  3. Select the desired action to insert it. This reveals the action’s configuration panel.

  4. Use the Name field to name the action. This can help users to understand your workflow at a glance. (optional)

  5. Use the Description field to add information describing the action. This can help users wanting to understand how your workflow functions (optional).

Configure the action

Use the following steps to configure the action.

  1. Set values for the Neurons for ISM System and Business Object.

  2. Click back in the main view to hide the slide-over.

Delete a Business Object Metadata action

Use the following steps to remove the action from your workflow:

  1. Access the workflow in draft mode to edit it.

  2. Either:

    • hover your mouse cursor over the action, and then click the red cross that appears over the top-right corner of the action to delete it. Or:

    • click on the action to open the action slide-over. Click the red 'Delete Step’ button to remove the action from your workflow.

  3. Click Publish in the top-right to commit your changes.

Take care when deleting an action to also remove any logic using its outputs: workflow steps may function incorrectly or break if they attempt to evaluate an output of a deleted action.

Was this helpful?

Still need help? Share an idea