Skip to content

LoginParams

With loginParams you can add additional parameters to the login process. These parameters can be shown either in the login dialog or configured with fix values without any UI based input fields.The loginParameters are automatically appended to the loginUrl and sent to the server. Furthermore all loginParams are displayed in the info dialog and are accessible in the $context object for further use.

Basic structure of loginParams:

    var Config = {
      eamType: 'maximo',
      server: '/maximo',
      loginParams: [
        { name: 'organization', hidden: false, label: 'Organisation', mandatory: true },
        {
         name: 'selectDummy',
         hidden: false,
         label: 'A select input field',
         options: [
            { label: 'option 1', value: 'a' },
            { label: 'option 2', value: 'b' },
            { label: 'option 3', value: 'c' },
            { label: 'option 4', value: 'd' },
            { label: 'option 5', value: 'e' },
            { label: 'option 6', value: 'f' }
         ]
        },
        {
         name: 'tenant',
         hidden: true,
         value: 'someTenant'
        }
      ]
    };

loginParams always need to have the following properties:

  • name: The name of the loginParam.
  • hidden: Defines, if the loginParam is visualized in the login dialog or not.

If a loginParam has the property hidden: false, you also need to define a label and if it is mandatory or not.

If a loginParam has the property hidden: true, you also need to set the value that will be automatically appended to the loginUrl.

If you define options, the loginParam will be displayed as a select field. If there are no options configured, it will resort to a standard text input field.