GPortal UI Controller icon

GPortal UI Controller

GPortal UI Controller

GPortal UI Controller

AI-generated

Overview

This node, named 'GPortal UI Controller', is designed to interact with the GPortal API to create or update entities within the GPortal system. It is useful in scenarios where users want to programmatically manage entities by either creating new ones or updating existing ones, with the ability to specify default field values dynamically. For example, it can be used in workflows that automate entity management in an organizational context, broadcasting UI commands to a GPortal socket server to trigger UI updates or actions.

Use Case Examples

  1. Creating a new entity with specified version and default field values.
  2. Updating an existing entity by its ID with new default field values.

Properties

Name Meaning
Action Specifies whether to create a new entity or update an existing one.
Entity Name or ID The name or ID of the entity to create. This is selectable from a list or can be specified via expression. Only shown when creating an entity.
Version The version number of the entity to create. Only shown when creating an entity.
Entity ID The ID of the entity to update. Only shown when updating an entity.
Default Field Values JSON object specifying default values for the entity's fields. Supports expressions for dynamic values. Shown for both create and update actions.

Output

JSON

  • executionId - The unique execution ID of the current workflow run.
  • currentStepName - The name of the current node executing the action.
  • currentAction - The action performed, either 'createEntity' or 'updateEntity'.
  • workflowId - The ID of the workflow running this node.
  • nodeExecutionsData
    • entityName - The name or ID of the entity being created (if action is createEntity).
    • entityId - The ID of the entity being updated (if action is updateEntity).
    • version - The version of the entity to create (if action is createEntity).
    • defaultFieldValues - The default field values provided for the entity in JSON format.

Dependencies

  • Requires credentials for GPortal API including domain and token for authentication.

Troubleshooting

  • If the 'defaultFieldValues' JSON is malformed, the node logs a warning and uses an empty object instead.
  • Errors during broadcasting to the GPortal socket server are logged; ensure the API credentials and domain are correctly configured.
  • If parameters are missing or invalid, warnings are logged; verify that all required parameters are provided according to the selected action.

Discussion