Upload User Branding

You can modify the Axeda® Connected Product Management Applications to display and support user-specific branding needs, including adding different color schemes, styles, and documentation to apply a custom look-and-feel.

Each Axeda Applications user account can have its own custom branding. If User1, User2, and User3 each have custom branding defined and applied, when User1 logs into the applications, the pages show the look-and-feel defined for his branding; when User2 logs into the applications, the pages show the look-and-feel defined for his branding; and so on.

Configuration required for user branding

Platform administrators need to configure the path for the user branding folder. This path should point to the public domain.

The Administration application checks for the Cascading Style Sheet (CSS), user.css, in the folder, public/<user_login_name>. If the file is not present, then the default styles are displayed. For additional information about the user.css file, refer to Example of user.css style sheet.

Contents and format for user branding

Once you have created the user.css file and other files needed for your custom branding, all user branding files need to be uploaded to the Platform and applied on a per user basis. User branding files typically include the following types of files:

o        Images - image files to apply to the Applications pages; these can be in JPEG or GIF format. For example, you may want to use your company's logo.

o        Styles - at minimum, the user.css stylesheet.

o        Documentation - documentation files (for example, PDF or DOC files) to display from the Applications pages, for example, from a custom Documents module in an Asset dashboard.

Before you upload the user branding, you need to create a directory structure with your files. The top level directory must be named the login name of the user for whom this branding will apply. For example, to set up the directory structure for the user, securitymgr, create a top level directory called securitymgr. Then, create three subdirectories whose names correspond to the type of file and must be named as follows:

o        Images - store image files in a directory called <userName>/images

o        Styles - store user.css and any style sheet(s) that it imports in a directory called <userName>/styles

o        Documentation - store documentation files in a directory called <userName>/doc.

Continuing with the example user login name, the directories would be securitymgr/images, securitymgr/styles, and securitymgr/doc.

After creating the files and storing them in the directory structure, create a ZIP file of the entire directory structure, with the user_name directory as the top level directory in the ZIP file. This ZIP file must be named for the user for whom this branding will apply, and be located in a path from which you can upload it to the Platform. Continuing the example, you create a ZIP file called securitymgr.zip, which contains the files in the securitymgr/images, securitymgr/styles, and security/doc directories. If you are working on a Windows machine, you can do this easily from Windows Explorer with WinZip. RIght-click the folder and select WinZip > Add to <userName>.zip, where <userName> is the name of the top level directory and the user to whom the branding will apply.

Important! The ZIP file must be named with the login name of a valid Axeda Applications user. For example, if user "John Smith" has a login name of "JSmith", then the branding file for John Smith needs to be "jsmith.zip" (note that the file name is not case-sensitive).

Procedure from this page

From this page, you can upload user branding files to support custom branding changes made to the Axeda Applications.

To upload user branding files

1.       Click Browse and type the path and path to the user branding files, in ZIP format. The ZIP file may contain any combination of styles, images, and docs, but the files must be defined in one of the supported folders: /images, /styles, or /docs.

2.       When the path to the ZIP file is shown, click Upload Branding.

The Platform retrieves and installs the ZIP file. If the file was successfully uploaded, the following message appears: User branding uploaded successfully. When the user for which the branding was uploaded next logs in to the Axeda Applications, he or she will see the changes defined in the branding files.

Notes: The Platform will ignore any files it does not understand or support that may be provided in the user branding ZIP file. If there are any problems with the contents of the ZIP file or with the Platform's ability to extract the ZIP file, those errors are shown in this page after you select Upload Branding.

If the user does not see his or her branding changes upon logging in to the Applications after a successful branding upload, it may be that the browser cache needs to be cleared. (See Resolving Login/Logout problems.)