System Configuration Documentation

The Mobile2b System Configuration gives administrators fine-grained control of the functionality of the platform.

The configuration uses the YAML markup language. In this documentation all available configuration parameters are listed including their expected value types and default values.

            
start:
  #
  carousel:
  - imageUrl: "IMAGE_LINK"
  # not mandatory
  title:
      en: "Some Title"
  # not mandatory
  subTitle:
      en: "Some Sub-Title"
  #
  tiles:
   - title:
      en: "Some Title"
   icon: "LINK_TO_IMAGE"
   action:
      type: "LIST_BUSINESS_OBJECTS" or "START_WORKFLOW" or "OPEN_INTERNAL_URL"
      data:
        modelId: "5de67e37f8028b0001156237"
        workflowId: "5e58f0b78016b800013d39d1"
        url: "/dashboard/kpi?5e54d77cc607110001be1125=5fd08d50f9f9d741cf113641"
    title:
      de: "Subelement Title"
    subElements:
    - title:
        de: "KPI-Dashboard"
      icon: "pie-chart"
      action:
        type: "OPEN_INTERNAL_URL"
        data:
          url: "/dashboard/kpi?5e54d77cc607110001be1125=5fd08d50f9f9d741cf113641"
workflows:
  # If set, required fields are marked with an * (default: false)
  showAsteriskOnRequiredFields: true
  # If set, images are compressed to this max MB size before upload
  maxImageSize: 1.0
  # Whether to show numbers in repeat groups, like `1.`, `2.` (default: false)
  showNumberingInRepeatGroups: true
  # Whether access control on workflows is enabled or not (default: true)
  accessControlEnabled: true
  # A list of IDs of workflows that cannot be deleted using the UI
  deleteLock:
  - "5b3235a20a975a73932596d4"
  - "5cb6d6980a975a23e9cc6384"
  # A list of IDs of business models for which the app shows selection buttons for each object instead of a searchable list
  # Warning: this should only be used for models with < 10 objects
  showObjectSelectionAsButtons:
  - "5cf642fb0a975a6aa0017dce"
  - "5d00f6068896f70001488bc4"
  # listed workflows (IDs) will be hidden after defined months after publishing
  workflowAutoExpiry:
     - "5b3235a20a975s73932596d4"
     - "5cb6d6980a975a23e9cc6384"
  workflowAutoExpiryAfterMonths: 12
reports:
  # Whether to show finish date and duration in reports (default: true)
  showDurationInExport: true
  # If set, a custom header image is shown instead of the default letterhead when exporting reports as PDF or DOCX
  headerImageUrl: "https://some-image.jpg"
  # Change the width/height of images in pdf reports (attention: the photo ratio remains unchanged)
  photoWidth: 500
  photoHeight: 500
  #
  sendersModelId: "BUSINESS_MODEL_ID"
  # Whether to show report table summary in report view (default:false)
  showSummary: true
  # Setting this to true (default false) shows 2 export buttons - Export to PDF and Export to Word
  showExportButtons: false
  # Default value for when opening a report, can be changed by the UI (toggle on the right side)
  includeEmptyValues: true
  # Whether to show the Job ID in the reports when printing/exporting or not (default true)
  showJobIdInExport: false
  # Whether to show the start date & time of Job in the reports when printing/exporting (default true)
  showStartInPrint: false
  # Whether to show previous jobs the reports when printing/exporting (default true)
  showPreviousJobsInExport: false
  # Whether to show triggered jobs the reports when printing/exporting (default true)
  showTriggeredJobsInPrint: false
  # Whether to show the mybusiness.ai footer in the reports when printing/exporting (default true)
  showGeneratedLabelInFooter: false
jobs:
  # Enable jobs in progress to be deleted by the admin, not only the user it is assigned to (default: false)
  alwaysAllowInProgressDeletion: true
  # Enable finished jobs to be deleted by the admin (default: false)
  allowCompletedJobsDeletionForAdminRole: true
  # Whether jobs in the future should be locked or open (default: false)
  allowFutureJobAccess: false
  # Whether to show a common case ID accross multiple jobs (default: false)
  showCaseId: false
  # Whether to highlight tasks with a colored background (default: false)
  highlightTasks: false
  # Globally enable or disable email notifications for newly created jobs (default: true)
  enableEmailNotifications: true
  # Globally set email notifications for jobs in days (default: 1)
  emailNotificationsEarliestBeforeDays: 1
  # Globally set email notifications for overdue jobs in days (default: 1)
  emailNotificationsOverdueInDays: 1
  responsibilitySelect:
    # Allow groups selection as responsible for a job (default:true)
    includeGroups: true
  #
  missedJobReasonOptions:
   de:
    - "Feiertag"
    - "Sonstiges"
    en:
    - "Holiday"
    - "Other"
  # Globally enable to delete also jobs in progress (default: false)
  alwaysAllowInProgressDeletion: true
  # Show Symbols (before job planning) to preselect workflows and relationsships
  templates:
  - icon: "sitemap"
    label:
      de: "Preselect Job #1"
    workflowId: "5df35fa39306590001c17426"
    relationships:
    - modelId: "5cbf7f6c2ad84800015a1c34"
    - modelId: "5c9e30b6790d640001ab8c8c"
    - modelId: "5cbf5ee52ad84800015a1a2f"
    - modelId: "5cbf5f422ad84800015a1a30"
    - modelId: "5d1c7be6324ccb0001ec383f"
    - modelId: "5cb722af2cb5f400013dfba8"
  - icon: "sitemap"
    label:
      de: "Preselect Job #2"
    workflowId: "5df35fb99306590001c17427"
    relationships:
    - modelId: "5cbf7f6c2ad84800015a1c34"
    - modelId: "5c9e30b6790d640001ab8c8c"
    - modelId: "5cbf5ee52ad84800015a1a2f"
    - modelId: "5cbf5f422ad84800015a1a30"
    - modelId: "5d1c7be6324ccb0001ec383f"
    - modelId: "5cb722af2cb5f400013dfba8"
  - icon: "sitemap"
    label:
      de: "Preselect Job #3"
    workflowId: "5df35fc49306590001c17428"
    relationships:
    - modelId: "5cbf7f6c2ad84800015a1c34"
    - modelId: "5c9e30b6790d640001ab8c8c"
    - modelId: "5cbf5ee52ad84800015a1a2f"
    - modelId: "5cbf5f422ad84800015a1a30"
    - modelId: "5d1c7be6324ccb0001ec383f"
    - modelId: "5cb722af2cb5f400013dfba8"
# Show Symbol opening more Sub-symbols
  - icon: "cogs"
    label:
      de: "Preselect Job #4 more"
    subTemplates:
    - icon: "cogs"
      label:
        de: "Preselect Job #4.1"
      relationships:
      - modelId: "5cbf7f6c2ad84800015a1c34"
      - modelId: "5c9e30b6790d640001ab8c8c"
      - modelId: "5cbf5ee52ad84800015a1a2f"
      - modelId: "5cbf5f422ad84800015a1a30"
      - modelId: "5d1c7be6324ccb0001ec383f"
      - modelId: "5cb722af2cb5f400013dfba8"
    - icon: "cogs"
      label:
        de: "Preselect Job #4.2"
      relationships:
      - modelId: "5cbf7f6c2ad84800015a1c34"
      - modelId: "5c9e30b6790d640001ab8c8c"
      - modelId: "5cbf5ee52ad84800015a1a2f"
      - modelId: "5cbf5f422ad84800015a1a30"
      - modelId: "5d1c7be6324ccb0001ec383f"
      - modelId: "5cb722af2cb5f400013dfba8"
    - icon: "cogs"
      label:
        de: "Preselect Job #4.3"
      relationships:
      - modelId: "5cbf7f6c2ad84800015a1c34"
      - modelId: "5c9e30b6790d640001ab8c8c"
      - modelId: "5cbf5ee52ad84800015a1a2f"
      - modelId: "5cbf5f422ad84800015a1a30"
      - modelId: "5d1c7be6324ccb0001ec383f"
      - modelId: "5cb722af2cb5f400013dfba8"
    - icon: "cogs"
      label:
        de: "Preselect Job #4.4"
      relationships:
      - modelId: "5cbf7f6c2ad84800015a1c34"
      - modelId: "5c9e30b6790d640001ab8c8c"
      - modelId: "5cbf5ee52ad84800015a1a2f"
      - modelId: "5cbf5f422ad84800015a1a30"
      - modelId: "5d1c7be6324ccb0001ec383f"
      - modelId: "5cb722af2cb5f400013dfba8"
  - icon: "random"
    label:
      de: "Sonstige"
      en: "Empty"
    relationships:
    - modelId: "5cbf7f6c2ad84800015a1c34"
    - modelId: "5c9e30b6790d640001ab8c8c"
    - modelId: "5cbf5ee52ad84800015a1a2f"
    - modelId: "5cbf5f422ad84800015a1a30"
    - modelId: "5d1c7be6324ccb0001ec383f"
    - modelId: "5cb722af2cb5f400013dfba8"
businessObjects:
  # Enable to duplicate a business object with all hierarchical links (relations)
  duplicateWithRelations:
  - "5e54d77cc607110001be1125"
  # Disable access control on specific business object collections (default: enabled)
  accessControlDisabled:
  - "5d249b082fa6e0000175e9c9"
  # If set to false the Gallery page is not shown
  showGallery: false
  # If set to false the Map page is not shown
  showMap: false
  # Using to manually add events to business object timeline
  events:
   #
   icon: icon name from here - https://fontawesome.com/v4.7.0/icons/, do not write `fa-` just the icon name
   #
   type: unique string, for example "TYPE_1"
   #
   label: {en:"Some text",de:"Some text"}
                # To define an idPattern for a Business object use the element link of the ID field and define the pattern e.g. starting with W-
  idPattern:
    5f436eae9444e8500d0ec3b0: "W-{ID}"
businessModels:
  # Used for filtering business objects table
  hierarchy:
  - "model_id_1"
  - "model_id_2"
  - "model_id_3"
ui:
  # A custom color for buttons, icons etc.
  primaryColor: "#E20074"
  # A custom color for titles of groups and nested workflows
  groupTitleColor: "#606060"
  # A custom background color for groups and nested workflows
  groupBackgroundColor: "#606060"
  # A custom color for top bars
  topBarBackgroundColor: "#E20074"
  # A custom color for top bar titles and icons
  topBarTitleColor: "#FFFFFF"
  # A custom color for the sidebar
  sideMenuBackgroundColor
kpiDashboard:
  #
  modelHierarchy:
  - "BUSINESS_MODEL_ID"
  - "BUSINESS_MODEL_ID"
  #
  indicatorLimits:
    #
    amberLimit: 0-1
    #
    redLimit: 0-1
businessModels:
  hierarchy:
  # Define the business model hierarchy to show in the business model overview and properties
  - "5e54d77cc607110001be1125"
  - "5fc5fbbaf2b78d27b72cad84"
  - "5db2d38a18ae7a00015691f9"
inventory:
  #
  articleModelId: "BUSINESS_MODEL_ID"
  #
  accountModelId: "BUSINESS_MODEL_ID"
users:
  # Used when creating new user
  defaultGroups: [1000,1001,1002]
  # Used when creating new user
  defaultFeatures: ["news","jobs","workflows","projects","time","documents","inventory","messaging","sensors","objects"]
  # Custom fields for users
  customFields:
    - label:
      en: "Max jobs per month"
    type: "NUMBER"
    id: "maxJobs"