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.

Refresh DataSources​

Many actions support an optional refreshDataSourcesPayload property that allows selective control over which datasources should be refreshed after the action completes. If refreshDataSourcesPayload is not specified, all datasources will be refreshed.

RefreshDataSourcesPayload Interface​

interface RefreshDataSourcesPayload {
   whitelist?: string[];  // Only these datasources will be refreshed
   blacklist?: string[];  // All datasources EXCEPT these will be refreshed
}

Refresh Logic​

  • Without whitelist/blacklist: ALL datasources are refreshed (default behavior)
  • With whitelist: ONLY datasources listed in the whitelist are refreshed
  • With blacklist: ALL datasources EXCEPT those in the blacklist are refreshed

Datasource Identification Formats​

Two formats are supported for identifying datasources:

  1. Simple name - matches all datasources with the given name

    "crm.customer.get"

  2. Name with argument - matches only the specific datasource with a particular first argument

    "evalScriptByCode('customer.validate')"

Usage Examples​

// Refresh only selected datasources
{
   whitelist: ["crm.customer.get", "evalScriptByCode('customer.validate')"]
}

// Refresh all datasources EXCEPT heavy reports
{
   blacklist: ["crm.heavy.report"]
}

// Combination - specific script + general datasource
{
   whitelist: [
      "evalScriptByCode('muj.spel')",   // Only this specific script
      "crm.customer.get"                 // All calls to this datasource
   ]
}

In Fluent Forms (JSON expressions)​

{
   "id": "${$context.entity.id}",
   "refreshDataSourcesPayload": {
      "whitelist": ["evalScriptByCode('customer.validate')"]
   }
}
{
   "id": "${$context.entity.id}",
   "refreshDataSourcesPayload": {
      "blacklist": ["tickets.heavy.report"]
   }
}

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}" }

Address Management Actions​

LoadAddressById​

Loads an address by its ID.

Type: [Address] Load LoadAddressById

Properties:

  • id (string): The unique identifier of the address.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["address.get", "evalScriptByCode('address.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["address.heavy.report"] } }

LoadAddressByKey​

Loads an address by its key.

Type: [Address] Load LoadAddressByKey

Properties:

  • key (string): The address key.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }
{ "key": "${$value.someKey}", "refreshDataSourcesPayload": { "whitelist": ["address.get", "evalScriptByCode('address.validate')"] } }
{ "key": "${$value.someKey}", "refreshDataSourcesPayload": { "blacklist": ["address.heavy.report"] } }

Billing Actions​

LoadBillingDocumentById​

Loads a billing document by its ID.

Type: [BillingDocument] Load LoadBillingDocumentById

Properties:

  • id (string): The unique identifier of the billing document.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["billing.document.get", "evalScriptByCode('billing.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["billing.heavy.report"] } }

LoadBillingDocumentByKey​

Loads a billing document by its key.

Type: [BillingDocument] Load LoadBillingDocumentByKey

Properties:

  • key (string): The billing document key.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }
{ "key": "${$value.someKey}", "refreshDataSourcesPayload": { "whitelist": ["billing.document.get", "evalScriptByCode('billing.validate')"] } }
{ "key": "${$value.someKey}", "refreshDataSourcesPayload": { "blacklist": ["billing.heavy.report"] } }

Catalog Actions​

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}" }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "code": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6", "catalogCode": "Test.CatalogCode" }
{ "code": "${$value.code}", "catalogCode": "${$value.catalogCode}" }
{ "code": "${$value.code}", "catalogCode": "${$value.catalogCode}", "refreshDataSourcesPayload": { "whitelist": ["catalog.specification.get", "evalScriptByCode('specification.validate')"] } }
{ "code": "${$value.code}", "catalogCode": "${$value.catalogCode}", "refreshDataSourcesPayload": { "blacklist": ["catalog.heavy.report"] } }

LoadCatalogSpecificationById​

Loads a catalog specification by its ID.

Type: [CatalogSpecification] Load LoadCatalogSpecificationById

Properties:

  • id (string): The unique identifier of the specification.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["catalog.specification.get", "evalScriptByCode('specification.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["catalog.heavy.report"] } }

LoadCatalogSpecificationByCode​

Loads a catalog specification by its code.

Type: [CatalogSpecification] Load LoadCatalogSpecificationByCode

Properties:

  • code (string): The specification code.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "code": "Test.Code" }
{ "code": "${$value.someCode}" }
{ "code": "${$value.code}", "refreshDataSourcesPayload": { "whitelist": ["catalog.specification.get", "evalScriptByCode('specification.validate')"] } }
{ "code": "${$value.code}", "refreshDataSourcesPayload": { "blacklist": ["catalog.heavy.report"] } }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["catalog.category.get", "evalScriptByCode('category.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["catalog.heavy.report"] } }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "code": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6", "catalogCode": "Test.CatalogCode" }
{ "code": "${$value.code}", "catalogCode": "${$value.catalogCode}" }
{ "code": "${$value.code}", "catalogCode": "${$value.catalogCode}", "refreshDataSourcesPayload": { "whitelist": ["catalog.category.get", "evalScriptByCode('category.validate')"] } }
{ "code": "${$value.code}", "catalogCode": "${$value.catalogCode}", "refreshDataSourcesPayload": { "blacklist": ["catalog.heavy.report"] } }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["config.registervalue.get", "evalScriptByCode('registervalue.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["config.heavy.report"] } }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "code": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6", "registerCode": "Test.RegisterCode" }
{ "code": "${$value.code}", "registerCode": "${$value.registerCode}" }
{ "code": "${$value.code}", "registerCode": "${$value.registerCode}", "refreshDataSourcesPayload": { "whitelist": ["config.registervalue.get", "evalScriptByCode('registervalue.validate')"] } }
{ "code": "${$value.code}", "registerCode": "${$value.registerCode}", "refreshDataSourcesPayload": { "blacklist": ["config.heavy.report"] } }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["crm.account.get", "evalScriptByCode('account.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["crm.heavy.report"] } }

LoadAccountByKey​

Loads an account by its key.

Type: [Account] Load LoadAccountByKey

Properties:

  • key (string): The account key.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "whitelist": ["crm.account.get", "evalScriptByCode('account.validate')"] } }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "blacklist": ["crm.heavy.report"] } }

LoadCampaignById​

Loads a campaign by its ID.

Type: [Campaign] Load LoadCampaignById

Properties:

  • id (string): The unique identifier of the campaign.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["crm.campaign.get", "evalScriptByCode('campaign.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["crm.heavy.report"] } }

LoadCampaignByCode​

Loads a campaign by its code.

Type: [Campaign] Load LoadCampaignByCode

Properties:

  • code (string): The campaign code.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "code": "Test.Code" }
{ "code": "${$value.someCode}" }
{ "code": "${$context.entity.code}", "refreshDataSourcesPayload": { "whitelist": ["crm.campaign.get", "evalScriptByCode('campaign.validate')"] } }
{ "code": "${$context.entity.code}", "refreshDataSourcesPayload": { "blacklist": ["crm.heavy.report"] } }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["crm.customer.get", "evalScriptByCode('customer.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["crm.heavy.report"] } }

LoadCustomerByKey​

Loads a customer by its key.

Type: [Customer] Load LoadCustomerByKey

Properties:

  • key (string): The customer key.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }
{ "key": "${$value.someKey}", "refreshDataSourcesPayload": { "whitelist": ["crm.customer.get", "evalScriptByCode('customer.validate')"] } }
{ "key": "${$value.someKey}", "refreshDataSourcesPayload": { "blacklist": ["crm.heavy.report"] } }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["crm.lead.get", "evalScriptByCode('lead.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["crm.heavy.report"] } }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "whitelist": ["crm.lead.get", "evalScriptByCode('lead.validate')"] } }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "blacklist": ["crm.heavy.report"] } }

LoadPersonById​

Loads a person by their ID.

Type: [Person] Load LoadPersonById

Properties:

  • id (string): The unique identifier of the person.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["crm.person.get", "evalScriptByCode('person.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["crm.heavy.report"] } }

LoadPersonByKey​

Loads a person by their key.

Type: [Person] Load LoadPersonByKey

Properties:

  • key (string): The person key.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "whitelist": ["crm.person.get", "evalScriptByCode('person.validate')"] } }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "blacklist": ["crm.heavy.report"] } }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "whitelist": ["ordering.order.get", "evalScriptByCode('order.validate')"] } }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "blacklist": ["ordering.heavy.report"] } }

LoadOrderById​

Loads an order by its ID.

Type: [Order] Load LoadOrderById

Properties:

  • id (string): The unique identifier of the order.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["ordering.order.get", "evalScriptByCode('order.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["ordering.heavy.report"] } }

LoadOrderLinesByOrderId​

Loads order lines by order ID.

Type: [OrderLine] Load LoadOrderLinesByOrderId

Properties:

  • orderId (string): The order ID.

Examples:

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

LoadOrderLineById​

Loads an order line by its ID.

Type: [OrderLine] Load LoadOrderLineById

Properties:

  • id (string): The unique identifier of the order line.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["ordering.orderline.get", "evalScriptByCode('orderline.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["ordering.heavy.report"] } }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "module": "Ticketing", "executionId": "${$context.entity.executionId}", "activityId": "${$context.entity.activityId}" }
{ "module": "Ticketing", "executionId": "${$context.entity.executionId}", "activityId": "${$context.entity.activityId}", "refreshDataSourcesPayload": { "whitelist": ["process.task.get", "evalScriptByCode('task.validate')"] } }
{ "module": "Ticketing", "executionId": "${$context.entity.executionId}", "activityId": "${$context.entity.activityId}", "refreshDataSourcesPayload": { "blacklist": ["process.heavy.report"] } }

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.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "module": "Ticketing", "businessKey": "ef8a961c-751e-4ae3-98c8-743b997ee869", "history": true }
{ "module": "${$value.module}", "businessKey": "${$value.businessKey}", "history": "${$value.history}" }
{ "module": "Ticketing", "businessKey": "${$context.entity.id}", "history": true, "refreshDataSourcesPayload": { "whitelist": ["process.task.get", "evalScriptByCode('task.validate')"] } }
{ "module": "Ticketing", "businessKey": "${$context.entity.id}", "history": true, "refreshDataSourcesPayload": { "blacklist": ["process.heavy.report"] } }

Stock Actions​

LoadStockItemById​

Loads a stock item by its ID.

Type: [StockItem] Load LoadStockItemById

Properties:

  • id (string): The unique identifier of the stock item.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["stock.item.get", "evalScriptByCode('stockitem.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["stock.heavy.report"] } }

LoadStockItemByKey​

Loads a stock item by its key.

Type: [Stock] Load LoadStockItemByKey

Properties:

  • key (string): The stock item key.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.someKey}" }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "whitelist": ["stock.item.get", "evalScriptByCode('stockitem.validate')"] } }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "blacklist": ["stock.heavy.report"] } }

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}" }

LoadStockItemByEntCatSpecRef​

Loads a stock item by its entity catalog specification reference.

Type: [StockItem] Load LoadStockItemByEntCatSpecRef

Properties:

  • entCatSpecRef (string): The entity catalog specification reference.

Examples:

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

LoadStockById​

Loads stock by its ID.

Type: [Stock] Load LoadStockById

Properties:

  • id (string): The unique identifier of the stock.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["stock.get", "evalScriptByCode('stock.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["stock.heavy.report"] } }

LoadStockByKey​

Loads stock by its key.

Type: [Stock] Load LoadStockByKey

Properties:

  • key (string): The stock key.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.key}" }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "whitelist": ["stock.get", "evalScriptByCode('stock.validate')"] } }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "blacklist": ["stock.heavy.report"] } }

Tickets Actions​

LoadTicketById​

Loads a ticket by its ID.

Type: [Ticket] Load LoadTicketById

Properties:

  • id (string): The unique identifier of the ticket.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "id": "0ea3fbb4-b32a-4d7d-8a0d-c10c7c2b4ab6" }
{ "id": "${$context.entity.id}" }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "whitelist": ["tickets.get", "evalScriptByCode('ticket.validate')"] } }
{ "id": "${$context.entity.id}", "refreshDataSourcesPayload": { "blacklist": ["tickets.heavy.report"] } }

LoadTicketByKey​

Loads a ticket by its key.

Type: [Ticket] Load LoadTicketByKey

Properties:

  • key (string): The ticket key.
  • refreshDataSourcesPayload (RefreshDataSourcesPayload): Optional datasource refresh configuration.

Examples:

{ "key": "Test.Key" }
{ "key": "${$value.key}" }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "whitelist": ["tickets.get", "evalScriptByCode('ticket.validate')"] } }
{ "key": "${$context.entity.key}", "refreshDataSourcesPayload": { "blacklist": ["tickets.heavy.report"] } }

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.