23 Matching Annotations
  1. Last 7 days
  2. docs-staging.docs.admlabs.aws.swinfra.net docs-staging.docs.admlabs.aws.swinfra.net
    1. Advanced filtering

      There is also another functionality that was introduced: "Convert filter to query string". I think it's also worth mentioning it under this paragraph.

      We introduced a dedicated request/response pair event for converting filters to query strings:

      octane_convert_filter_to_query:

      ---Direction: Sent from the external action to the client.

      ---Purpose: Requests active filter with filter_id to be converted to query strings, associated within the widget identified by panel_id.

      ---Example payload: js { event_name: 'octane_convert_filter_to_query', workspace: this.params.workspace, shared_space: this.params.shared_space, data: { panel_id: this.params.panel_id, filter_id: filterId, filter: filter, entity_type: 'work_item' } } and:

      octane_filter_converted_to_query:

      ---Direction: Sent from the client to the external action as a response to the octane_convert_filter_to_query.

      ---Purpose: Provides the filter with filter_id converted to query strings, associated within the widget identified by panel_id.

      ---Example payload: js { data: { panel_id: panelId, filter_id: filterId, query: query } }

    2. You send an event requesting that OpenText Core Software Delivery Platform open the Advanced filter dialog box with specified scope and constraint

      We support multiple advanced filters within the same widget, and the unique 'filter_id' is how we differentiate between them.

  3. Jan 2026
  4. docs-staging.docs.admlabs.aws.swinfra.net docs-staging.docs.admlabs.aws.swinfra.net
    1. Scripted widgets can request item colors from OpenText Core Software Delivery Platform by ID or by field value.

      can request item colors for a given list of entity types and their corresponding entity ids; e.g: { entity_type: 'metaphase', entity_id: 'metaphase.work_item.new' }

    2. panel_id,    entity_type: 'work_item',    ids: ['1001', '1002', '1003'] // optional; omit if you want a palette by subtype or field value

      entities: [ <br /> { entity_type: 'metaphase', entity_id: 'metaphase.work_item.new' }, { entity_type: 'metaphase', entity_id: 'metaphase.work_item.intesting' }, { entity_type: 'list_node', entity_id: 'list_node.test_level.unit' }, ]

    3. When the user clicks Apply in the Advanced filter dialog box, OpenText Core Software Delivery Platform does the following:

      When the user closes the Advanced filter dialog, external widget should listen for octane_filter_dialog_closed and get data.filter object which contains the filter selected by the user, and then update the config

    4. Have OpenText Core Software Delivery Platform write the resulting filter JSON into a specific property of your configuration object

      There is also another event called: octane_filter_dialog_closed sent from CSDP to external widget to inform it that the filter dialog has been closed, and provides the filter data as configured by the user

    5. All of these choices are saved in a single configuration object per widget instance, and persisted by OpenText Core Software Delivery Platform

      The filter is not persisted by CSDP. Filter persistence is handled by the external file.

    6. Every scripted widget starts with a JSON configuration file. The file defines the widget's identity and makes it available in the dashboard widget gallery. This JSON configuration defines the following:

      We also introduced a new property called: "Description". It is optional, and it will appear in Widget Gallery under the widget's title

    7. Every scripted widget starts with a JSON configuration file. The file defines the widget's identity and makes it available in the dashboard widget gallery. This JSON configuration defines the following:

      We should also specify that the supported module is dashboard. Besides mode.name: "widget", we need to add: "modules": ["dashboard"]