Platform Parameters and File Storage
This page is a reference for the platform’s underlying configuration catalogue and its file storage setup. These are advanced settings, usually managed with support, but documented here for completeness.
Parameter Keys
Section titled “Parameter Keys”A parameter key defines a configurable setting in the platform: its type (text, number or yes/no), who can see and change it, and whether different contexts can hold their own value. Together, parameter keys are the catalogue of every option the platform exposes.
Identification
Section titled “Identification”Basic identification information for this parameter key.
No fields defined for this section.
Parameter Definition
Section titled “Parameter Definition”Core parameter definition including section, name, and display information.
| Field | Description |
|---|---|
| Parameter Section | The section this parameter belongs to |
| Display Parent Section | Optional parent section used only for grouping in the parameter list; falls back to Parameter Section when blank |
| Display Section | The display section name shown in the user interface |
| Parameter Name | The internal name of this parameter |
| Display Name | The user-friendly name shown in the interface |
| Description | Detailed description of what this parameter controls |
Configuration
Section titled “Configuration”Parameter type, access levels, and inheritance settings.
| Field | Description |
|---|---|
| Parameter Type | The data type of this parameter (1=text, 2=multiline, 10=numeric, etc.) |
| Parameter Set ID | ID of the parameter set for constrained values |
| Variant Class ID | ID of the variant class for parameter variations |
| Secondary Variant Class ID | ID of the secondary variant class for additional parameter variations |
| User Specific | Whether this parameter can have different values per user |
| Multiple Match Resolution | How multiple matching user-specific values are resolved: single, bitwise-or, or maximum |
| View Level | Minimum access level required to view this parameter |
| Edit Level | Minimum access level required to edit this parameter |
Default Values
Section titled “Default Values”Default value and variant class configuration.
| Field | Description |
|---|---|
| Default Value | The default value for this parameter |
| Inherit From Section | Section to inherit parameter value from |
| Inherit From Name | Parameter name to inherit value from |
Parameter Values
Section titled “Parameter Values”A parameter value is the actual setting stored against a parameter key. Values can apply system-wide or be set for a specific user, user group or department, so the same setting can differ by context, such as per-client email server settings.
Fields
Section titled “Fields”| Field | Description |
|---|---|
| Parameter Value ID | The unique identifier for this parameter value |
| Parameter Variant | Primary variant identifier for context-specific parameter values |
| Parameter Secondary Variant | Secondary variant identifier for additional context specificity |
| User | User this parameter value is specific to, if user-specific |
| Users | Multiple users this parameter value applies to |
| User Groups | User groups this parameter value applies to |
| Departments | Departments this parameter value applies to |
| Parameter Value | The actual parameter value content |
| Last Modified | Timestamp of the most recent modification to this parameter value |
| Created | Timestamp when this parameter value was created |
Naming rules on settings lists
Section titled “Naming rules on settings lists”Names on the platform’s settings lists are checked without regard to case. A second entry named Qualified alongside an existing qualified is refused when it is saved, rather than becoming a name that neither the API nor Bulk Actions can resolve.
The rule covers the billing lookups, the CRM settings and the task type registries. Two names are scoped rather than global, so the same name may still be reused: deal and chase stage names are unique within their pipeline, and sequence step names within their sequence.
The Sales Targets form applies the same idea to a different field: it refuses a second target for the same period, scope and metric, however it is created.
Customising fixed dropdown options
Section titled “Customising fixed dropdown options”Object Customisations lets administrators remove or rename fixed options in a field’s dropdown. These are choices such as Auto (Number) or Auto (Customer), offered alongside records you can select.
Use this when staff should choose a specific record instead of an automatic option. Keep the options you need and give them suitable labels. An empty option list removes all fixed choices; a field that allows a blank value still allows one.
Customisations can only remove or rename options already defined for that field. They cannot add new values. The choices apply to add and edit forms, including inline add forms and their dropdowns.
Ask your administrator or support to configure the field under Object Customisations.
SMS on non-live platforms
Section titled “SMS on non-live platforms”On a non-live platform, customer SMS can reach only the handsets listed under TEST destinations for customer SMS.
An empty list permits no outbound SMS. Administrators should check the permitted destinations before testing. See Twilio setup.
Email on non-live platforms
Section titled “Email on non-live platforms”TEST whitelist for customer emails controls which intended recipients can receive customer email on a non-live platform.
Enter one full email address or exact domain, such as @example.com, per line. List subdomains separately. Blank lines and lines beginning with # are ignored.
An empty whitelist permits nobody. Unapproved recipients are suppressed; messages are not redirected to a substitute test address.
Check the sandbox banner and permitted recipients before testing customer messages.
Stored File Providers
Section titled “Stored File Providers”A stored file provider configures a place files can be saved, from local disk to cloud services like AWS or Google Drive. Each provider holds its connection and authentication settings, and the platform routes files to the right provider by priority and need.
Identification
Section titled “Identification”Basic identification information for this stored file provider.
No fields defined for this section.
Provider Details
Section titled “Provider Details”Provider name and basic configuration.
| Field | Description |
|---|---|
| Stored File Provider | The name of this file storage provider |
Connection Settings
Section titled “Connection Settings”Authentication and connection parameters for the storage provider.
| Field | Description |
|---|---|
| Stored File Provider Type | The type of storage provider (determines available connection options) |
| Login | Login credentials for the storage provider |
| Client Secret | Client secret for OAuth authentication |
| Refresh Token | OAuth refresh token |
| Access Token | OAuth access token |
| Secret Key | Secret key for API authentication |
| API Key | API key for service authentication |
| Key File | Private key file content for authentication |
| Connection String | Complete connection string for the storage service |
Usage Settings
Section titled “Usage Settings”File type and priority configuration for this provider.
| Field | Description |
|---|---|
| Use For Files | File types this provider should be used for |
| Priority | Priority level for this storage provider |
Stored File Provider Types
Section titled “Stored File Provider Types”A stored file provider type is a category of storage, such as local disk, AWS S3 or Google Cloud Storage. Each type defines the connection settings a provider of that kind needs and how the platform talks to it.
Stored File Provider Type Name
Section titled “Stored File Provider Type Name”Basic identification and display settings for the stored file provider type, including the name, display class, and position ordering for user interface presentation.
| Field | Description |
|---|---|
| Stored File Provider Type | Name of the stored file provider type |
| Stored File Provider Type Display Class | CSS class used for displaying this stored file provider type in the interface |
| Stored File Provider Type Display Position | Numeric position for ordering stored file provider types in lists and displays |
Settings
Section titled “Settings”Configuration settings for the stored file provider type, including connection settings that define how the provider connects to external storage services.
| Field | Description |
|---|---|
| Use Connection Settings | Connection settings that define how this provider type connects to external storage services |
Related
Section titled “Related”- Disaster Recovery Files: the encrypted backups the platform produces.
- Bulk Import Files: bringing data into the platform in bulk.
Want billing that bends to your exact configuration and storage needs? see how flexible SAFE Billing Platform can be