Version: 2024.1.1

Overview

Overview​

All default settings are defined in the main appsettings.json which you can find both in ìnPoint.Web.Server and inPoint.Identity.Server. To make it easier to manage those it is suggested to use the exact same file for both projects.

This file is formatted as a .json file (javascript notation), so make sure it is valid - otherwise a parsing error will be shown in the log file.

Starting inPoint.Web 2019.4.1 you can have multiple appsettings.json files - named by convention - inPoint.Web will merge those together; this allows you to separate custom settings in whichever way you want:

  • any customer specific settings can be split across other files
  • no need to pollute the default appsettings.json
  • you could separate settings per use-case - e.g. the Project Global Site could have it's definitions separated from the others
  • you could split them by section (one for sidebar, one for quickActions, etc...)

Following sections are supported (anything else must be done directly in the main appsettings.json):

  • defaults
  • archiveTargets
  • sidebar/items
  • quickActions
  • itemActions/actions and /categories
  • itemFlows/categories

Note letter case of the section names should match amongst all of the appsettings file (e.g. using quickActions in one file and QuickActions in the other will cause an error)

The files must follow a standard naming conversion and be next to your other appsettings.json file:

appsettings.addon-*.json

Where "*" can be anything you desire.

In the following sections any setting marked with * means it's required.

Live reload​

You can change any settings in the appsettings.json (except for the Host section) and the settings will immediately be reloaded without the need to restart the inPoint.Web.Server Windows Service.
Note: you will have to manually refresh your browser for those new settings to take effect.

Localization​

Some configurations accept "localized text", which means you can provide a different text depending on the user's chosen language, e.g.:

"title": { "en": "Favorites", "de": "Favoriten" }

ATTENTION: Localization is currently NOT working for all configurations directly loaded without User Context, e.g. ItemActions.

Following language codes are currently available:

  • bg: Bulgarian
  • cs: Czech
  • de: German
  • de-AT: German (Austria)
  • de-CH: German (Switzerland)
  • de-DE: German (Germany)
  • en: English
  • en-GB: English (United Kingdom)
  • en-US: English (United States)
  • es: Spanish
  • fr: French
  • hr: Croatian
  • hu: Hungarian
  • it: Italian
  • lt: Lithuanian
  • ru: Russian
  • sk: Slovakian
  • sl: Slovenian
  • uk: Ukrainian

Branding​

It is possible to change the color schema in the topbar and sidebar, as well as the name, logo and link in the topbar.

Topbar​

The following UI changes can be applied to the topbar

name​

Default Value: "H&S"
Expected Value: A text that will be shown on image hover.

image​

Default Value: "/hs_logo.svg"
Expected Value: Valid URL to image file or path to image shown in the topbar. The path should start with a /, it should be saved in the /wwwroot folder. Public URLs are supported too, e.g. http://www.hs-soft.com/img/men_HS_Logo_white.png

url​

Default Value: "http://www.hs-soft.com"
Expected Value: A link that will be visited on image click.

background​

Default Value: ""
Expected Value: Optional CSS background and/or color string, e.g. a gradient linear-gradient(to bottom, #DC143C 0%, #990000 100%) or a color crimson

borderColor​

Default Value: ""
Expected Value: Optional CSS color string, e.g. crimson, #DC143C, rgb(220, 20, 60), hsl(348, 83.3%, 47.1%) or rgba(220, 20, 60, 1) for a vivid red.

item​

Note: Only for inPoint.Web.IdentityServer

This node styles topbar links in their default state
UI changes can be applied via

  • color:
    Optional CSS color string, e.g. crimson, #DC143C, rgb(220, 20, 60), hsl(348, 83.3%, 47.1%) or rgba(220, 20, 60, 1) for a vivid red.

Example:

"item": {
    "color": "white",
}

activeItem​

Note: Only for inPoint.Web.IdentityServer

This node styles topbar links in their active state
UI changes can be applied via

  • color:
    Optional CSS color string, e.g. crimson, #DC143C, rgb(220, 20, 60), hsl(348, 83.3%, 47.1%) or rgba(220, 20, 60, 1) for a vivid red.
  • background:
    Optional CSS background and/or color string, e.g. a gradient linear-gradient(to bottom, #DC143C 0%, #990000 100%) or a color crimson

Example:

"activeItem": {
    "background": "rgba(136,0,0,.8)",
    "color": "#eee",
}

Note: Only for inPoint.Web.Server

The following UI changes can be applied to the sidebar

background​

Default Value: "#222d32"
Expected Value: Optional CSS background and/or color string, e.g. a gradient linear-gradient(to bottom, #DC143C 0%, #990000 100%) or a color crimson.

caption​

This node styles the groups and the footer link in the sidebar
UI changes can be applied via

  • color:
    Optional CSS color string, e.g. crimson, #DC143C, rgb(220, 20, 60), hsl(348, 83.3%, 47.1%) or rgba(220, 20, 60, 1) for a vivid red.
  • background:
    Optional CSS background and/or color string, e.g. a gradient linear-gradient(to bottom, #DC143C 0%, #990000 100%) or a color crimson

NOTE: Due to the default CSS, !important needs to be appended to every provided UI changes

Example:

"caption": {
    "background": "#800 !important",
    "color": "#ddd !important",
}

item​

This node styles sidebar links in their default state
UI changes can be applied via

  • color:
    Optional CSS color string, e.g. crimson, #DC143C, rgb(220, 20, 60), hsl(348, 83.3%, 47.1%) or rgba(220, 20, 60, 1) for a vivid red.

Example:

"item": {
    "color": "white",
}

activeItem​

This node styles sidebar links in their hover and active state
UI changes can be applied via

  • background:
    Optional CSS background and/or color string, e.g. a gradient linear-gradient(to bottom, #DC143C 0%, #990000 100%) or a color crimson
  • color:
    Optional CSS color string, e.g. crimson, #DC143C, rgb(220, 20, 60), hsl(348, 83.3%, 47.1%) or rgba(220, 20, 60, 1) for a vivid red.
  • borderColor:
    Optional CSS color string, e.g. crimson, #DC143C, rgb(220, 20, 60), hsl(348, 83.3%, 47.1%) or rgba(220, 20, 60, 1) for a vivid red.

Example:

"activeItem": {
    "background": "rgba(136,0,0,.8)",
    "color": "white",
    "borderColor": "#fc0000",
}

Full Example​

Display the inPoint.Web Client in a vivid red color schema.

"branding": {
    "topbar": {
        "name": "H&S",
        "image": "/hs_logo.svg",
        "url": "http://www.hs-soft.com",
        "background": "linear-gradient(to bottom, #dc143c 0%, #900 100%)",
        "borderColor": "#700",
        "item": {
            "color": "white",
        },
        "activeItem": {
            "background": "rgba(136,0,0,.8)",
            "color": "white",
        }
    },
    "sidebar": {
        "background": "linear-gradient(to bottom, #900 0%, #dc143c 100%)",
        "caption": {
            "color": "#ddd !important",
            "background": "rgba(136,0,0,.8) !important",
        },
        "item": {
            "color": "white",
        },
        "activeItem": {
            "background": "rgba(136,0,0,.8)",
            "color": "white",
            "borderColor": "#fc0000",
        }
    }
}

Tools​

Local Contact Info​

You can provide additional information, that will be displayed with errors that require reporting to a system administrator:

  • text A message in your default language. Defaults to Unexpected error. Please contact your system administrator.
  • email An optional email address, that will be displayed after the text.
  • url An optional additional Link, that will be displayed after the text.
"localContactInfo": {
    "text": "Please contact Mr. Smith from IT",
    "email": "mr.smith@company.com",
    "url": "https://report.company.com/new-error",
}