Security Secrets Reference

Securely store credentials and secrets.

Reference → Modules → Security → UI → RuntimeUsers | Users | Permissions | Policies | Secrets | Monitor

Configuration Properties

Access at: Security → Secrets

Important: Only administrators can view or edit SecretValue. Standard users can reference secrets in configurations but cannot see the actual values.

Secret Reference Syntax

A secret is referenced (never pasted inline) from any password or credential field using a single, platform-wide syntax:

/secret:<Name>

The colon form is the stored syntax that FrameworX resolves at runtime. Older documentation showing a dash form (/secret-<Name>) is stale — use the colon form.

In the Designer, most fields that accept a secret reference render with a dropdown picker that writes the correct /secret:<Name> value for you; the field may also display a friendly label like [Secret: <Name>] — that is the UI label, while the stored value is always /secret:<Name>.

Embedded form (composite strings)

Inside a larger configuration string (such as a connection string that mixes plain text and one or more secrets), the embedded form is used:

#</secret:<Name>/secret>

The same server-side resolver decrypts both forms.

Where it resolves

Resolution happens server-side during value decryption. Password-bearing fields that already flow through the platform's TPassword decryption pipeline get secret resolution automatically — consumer modules (Dataset, Device, TagProvider, Historian) do not implement their own lookup. A missing or misnamed reference silently returns the raw text unchanged, which means the downstream connection attempt will fail as if the password were wrong; check the audit log to diagnose.

Usage in Configurations

Datasets Integration

When configuring database connections:

1. Navigate to Datasets → DBs
2. In the LogonPassword field, either type the reference directly or click the secret picker
3. The field stores /secret:<Name>; the Designer may display it as [Secret: <Name>]
4. Connection uses the decrypted value at runtime

Stored value example:

Database: RuntimeUsers
Authentication: SQL Server Auth
Username: dbuser
LogonPassword: /secret:DBRuntimePass

See Datasets DBs Reference for the complete DB-row schema.

Device/TagProvider Integration

For MQTT, OPC UA, and other protocols:

1. Navigate to Devices → Channels or TagProviders
2. In authentication fields, use the secret reference syntax
3. Format: /secret:<SecretName>

Example:

MQTT Broker Authentication:
Username: mqttuser
Password: /secret:MQTTBrokerPass

Script Access

Configuration Examples

Basic Secret Setup

Runtime Users Database Example

1. Create secret:
   • Name: RuntimeUsersDBPass
   • Type: Password
   • Value: [encrypted]
   • Description: RuntimeUsers SQL authentication
2. Use in Dataset:
   • Go to Datasets → DBs → RuntimeUsers
   • Set the LogonPassword field to: /secret:RuntimeUsersDBPass

Security Considerations

Access Control Matrix

Encryption Details

• Values encrypted using AES-256
• Stored encrypted in the solution file
• Decrypted only at runtime, server-side
• Never logged in plain text
• Not included in solution exports — the target system must recreate values

Best Practices

Naming Conventions

Implementation Guidelines

1. Create secrets before configuration
   • Define all secrets in the Security module first
   • Then reference in other modules using /secret:<Name>
2. Use descriptive names
   • Good: ProductionSQLPass
   • Bad: Secret1
3. Document usage
   • Always fill the Description field
   • Include where the secret is used
   • Note rotation schedule if applicable
4. Regular rotation
   • Change production secrets periodically
   • Update the SecretValue — references stay the same
   • Test thoroughly after changes
5. Environment separation
   • Use different secrets for Dev/Test/Production
   • Name accordingly: DevDBPass, ProdDBPass

Migration and Portability

Exporting Solutions

When exporting solutions:

• Secret names and types are exported
• Secret values are NOT exported
• The target system must recreate values
• /secret:<Name> references in consumer fields carry over unchanged — recreate the secrets with the same Names to keep references valid

Import Process

1. Import solution to new system
2. Navigate to Security → Secrets
3. For each secret, enter appropriate value
4. Test all connections

Troubleshooting

Common Issues

Validation

Test secret configuration:

1. Create test secret
2. Reference in test connection as /secret:<Name>
3. Verify connection succeeds
4. Check runtime logs for errors

Audit Trail

Secret operations are logged:

• Creation/modification timestamp
• User who made changes
• NOT the actual values

See Also

• Security Module Reference — Complete security documentation
• Datasets DBs Reference — LogonPassword accepts /secret:<Name>
• Security Module How-to — Security guidelines

In this section...