Skip to main content
Version: 2.4

Success Actions / Error Actions

These actions are used in ButtonComponent (via successActions, errorActions inputs) to trigger specific side effects or state changes after a button operation completes (either successfully or with an error).

Most commonly, they are used after executing a SPEL script to define how the application should react depending on whether the script finished successfully or encountered an error.

Core Actions​

Logout​

Performs a user logout.

Type: [Core] Logout

Navigates to a specific URL.

Type: [Core] Navigate

Properties:

  • url (string | UrlTree): The destination URL.
  • extras (NavigationExtras): Optional navigation extras.
  • newTab (boolean): Whether to open in a new tab.

Examples:

{ "url": "/dashboard", "extras": { "queryParams": { "user": "john", "active": true } }, "newTab": true }
{ "url": "${$value.url}", "extras": "${$value.extras}", "newTab": "${$value.newTab}" }

HardReload​

Performs a hard reload of the application.

Type: [Core] HardReload

ShowMessage​

Displays a toast message to the user.

Type: [Core] ShowMessage

Properties:

  • text (string): The message text.
  • severity (ToastSeverity): The severity of the message (e.g., 'success', 'error').
  • title (string): Optional title for the message.

Examples:

{ "text": "Successfully updated!", "severity": "success", "title": "SUCCESS" }
{ "text": "${$value.text}", "severity": "${$value.severity}", "title": "${$value.title}" }

Catalog Actions​

LoadCatalogSpecificationByCodeAndCatalogType​

Loads a catalog specification using its code and catalog code.

Type: [CatalogSpecification] Load LoadCatalogSpecificationByCodeAndCatalogType

Properties:

  • code (string): The specification code.
  • catalogCode (string): The catalog code.

Examples:

{ "code": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6", "catalogCode": "Test.CatalogCode" }
{ "code": "${$value.code}", "catalogCode": "${$value.catalogCode}" }

LoadCatalogSpecificationById​

Loads a catalog specification by its ID.

Type: [CatalogSpecification] Load LoadCatalogSpecificationById

Properties:

  • id (string): The unique identifier of the specification.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadCatalogSpecificationByCode​

Loads a catalog specification by its code.

Type: [CatalogSpecification] Load LoadCatalogSpecificationByCode

Properties:

  • code (string): The specification code.

Examples:

{ "code": "Test.Code" }
{ "code": "${$value.someCode}" }

LoadCatalogCategoryById​

Loads a catalog category by its ID.

Type: [CatalogCategory] Load LoadCatalogCategoryById

Properties:

  • id (string): The unique identifier of the category.
  • forceRefresh (boolean): Optional flag to force a refresh.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadCatalogCategoryByCodeAndCatalogCode​

Loads a catalog category by its code and catalog code.

Type: [CatalogCategory] Load LoadCatalogCategoryByCodeAndCatalogCode

Properties:

  • code (string): The category code.
  • catalogCode (string): The catalog code.
  • forceRefresh (boolean): Optional flag to force a refresh.

Examples:

{ "code": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6", "catalogCode": "Test.CatalogCode" }
{ "code": "${$value.code}", "catalogCode": "${$value.catalogCode}" }

LoadCatalogById​

Loads a catalog by its ID.

Type: [Catalog] Load LoadCatalogById

Properties:

  • id (string): The unique identifier of the catalog.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadCatalogByCode​

Loads a catalog by its code.

Type: [Catalog] Load LoadCatalogByCode

Properties:

  • code (string): The catalog code.

Examples:

{ "code": "Test.Code" }
{ "code": "${$value.someCode}" }

Config Form Actions​

LoadRegisterValueById​

Loads a register value by its ID.

Type: [RegisterValue] LoadById RegisterValue

Properties:

  • id (string): The unique identifier of the register value.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadBatchRegisterValueByRegisterCodeAndCode​

Loads register values by register code and value code.

Type: [RegisterValue] LoadBatchByRegisterVaRegisterCodeAndCode

Properties:

  • registerCode (string): The code of the register.
  • code (string): The code of the value.

Examples:

{ "code": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6", "registerCode": "Test.RegisterCode" }
{ "code": "${$value.code}", "registerCode": "${$value.registerCode}" }

LoadRegisterById​

Loads a register by its ID.

Type: [Register] Load Register by id

Properties:

  • id (string): The unique identifier of the register.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadRegisterByCode​

Loads a register by its code.

Type: [Register] Load Register by code

Properties:

  • code (string): The register code.

Examples:

{ "code": "Test.Code" }
{ "code": "${$value.someCode}" }

Customer Actions​

LoadAccountById​

Loads an account by its ID.

Type: [Account] Load LoadAccountById

Properties:

  • id (string): The unique identifier of the account.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadAccountByKey​

Loads an account by its key.

Type: [Account] Load LoadAccountByKey

Properties:

  • key (string): The account key.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }

LoadCampaignById​

Loads a campaign by its ID.

Type: [Campaign] Load LoadCampaignById

Properties:

  • id (string): The unique identifier of the campaign.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadCampaignByCode​

Loads a campaign by its code.

Type: [Campaign] Load LoadCampaignByCode

Properties:

  • code (string): The campaign code.

Examples:

{ "code": "Test.Code" }
{ "code": "${$value.someCode}" }

LoadCustomerById​

Loads a customer by its ID.

Type: [Customer] Load LoadCustomerById

Properties:

  • id (string): The unique identifier of the customer.
  • loadAll (boolean): Whether to load all related data.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadCustomerByKey​

Loads a customer by its key.

Type: [Customer] Load LoadCustomerByKey

Properties:

  • key (string): The customer key.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }

LoadLeadById​

Loads a lead by its ID.

Type: [Lead] Load LoadLeadById

Properties:

  • id (string): The unique identifier of the lead.
  • loadAll (boolean): Whether to load all related data.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadLeadByKey​

Loads a lead by its key.

Type: [Lead] Load LoadLeadByKey

Properties:

  • key (string): The lead key.
  • loadAll (boolean): Whether to load all related data.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }

LoadPersonById​

Loads a person by their ID.

Type: [Person] Load LoadPersonById

Properties:

  • id (string): The unique identifier of the person.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadPersonByKey​

Loads a person by their key.

Type: [Person] Load LoadPersonByKey

Properties:

  • key (string): The person key.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }

Inventory Actions​

LoadEntityInstanceConfigurationById​

Loads an entity instance configuration by its ID.

Type: [Inventory] Load EntityInstanceConfiguration By Id

Properties:

  • id (string): The unique identifier of the configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadEntityInstanceConfigurationByKey​

Loads an entity instance configuration by its key.

Type: [Inventory] Load EntityInstanceConfiguration By Key

Properties:

  • key (string): The configuration key.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }

Ordering Actions​

LoadOrderByKey​

Loads an order by its key.

Type: [Order] Load LoadOrderByKey

Properties:

  • key (string): The order key.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }

LoadOrderLinesByOrderId​

Loads an order by its key.

Type: [OrderLine] Load LoadOrderLinesByOrderId

Properties:

  • orderId (string): The order id.

Examples:

{ "orderId": "${$value.orderId}" }

LoadOrderById​

Loads an order by its ID.

Type: [Order] Load LoadOrderById

Properties:

  • id (string): The unique identifier of the order.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadOrderLineById​

Loads an order line by its ID.

Type: [OrderLine] Load LoadOrderLineById

Properties:

  • id (string): The unique identifier of the order line.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

Process Actions​

LoadTaskByExecutionIdAndActivityId​

Loads a task using its execution ID and activity ID.

Type: [Task] Load LoadTaskByExecutionIdAndActivityId

Properties:

  • module (string): The module name.
  • executionId (string): The execution ID.
  • activityId (string): The activity ID.

LoadTasksByBusinessKey​

Loads tasks by business key.

Type: [Task] Load LoadTasksByBusinessKey

Properties:

  • module (string): The module name.
  • businessKey (string): The business key.
  • history (boolean): Whether to include history.

Examples:

{ "module": "Ticketing", "businessKey": "ef8a961c-751e-4ae3-98c8-743b997ee869", "history": true }
{ "module": "${$value.module}", "businessKey": "${$value.businessKey}", "history": "${$value.history}" }

Stock Actions​

LoadStockItemById​

Loads a stock item by its ID.

Type: [StockItem] Load LoadStockItemById

Properties:

  • id (string): The unique identifier of the stock item.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadStockItemByKey​

Loads a stock item by its key.

Type: [Stock] Load LoadStockItemByKey

Properties:

  • key (string): The stock item key.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }

LoadStockItemBySerialNumber​

Loads a stock item by its serial number.

Type: [StockItem] Load LoadStockItemBySerialNumber

Properties:

  • serialNumber (string): The serial number.

Examples:

{ "serialNumber": "123456789" }
{ "serialNumber": "${$value.serialNumber}" }

LoadStockById​

Loads stock by its ID.

Type: [Stock] Load LoadStockById

Properties:

  • id (string): The unique identifier of the stock.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadStockByKey​

Loads stock by its key.

Type: [Stock] Load LoadStockByKey

Properties:

  • key (string): The stock key.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.key}" }

Tickets Actions​

LoadTicketById​

Loads a ticket by its ID.

Type: [Ticket] Load LoadTicketById

Properties:

  • id (string): The unique identifier of the ticket.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }

LoadTicketByKey​

Loads a ticket by its key.

Type: [Ticket] Load LoadTicketByKey

Properties:

  • key (string): The ticket key.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.key.id}" }

Usage in Components​

These actions are primarily used in the following components, often passed as successActions or errorActions inputs or configured via metadata:

  • ButtonComponent (dtl-button): Accepts successActions and errorActions inputs to execute after button operations.
  • FluentInplaceComponent (dtl-fluent-inplace): Accepts successActions and errorActions inputs, triggered after saving inplace edits.