UI configuration checklist

Owned by Guillaume LEPICARD
Last updated: Aug 04, 2023 by Emilie Nucci
4 min read

Logos / Images

From your application technical admin interface, select “Customize your back office”

Upload the different logos / images:

Name

Usage in Back Office

Usage in Portal

Constraints

Name

Usage in Back Office

Usage in Portal

Constraints

On the BO header

Logo in the menu

None

Should be a PNG with transparency

On the FO header

 

Logo in all pages but

  • sign in

  • register

  • home

  • shared boards

Should be a PNG with transparency

On the BO login page

Logo on the sign in screen

Logo in home

Should be a PNG with transparency

On the FO login page

None

Logo in

  • sign in

  • register

  • shared boards

Should be a JPG of at least 1024x768 pixels, and at most 1920x960

loginBackgroundPreview

Image on the sign in screen

Image in

  • sign in

  • register

Should be a JPG of at least 1024x768 pixels, and at most 1920x960

faviconPreview

Favicon used on the Back end

None

Should be a .ico file

Background of 404 error screen

None

Image in

  • 404 errors

  • register feed back timeout

Should be a JPG of at least 1024x768 pixels, and at most 1920x960

500 error page wallpaper

None

Image in

  • 500 errors

  • register feed back error

Should be a JPG of at least 1024x768 pixels, and at most 1920x960

Portal colors

Within src/assets/_common/bootstrap/_project/global_variables.scss

You should change 2 colors in the portal application:

  • $primary Default value #FDD900, used on Form sign in button, Register sign up button and natural search homepage widget

  • $secondary Default value #00A5C8, used for call to action

Notification emails

You will need to configure email notifications templates.

Boards related

You can customize boards related templates by setting in WXM_CART2 plugin the parameter email.root with a SAN path to your customized templates folder. Example:

/<customer>/emails/boards will instruct the WXM_CART2 plugin to load all templates from SAN’s directory /<customer>/emails/boards.

The plugin will expect following templates to exist (default template can be found in WXM_CART2/res/email):

Whereas the recipient of the email refers to an existing user for which we know his UI language, only the default locale is loaded, you cannot define different values for different user locales.

Within the template, you cannot reference the bundle.

collaborate.html

The template can be specialized per board type. Create a <type>/collaborate.html

Used to notify a user that he has been added as a collaborator on a cart. Subject of the mail is defined in

Email subject: WXM_CART2 bundle from key: email.collaborate.subject

download-zip.html

The template can be specialized per board type. Create a <type>/download-zip.html

Used to notify a user that a board he owns has been downloaded

Email subject: WXM_CART2 bundle from key: email.download-zip.subject

share.html

The template can be specialized per board type. Create a <type>/share.html

Used to notify an external user that a board has been shared with him

Email subject: WXM_CART2 bundle from key: email.share.subject

As the recipient is unknown from the system, we cannot determine the locale to use. Only the default locale is loaded.

sharezip.html

The template can be specialized per board type. Create a <type>/sharezip.html

Used to notify an external user that a zip has been shared with him

Email subject: WXM_CART2 bundle from key: email.sharezip.subject

As the recipient is unknown from the system, we cannot determine the locale to use. Only the default locale is loaded.

zip-available.html

Used to notify a zip is ready

Email subject: WXM_CART2 bundle from key: email.download-zip.subject

Registration related

You can customize registration related templates by setting in PACKAGED_RegistrationEmails plugin the parameter email_root with a SAN path to your customized templates folder. Example:

/<customer>/emails/registration will instruct the PACKAGED_RegistrationEmails plugin to load all templates from SAN’s directory /<customer>/emails/registration.

The plugin will expect following templates to exist (default template can be found in PACKAGED_RegistrationEmails/res/email):

account_email_verification.html

Used to verify an email address during the registration process. Recipient has to clink on a link to finalize his account request.

Email subject: PACKAGED_RegistrationEmails bundle from key: email.account_email_verification.subject

Translatable text inside the template (from PACKAGED_RegistrationEmails bundle)

title Title inside the email (email.account_email_verification.title)

body Body text of the email (email.account_email_verification.body)

reason Why user is receiving this email (email.account_email_verification.reason)

buttonLabel Label of the button (email.account_email_verification.verify)

buttonUrl URL of the button

account_pending.html

Used to notify a user that his account request is being reviewed

Email subject: PACKAGED_RegistrationEmails bundle from key: email.account_pending.subject

Translatable text inside the template (from PACKAGED_RegistrationEmails bundle)

title Title inside the email (email.account_pending.title)

body Body text of the email (email.account_pending.body)

reason Why user is receiving this email (email.account_pending.reason)

account_request.html

Used to notify users of role defined by their ID in plugin approving_recipient_roles_for_public_owner_user parameter or email addresses in approving_recipient_emails_for_public_owner_user that a new account request has been submitted (the email address has been verified)

Email subject: PACKAGED_RegistrationEmails bundle from key: email.account_request.subject

Translatable text inside the template (from PACKAGED_RegistrationEmails bundle)

title Title inside the email (email.account_pending.title)

body Body text of the email (email.account_pending.body)

reason Why user is receiving this email (email.account_pending.reason)

buttonLabel Label of the button to review the account request (email.account_request.button)

buttonUrl Url of the button

user The email of the user requesting access

account_welcome.html

Used to notify a user that his account has been activated

Email subject: PACKAGED_RegistrationEmails bundle from key: email.account_welcome.subject

Translatable text inside the template (from PACKAGED_RegistrationEmails bundle)

title Title inside the email (email.account_welcome.title)

body Body text of the email (email.account_welcome.body)

reason Why user is receiving this email (email.account_welcome.reason)

buttonLabel Label of the button to access the application(email.account_welcome.button)

buttonUrl Url of the button

user The email of the user requesting access

Common texts

Following PACKAGED_RegistrationEmails bundle keys can be configured:

contact Contact email (email.account_common.contact)

abuse Abuse text (email.account_common.abuse)

Engine based

You can customize engine managed notifications by personalizing templates from /__default/bov3/template/mail in /SAN/__perso/bov3/template/mail

authorizedusers/user_deactivate.html

login/mail_confirm_user.html

login/mail_password_changed.html

statusPageEvents/mail_status_page_events.html