Skip to main content

Noetix Platform and its core components

Overview

The Noetix Platform includes the following main components that work together to create an enterprise architecture for reporting:

NQS serves as a central repository for storing and managing metadata that describes data from disparate sources.

NWQ provides an easy web-based access to create and run reports.

Magnitude NoetixViews (NoetixViews) contains customized views of your Oracle E-Business Suite data. For more information about NoetixViews, see the Magnitude NoetixViews Administrator Guide.

As Noetix Platform is extensible, third-party query tools can also be used with it.

Noetix Platform Architecture

About NQS

Noetix QueryServer (NQS) acts as a central repository for storing and managing metadata that describes data from disparate sources, creating a powerful library of virtual tables (VTables) and views. Across departments, enterprises, or suppliers, NQS securely manages data access and query activity by providing a single point of query maintenance—regardless of the number of data sources or structure complexity.

Today, when your users want to retrieve data from a database, they log on to the database, run a query (SQL command), and then view the results. If the user wants to access different data in a different database, they must also log on to this database and then run a query.

With NQS, the user can access all data through NQS. When the user (or the query tool that the user is running) runs a query, the SQL command is transparently routed by NQS to the correct physical database. The way that a query is routed is completely configurable by the administrator. If the user wants to access a different set of data, they can issue the new query against NQS without having to log on again.

From CRM and HR to ERP applications, NQS bridges the gap between heterogeneous data sources, delivering accessible information without the time and expense associated with other data integration solutions. NQS’s patented query routing technology intelligently ensures reporting efficiency, reducing bottlenecks and improving performance while effectively scaling to meet and deliver information when and where needed.

Benefits of NQS include:

Patented routing technology: Using the power of metadata, NQS optimizes query performance, improving data access efficiency and report generation.

Data integration: NQS integrates multiple, disparate data sources to provide centralized query and data access management.

Flexibility: NQS delivers secure, reliable data access control across departments, enterprises, and business partner operations.

Speed: NQS presents a single query repository of business-oriented views to speed report generation and development.

NQS consists of the components and tools, which are shown in Figure 1.2. The sections following the diagram give a brief overview of the components and tools.

NQS Architecture

NQS Components

Noetix QueryServer service: A Windows server application (that is a Windows Service) that includes metadata management and intelligent routing capabilities. Noetix QueryServer service is the heart of NQS and acts as a logical layer to isolate client applications from changes in the physical servers.

NQS repository: A Microsoft SQL Server database used to store all NQS metadata. This database can exist on the same computer as the Noetix QueryServer service or on a separate computer for scalability. NQS communicates with the repository database through the Microsoft ODBC driver for SQL Server.

NQS Monitor repository: A SQL Server database used to store logs of NQS activity. This database can exist on the same computer as the Noetix QueryServer service or on a separate computer for scalability.

NQS Connect: Connectivity software, in the form of an ODBC driver, that enables client/server applications, report servers and Web servers that use ODBC and OLE DB to directly connect to RDBMS data sources. Through ongoing communication with the Noetix QueryServer service, NQS Connect obtains information for the client directly from the RDBMS. This component is installed on each server and client computer that communicates directly with NQS.

Noetix Cache Maintenance Server (optional): A Windows server application (that is, a Windows Service) responsible for caching data for better query performance. The Noetix Cache Maintenance Server component (CMS) can be installed on the same computer as the Noetix QueryServer service or on a separate computer for scalability.

CMS does the real work of caching the data from the source to the defined cache connection, that is, the target. You can install and configure one or more Cache Maintenance Servers for your enterprise, and add more servers in the future as your performance needs grows.

Noetix agent tools (optional): The Noetix agent tools allow you to schedule recurring tasks and automatic alerts. Agent jobs can be set up to inform you about specific conditions in your data (for example, sales exceed 5,000 orders) or scan your metadata looking for problems. Agent jobs can also be set up to schedule backups of NQS. The agent tools are installed on the same server as your NQS repository. NQS Administrator provides easy access to setting up Agent jobs and alerts.

Heterogeneous mapping server (optional): The heterogeneous mapping server (HMS) feature allows you to set up heterogeneous mappings for VTables. Heterogeneous mappings are used to bring together data from different servers, or from different database types.Loopback server: Loopback server is a special server created by the system in Noetix QueryServer (NQS) that points back to the NQS server. The loopback server is created the first time you start NQS Administrator. The connection information of the loopback server contains the connection details for an NQS data source. The log in credentials of the loopback server is the same as the log in credentials of the SysAdmin user account.

The loopback server is created to support virtual views (VViews). VViews are objects that are based on other virtual tables in NQS. Since VViews are based on NQS virtual tables and not on underlying tables from external data sources such as Oracle or Microsoft SQL Server, a special NQS data source has to be created to process VViews.

The following figure describes the behavior when you execute a typical SQL query against a virtual table in NQS. The incoming SQL is translated by NQS to physical SQL that is targeted for the raw data source such as Oracle or SQL Server.

The following figure describes the behavior when you execute a typical SQL query against a VView in NQS. Since the physical SQL actually points back to NQS itself by using the loopback server, the SQL query must be translated again. This translation continues to loop back to NQS through the loopback server until the underlying virtual table that the VView is based on, is discovered. The final physical SQL is then sent to the raw data source that the virtual table poins to.

Additionally, NQS lets VViews to be based on other VViews. In this scenario, multiple loop backs to the NQS server may occur until the underlying virtual table is finally discovered.

NQS Administrator Tools

There are four main tools to administer the NQS components. These administrator tools are installed along with the Noetix QueryServer service, but can also be installed on administrator computers for easier access. For more information about these tools, see Noetix Platform Administration Guide.

NQS Administrator: A Windows-based application used by administrators to set up, manage, control and optimize the enterprise DSS architecture. Manages the metadata in the NQS repository, as well as the Noetix Cache Maintenance Server.

NQS Monitor: A Windows-based application used to track and analyze query and resource usage. Manages the NQS Monitor repository.

NQS Query: A Windows-based application used to run ad hoc queries against the NQS repository.

About NWQ

Noetix WebQuery (NWQ) is a web-based query tool for exclusive use with NQS. With NWQ, users can create, run, and share ad hoc reports based on data exposed by NQS.

NWQ requires no client-side installation, simplifying deployment and management concerns. Like all Magnitude products, NWQ’s open architecture is ideal for use in a complete business intelligence solution.

Features of NWQ include:

Internet-ready reports: Web-enabled capability delivers information when and where needed.

Quick installation: Easy-to-use interface assures fast deployment, eliminating extensive training.

Flexibility: Open architecture uses XML standards to provide powerful compatibility with most web-enabled systems.

NWQ consists of the components and tools, which are shown in Figure 1.3. The sections following the diagram give a brief overview of each component.

NWQ Architecture

NWQ Components

Noetix Gateway: The Noetix Gateway (gateway) is a Microsoft Windows web service that is used to manage and run ad hoc reports and deliver subscriptions.

The gateway communicates with the Noetix QueryServer service through NQS Connect to authenticate users, save reports, create folders, and perform other tasks.

NWQ repository: The NWQ repository is used to store the ad hoc reports, folders, and so on, that are created by end users. This repository is housed within the NQS repository.

NWQ Administrator Tools

NWQ and NWQ Administrator allow you to use and administer NWQ. More information about these tools can be found in this guide and in the online help files for NWQ and NWQ Administrator.

NWQ: NWQ client is a web-based interface that interacts with the gateway. From this interface, end users can build and run reports for use in the browser or in Microsoft Excel.

NWQ Administrator: NWQ Administrator is a browser-based administrative tool that manages NWQ profiles, customizing which features and tools in NWQ each end user can access. Using NWQ Administrator, you can also generate a list of all queries a user owns or take ownership of any NWQ query. NWQ Administrator also allows you to view a listing of queries, subscriptions, and subscription schedules. In addition, NWQ Administrator allows you to view query usage in two ways: by user and by query.

NWQ Printer Utility: NWQ Printer Utility is a Windows-based administrative tool that allows you to manage paper source values for printers used in NWQ subscriptions deliveries.

About Noetix Delivery Services

Noetix Delivery Services comprises Noetix DeliveryManager and Noetix DeliveryServer, which are Microsoft Windows services used for subscription delivery. The two services are used to deliver subscriptions to printers, email addresses, and network locations.

Noetix DeliveryManager

Noetix DeliveryManager hosts a central queue for all scheduled subscriptions and delegates the deliveries to one or more instances of Noetix DeliveryServer.

On receiving a subscription, Noetix DeliveryManager:

Makes calls to gateway to retrieve delivery settings for the subscription, and then places it in the central queue.

Waits for Noetix DeliveryServer to request a subscription, and then sends it.

Receives delivery status from Noetix DeliveryServer.

If Noetix DeliveryServer fails to deliver a subscription or stops responding, an error will be logged for the subscription in NWQ.The settings for Noetix DeliveryManager are configured in the NoetixDeliveryManager.exe.config file, which is located in <hard disk drive>:\Program Files\ Noetix\NWQ\Delivery. For more information about the configuration file, see Noetix DeliveryManager.exe.config in “Maintenance.”

Noetix DeliveryServer

Noetix DeliveryServer delivers a subscription to a printer, email address, or network location. For example, subscriptions can be delivered to Noetix Dashboard. Microsoft SQL Server Reporting Services is used for rendering the query in various file formats, such as PDF and HTML.

Noetix DeliveryServer requests a subscription from Noetix DeliveryManager, which hosts a central queue for all the subscriptions. Then, Noetix DeliveryServer delivers the subscription to its destination.

On receiving the subscription from Noetix DeliveryManager, Noetix DeliveryServer:

Runs and renders the subscription through SQL Server Reporting Services.

Delivers the subscription to a printer, email address, or network location.

Sends delivery status to Noetix DeliveryManager.

If Noetix DeliveryServer fails to deliver a subscription or stops responding, an error will be logged for the subscription in NWQ. The settings for Noetix DeliveryServer are configured in the Noetix DeliveryServer.exe.config file, which is located in <hard disk drive>:\Program Files\Noetix\NWQ\Delivery. For more information about the configuration file, see Noetix DeliveryServer.exe.config in “Maintenance.”

Noetix Add-in for Microsoft Excel

Noetix Add-in for Microsoft Excel (add-in) provides you an alternative approach to access and run the queries available in your instance of NWQ from Microsoft Excel. The Report Browser of the add-in displays the queries that are available in the Public and Personal folders of NWQ. Any change made to the queries in NWQ is reflected in the add-in reports after the report is refreshed in the add-in.

The benefits of the add-in are the following:

Run reports from several servers in one workbook.

Convert the Query in Excel embedded queries to add-in reports.

Access NWQ from the add-in.

About Noetix Generator

The Noetix generators for Noetix Platform are as follows:

Noetix Generator for Noetix Platform—Oracle E-Business Suite Edition (Noetix Generator)

Noetix Generator for Noetix Platform—Noetix Analytics Edition (Noetix Generator)

Noetix Generator for Noetix Platform—Oracle E-Business Suite Edition (Noetix Generator) exports the base views, user data, and security structure from your NOETIX_SYS schema in the Oracle database to NQS and NWQ in Noetix Platform. This helps you to not only access your NoetixViews data in NQS and NWQ, but it also ensures that proper security is applied. Noetix Generator also generates prebuilt reports created by Magnitude NoetixViews Administrator (NoetixViews Administrator). These reports provide immediate answers to many common business questions. For more information, see the Noetix Generator for Noetix Platform Administrator Guide for Oracle E-Business Suite.

Noetix Generator for Noetix Platform—Noetix Analytics Edition (Noetix Generator) exports the base views, table information, and related folder information from your Active Meta Data Repository (AMDR) schema to NQS and NWQ in Noetix Platform. For more information, see the Noetix Generator for Noetix Platform Administrator Guide for Noetix Analytics.

About NoetixViews

NoetixViews unlocks the data hidden in corporate databases by providing user-friendly, plug-and-play business views of data, helping speed the flow of information throughout the enterprise. Customized to each unique database configuration, the automated install process cuts weeks off typical custom installations. NoetixViews provides the fast track to delivering familiar business terminology right to employees, partners, and customers.

By hiding complexity within metadata, NoetixViews simplifies and greatly accelerates report generation and ad hoc query creation, empowering decision-makers and front-line employees with timely and accurate access to critical information. Designed with integration in mind, the Noetix Platform extends the power of NoetixViews information to a myriad of third-party reporting and analytical tools.

NoetixViews is available for Oracle E-Business Suite. For information on installing and managing NoetixViews, see your Magnitude NoetixViews Administrator Guide.

About NoetixAnswers

NoetixAnswers immediately enhances the solution provided by Magnitude Software, Inc. by providing instant answers to common business questions without complicated query development. NoetixAnswers uses the access and translation capability of installed Magnitude products to deliver custom answers without the need to define data locations or write query code.

Available for NoetixViews modules, NoetixAnswers enables the power within the Noetix metadata to automatically map and create application-specific queries customized to each unique application configuration. With NoetixAnswers, Noetix delivers more than business views – it provides instant access to business information without taxing IT resources.

For more information about installing and managing NoetixViews, see the Magnitude NoetixViews Administrator Guide.

About Noetix Logging Service

Noetix Logging Service records the user actions and results of the prerequisites check done using the Noetix Platform Prerequisite Checker (Prerequisite Checker) standalone client or the prerequisites check done during the Noetix Platform installation. Noetix Logging Service also tracks the state of the installation on different computers in a typical multi-computer installation. A typical multi-computer installation involves installing Noetix Platform components on two, three or four computers. For more information, see the Noetix Platform Installation Guide.

The information recorded or tracked by Noetix Logging Service is stored in a log file. For more information about the log file, see About Log File.

Noetix Logging Service is installed on the computer on which you have installed NQS. This will be the first computer in a typical multi-computer installation.

Components of Noetix Logging Service

Noetix Logging Service comprises the following components:

RepositoryStateService: This service runs on the NQS computer. It keeps track of the current installation state in a multi-computer installation and responds to requests from other computers (involved in a multi-computer installation) for the current installation state.

ClientStateProxy: This is a proxy for RepositoryStateService and runs on computers other than the NQS computer in a multi-computer installation. Before the installation is started on the second, third, or fourth computer, ClientStateProxy remotely connects to the NQS computer (first computer) and requests the RepositoryStateService for the current installation state. Based on the current installation state, the installation wizard proceeds with the next component’s installation on the computer.

RepositoryLoggingService: This service runs on the NQS computer. In a typical multi-computer installation, RepositoryLoggingService manages the synchronization of log files on other computers with the log files on the NQS computer. RepositoryLoggingService will continually run on NQS computer after installation because it is critical for the synchronization of log files.

ClientLoggingProxy: This is a proxy for RepositoryLoggingService. In a multi-computer installation, it runs on computers other than the NQS computer. It synchronizes the log files on different computers with the log files on the central repository (NQS computer).

About Log File

Log files are created each time you run the Noetix Platform installation wizard or Noetix Platform Prerequisite Checker (Prerequisite Checker). You can distinguish the log files based on the time specified in the log file name. For more information about the naming convention of the log files, see Naming Convention of Log Files in “Maintenance.”

The information is immediately written to the log files on the local computer to prevent loss of any data. The log files created for the Noetix Platform typical multi-computer installation are periodically synchronized with the log files on the NQS computer. Any non-public information is stored in an encrypted form in the log file.

A log file is complete or well-formed when a full run of the Noetix Platform installation wizard or Prerequisite Checker is completed. In a typical multi-computer installation, the log files can be used by administrators to have detailed information about the user selections and actions during installation, prerequisite checks, and installation state of a computer. The user can also send the log files to Magnitude Support for troubleshooting by attaching them to an email message.

Types of Log Files

The following types of log files are created by Noetix Logging Service:

The .xml file is created during the installation or prerequisite checks. In a typical multi-computer installation, the .xml file on the NQS computer is synchronized with the .xml files on the other computers. This file records the user actions and components selected during installation and also the prerequisite check results.

The .log file is created during the installation. However, in a typical multi-computer installation, the .log file on the NQS computer is not synchronized with the .log files on the other computers. This file has the information that is available when you click Show Details on the Installing page during the installation of Noetix Platform.

Location of Log Files

The log files are created in <hard disk drive>:\Program Files\Common Files\Noetix\Logs on the local computer.

If you have a Program Files folder in multiple hard disk drives (C, D, and E), the primary Program Files folder will be considered for storing the log files. To locate the primary Program Files folder, type %ProgramFiles% in the Address bar of Windows Explorer, and press ENTER.

How a Query is Processed

When a user runs a query in NWQ, the request is sent through the Noetix components to be processed, translated, and returned to the user as data, as described in this section and the following diagram:

Query Flow Through the Noetix Platform

The logical query run by the user is sent to the gateway through HTTP GET and POST requests over TCP/IP (step 1 in Query Flow Through the Noetix Platform). The gateway sends the query to the NQS Connect ODBC driver (step 2). This driver sends the query to the Noetix QueryServer service (step 3). When NQS Connect and the Noetix QueryServer service are on separate servers, this is done using a series of DCOM calls using the network protocol available on the NWQ and NQS servers (usually TCP/IP).

When using a third-party query tool, the tool would send the query straight to NQS Connect without passing through the gateway.

The query is next processed and transformed by the NQS (step 4). NQS uses the metadata in the NQS repository and cost-based optimization algorithms to determine the optimal mapping of the logical query to a physical server. After NQS determines which physical server should handle the query, it transforms the query so that it is executable by this server. The transformed query, as well as connection information for the server, is sent back to NQS Connect (step 5), which sends the query through an RDBMS-specific ODBC driver (step 6) to the physical server (step 7). The physical server returns the query results through NQS Connect to the gateway (Step 8). The gateway transforms the query result set into an XML document, which it sends to NWQ through HTTP (step 9).

To the person using NWQ, it appears that a query has been run against the target database and their data has been returned, as in Query Flow from a User’s Perspective. The query routing and other technical details are completely invisible.

Query Flow from a User’s Perspective

Setting Up Noetix Platform

After installing the Noetix Platform software and generating NoetixViews, Magnitude Software, Inc. recommends that you perform the following tasks to finish setting up your Noetix Platform environment:

Change SysAdmin password. For information, see Group Users into Organizations in “Managing Users, Organizations.”

Start NQS Monitor. For information, see NQS Monitor in “Using Administrator Tools.”

Create administrative users. For information, see Manage User Accounts in “Managing Users, Organizations.”

Configure other data sources and/or security structures in NQS. For information, see Noetix QueryServer (NQS)—virtual tables (VTables) and mappings and Noetix QueryServer (NQS) servers and connections.

Review or customize NWQ profiles. For information, see Manage Profiles in “Managing Security.”

Grant NWQ folder permissions. For information, see Granting Permission to an NWQ Folder in “Managing Security.”

About the Use of email in Noetix Platform

Noetix Platform uses the email feature to deliver subscriptions to an email address, send notifications about the success or failure of subscriptions and agent jobs, send alerts for the agent jobs, and send information related to a build in Noetix Generator Manager. This section provides information about how and when Noetix Platform uses the email feature.

To use email in Noetix Platform, you must configure a Simple Mail Transfer Protocol (SMTP) server. For information about configuring an SMTP server, see the Microsoft documentation.

Noetix Platform uses email to accomplish the following tasks:

To deliver subscriptions to email addresses using its email delivery cartridge. Noetix Platform uses its email delivery cartridge to perform this task. For information about delivering subscriptions to one or more email addresses, see “Delivering Subscriptions” in the section “Creating and Delivering Subscriptions” in the NWQ User Help.

To send notifications about the success or failure of subscription deliveries and agent jobs using Microsoft SQL Server’s SQL Server Agent Mail, which uses Database Mail. For information about how Noetix Platform uses SQL Server Agent Mail for this task, see Setting Up an email Profile in “Maintenance.”

To send alerts for the agent job using SQL Server’s SQL Server Agent Mail, which uses Database Mail. For information about how Noetix Platform uses SQL Server Agent Mail for this task, see Setting Up an email Profile in “Maintenance.”

To send information related to a build in Noetix Generator Manager. Noetix Generator Manager, a web-based tool of Noetix generators for Noetix Platform, sends an email message when a conversation in a build is waiting for user input for more than 15 minutes and when a build is completed, failed, or stopped. For more information, refer to the respective documentation of Noetix generators for Noetix Platform.

Was this article helpful?

We're sorry to hear that.