Muse Release 2.8.0.0

We are pleased to announce the latest release of The Muse Platform, version 2.8.0.0. Our team has been working quite hard for the last few years on developing brand new products and extending with new features the existing ones. Our goal continues to provide a world class digital library platform and information management to enjoy the best possible user experience.

Some of the highlights of the new version are presented below, including a description of the new products and the detailed list of changes is available in Muse Release Notes PDF Document.

New Products

 

  • Discover Search

    The Discover Search is our pure index search application, introduced under the Muse Search Application starting with version 8.2. The content searched by Discover is provided by Muse Central Index, which contains article and title metadata harvested from various publishers.

    The Discover Search comes with all powerful features of the index search such as faceting and full result set availability. And many post-search functions that are also available in the Federated Search (now labeled as OneSearch), like viewing and saving the selected records in various formats.

    The Muse Search application is fully configurable, allowing both the Federated Search and Discover Search, or just Federated Search or just Discover Search pages. Enabling, disabling the search features are done through the Muse Console for Applications Administration (MCAA).

  • Muse LinkResolver, version 1.1.0.0

    This is our standalone link resolver application, implementing the OpenURL standard version 0.1. The content on which the links resolver relies is provided by Muse Central Index, the metadata received in the OpenURL request is searched in Muse Central Index and the results are displayed. Some of the features available in the current version are:

    • Support for displaying third party links to external specialized providers, passing the OpenURL parameters received by the linkresolver. Examples: Google Scholar, Clarivate JCR, EigenFactor, etc.  Links to other linkresolvers can be created as well.
    • The Muse LinkResolver user interface theme is preserving the same Muse Search Application theme, for a smooth user experience.
    • Extended the user authentication methods by implementing IP authentication. Thus the end user authentication for Muse LinkResolver can be done based on the browser's IP address. Anonymous authentication can be configured as well, by allowing access from any IP address.

    The complete release notes are available in the Muse LinkResolver Release Notes.pdf document.

  • The Muse Identity Manager, version 2.1.0.7

    Muse Identity Manager (Muse IDM) is our new web based application with processes for identifying, authenticating and authorizing individuals or groups of people to access configured applications by associating user rights and restrictions with established identities.

    • Various registration workflows can be configured for user registration:
      • allow direct registration with or without email validation;
      • allow registration only from specific predefine domains;
      • allow registration after email validation and administrator approval.
    • Custom fields can be defined for the users registration form. Each custom field defined can have predefined values and validation rules. For example, validation rules can be specified for a Telephone number, to allow phone numbers from a specific country, operator. Mandatory custom fields can be specified.
    • An administration interface for centralized users management is available with many features like user searching and filtering, bulk updates, sending emails, export as CSV, import from CSV file, login history and user statistics.
    • A payment workflow care be enabled in the registration process, the following vendors were successfully tested: Stripe, Paystack and Verifone Payment Platforms.
    • The following authentication protocols are supported:
      • SAML 2.0. SAML integrations come with the following features: SAML 2.0 based Single Logout (SLO), metadata profile and SAML attributes filtering.
      • OAuth 2.0. Muse IDM can be configured as Authorization Server and offers support to manage OAuth2 clients through the Administrator Console. This feature was successfully tested with Muse Proxy, miniOrange(an OAuth2 client for WordPress) and Moodle version 3.7.1
      • HMAC. Integrations with Muse Search and Muse Proxy applications through HMAC authentication protocol.

    The complete release notes are available in the Muse Identity Manager Release Notes.pdf document.

New Features and Enhancements

 

  • Muse Search Application, version 8.4
    • Extended the results display in the Search Results page to include the link for Muse LinkResolver, which will open in a new browser tab, receiving citation details in OpenURL format.
      The Muse LinkResolver does not replace the existing external Link Resolver, it is an add-on. The availability of link resolvers for the Muse results is fully configurable, both Muse LinkResolver and another external link resolver can be available at the same time, or either one of them or none.
    • Added text translation for the results metadata (e.g. Title, Description, Subject, Notes, etc.) in any of the 12 languages in which the interface is available: Arabic, Greek, Spanish, Romanian, Latin American Spanish, French, Dutch, German, Turkish, Japanese, Chinese Traditional, Chinese Simplified. Thus, in the footer section of each result, a dropdown with the Language icon is available, from which the end user can select the translation language. The translated texts are displayed inline under the original text.
      The Muse translation module uses Microsoft's Translator API.
    • The following libraries used in the application were updated to their latest versions available: AngularJS, JQuery, Microsoft Cognitive Services Speech, Virtual Keyboard, Twitter Typeahead.
  • Muse Proxy, version 5.4.0.2

    The complete release notes are available in the Muse Proxy Release Notes.pdf document

  • Muse Core and Modules
    • Introduced a new core service for query spell-checking. Multiple implementations are available: spellcheck against the collection of queries used by the end users in a Muse system, against imported dictionaries, against a third-party service.
    • Created the structure and module for integrating with Document Delivery service workflows.
    • Implemented core support for validating and normalizing the standard identifiers such as ISBN, ISSN and DOI. These operations are automatically done when the Muse records are being formed.
    • Implemented query suggestions feature using the embedded Solr service starting from the indexed queries used by the end users in a Muse system. The entire set of tools was created to deal with queries extraction and indexing on a daily basis. In a multitenant system with end users from different domains (legal, medical, engineering, etc.) it is possible to make available only the queries used in a specific application.
    • Created an API for connectors for gRPC (google's Remote Procedure Calls) - https://grpc.io/
  • Muse Administrator Console (MCAA)
    • Added support for Syntax Highlight when raw editing any configuration file (for example of login modules, of Source Packages, etc.).
    • Extended the HTTPS Certificates section to display the validity status (e.g. expired/valid) for each certificate. The about to expire certificates are highlighted.
    • In the MCAA console, "Information" section, the administrator can configure the email settings to be used for the Send Records by Email functionality from within the application. It is now possible to check the edited email settings. To perform this test an email will be sent using email parameters specified in ${APPLICATION_HOME}/profiles/SendMail.xml.
    • The sources group names and descriptions can now be edited and set per language, hence it is possible to have now the sources group names translated in all interface available languages.
  • Muse Control Center
    • Changing the way task files are displayed in case their number is large in the web interface. A dropdown selector is used when number of loaded files exceeds a specified number.
    • Extended the download log file mechanism present in Ant, FTP, Log tasks in order to allow downloading all the associated log files (e.g. FTPUpload.log, FTPUpload.log.1, ...,FTPUpload.log.n) as an archive.
    • To improve the administrator's experience, the following were implemented: allow tasks listing in the default order after a sort operation by Name, Type, Status took place; display an indicator to show the sorting direction after being applied.
    • Extended the existing FTP task in order to upload/download file on SFTP servers using key authentication.
    • The tasks in a taskfile can now be visually arranged more quickly by drag-n-drop.
    • Multiple tasks from within a taskfile can be selected and deleted in one action.
    • Added filtering capabilities to narrow down the list of tasks in a task file, to quickly locate a task or set of tasks. The filtering is done by Name, Description, Task Type and Status.
    • New features were implemented for managing the task files: The "Save as" action allows now choosing the destination folder where the *.tsk file is saved; The "Load" action provides a file browser feature to locate and load the *.tsk file; The "New" action provides the same file browser to create the new task file.
    • Improved the editing of an Ant task by adding a raw edit feature for its XML configuration files.
    • Added support to view in the Muse Control Center interface the log files associated with Ant and FTP and Log tasks.
  • Muse Central Index
    • Extended the Muse Central Index to allow more flexibility when running in multitenant implementations, to be able to specify lists of source identifiers to act as filters for the searches. Thus it is possible now in a multitenant Muse system to have a single index for all tenants and specify lists of source IDs to search for.
    • Started the work of harvesting publisher metadata to grow the Muse Central Index. We started with getting the titles metadata which are provided by each vendor in different ways, mostly by KBART standard.
    • Implemented support for ingesting data from the JATS (Journal Article Tag Suite) format.
    • Created a new data model for the database where the records are stored, to be used more efficiently by the new Discover application. Also, to allow support for filtering on various criteria (like source, created at date, etc.).
    • Ingesting ZIP archives that contain XML files is now possible.
    • Added support for re-indexing updated records in the database. For implementing such a feature, it was needed to add timestamp values for each record in the database, like createdDate and lastModifiedDate.
  • Muse Statistics Platform
    • The Muse Statistics Platform is our service for customers and partners for offering usage statistical information. Muse log files are uploaded on daily basis from customers and partners Muse installations and used for generating rich statistical information. Each customer, partner has access details to view the statistics.
    • Statistics are generated for both Muse Search and Muse Proxy, the following dashboards are available:
      Muse Search
      • Application Logins. Showing statistical information on Muse Search user logins and sessions per various criteria (by date, by user identifier, by application identifier, by user country and by server), in the selected period of time. The statistics information is based on the content of the ICECoreStatistics.log files.
      • Application Searches. Showing statistical information on user searches per various criteria (by date, by user identifier, by application identifier, by user country, by server, by resource), in the selected period of time. The most searched terms can also be seen. The statistics information is based on the content of the ICECoreStatistics.log files.
      • Expert Statistics. Showing expert statistical information that can be used by administrators to troubleshoot a Muse Search installation from sources point of view (connectors), such as download speed, time consumed on records processing versus the time spent on network for download and unsupported queries. The statistics information is based on the content of the ICECoreStatistics.log files.
      • Java Virtual Machine. Statistical information on the heap, runtime and used memory and number of threads used by Muse Search. The statistics information is based on the content of the ICECoreStatistics.log files.
      • Security. Showing the users accessing from different, multiple geographies. The user IDs present in this information could be from compromised accounts, a more thorough analysis is recommended before taking any actions to disable them.
      • Sessions per Server (in case of load balanced implementation with more than one servers). Showing statistical information on active client sessions per server. The statistics information is based on the content of the ICECoreStatistics.log files.
      • User Activity. Showing statistical information for an individual user selected from the list or entered manually. The statistics information is about the logins, total time spent, searches, and it is based on the content of the ICECoreStatistics.log files.
      • User-Agent Information. Statistical information about user device, browser engine and operating system. The statistics information is based on the content of the Muse Embedded Tomcat access log files.
      Muse Proxy
      • General Usage Statistics: Application Logins. Showing statistical information on the user logins into Muse Proxy Applications per various criteria (by date, by user identifier, by application identifier, by user country and by server), in the selected period of time. The statistics information is based on the content of the MuseProxyStatistics.log files.
      • General Usage Statistics: Client Sessions. Showing the user active sessions in the selected period of time as maximum, minimum and average values. The statistics information is based on the content of the MuseProxyStatistics.log files.
      • General Usage Statistics: Source Accesses. Showing the number of accesses per each Target (Muse Proxy Source Profile). A Muse Proxy Source Profile is a configuration file which stores the necessary code and credentials to access the Target Data Source. The statistics information is based on the content of the MuseProxyStatistics.log files.
      • Publisher Content Access Statistics. Access statistical information to see how users make use of the subscribed electronic resources. The information presented contains details on the accessed resources, from the name of the platform to type and format of the resource accessed and user details such as the country. Where a publisher knowledge base is available, the information is enriched with additional metadata such as the publisher name, publication title, print and online identifiers and DOI. The statistics information is based on the analysis of the Muse Proxy access.log files.
      • Security. Showing the users accessing from different, multiple geographies. The user IDs present in this information could be from compromised accounts, a more thorough analysis is recommended before taking any actions to disable them.
      • User Activity. Showing statistical information on active client sessions per server. Showing statistical information for an individual user selected from the list or entered manually. The statistics information is about the logins, total time spent, accessed resources, and it is based on the content of the MuseProxyStatistics.log and Muse Proxy access.log files.
      • User-Agent and Referer Information. Statistical information about user device, browser engine, operating system and referer URL. The statistics information is based on the content of the access.log files.

We offer a Free 30 Day Trial period to fully evaluate the latest version of the Muse Search Application. You can obtain the access by simply filling in the trial form.

A new version of the MuseKnowledge Application was released, containing new exciting features for a better user experience. Some of the new features are listed below:

  1. Create Bibliography items out of search results in various styles: APA, BibTexX, Nature, IEEE, MLA, Chicago, NLM, etc. The generated bibliography elements can be printed or copied for insertion into external documents.
  2. Integrated a Document Delivery service workflow. Document Delivery is a service that provides electronic delivery of an article or book chapter (subject to copyright restrictions) which are not part of the institution' subscriptions. Usually the delivery is covered by an existing institution subscription plan at the document delivery platform.
    Currently the integration was done with the ReprintsDesk platform at API level, but any vendor of document delivery services supporting a similar workflow can be integrated.
    - The document delivery button (with a vendor logo) is available at the results that qualify for the workflow, e.g. there are no fulltext links available in the metadata content, or the searched source is marked explicitly as not having fulltext by configuration.

    - Clicking the button opens a modal window in which the article's availability is checked at the document delivery platform and if existing the estimated price is displayed:

    - The user can further request the article by filling in the form:

    - If a quick download of the article is available, the PDF file can be downloaded immediately.
  3. Extended the metadata elements displayed for each result to include detailed Coverage information if available.
  4. New features implemented for Discover:
    - Added support for different sources of suggestions based on the search attribute selected, in the Discover page search form. For example when searching with the Subject attribute, the suggestions offered when writing the query are from all indexed subject values. Associating the suggester source to be used for each search attribute can be done from the Muse Administration Console.
    - Added query Highlight functionality, e.g. the searched terms are highlighted in the results contents.
    - Added Email Results functionality, e.g. the selected results can be sent by email.

As usual we offer a Free 30 Day Trial period to fully evaluate the new version of MuseKnowledge™ Application. You can request a trial access by simply filling in the trial form.

To address the recent widespread Apache Log4j 2 emerged vulnerabilities (https://logging.apache.org/log4j/2.x/security.html), the MuseKnowledge team released a new version of MuseKnowledge™ Proxy to contain the latest Log4j library version - 2.17.0.
The Apache Log4j 2 library is used by few components in Muse Proxy. The core logging mechanism of the Muse Proxy is based on the in-house built logger and logs such as access.log, MuseProxy.log, MuseProxyStatistics.log are produced using the in-house logger, and not Log4j.

When upgrading make sure that the entire Library ecosystem stay safe by updating any Java based related software used in the portal, authentication services (LDAP, SAML, etc.), log processing, monitoring infrastructure, etc. as per the Log4j CVEs.

The new MuseKnowledge™ Proxy version is available for trial, purchase or upgrade. Besides the security update, several new features are available and presented below. The detailed list of changes is available in MuseKnowledge™ Proxy Release Notes PDF Document.

  • The TLSv1.3 standard can now be used on both ends of Muse Proxy if running under JVM version 8, at least, update 262. For the server end Muse Proxy is now configured with TLSv1.2 and TLSv1.3 only as enabled protocols. For sources' end TLS v1.3 can be configured if needed, however, there are still many servers not supporting it, hence, by default TLS v1.3 cannot be enabled for all the sources.
  • In the Muse Proxy Administrator Console, Utilities section, the Un-Rewrite URL tool was extended to support un-rewrite "Rewrite By Host" URLs.
  • The Find/Replace filter is able to process (rewrite, unrewrite, rewriteHostHTTPS, etc) strings that represents the Base64 encoded form of an URL/Host and then re-encode it back. By using the attribute base64 we can achieve decode, rewrite (or any other group process) and then re-encode in Base 64 as long as the replacement group represents the Base64 sole representation of an URL/host.

Since the beginning of the COVID-19 global crisis, the MuseKnowledge™ Proxy Trial periods are extended from 30 days to 90 days. Request your Trial License Key by simply filling in the trial form.

A new version of the MuseKnowledge Application was released, containing new exciting features for a better user experience. The new features are listed below:

1. Implemented a new feature in the Search Sources panel that allows end-users to make decisions when selecting the sources to search, based on performance and popularity metrics. More exactly,  nesides sorting alphabetically, there are two other options available in the sort feature of the Search Sources panel:

  • Fastest Sources. When selecting, the sources are displaying sorted by their performance metrics, from the fastest ones in retrieving results to the slowest one. A graphical representation of their performance is displayed next to each source name, consisting in colored bricks according to the value. It is a strength-style visual indicator. A tooltip is displayed on the graphical bars with the actual performance values, in seconds.
  • Popular Sources. When selecting, the sources are displaying sorted by their popularity, e.g. by how many record links from the search results were accessed for each source. The end users may navigate more on results of some specific sources. The same visual strength-style representation is displayed next to each source name.

2. A Live Chat feature was implemented to allow users connecting in real time via chat with a Library representative (operator) for online support. The chat box allows users to ask any questions they may have for clarification about the MuseKnowledge™ Application and its resources. An operator will respond when available and engage into conversation.Depending on the integrated chat platform, the may see the chat box only when an operator is available at the Library and logged into the chat server. Or, the user may get the chat box but it allows only to send an email to the offline operator. In most cases, to be able to use the chat functionality, the user is requested to enter a name and email address.Many Live Chat Platforms can be integrated into the MuseKnowledge Search Application.

The following platforms were tested successfully: Live Helper Chat, LiveChat and Pure Chat.

More details about this feature are available in the following article: MuseKnowledge Live Chat | EduLib

3. Enhanced the "Email Results" functionality with a new option - "Send to Library". If "Send to Library" option is checked, the email is sent to the Library email address. Users can use this option if they're having a problem with the search results, availability of subscribed content, or just want to tell us their thoughts about how it's working. A library email address where the emails are sent must be configured.

4. A new CSS file was introduced specifically for the Right-to-Left display to allow customizations. The new CSS file is editable through the Muse Administration Console.

As usual we offer a Free 30 Day Trial period to fully evaluate the new version of MuseKnowledge™ Application. You can request a trial access by simply filling in the trial form.

A new version of MuseKnowledge™ Proxy was released and it is available for trial, purchase or upgrade. The highlights of the new version are presented below. The detailed list of changes is available in MuseKnowledge™ Proxy Release Notes PDF Document.

  • An Audit Report can now be generated using the MuseKnowledge Administrator Console, Manage Applications section for the current selection of applications. The report includes a cumulative section, individual application details, and Source Profiles details.
  • Testing and managing the Authentication for LDAP Configuration in the MuseKnowledge Administrator Console is now possible. In order to ease the LDAP authentication configuration visual management and step by step tests are available. Check Network Parameters, Check Root (Bind) Authentication, discovering Search Bases, searching for the user (or any Search String), entirely testing the whole chain with a User and Password are now possible in an intuitive manner from the same screen allowing visual edit. Raw edit is still available.
  • The Priority cookie attribute is now set to MuseKnowledge Proxy Session and ID cookies. This attribute is interpreted by Chrome, Microsoft Edge and other Chromium based browsers, while the others are ignoring it. This way, in case the per domain cookie capacity (usually 180 cookies) exceeds on the end-user browser side, the proxy session cookie is not evicted hence the session could still be maintained. This is configurable through the priority="High" XML attribute of the PRIMARY_COOKIE_CONFIG and SECONDARY_COOKIE_CONFIG elements in the MuseProxy.xml configuration file. Note that these two settings, PRIMARY_COOKIE_CONFIG and SECONDARY_COOKIE_CONFIG, are overwritten when upgrading, so the customized bits need to be manually reverted.
  • In this release the JavaScript libraries involved in the default application interface templates (MKPF and MuseProxyFoundation), in the static pages and in the MuseKnowledge Administration Console were updated to newer versions.
  • Expired link corresponding to applications with indirect authentication (SAML, SSO,  RemoteAuth) are not triggering the login flow if the HTTP request headers Purpose: prefetch or Sec-Purpose: prefetch are present.
  • A Request Timeout for reading the entire HTTP request is now available in the MuseProxy.xml configuration file. Note that it must be significantly higher than the KEEP_ALIVE_INTERVAL and READ_TIMEOUT value. In case a load balancer or a reverse proxy is used in front of the MuseKnowledge Proxy they normally take care of this aspect.
  • The logUserID is now available in the Application FreeMarker model and can be accessed through session.getLogUserID() in the FreeMarker templates, in cases of applications which may have clear human readable userIDs and no displayName is available in the post-authentication properties or the authentication module does not have such properties.
  • The debug log now adds more information about client connection, especially on some client side errors so that the client / peer IP (end-user / load-balancer IP in case the end-user IP is not encoded by the load balancer) is also part of the same log entry without the need to identify it in previous entries or in entries from other log files. For the vendor side of connection efforts were made so that the source.ip and target.hostPort are logged in the same error entry for some errors. The client.ip, source.ip and target.hostPort information is, however, not duplicated for each log entry with a [connection.id=...]. Hints about HTTP Tunnel connections are now present.

To support libraries during COVID-19 global crisis, MuseKnowledge™ Proxy Trial periods are now extended from 30 days to 90 days. Request your Trial License Key by simply filling in the trial form.

A Live Chat is available in the MuseKnowledge Search Application starting with the upcoming version 8.1. It allows end-users to connect in real time via chat with a Library representative (operator) for online support about how to use MuseKnowledge Search Application and its search resources.

End User’s Perspective

The chat is available for end users in the MuseKnowledge Search Application in the lower right corner and it can have different appearances, depending on the Live Chat Platform integrated. Below is a screenshot with the initial form of the chat box and the next forms after filling in the required details and starting the conversation.

Administrator’s Perspective

Many Live Chat Platforms can be integrated into the MuseKnowledge Search Application. The following platforms were tested successfully: Live Helper ChatLiveChat and Pure Chat.

1. Customers without an existing live chat solution

For customers without an existing Live Chat Solution, either self hosted or subscribed, we can offer this service in our hosted Live Chat Platform. We will provide you operator account(s) in our hosted chat platform and take care of the necessary configurations in your MuseKnowledge Search Application for enabling the Live Chat functionality.

2. Customers with an existing live chat solution

The customers having a subscription for a commercial chat solution, or hosting one themselves, can enable the Live Chat functionality by following the below instructions. Minimal knowledge on JavaScript, HTML is needed; if the integration does not succeed please contact the MuseGlobal Support team for help.

  1. Obtain the JavaScript code from your Live Chat Platform which needs to be integrated into the application. Usually this is obtained from an administration console of your chat platform or FAQ item. For more details you should address to the support team of your Live Chat Platform.
  2. Access the MuseKnowledge Console for Applications Administration of your installation, e.g. https://yourdomain/mmc . Select the application for which to enable Live Chat functionality from the applications list and access the Application General Settings -> Interface Options left menu item.
  3. In the new page access the Functionality tab and set to yes the Enable Chat: option.
  4. Replace the existing code from the revealed text area with the below code in which replace the placeholders (e.g. {js_chat_object}{html_chat_object}, etc.) with the appropriate values corresponding to your chat JS or HTML code content. Note that it is mandatory to have the "init" and "destroy" functions for chat object initialization and removal, as these are wired from the application code:
    app.constant("chat", {
        "init": function(language){
    
            // If the chat object is already initialized, then exit, nothing else to do.
            // Example:
            if (window.{js_Chat_Object}){
                return;
            }   
       
         // Paste here the JS code specific to your chat platform, obtained as explained above.
        },
        "destroy": function(languageChanged){
            // If to apply a new chat language destroy is not needed, just return when languageChanged == true.
    
            // If the chat object does not exist, then exit, nothing else to do.
            // Example:
            if (!window.{js_Chat_Object}){
                return;
            }
    
            // Remove all JS/HTML chat objects/elements unless your chat has its own unloading method (which must be used in this case).
            // Examples:
            window.{js_Chat_Object}" = undefined;
            angular.element("{html_chat_object}").remove();
        }
    });

 

Craiova, Romania, 1st February 2021

EduLib S.R.L., a specialist software development company serving the library and education technology market for over 20 years, is pleased to announce the launch of its newly redesigned website. Over the past year, the EduLib team has been working to build a new website that better reflects its development and support service offerings, improves navigation to its technical materials and provides a refreshed look and feel to welcome and engage its partners and customers.

EduLib’s goal with this new website is to provide partners and customers with up-to-date and in-depth technical content about the Muse Knowledge platform and the range of Muse development, support and technical services exclusively provided by the EduLib team. EduLib plans to update its new website regularly to reflect all of the latest product information and technical resources for the Muse Knowledge platform and related offerings.

Since 1998, EduLib has successfully served as the exclusive development partner for Muse solutions, and today, the EduLib team of experts proudly leads development of the Muse Knowledge digital library platform, launched in 2016.

EduLib is excited to share its new website with you and your feedback is important to us. Please share any questions, comments or concerns to this email form here.

The Muse™ Federated Search (MuseSearch™) and the Standalone Muse™ Proxy for Muse™ Proxy Applications are two client oriented services powered by Muse™ Technology. Being two separate services it is recommended to run them on separate servers (either physical or virtual machine) to have a clear separation of them from management and technical point of view.

However, there are cases when this setup is not wanted, hence it is required to run them both on the same server (of course only if the hardware characteristics are met). This is the subject of this article.

A Muse™ Proxy component (Software Integration Edition) is already part of Muse™ Federated Search by default for providing IP authentication to data service providers and to rewrite records URLs for end-user link navigation to native records or fulltext.

Technically there are two solutions for hosting the Muse™ Federated Search and a Standalone Muse™ Proxy for Muse™ Proxy Applications services on the same server. These solutions are possible due to the Muse Proxy functionality of binding to multiple IPs.

1. Muse™ Federated Search that includes by default Muse™ Proxy (Software Integration Edition) and a second Standalone Muse™ Proxy with Muse™ Proxy Applications component enabled, which means two Muse™ Proxy instances.

AdvantagesDisadvantages

  • The main advantage is that the two services are clearly separated.


  • This setup is pretty complex because it requires extra configurations and customizations in both Muse Proxy instances, not to mention maintenance work, like upgrading to newer versions.

2. Muse™ Federated Search with Muse™ Proxy (Software Integration Edition) but which also enables the Muse™ Proxy Applications component, hence a single Muse™ Proxy instance serving for both, MuseSearch™ clients and for the clients using Muse™ Proxy Applications.

AdvantagesDisadvantages

  • The main advantage of this setup is from the maintenance point of view as there is only one Muse Proxy instance to manage.


  • The monitoring and statistics are common for both Muse Federated Search and Muse Proxy Applications services, hence they cannot be differentiated;

  • The maintenance done for the Muse Proxy for one of the services will affect the other service as well, at least from the downtime point of view;

  • The high usage of one service will affect the performance of the other service.

 

Next are presented the steps for implementing the above 2 solutions.

1. Running two Muse™ Proxy instances on the same server as part of the Muse™ Federated Search and Muse™ Proxy Applications services.

  • The first step is to install the Muse™ Federated Search and the Muse™ Proxy needed for it. The installations of Muse™ Federated Search and Muse™ Proxy for Federated Search are not covered in this article. The only note is that the Muse™ Proxy server must be configured to bind to the IPs specific for the Muse™ Federated Search service.
  • Make the preparations for installing the Muse™ Proxy Applications service. Because a second Muse™ Proxy service will be installed on the same machine, there are several preparations to be made prior to the installation:
  • uninstall the Muse™ Proxy service used by the Muse™ Federated Search service; this is done by running the %MUSE_HOME%\proxy\UnInstallMuseProxyService.bat script on a Windows OS or ${MUSE_HOME}/proxy/setup/startMuseProxyServiceSetup.[sh|csh] on a
    Linux OS.
  • uninstall the Muse™ Proxy service used by the Muse Federated Search service; this is done by running the %MUSE_HOME%\proxy\UnInstallMuseProxyService.bat script on a Windows OS or ${MUSE_HOME}/proxy/setup/startMuseProxyServiceSetup.[sh|csh] on a
    Linux OS.

    • on a Windows OS rename %CommonProgramFiles(x86)%\InstallShield into %CommonProgramFiles(x86)%\InstallShield.MFS and %USERPROFILE%\muse-proxy-options.txt into %USERPROFILE%\muse-proxy-options.txt.MFS;
    • on a Linux OS rename ${HOME}/InstallShield into ${HOME}/InstallShield.MFS and ${HOME}/muse-proxy-options.txt into ${HOME}/muse-proxy-options.txt.MFS;
  • Install Muse™ Proxy according to the instructions from the Muse™ Proxy Install.pdf manual. During the installation process make sure to install Muse™ Proxy in a different location than the one used by the Muse™ Federated Search service and do not install Muse™ Proxy as a service when asked by the setup. Installing it as a service will be done manually. Do not start the new Muse Proxy instance yet.
  • Make the following postinstall configurations:
  • edit the MuseProxy.xml file from the newly installed Muse™ Proxy and add in the BINDADDRESS field the list of IPs for the Muse™ Proxy Applications service on which to bind;
  • edit the MuseProxy.xml file from the newly installed Muse™ Proxy and add in the RMI_SERVER_ADDRESS field the first IP from the list of IPs for the Muse™ Proxy Applications service;
  • edit the startMuseProxy[.|bat|csh] and stopMuseProxy[.|bat|csh] scripts from the newly installed Muse™ Proxy and after the line containing the Copyright statement add the following:
    • In the Windows OS scripts (startMuseProxy.bat/stopMuseProxy.bat) add the following line:

      set MUSE_HOME=location_on_disk_of_MuseProxy

      where replace location_on_disk_of_MuseProxy with the actual location on disk of the newly installed Muse™ Proxy.

    • In the Linux OS scripts (startMuseProxy[.csh]/stopMuseProxy[.csh]) add the following line:

      export MUSE_HOME=location_on_disk_of_MuseProxy

      where replace location_on_disk_of_MuseProxy with the actual location on disk of the newly installed Muse™ Proxy.

  • On Windows OS edit the InstallMuseProxyService.bat script from the newly installed Muse™ Proxy and change the line::

    set SERVICE_NAME=Muse Proxy Server

    to

    set SERVICE_NAME=Muse Proxy Server Applications

  • after the above added line add the following:

    set MUSE_HOME=location_on_disk_of_MuseProxy

    where replace location_on_disk_of_MuseProxy with the actual location on disk of the newly installed Muse™ Proxy.

  • Install the new Muse™ Proxy instance as system service as following:
  • On Windows OS run the following script from the newly installed Muse™ Proxy:

    InstallMuseProxyService.bat

  • On Linux OS copy the existing /etc/init.d/museproxy into /etc/init.d/museproxyapps and:
    • edit /etc/init.d/museproxyapps and change the value of the MUSE_HOME variable to point to the location on disk of the newly installed Muse™ Proxy;
    • configure the /etc/init.d/museproxyapps script to be started at boot by using system tools such as update-rc.d:

      update-rc.d museproxyapps defaults

  • Start the Muse™ Proxy Applications service as following:
    • On Windows OS go to the “Services” Management Control Console, locate the “Muse™ Proxy Server Applications” service and start it; or start it by running the following command in a Command Prompt window:

      net start "Muse Proxy Server Applications"

    • On Linux OS run the following command:

      /etc/init.d/museproxyapps start

  • Update the MUSE_HOME environment variable to point to the Muse™ Federated Search home location (default /opt/muse on Linux and C:\Program Files (x86)\muse on Windows). On Windows go to Control Panel->System->Advanced system settings->Environment variables, locate the definition of the MUSE_HOME variable and change it accordingly. On Linux this is done by editing the user profiles, individually per user in ${HOME}/.login or globally in /etc/profile.
  • Install the Muse™ Proxy service for Muse™ Federated Search; this is done by running the

    %MUSE_HOME%\proxy\InstallMuseProxyService.bat

    script on a Windows OS or

    ${MUSE_HOME}/proxy/setup/startMuseProxyServiceSetup.[sh|csh]

    on a Linux OS.

  • Start the Muse™ Proxy service used by the Muse™ Federated Search as following:
  • On Windows OS go to the Services Management Control Console, locate the Muse™ Proxy Server service and start it; or start it by running the following command in a Command Prompt window:

    net start "Muse Proxy Server"

  • On Linux OS run the following command:

    /etc/init.d/museproxy start

2. Using the Muse™ Proxy instance from the Muse™ Federated Search service to also serve the Muse™ Proxy Applications service.
The Muse™ Proxy instance from the Muse™ Federated Search service does not have included in the license Muse™ Proxy Applications, hence it must be upgraded to include Muse™ Proxy Applications. For this purpose the latest version of the Muse™ Proxy setup kit must be run with the acquired license that includes Muse™ Proxy Applications. This will be seen as an upgrade, hence the existing configurations of the Muse™ Proxy for the Muse™ Federated Search service will be preserved.