Index | Prev | Next

Customizing the login screen

There are several ways that you can customize the login screen with your own logo and text. Best practice for customizing the login screen is to create a custom module and use the “module scheme” to provide resources for your custom login as described in the “Login Screen Customization Overview” topic in the Niagara Developer Guide. This procedure describes how to use the file system (instead of module scheme) to support customizing.
Prerequisites:
  • The logo image that you plan to use must be available to your file system or development environment.
  • Open connection to your station.
 NOTE: Starting in Niagara 4.10u3, custom login screen resources in the shared station home (file:^) are no longer permitted. Starting in Niagara 4.10u4, login screen resources in a "public" subfolder of the private station home is allowed so that you can add a logo image to this location and reference it using an ord reference. For example: file:^^public/myLogo.png 

The following list describes how different versions allow different (increasingly secure) methods for access to your custom login resources.

Niagara 4 version Customizing method supported

Niagara 4.10
  • A shared station home location can be used with a (file:^) file ord reference.
  • Module scheme is supported.

Niagara 4.10u3
  • No file location support is provided. Resources must be included in a module and referenced in the BWebService properties with a module ord instead of referencing the station file system directly.
  • Module scheme supported.

Niagara 4.10u4 and later.

  • Only the file:^^public subdirectory location works.
  • Module scheme supported.

Perform the following steps:
  1. Add your logo image file to the appropriate file folder of the Station, depending on the method you are using (see table above).
    • Niagara 4.10u1 and earlier, you can drag your image to the shared station files folder: local:|file:/C:/Users/myUserName/Niagara4.10/tridium/stations/stationName/public
    • Niagara 4.10u4 and later, you must create and add your image to a “protected station home” public folder local:|file:/C:/ProgramData/Niagara4.10/tridium/stations/stationName/public
  2. Expand Config > Services, right-click on the WebService node and select Views > AXSlot Sheet.
  3. Right-click under the current slots and select Add Slot from the popup menu.
  4. Enter logo as the name and baja Ord as the type and click OK.
  5. In the nav tree, right-click on the WebService node and select Views > AXProperty Sheet.
  6. Scroll down to the logo slot and click the down arrow next to the folder icon and select File Ord Chooser.
  7. Browse to select the image that you want to use as the logo on the login screen and click Save.
  8. Right-click on the Config node of the station and select Views > AXSlot Sheet.
  9. Right-click under the slots and select Add Slot from the popup menu.
  10. Enter displayName as the name and baja Format as the type and click OK.
  11. Right-click on the Config node and select Views > AXProperty Sheet .
  12. In the Display Name field, enter the text that you want to display on the login screen, for example: Custom Text Here.
    For example, Custom Text Here
  13. Click the Save icon in the toolbar.
  14. Restart the station and log in through a browser window (http://localhost/login) to see your customized login screen:
Image

Related Links

  • Other elements to add to Px views (Parent Topic)

    • Index | Prev | Next