Bug 1176249

Created attachment 971311 [details]
JBossEAPConsole

Heikko, what is the desired behaviour for admin console with LP installed? Should the header show LP logo with LP version, or EAP logo with EAP version?

The name of the application is actually an image which is included in the core jar of the console.  I'm not sure if the console allows this image to be changed without rebuilding the jar.  So I believe it's an issue of the console and not with the productization build.

The product title is an image (product_title.png) within the console jar. It needs to be that way because the Red Hat brand team requires a specific font for this. 

The version is text that comes from the "product-version" attribute in the management model. 


Layered products that want to change this need to do the following:

1.1) patch the jar file with a custom "product_title.png", respecting the styling constraints (font face, size, etc)
1.2) release an include a custom maven artefact for inclusion with the layered product


2) Set the correct value the root level for "product-version" attribute in the layered product distribution

Regarding Brian's comment #17:

3) Is only an option if we get the images soon and (more importantly) the "product-
name" attribute is known for all LP's and not changed in the future.


Alternatively see #comment18.

We agreed to implement option 3 based on Brian's proposal in comment #18: 

The console will read the attribute "product-name" from the root resource and take it as basis to look for a matching logo. As product names tend to contain a mix of upper / lower case characters and white space, the product name is turned into lower case and all none alpha numeric characters will be removed before looking for the logo: 

"BPM Suite" --> bpmsuite.png
"Crazy - *PRODUCT* / Name" --> crazyproductname.png

If there's no matching logo, the console will fall back to the EAP logo. Custom logos need to be transparent PNGs with a dimension of 382x30 pixel.

Shelly could you please provide a logo for the BPM Suite which meets the requirements (see comment #20)?

Harald, is there a font requirement as well that the folks providing the logos need to follow? AIUI the font requirement is why this is a graphic and not text, and I suspect it would apply to any product.

Created attachment 981916 [details]
Product images for BRMS

The productization team can provide the internal git repo location of these images but I've attached them here for now.  Note, that BRMS is provided with the purchase of BPMSuite. So if both are installed, what product name should be used in that case for the EAP Admin console?

Created attachment 981917 [details]
Product images for BPMSuite

Catherine Robson should know about the exact requirements for the product logo.

Shelly,

I think what product name layered products want to use is a decision for those layered product teams.

Technically, the logo the console will pick is determined by the value of the product-name attribute in the root resource of the management resource tree (e.g. the one displayed if you start a server, start the CLI and connect, and run the "ls -l" command or the ":read-resource" low level operation).

https://developer.jboss.org/docs/DOC-47927, section "Establishing identity" details where that value comes from. It's the value of the "JBoss-Product-Release-Name" manifest property in the MANIFEST.MF of the org.jboss.as.product:<XXX> module. The value of "XXX" is determined by the "slot" property in bin/product.conf. The bin/product.conf file EAP ships says slot=eap. A layered product can either replace bin/product.conf file to trigger use of some other module, or it can override the org.jboss.as.product:eap module in its layer. The former is cleaner.

There can only be 1 value, so if products are composed of different items, someone involved with the product will need to pick the value.

We are just having a conversation on Layering vs AddonOn. Fuse apparently now is addon, so is SY - rather than a layer.

We think this might be the right thing for BRMS and BPMS. So we should stick with the vanilla EAP identity, and work as an add-on for this. This way we don't need to do any re-branding.

Verified for EAP 6.4.0.ER2.

It's necessary to copy/rename corresponding slots for modules 
org.jboss.as.console and
org.jboss.as.domain-http-error-context as well.

eg. for slot bpmsuite you have to do something like

cp -R modules/system/layers/base/org/jboss/as/console/eap/ modules/system/layers/base/org/jboss/as/console/bpmsuite
sed -i 's|slot="eap"|slot="bpmsuite"|' modules/system/layers/base/org/jboss/as/console/bpmsuite/module.xml

cp -R modules/system/layers/base/org/jboss/as/domain-http-error-context/eap/ modules/system/layers/base/org/jboss/as/domain-http-error-context/bpmsuite
sed -i 's|slot="eap"|slot="bpmsuite"|' modules/system/layers/base/org/jboss/as/domain-http-error-context/bpmsuite/module.xml