Maxim Reprting: Maxim-Cgns Metadata Overview...2 Maxim Metadata...2 Reprt Object Structures...2 Maxim Metadata Mdel...4 Metadata Publishing Prcess...5 General Architecture...5 Metadata Publishing Prcess Executin...6 Prcess Cnfiguratin...9 Reference Cgns SDK libraries...9 Create a Namespace in Cgns Cnfiguratin...9 Set System Prperties...11 Set End Pint Prperties...12 Functinal Cnsideratins...13 Maxim Base Services 7.1.1.6 Fix Pack 1
Overview T supprt integratin with Cgns 8 reprting tls, the 7.1.1.6 fix pack implements functinality that enables Maxim t create and publish Metadata Packages. These packages include data mdels, based n Reprt Object Structures, that allw Maxim reprt authrs t design Cgns 8 reprts accrding t Maxim business bjects definitins. Maxim Metadata Cgns 8 reprting tls require data surces t be lgically defined by means f a metadata mdel. A metadata mdel is respnsible f prviding an accurate representatin f the elements available in the physical definitin f its crrespnding data surce. Maxim-Cgns integratin prvides metadata mdels that encapsulate the cmplexity f Maxim s physical database definitin and expse a user friendly view f Maxim s business bjects definitins. Maxim metadata, when published t Cgns 8, define the tables, attributes and relatinships that the reprting tls will be using t reference Maxim data cntent. Reprt Object Structures Object Structure: REP_WORKORDER WORKORDER ASSET Cllectin f Business Objects and Relatinships that define the data cntent f Maxim Wrk Orders Business Objects define persistent attributes LOCATIONS Business bject relatinship based n where clause: assetnum = :assetnum and siteid=:siteid Maxim Base Services 7.1.1.6 Fix Pack 2
Maxim metadata mdels are based n Reprt Object Structures (ROS). ROS prvide a cllectin f the business bjects, and their assciated relatinships, that define Maxim s functinal cmpnents (i.e. Assets, Wrkrders, etc.) data structure metadata -. Maxim reprting functinality already leverages ROS data structures t effectively interact with Maxim s database. Business bjects define data attributes available fr Maxim reprting functinality; when registered t a ROS, business bject attributes are subject t Object Structure Applicatin exclude/include fields functinality. This functinality permits the exclusin f specific persistent attributes frm its crrespnding business bject enabling yu t simplify the amunt f data supprted by the ROS withut affecting the business bject definitin. Relatinships between parent and child bjects are specified at the parent s relatinship tab via the Database Cnfiguratin applicatin. A SQL statement specifies the attributes utilized t establish the parent child relatinship. The Cgns Metadata publishing prcess implemented in Maxim Base Services 7.1.1.6 fix pack ONLY SUPPORTS clumn t clumn relatinships (simple relatinships) fr example: WORKORDER establishing a parent relatinship with ASSET, by means f their crrespnding ASSETNUM and SITEID clumn values will be specified by this SQL statement: assetnum=:assetnum and siteid=:siteid. Realtinships defined by SQL statements that include filters and/r sub-selects (cmplex relatinship) will generate a metadata generatin prcessing exceptin and the publishing prcess will be interrupted. Maxim Base Services 7.1.1.6 Fix Pack 3
T reslve this prblem it is necessary t re-define the relatinship via a COLUMN TO COLUMN relatinship. An example f a cmplex relatinship is: WORKORDER establishing a parent relatinship with ASSET, by means f their crrespnding ASSETNUM clumn SITEID clumn values and that restricts the pssible result set based n a sub-select statement that validates additinal LINETYPE against the SYNONYMDOMAIN bject: assetnum=:assetnum and siteid=:siteid and linetype nt in (select value frm synnymdmain where dmainid='linetype' and maxvalue='tool') Maxim Base Services 7.1.1.6 Fix Pack 4
Maxim Metadata Mdel T prperly represent Maxim s metadata (business bjects, relatinships, and physical tables), Maxim metadata publishing prcess creates a layered data mdel based n tw different relatinal mdel views: Data Surce View The Data Surce View will prvide a lgical representatin f the physical tables and views defined in Maxim s database. Cgns Surce Query subjects are used t represent these data structures in Maxim s metadata mdel Business Lgic View The Business Lgic View is respnsible f prviding all the necessary metadata fr Query Studi and Reprt Studi applicatin cnsumptin. The Business Lgic View prvides a layer f abstractin between business lgic and their underlying data surces. In Maxim s cntext, business lgic is represented by business bjects and data surces are represented by the table and view cmpnents defined at the database level. Business Lgic View Clumn Exclusins Data Surce View Relatinships Tables Attributes Data types Maxim Metadata Package Maxim Base Services 7.1.1.6 Fix Pack 5
Metadata Publishing Prcess General Architecture The Metadata Publishing Prcess is an end-t-end synchrnus integratin scenari that enables Maxim t cmmunicate ROS data structures t Cgns 8 BI Server. Maxim Base Services 7.1.1.6 Fix Pack 6
Maxim metadata is cnfrmed by the Business Objects defined in Maxim s Data Dictinary Object Structures prvide functinal cntext t a grup f Business Objects. (i.e. purchasing, wrk rder escalatin, etc) Invcatin Channels supprt the required prcessing functinality t cnvert an bject structure int a Cgns Transactin. Invcatin Channels leverage End Pint cnnectivity lgic t request the executin f a service in a cntext ther than Maxim. End Pints supprt the required prcessing functinality t leverage Cgns SDK libraries t invke metadata mdeling services available via Cgns Business Intelligence Server. The referred services prvide a standard interface fr Cgns metadata creatin and package publishing. Metadata Publishing Prcess Executin The Metadata Publishing prcess is initiated frm a Select Menu Actin ptin in the Object Structure Applicatin. This new menu ptin is nly available t the System Administratr security grup. If yu require ther grups and/r users t have access t the Publish as Cgns Package menu yu ll need t re-cnfigure Security Grups settings. Maxim Base Services 7.1.1.6 Fix Pack 7
When selected, the Publish as Cgns package triggers the executin f the REP_MXINTOBJECTInvcatin invcatin channel. The invcatin channel integratin cmpnent implements all the prcessing lgic t generate and publish Maxim metadata as Cgns package: Maxim metadata assciated with the selected ROS is identified ROS data structure is created ROS data structure is transfrmed t Maxim metadata Maxim metadata is translated int Cgns Actins Cgns transactin is created Cgns transactin is published t Cgns 8 BI server At the end f the publishing prcess a dialgue will display the result f the publishing prcess: Maxim Base Services 7.1.1.6 Fix Pack 8
After the publishing prcess is successfully executed, yu will be able t wrk with the published metadata package via Cgns 8 reprting tls. The metadata package will be uniquely identified in the Cgns 8 Cntent Stre by the fllwing naming cnventin: <ObjectStructureName>Package Maxim Base Services 7.1.1.6 Fix Pack 9
When displayed via Query Studi r Reprt Studi, the metadata cntent will present the same data structure cnfiguratin as it is specified in its crrespnding ROS: Objects, Attributes and their crrespnding relatinships. Maxim Base Services 7.1.1.6 Fix Pack 10
Prcess Cnfiguratin Reference Cgns SDK libraries T enable the publishing f the Reprt Object Structures as Cgns Packages, Cgns SDK libraries are REQUIRED. In these next steps, the Cgns SDK JAR files will be added t the classpath f the applicatin server where Maxim is running. Websphere Applicatin Server Cpy the fllwing jars frm <Cgns SDK Installatin Directry>\sdk\java\lib t the applicatin server lib directry: 1. cgns-axis.jar 2. cgnsclient.jar Restart the applicatin server. Weblgic Applicatin Server Add the fllwing jar files t the server classpath entry in the setdmainenv.cmd file that crrespnds t Maxim s BEA dmain: 1. cgns-axis.jar 2. cgnsclient.jar 3. cmmns-lgging.jar 4. cmmns-discvery.jar 5. xercesimpl.jar 6. xalan.jar 7. lg4j-1.2.13.jar The first 6 jar files are lcated in <Cgns SDK Installatin Directry>\sdk\java\lib. The last jar can be fund in <V7>maxim\applicatins\maxim\lib. Restart the applicatin server. Maxim Base Services 7.1.1.6 Fix Pack 11
Create a Namespace in Cgns Cnfiguratin T create the Namespace t authenticate Maxim Metadata publishing prcess, access Cgns Cgns Cnfiguratin. In the Explrer View n the left hand side, navigate dwn t Security - Authenticatin. Click n New Resurce Namespace. Maxim Base Services 7.1.1.6 Fix Pack 12
Enter the cnfiguratin values t create the Namespace. A dialg will then appear that the namespace is being created. Supprted types fr this 7.1.1.6 fix pack are NTLM and LDAP. Depending n the type selected, yu ll need t prvide different cnfiguratin values. Fr additinal infrmatin n hw t cnfigure Cgns NTLM r LDAP namespace prperties please refer t the IBM Cgns 8 Business Intelligence Installatin and Cnfiguratin Guide dcument. Maxim Base Services 7.1.1.6 Fix Pack 13
Set System Prperties Lgin t the Maxim applicatin with Administrative Privileges. Access the System Cnfiguratin System Prperties applicatin. Lcate the Cgns Prperty Values by selecting filter, and in the descriptin field, enter Cgns. The Cgns Prperty values belw display. These values need t be cnfigured fr yur unique envirnment. Details n these are belw: System Prperty Name mxe.reprt.cgns.db.type mxe.reprt.cgns.db.sql.name mxe.reprt.cgns.db.schemaname mxe.reprt.cgns.datasurce mxe.reprt.cgns.cntent.stre.pac kage.lcatin Descriptin Required system prperty that defines the database type frm which metadata will be extracted. Valid prperty values include: DB2 (DB2) OR (Oracle) SS (SQL Server) Required system prperties (fr Maxim installatins running SQL Server database).identifies the catalgue name assciated with the SQL Server database Required system prperty that defines the database schema name frm which the metadata will be extracted This value MUST be prvided in UPPERCASE Optinal system prperty that defines the data surce t which the metadata package will be assciated with. Optinal system prperty that defines a lcatin under t the Cgns Cntent Stre PUBLIC flder where the metadata package will be created The package lcatin specified in this prperty MUST exist in the Cgns Cntent Stre, under the PUBLIC flder BEFORE initiating the publish prcess Maxim Base Services 7.1.1.6 Fix Pack 14
Set End Pint Prperties Lgin t the Maxim applicatin with Administrative Privileges. Access the Integratin - End Pints applicatin. And access the End Pint Name, MXCOGNOS. In the End Pints details page, set the data surce name, cntent stre package lcatin, Cgns server URL, prject base directry, Cgns namespace id, Cgns username, and passwrd. Details n these are belw: End Pint Prperty Name Descriptin Identifies a lcatin under the Cgns Cntent Stre PUBLIC flder where the metadata package will be created. CONTENT_STORE_PA CKAGE_LOCATION When prvided, this end pint prperty verrides the system level value defined by mxe.reprt.cgns.cntent.stre.package.lcatin When the end pint prperty is nt prvided, Maxim metadata packages are created under the PUBLIC flder. Identifies the Data Surce Cnnectin t which the metadata package is assciated with. DATA_SOURCE_NAME When prvided, this end pint prperty verrides the system level value defined by mxe.reprt.cgns.datasurce NAMESPACE_ID Identifies the Cgns Security Namespace t be used when publishing Maxim metadata. PASSWORD Passwrd t be used when authenticating with Cgns Business Intelligence server PROJECT_BASE_DIR Identifies a file system lcatin at the Cgns Business Intelligence Server where metadata prject will be created prir t its publishing URL USERNAME Under the specified file lcatin a sub-flder is created. Naming cnventin f sub-flder is: <ObjectStructureName>_<PublishingDate>_<PublishingTim e> Identifies the URL t be used t establish a cnnectin with Cgns Business Intelligence integratin service. The URL value t be used shuld be the EXTERNAL DISPATCHER URI Username t be used when authenticating with Cgns Business Intelligence Server. Maxim Base Services 7.1.1.6 Fix Pack 15
Functinal Cnsideratins Maxim Metadata Publishing Prcess REQUIRES Cgns SDK libraries t be referenced by Applicatin Server. Required libraries are: cgns-axis.jar cgnsclient.jar Maxim metadata is based n Reprt Object Structure definitin Nn-persistent bjects are NOT cnsidered part f metadata Nn-persistent attributes are NOT cnsidered part f metadata Fr PERSISTENT attributes, Object Structure applicatin s Include/Exclude functinality is cnsidered by metadata publishing prcess Business Object Relatinships Only SIMPLE relatinships between business bjects are supprted by the metadata publishing prcess in Maxim base services 7.1.1.6 fixpack Any relatinship with SQL where clause syntax invlving mre than clumn t clumn relatinship is cnsidered a COMPLEX relatinship MXCOGNOS End Pint Requires Cgns SDK libraries t successfully: Establish cnnectivity with Cngs BI Server Execute metadata publishing prcess via Cgns integratin service Cgns BI Server Authenticatin Maxim base services 7.1.1.6 fixpack supprted namespaces: NTLM LDAP Any prduct data cntained herein has been reviewed fr accuracy as f the date f initial publicatin. Prduct data, including prduct enhancements and release dates, is subject t change withut ntice. Any statements regarding IBM s future directin and intent are subject t change r withdrawal withut ntice, and represent gals and bjectives nly. THE INFORMATION PROVIDED IN THIS DOCUMENT IS DISTRIBUTED AS IS WITHOUT ANY WARRANTY, EITHER EXPRESS OR IMPLIED. IBM EXPRESSLY DISCLAIMS ANY WARRANTIES IF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT Maxim Base Services 7.1.1.6 Fix Pack 16