Information

  • PLANTA pulse is based on the Meteor framework.
  • The related settings are contained within the docker-compose.yml file under "METEOR_SETTINGS” and can be edited there, if needed.
    • When making changes, the JSON syntax needs to be observed. (It can be checked with a JSON validator, e.g. JSONLint.)
  • In the Meteor Settings, several parameters can be edited, e.g. the authentication methods or settings regarding the self-registration.
{
  "saml":[
    
  ],
  "public":{
    "backgroundPath":[
      "/logo_background.svg",
      ""
    ],
    "enableInAppNotifications":true,
    "forbidUserReg":false,
    "disconnectTimeSec":600
  },
  "userAuth":{
    "userpw":true,
    "saml":false
  },
    "mailServer":{
      "from":" ",
      "host":" ",
      "port":" ",
      "username":" ",
      "password":" ",
      "disableCertCheck":true,
      "enableTLS":false
    },
    "hideFeatures":{
      "applicationLogs": false,
      "timeRecording": false,
      "selfRegistration": false,
      "emailSettings": false
    },
   "pulsePlan":"free",
   "microsoftGraph": {
     "graphEndPoint": "https://graph.microsoft.com/v1.0",
     "clientId": "<ID>",
     "clientSecret": "<ID>",
     "tenantId": "6e0cb325-66f1-4d84-a389-b4fae3f7d264",
     "redirectUri": "https://planta.plantapulse.de",
     "permissionScope": [
       "user.read",
       "Files.ReadWrite.All"
     ]
   }
  }
}
JSON

Parameter

ParameterOptional?Possible ValuesDefaultDescription
publicOptional


forbidUserRegOptionalBooleantrueDeactivates the self-registration in PLANTA pulse: false = self-registration is possible, true = self-registration is not possible; can also be configured in the Administration panel.
If the value false has not been configured in both places, the self-registration is still deactivated.
backgroundPathOptional
(from Release 25)
String-Default background image
disconnectTimeSecOptionalInt60 secondsTime until client disconnect
enableInAppNotificationsRequired (from Release 25)Boolean-Activates the in-app notifications
loggerOptionalSee Logger

userAuthOptional


userpwOptionalBooleantrueLocal users (see also Authentication Methods)
samlOptionalBooleanfalseAuthentication method "SAML"
Requires further parameters (see below)
samlOptional

SAML configuration (see Authentication Methods)
providerRequiredString
SAML provider
entryPointRequiredString
SAML endpoint
issuerRequiredString
URL to the application
idpSLORedirectURLRequiredString
Single Logout URL on the IdP
federationMetaDataUrlRequiredString
URL to the metadata of the IdP
privateKeyFileRequiredString
File with the application key, Base64-encoded
publicCertFileRequiredString
File with the application certificate, Base64-encoded
buttonNameOptionalStringSSO LoginText on the login button
fileUploadOptional


maxSingleAttachmentSizeOptionalInt50 (MB)Maximum allowed size per attachment
plantaServiceOptional

Settings for the PLANTA project system in which hours worked are to be recorded; can also be configured in the Administration panel.
The settings in the Administration panel overwrite the settings configured here.
protocolRequiredString
Protocol used
hostRequiredString
Host of the PLANTA project system
portRequiredNumber
Port of the PLANTA project system
timeOutOptionalNumber
Time for requests until timeout
activeModulesOptional

Active components in PLANTA pulse (without the parameter, all components are active)
cardsOptionalBooleantrueWork with cards and boards
timeTrackingOptional

Settings for time recording; can also be configured in the Administration panel.
The settings in the Administration panel overwrite the settings configured here.
showAttendanceOptionalBooleanfalseDisplay presence time
allowProjectSystemOptionalBooleanfalseActivate time recording on PLANTA project elements
disabledInNotSyncedBoardsOptionalBooleanfalseDisable time recording on cards of unsynchronized boards
pulsePlanOptionalStringfreeIndicates with which cost plan the system was created
microsoftGraphOptional

Required for the Microsoft 365 integration
graphEndPointRequiredStringhttps://graph.microsoft.com/v1.0Endpoint URL
clientIdRequiredString-Client ID of the PLANTA pulse Azure App
clientSecretRequiredString-Secret ID of the PLANTA pulse Azure App
tenantIdOptionalString-Azure AD tenant ID
redirectUrlRequiredString-Redirction URL for authentication URL of the system
permissionScopeRequiredString"permissionScope": ["user.read", "Files.ReadWrite.All"]App permissions for accessing  OneDrive files within the organization
defaultApiVersionOptionalString"2.0"Defines the version for endpoints, if no version is included in the URL. Can also be configured in the Administration panel.