Skip to main content

Other Settings

SOLID provides various system-wide settings and configurations to manage your application's behavior and functionality.

Overview​

The Settings module includes:

  • List of Values management
  • Message and Queue logs
  • Import/Export job tracking
  • Saved views management
  • System configurations

List of Values​

Purpose​

  • Manage reusable value lists
  • Centralize dropdown options
  • Maintain data consistency
  • Support multiple languages
  • Version control values

Configuration​

{
  "list": {
    "name": "status_codes",
    "description": "Common status codes for orders",
    "type": "string",
    "values": [
      {
        "value": "pending",
        "label": {
          "en": "Pending",
          "es": "Pendiente"
        }
      },
      {
        "value": "processing",
        "label": {
          "en": "Processing",
          "es": "Procesando"
        }
      },
      {
        "value": "completed",
        "label": {
          "en": "Completed",
          "es": "Completado"
        }
      }
    ]
  }
}

Message & Queue Logs​

Message Log​

  • Track system messages
  • Monitor notifications
  • Debug delivery issues
  • View message history
  • Export log data
{
  "messageLog": {
    "filters": {
      "type": ["email", "sms"],
      "status": ["sent", "failed"],
      "dateRange": {
        "start": "2024-01-01",
        "end": "2024-01-31"
      }
    },
    "columns": [
      "timestamp",
      "type",
      "recipient",
      "subject",
      "status",
      "error"
    ]
  }
}

Queue Log​

  • Monitor job queues
  • Track job status
  • View error details
  • Retry failed jobs
  • Performance metrics
{
  "queueLog": {
    "queues": {
      "email": {
        "status": "active",
        "jobs": {
          "pending": 5,
          "processing": 2,
          "failed": 1
        },
        "metrics": {
          "avgProcessingTime": "2.5s",
          "throughput": "100/min"
        }
      }
    }
  }
}

Import & Export Jobs​

Import Management​

  • Track import progress
  • Validate data
  • Handle errors
  • Map fields
  • Schedule imports
{
  "import": {
    "source": {
      "type": "csv",
      "file": "customers.csv",
      "encoding": "UTF-8"
    },
    "mapping": {
      "email": "Email Address",
      "firstName": "First Name",
      "lastName": "Last Name"
    },
    "options": {
      "skipHeader": true,
      "batchSize": 1000,
      "onError": "skip"
    }
  }
}

Export Management​

  • Configure exports
  • Format options
  • Schedule exports
  • Delivery options
  • Track progress
{
  "export": {
    "target": {
      "type": "csv",
      "filename": "sales_report_{{date}}"
    },
    "data": {
      "query": {
        "model": "sales",
        "filters": {
          "date": {
            "gte": "{{startDate}}",
            "lte": "{{endDate}}"
          }
        }
      }
    },
    "schedule": {
      "frequency": "monthly",
      "day": 1,
      "time": "00:00",
      "timezone": "UTC"
    }
  }
}

Saved Views​

View Management​

  • Save custom views
  • Share with teams
  • Set defaults
  • Manage permissions
  • Version control
{
  "savedView": {
    "name": "High Value Orders",
    "resource": "orders",
    "type": "list",
    "config": {
      "filters": {
        "total": {
          "gte": 1000
        },
        "status": ["pending", "processing"]
      },
      "sort": [
        {
          "field": "total",
          "direction": "desc"
        }
      ],
      "columns": [
        "orderNumber",
        "customer",
        "total",
        "status",
        "createdAt"
      ]
    },
    "sharing": {
      "roles": ["sales_manager", "account_executive"],
      "isDefault": false
    }
  }
}

Common Operations​

Managing Lists​

{
  "operation": "createList",
  "list": {
    "name": "priority_levels",
    "values": [
      {
        "value": "high",
        "label": "High Priority",
        "color": "red"
      },
      {
        "value": "medium",
        "label": "Medium Priority",
        "color": "yellow"
      },
      {
        "value": "low",
        "label": "Low Priority",
        "color": "green"
      }
    ]
  }
}

Monitoring Queues​

{
  "operation": "getQueueMetrics",
  "queues": ["email", "sms", "notifications"],
  "metrics": [
    "jobCount",
    "processingTime",
    "errorRate",
    "throughput"
  ],
  "timeframe": {
    "last": "24h"
  }
}

Managing Imports​

{
  "operation": "importData",
  "config": {
    "source": {
      "type": "excel",
      "file": "products.xlsx",
      "sheet": "Sheet1"
    },
    "target": {
      "model": "products",
      "mode": "upsert",
      "key": "sku"
    },
    "validation": {
      "stopOnError": false,
      "errorThreshold": 0.1
    }
  }
}

Creating Views​

{
  "operation": "createView",
  "view": {
    "name": "Active Projects",
    "resource": "projects",
    "type": "kanban",
    "config": {
      "groupBy": "status",
      "columns": ["todo", "in_progress", "review", "done"],
      "cardFields": [
        "title",
        "assignee",
        "dueDate",
        "priority"
      ]
    }
  }
}

Best Practices​

List of Values

  • Use meaningful names
  • Document purpose
  • Consider translations
  • Regular reviews
  • Version control

Logging

  • Set retention periods
  • Monitor storage
  • Regular cleanup
  • Error alerts
  • Performance monitoring

Import/Export

  • Validate data
  • Handle errors gracefully
  • Schedule off-peak
  • Monitor resources
  • Backup data

Saved Views

  • Clear naming
  • Document purpose
  • Regular cleanup
  • Test performance
  • Review permissions