DataMonitorManager

Versions

• 1.0.0

v1.0.0

Basic Information

Class Name: DataMonitorManager

Title: Data Monitor Manager

Version: 1.0.0

Author: Drew Shea

Organization: OneStream

Creation Date: 2025-03-02

Default Routine Memory Capacity: 2.0 GB

Tags

Data Monitor, Data Monitoring, Data Analysis

Description

Short Description

The Data Monitor Manager to handle data monitor namespaces.

Long Description

The Data Monitor Manager is used to handle data monitor namespaces. This includes adding and removing data monitors to or from a given namespace. Namespaces can be helpful when running data monitors as part of a group or arena.

Use Cases

1. Add Data Monitor to Namespace

Data Monitors can be extremely helpful for organizing and managing monitoring tasks across different business contexts. This use case enables users to add existing Data Monitors to specific namespaces, creating logical groupings for better organization and management. By adding Data Monitors to namespaces, users can efficiently categorize monitors based on departments, functions, or monitoring objectives. This structured approach allows for easier navigation, retrieval, and execution of monitoring tasks based on specific business needs.

Routine Methods

1. Init (Constructor)

• Method: __init__

  • Type: Constructor

  • Allow In-Memory Execution: No

  • Read Only: No

  • Method Limits: N/A

  • Outputs Dynamic Artifacts: No

  • Short Description:

    • Initializes the Data Monitor Manager.

  • Detailed Description:

    • Initializes the Data Monitor Manager. This routine is used to handle data monitors in relation to a given namespace. The data monitors are associated with a namespace, and this namespace is specified in the constructor. The namespace is used to organize the data monitors and to make it easier to manage them.

  • Inputs:

    • Required Input
      • Data Monitor Namespace Name: Specify the name of the data monitor namespace.
        • Name: name
        • Tooltip:
          • Validation Constraints:
            • This input may be subject to other validation constraints at runtime.
        • Type: str
      • Data Monitor Namespace Description: Specify the description of the data monitor namespace.
        • Name: description
        • Tooltip:
          • Validation Constraints:
            • This input may be subject to other validation constraints at runtime.
        • Type: str

  • Artifacts: No artifacts are returned by this method

2. Add Datamonitor (Method)

• Method: add_datamonitor

  • Type: Method

  • Memory Capacity: 2.0 GB

  • Allow In-Memory Execution: No

  • Read Only: No

  • Method Limits: N/A

  • Outputs Dynamic Artifacts: No

  • Short Description:

    • Add a data monitor to a namespace.

  • Detailed Description:

    • Add a data monitor to the namespace associated with this constructor. This will allow the data monitor to be managed as part of a broader group.

  • Inputs:

    • Required Input
      • Data Monitor: Please write a valid Data Rule name.
        • Name: datamonitor_id
        • Tooltip:
          • Validation Constraints:
            • This input may be subject to other validation constraints at runtime.
        • Type: str

  • Artifacts: No artifacts are returned by this method

Interface Definitions

No interface definitions found for this routine

Developer Docs

Routine Typename: DataMonitorManager

Method Name	Artifact Keys
__init__	N/A
add_datamonitor	N/A