Configuration Tools
Overview
Configurations store typed, cacheable key/value settings that logic reads at runtime. Logic Assist supports searching, listing, reading, creating, and updating Configuration records. Requires Logic Composer.
CacheEntryStrategy values:
| Value | Meaning |
|---|---|
Volatile | The data can change at any time |
Ephemeral | The data is stored for a short duration, as specified by its time-to-live (TTL) |
Constant | The value never changes and can be cached indefinitely |
The type parameter is a .NET TypeCode describing the data type of the configuration value (e.g. String, Int32, Boolean, Decimal, DateTime), and timeToLive is expressed in minutes.
search_configuration
Searches Logic Fabric configurations by name.
| Parameter | Type | Required | Description |
|---|---|---|---|
configurationName | string | ✓ | The name of the configuration to search for. |
Returns: Matching Configurations including name, title, description, and project.
list_configurations
Lists all Logic Fabric configurations.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | GUID | The ID of the project to filter configurations by. Optional. | |
pageNumber | int | The page number for pagination. If not provided, defaults to the first page. Optional. | |
pagingCookie | string | The paging cookie for pagination. This should be provided if pageNumber is provided and there are more records to retrieve. Optional. |
Returns: A paginated list of Configurations including name, title, description, and project.
See Pagination for details on iterating through large result sets.
get_configuration_details
Gets the details for a Logic Fabric configuration by configuration id.
| Parameter | Type | Required | Description |
|---|---|---|---|
configurationId | GUID | ✓ | The ID of the configuration. |
Returns: Full Configuration details including name, value, type, cache strategy, time-to-live, title, description, and project.
get_configuration_preview_url
Get a preview URL for a Logic Fabric configuration.
| Parameter | Type | Required | Description |
|---|---|---|---|
configurationName | string | ✓ | The name of the configuration. |
projectId | GUID | ✓ | The ID of the project for the configuration. |
value | string | ✓ | The value for the configuration. |
cacheEntryStrategy | CacheEntryStrategy | ✓ | The cache entry strategy for the configuration. |
timeToLive | int | ✓ | The time to live for the configuration cache entry in minutes. |
title | string | The title for the configuration. Optional. | |
description | string | The description for the configuration. Optional. |
Returns: A preview URL for the configuration record.
create_configuration
Creates a new Logic Fabric configuration and returns the configuration id.
| Parameter | Type | Required | Description |
|---|---|---|---|
configurationName | string | ✓ | The name of the configuration to create. |
projectId | GUID | ✓ | The ID of the project to create the configuration in. |
type | TypeCode | ✓ | The type of the configuration value. |
value | string | ✓ | The value for the configuration. |
cacheEntryStrategy | CacheEntryStrategy | ✓ | The cache entry strategy for the configuration. |
timeToLive | int | ✓ | The time to live for the configuration cache entry in minutes. |
title | string | The title for the configuration. Optional. | |
description | string | The description for the configuration. Optional. |
Returns: The GUID of the newly created Configuration and its URL.
Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.
update_configuration_value
Updates a Logic Fabric configuration value.
| Parameter | Type | Required | Description |
|---|---|---|---|
configurationId | GUID | ✓ | The ID of the configuration to update. |
value | string | ✓ | The new value for the configuration. |
Returns: Confirmation that the configuration value was updated.
Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.
Best practice: Always call get_configuration_details first to read the current value and settings before updating.