Meteor Settings

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.

JSON

{
  "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"
     ]
   }
  }
}

Parameter

Parameter	Optional?	Possible Values	Default	Description
public	Optional
`forbidUserReg`	Optional	Boolean	`true`	Deactivates 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.
`backgroundPath`	Optional (from Release 25)	String	-	Default background image
`disconnectTimeSec`	Optional	Int	60 seconds	Time until client disconnect
`enableInAppNotifications`	Required (from Release 25)	Boolean	-	Activates the in-app notifications
`logger`	Optional	See Logger
userAuth	Optional
`userpw`	Optional	Boolean	`true`	Local users (see also Authentication Methods)
`saml`	Optional	Boolean	`false`	Authentication method "SAML" Requires further parameters (see below)
saml	Optional			SAML configuration (see Authentication Methods)
`provider`	Required	String		SAML provider
`entryPoint`	Required	String		SAML endpoint
`issuer`	Required	String		URL to the application
`idpSLORedirectURL`	Required	String		Single Logout URL on the IdP
`federationMetaDataUrl`	Required	String		URL to the metadata of the IdP
`privateKeyFile`	Required	String		File with the application key, Base64-encoded
`publicCertFile`	Required	String		File with the application certificate, Base64-encoded
`buttonName`	Optional	String	SSO Login	Label of the Login button
fileUpload	Optional
`maxSingleAttachmentSize`	Optional	Int	50 (MB)	Maximum allowed size per attachment
plantaService	Optional			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.
`protocol`	Required	String		Protocol used
`host`	Required	String		Host of the PLANTA project system
`port`	Required	Number		Port of the PLANTA project system
`apiToken`	Optional	String		Required for web services from PLANTA project 39.5.19 onwards
`timeout`	Optional	Number	10000	Time in ms for requests until timeout
`maxRetries`	Optional	Number	3	Number of automatic retries
activeModules	Optional			Active components in PLANTA pulse (without the parameter, all components are active)
`cards`	Optional	Boolean	`true`	Work with cards and boards
timeTracking	Optional			Settings for time recording; can also be configured in the Administration panel. The settings in the Administration panel overwrite the settings configured here.
`showAttendance`	Optional	Boolean	`false`	Display presence time
`allowProjectSystem`	Optional	Boolean	`false`	Activate time recording on PLANTA project elements
`disabledInNotSyncedBoards`	Optional	Boolean	`false`	Disable time recording on cards of unsynchronized boards
`pulsePlan`	Optional	String	`free`	Indicates with which cost plan the system was created
microsoftGraph	Optional			Required for the Microsoft 365 integration
`graphEndPoint`	Required	String	https://graph.microsoft.com/v1.0	Endpoint URL
`clientId`	Required	String	-	Client ID of the PLANTA pulse Azure App
`clientSecret`	Required	String	-	Secret ID of the PLANTA pulse Azure App
`tenantId`	Optional	String	-	Azure AD tenant ID
`redirectUrl`	Required	String	-	Redirction URL for authentication URL of the system
`permissionScope`	Required	String	`"permissionScope": ["user.read", "Files.ReadWrite.All"]`	App permissions for accessing OneDrive files within the organization
`defaultApiVersion`	Optional	String	"2.0"	Defines the version for endpoints, if no version is included in the URL. Can also be configured in the Administration panel.