Skip to content

Org settings

The following items can be set in the org settings configuration.

  1. Profile popup
  2. Card settings
  3. Roster
  4. General global configuration
  5. Settings

Items 1 through 4 can be set by group with a default provided as a fallback. The mechanism is via nested keys:

{
    "profile": {
        "default": {
            // fallback settings
        },
        [group handle]: {
            // settings for specific groups
        }
    }
}
  • saveLocation: on | off - geocode dispatch data
  • userDisplay: template, general user display
  • week: monday | sunday - first day of the week
  • relationDisplay
  • wizard: [Object]
    • version: 1 OR 2.If version is not provided then default it take version 1
    • start: [Object] If version 2 then provide trackers otherwise just provide the single tracker id.
      • trackers: [Array of strings]
    • intake: [Object] If version 2 then provide trackers otherwise just provide the single tracker id.
      • trackers: [Array of strings]
    • edit:[Object] If version 2 then provide trackers otherwise just provide the single tracker id.
      • trackers: [Array of strings]
  • dispatch: list of dispatches
  • content: display the content based on configuration
  • moderation: configure the information for moderation dialog
  • termsAndConditionsWikiId: id of the terms and conditions wiki
  • navigation: configured the navigation bar
  • bottomNavigation: configure the bottom navigation bar

Wizard properties configuration:-

Version 1

"settings": {
    "wizard": {
      "intake": "<tracker id>",
      "edit": "<tracker id>"
    }
}  

Version 2

"settings": {
    "wizard": {
      "version": 2,
      "intake": {
        "trackers": ["<tracker id>", "<tracker id>"]
      },
      "edit": {
        "trackers":["<tracker id>", "<tracker id>"]
      },
      "start": {
        "trackers":["<tracker id>", "<tracker id>"]
      }
    }
}  

Example

```json
{
  "settings": {
      "week": "monday",
      "userDisplay": ":last, :first",
      "relationDisplay": "",
      "wizard": {
        "start": "072a4c8d-839b-460f-ac6c-d704d2d4226e",
        "intake": "4fe25dc0-8e91-45e2-b6dd-0f3284094df8",
        "edit": "0b512742-8b79-480e-9c65-bc51cb5568bb"
      },
      "dispatch": {
        "save": [
          "programStatus"
        ],
        "display": [
          "programStatus",
          "orgTitle"
        ],
        "displayConnect": "or"
      },
      "content": [
        {
          "match": "^maintenance",
          "rule": "true",
          "action": "enable"
        },
       ...
      ],
      "moderation": {
        "title": "Flag content as inappropriate",
        "description": "Help us understand what's happening",
        "wiki": {
          "title": "Learn more about our community standards",
          "id": ""
        },
      },
      "termsAndConditionsWikiId": "7d8acbd7-3856-4587-8ff5-b38e4589f3fe",
      "navigation": {
        "default": {
          "backgroundColor": "#ffffff",
          "extendBodyBehindAppBar": true,
          "paddingLeft": "10px",
          "paddingRight": "10px",
          "border": {
            "bottomLeft": "25px",
            "bottomRight": "25px"
          },
          "header": [
           {
             "target": "search",
             "icon": "far fa-magnifying-glass",
             "color": "#ffffff"
           },
           {
             "target": "notification",
             "icon": "far fa-bell"
           },
           {
             "target": "shopping-cart",
             "icon": "far fa-bag-shopping",
             "options": {
               "pageId": "2a8a3b51-1159-4836-956d-abd50fc03b56",
               "title": "Shopping cart",
               "bucketHandle": "shopping-cart"
             }
           }
          ]
        }
      },
      "bottomNavigation": {
        "default": {
          "backgroundColor": "#ffffff",
          "border": {
            "topLeft": "25px",
            "topRight": "25px"
          }
        }
      }
  },
}
```
  • header: string array
  • headerByGroup: group handle to string array
  • actionConfig:
    • action: follow | email | mobile | chat
    • condition
    • icon
  • tabs
    • title
    • display:
    • show:
    • options: based on display

Supported header options: - :first, :last, :lastInitial, :adminName - :email - :createdAt - :gender - :mobile - :external - :status - :timezone

Example

```
{
    "profile": {
        "default": { 
            "header": [
            ":first :lastInitial",
            ":title, training since :createdAt",
            "{about.location}"
            ],
            "card": {
            "title": ":first :lastInitial",
            "description": ":timezone"
            },
          "tabs": [
              {
              "title": "Details",
              "display": "admin",
              "show": "admin",
              "condition": "user is admin",
              "icon": "fal fa-address-card",
              "color": "text-danger"
              },
              ...
          ],
          "actionConfig": [
              {
                "action": "follow",
                "tableData": {
                  "id": 0
                }
              },
              ...
          ]
        },
        "disabled": {used same configuration as default section but it disbled the thing in profile}
        [group handle]: {.. }
    }
}
```
{
  "card": {
    "default": {
      "title": ":first :lastInitial :adminName",
      "description": ":title, joined :createdAt",
      "attributes": [
        {
          "key": "location",
          "source": "about.country"
        }
      ]
    },
   [group handle]: {.. }
  }
}
{
  "roster": {
    "default": {
      "query": [
        {
          "query": "given labels [coach] sort by last",
          "title": "Coaches"
        },
        ...
      ]
    }
  }
}
  • dispatchActions:

    • action: like | comment | bookmark | task-global | task-local
    • condition
    • id
    • icon
    • label
  • theme:

    • titleColor: color to be used for the org title and other places
    • bodyColor: body text color (default to black)
    • iconColor: dispatch action icons color
    • actionColor: link/action color
    • sendButtonColor: chat/dispatch comment send button color
    • logoColor: Org logo color (white, dark, color, or null)
    {
      "general": {
        "default": {
          "dispatchActions": [
            {
              "action": "task-global",
              "condition": "user is admin",
              "tableData": {
                "id": 0
              }
            },
            ...
          ],
          "theme": {
              "titleColor": "#7e86e3",
              "bodyColor": "#000000",
              "iconColor": "#38096a",
              "actionColor": "#3f6fb7",
              "sendButtonColor": "#2fa4e7"
          }
        }
      }
    }