FAQ

Muse displays results as they are returned, fastest first, if ranking or sorting are not applied. The “Banded Retrieval” functionality allows you to specify the order of retrieval of Source records in the interface display.

More exactly banded retrieval is the concept of creating groups of sources – e.g. Group A, B and C. For any Search the results display will follow the order of banded retrieval – as in resources under Group A will display first, and the resources from Group B will display second, and the results from Group C will display last. This is often used for placing something that retrieves quickly at a lower ranking so that it is not always the first set of results to display – for example placing Google in Band B or C. Or if you want to always display first the records from the customer’s catalog source place the catalog source in the first defined band – A.

To set up “Priority Retrieval Bands” you have to do the following:
1) define the “Priority Retrieval Bands”. This is accomplished through the MCAA console and it is described in the “Muse Console for Application Administration.pdf” manual, chapter “2.1.1.2.3.30 Organize Sources – Priority Retrieval Bands”.

2) enable the use of the Retrieval Bands. This is also documented in the above mentioned manual in the same chapter; the Ranking feature is documented in chapter “2.1.3.4 Ranking Keys”. Mainly this consists in the following steps:
– add the “ICERankingKeySource” key in the “Ranking Keys Sequence” group from the “Application Modules -> Ranking Keys” section if not already existing. Make sure the “ICERankingKeySource” key is the first key in the “RankingKeysSequence” sequence, if not then move it up position by position until it reaches the first position.
– update the interface from the “Update Interface” button. At this section, for each language available in the application perform the “Update” interface, making sure that the “ICERankingKeySource” and “Banded Retrieval” are checked.

Note that enabling the “Priority Retrieval Bands” may slow down the records display in the interface, this depends on how fast the records are coming from the defined priority bands with the highest priority.

For example if you add in the first defined priority band a source that is retrieving records slower, no records will be displayed in the interface until the highest priority sources retrieve records. This may be falsely perceived by the end user as slow performance.

Without “Priority Retrieval Bands” enabled the Muse records are displayed in the interface as quickly as they are retrieved, the quickest sources records will display first.

There are 2 settings that need to be made in the MCAA console to enable deduplication:
1) Configure the deduplication algorithm. This is done as following:
– login in the MCAA console at your Muse Admin Consoles URL (http://Muse_host:Muse_Port/mmc/)
– select the application from the applications list and click on the left menu
“Application Modules” -> “DeDupe Keys”. The opening page will display the list of
all dedupe keys available and the ones currently installed in the application;
– click on the “Update Interface” button;
– in the “Update Interface” page, for each language available in the Language dropdown
select the ICEKeyTitle title from right in the “Groups” section and click the “Update” button.

2) Configure the default display behavior, whether to show or hide the duplicates:
– login in the MCAA console at your Muse Admin Consoles URL (http://Muse_host:Muse_Port/mmc/)
– select the application from the applications list and click on the left menu
“Application General Settings” -> “Interface Options”;
– Go to the “Search Options” tab and select for the “Display Duplicates:” section either
“Yes” or “No” as desired.

The functioning principle of this authentication scenario is as follows:
– the enduser accesses the provided Muse URL;
– if the enduser’s IP is among the IPs/subnets configured for the desired application then he/she will be successfully logged in;
– if the enduser is not IP authenticated then he/she will be presented with a Muse logon form where to enter the personal LDAP authentication details.
Below are the steps to implement this scenario:
1) configure the necessary Muse login modules for the desired application. Below is their list in order along with the correct flag values:
– ICELoginModuleXML – required;
– ICELoginModuleIP – sufficient;
– ICELoginModuleParametersRemap – required;
– ICELoginModuleLDAP – requisite.
The configuration of the login modules is done through the Muse Console for Applications Administration as follows: select the desired application from the list of application and click on the left menu – “Login Modules”; from this location manage the login modules: add, delete or edit them. The ICELoginModuleParametersRemap login module must have the following attributes and values: ldapUserPwd=”wwwAuthPwd” ldapUserID=”wwwAuthID” (see below).
The context for the desired application in the $ICE_HOME/jaas.config file should look like:
ApplicationID {
com.edulib.ice.security.authentication.ICELoginModuleXML required passwords="${ICE_HOME}/profiles/passwords.xml";
com.edulib.ice.security.authentication.ICELoginModuleIP sufficient hosts="${ICE_HOME}/profiles/hosts.xml";
com.edulib.ice.security.authentication.ICELoginModuleParametersRemap required ldapUserPwd="wwwAuthPwd" ldapUserID="wwwAuthID";
com.edulib.ice.security.authentication.ICELoginModuleLDAP requisite config="${MUSE_HOME}/home/ApplicationID/profiles/ICELoginModuleLDAP.xml";
};
2) Configure the login modules’ properties.
– copy ${ICE_HOME}/profiles/ICELoginModuleLDAP.xml to ${MUSE_HOME}/home/ApplicationID/profiles/ICELoginModuleLDAP.xml (is not already existing);
– for the ICELoginModuleIP login module add a new entry in the ${ICE_HOME}/profiles/hosts.xml file for the desired application along with the list of IPs/subnets that will access the application by IP.
– for the ICELoginModuleLDAP login module make the necessary configurations in the ${MUSE_HOME}/home/ApplicationID/profiles/ICELoginModuleLDAP.xml with the access details and settings for the LDAP server. The following fields from the ${MUSE_HOME}/home/ApplicationID/profiles/ICELoginModuleLDAP.xml must be filled in with proper values: LDAP-URL, BASE-DN and USER-AUTHENTICATION.
3) Add the necessary HTML files for the desired application for handling the IP/LDAP authentication scenario:
– an index (index.html) file which will be the access point for the enduser; the role of this is to transparently submit the username and password of the application.

Note: replace all ApplicationID and ApplicationPassword occurrences with the exact application ID and application password you wish to configure. Also, the html code above is the basic one, with no formatting. Please format it as needed and enclose it in complete/valid html pages.

You can configure LDAP authentication as a single authentication method. The steps are:
– copy the ${MUSE_HOME}/use/ice/profiles/ICELoginModuleLDAP.xml file into the application which is to be configured, into the ${MUSE_HOME}/home/ApplicationID/profiles/ folder, where replace ApplicationID with the exact application ID you wish to configure with LDAP authentication.
– configure the necessary Muse login modules for the application. Below is their list in the correct order along with the correct flag values:
– ICELoginModuleXML – required;
– ICELoginModuleParametersRemap – required;
– ICELoginModuleLDAP – requisite.
The configuration of the login modules is done through the Muse Console for Applications Administration as follows: select the desired application from the list of applications and click on the left menu – “Login Modules”; from this location manage the login modules: add, delete or edit them. The ICELoginModuleParametersRemap login module must have the following attributes and values: ldapUserPwd=”wwwAuthPwd” ldapUserID=”wwwAuthID” .
– Configure the properties of the ICELoginModuleLDAP login module:
– in the MCAA console select the desired application from the list of applications and click on the left menu – “Login Modules” and in the “Login Modules” panel click on the “Edit” link from next to the ICELoginModuleLDAP entry;
– in the editor page change the value for the “config” field from the default "${ICE_HOME}/profiles/ICELoginModuleLDAP.xml" to
${MUSE_HOME}/home/ApplicationID/profiles/ICELoginModuleLDAP.xml
where replace ApplicationID with the exact application ID you wish to configure with LDAP authentication.
– click the “Update” button;
– click the “Edit Config File” and configure the elements specific to the LDAP server, such as LDAP-URL, BASE-DN…etc.
– Create a login page where the enduser will enter his/hers LDAP credentials to login into the application:
– create a backup copy of the ${MUSE_HOME}/web/www/logon/ApplicationID/index.html file, where replace ApplicationID with the exact application ID you wish to configure with LDAP authentication.
– edit the ${MUSE_HOME}/web/www/logon/ApplicationID/index.html file, locate the line:

where replace the 2 ApplicationID occurrences with the exact application ID you wish to configure with LDAP authentication and ApplicationPassword with the right password.
– the access URL for authenticating with LDAP credentials in this application is:
http://MUSE_SERVER:MUSE_PORT/muse/logon/ApplicationID/
where replace ApplicationID with the exact application ID you wish to configure with LDAP authentication