Elixir Repertoire User Manual
Contents
1. Using Percent for USA AZ Apple would sum the value of Apples sold in Arizona and sum the value of all fruit in the USA and work out the percent from that In other words the value would be the percent of Arizona Apples compared to all fruit 1596 in this example Using Nested Percent on the other hand works out the sum relative to the siblings In this case USA AZ Apple would give the percentage of Apple sales compared to all fruit sales in Arizona AZ Apple AZ Orange AZ Pear In this nested case that is 50 In the Percent column all the items at the same level in the tree add up to 10096 In the Nested Percent column each element s children add up to 1002. Dolt executes the selected text as a JavaScript expression Show It evaluates the selected text as a JavaScript expression and outputs the result of evaluation back into the editor Reset resets the JavaScript engine to the default state Function Availability Different parts of the Repertoire toolset expose different objects and functions that you can interact with For example a Report script can utilise the Renderer object to query the mime type and interact with the RawReport object However it is an error to reference these objects when executing an Ensemble script eg a Composite DataSource script because these objects are not available in the Ensemble context You need to be aware when creating a reusable JavaScript file what context it will be running in so that you can ensure you are accessing the appropriate objects Referencing JavaScript Once you have created a JavaScript js file holding some functions you want to reuse you need to import it into your tool scripts The syntax for importing a javascript file is importScript ElixirWorkspace MyScripts Core js To avoid repeated import of the same scripts the import should be done in a script that is only executed once For example the Function Definitions of a Report template or the Script tab of a Composite DataSource Chapter 6 Function Reference Overview Many Elixir designers incorporate some form of data manipulation Taking the
3. Count of the customers in Washington using a Cube in a Composite DataSource Showing a Running Sum of your accumulated sales in a Report Highlighting the Percent of frozen goods sold to a chosen retailer in a Dashboard There are a standard set of functions such as Count Sum and Percent mentioned above that can be used throughout the Repertoire Suite General Functions Average The Average takes a sequence of values sums them and divides by the number of values This function will work on all numeric types The result will always be a double Comma Separated List The Comma Separated List takes a sequence of values and returns a single string holding these values separated by commas For example if the selected fields from three records are Apple Orange Strawberry you will get back a String Apple Orange Strawberry Comma Separated Set The Comma Separated Set takes a sequence of values and returns a single string holding the discrete values separated by commas This means duplicates are removed For example if the selected fields from five records are Apple Berry Apple Orange Berry you will get back a String Apple Berry Orange each item is only listed once Count The Count result is the number of values that the function has received This is most useful in cubes where usually different numbers of records are partitioned into each cell First The First function always replies with the first value that it rec
4. ENEE RU VS To de 3 2 3 Add FaleSystem emu per re cr RD es re ERR ERR ER E pis PR Ee 5 2 4 Add Local FileSystem deidades emer E apiid 6 2 5 Add Jar PUES ystems iot ate er Pt ke Oe E BR arre tintin Lr RI ET 7 2 6 Import Wizard s sasi eee 8 2 7 Build ET ceded iei erre ERREUR pr EE OTIR Re ED MEET 9 ANY Add Safe Wizard eee tn in en ae 12 K Safe Password Prompt or uet Perte oot S bte nes STR P Eo Ea ETHER nes SS 12 Chapter 1 About Elixir Repertoire Overview Elixir Repertoire is an integrated Business Intelligence suite designed for enabling Intelligent Enterprises to compete effectively in this fast moving globalized market Addressing the end to end information life cycle one can activate the entire suite or the individual products as required to aggregate and transform present and deliver navigate and visualize monitor and activate enterprise data Repertoire Designer Features Elixir Repertoire Designer is a stand alone design tool containing the following components Elixir Data Designer for extracting merging and processing data from a variety of datasources either to generate direct data output for example Excel files or database records or to feed data into Elixir Report and Elixir Dashboard Designers Elixir Report Designer for designing report templates and rendering data into a variety of output formats including PDF Excel and HTML Elixir Dashboard Designer for creation of
5. Safe A wizard will appear as shown in Figure 4 1 Add Safe Wizard Figure 4 1 Add Safe Wizard Add Safe Wizard Add Safe Enter a name and password for the Safe file Name required Name Password Repeat Password Previous Finish Cancel Enter a unique filename and enter and repeat the password The password will be required each time you open the file If the password is lost the file will be unreadable When you have entered all required details and pressed Finish you will be presented with a text editor You can enter plain text here in any format and for any purpose and it will be encrypted automatically each time it is saved On subsequent loading the Safe file prompts for a password to decrypt the file as shown in Figure 4 2 Safe Password Prompt Figure 4 2 Safe Password Prompt Enter Password Cancel Elixir Safe Using a Safe As we ve seen the Safe file contains plain text so you can use it for any purpose For example for storing all the passwords you need to remember If you store text in the form This is a comment Name Value Another Something Else then the file can be read as properties which can be used to parameterize a report or datasource To use these external properties within a report you put a script in your Report OnRenderBegin var props elxfn getSafeProperties Workspace Data safe pass se
6. installed Show Help The help button will provide an on line version of this help document along with the appropriate documents covering specific tools you have installed Show Console On clicking the Show Console icon the Console window appears as shown in Figure 2 2 Console Window The Console window lists all the log details The type of log details can be selected from the combo box There are three types of log details displayed they are Internal Log JavaScript and the User Log Figure 2 2 Console Window lil Elixir Repertoire 7 0 0 Console Joe InternalLog ju E Time Type Component Tue Apr 24 09 59 02 BST 2007 WARN JavaScript Execution This is a sample warning When the Internal Log is selected all the logged events from the launching of Elixir Ensemble are displayed The JavaScript log details are displayed if any errors have occurred during the scripting process The User Log is displayed if there are any errors in setting up the security parameters of the data sources Clicking the Clear icon clears the log The Save icon is used to save a copy of the log to a file This is a particularly useful file that can be sent to Elixir s support team so that they can assist with configuration problems The Elixir Interface e Combo Box The Combo Box present in the toolbar lists the various data sources and other views currently open in the workspace The user can select the
7. machine you can just double click on it and it will launch provided your jar file associations haven t been altered If the associations are not set up correctly then you can use a command line or batch file shell script like this java jar RepertoireRemote jar When launching the program from the client you will need to click the connect button at the top left of the main frame in order to connect to the server Enter the appropriate server name and port information along with your username and password in order to connect Note When launching directly from the remote jar the tool will not attempt to locate any updates to the program from your server Elixir Repertoire Remote Using Remote Once connected to the server the remote tool provides virtually identical functionality to the standalone Repertoire Designer Please see the manuals for Data Designer Report Designer and Dashboard designer for the available features Remote also includes the Schedule Designer which is also described in a separate manual Chapter 4 Elixir Safe Introduction Elixir Repertoire tools include a Safe file type A Safe is for holding valuable text based information for example passwords Each Safe is encrypted on disk using a password If you lose the password no one can get it back for you the contents are gone for good To create a Safe file choose a location in the Repository and from the popup menu select Add gt
8. view they wish to work on by selecting from the list e Progress Indicator The Progress Indicator indicates the progress of the application while the data is being loaded This indicator includes a popup menu that allows certain long operations to be aborted Close View A left click will close the current view Right clicking will show a popup menu with a list of options 1 Close This View On selecting this option the currently active view is closed same as left click 2 Close Others On selecting this option the views other than the currently active view are closed 3 Close All On selecting this option all the views are closed Elixir Repository The toolbar icon at the top of the Repository panel is used to add new files and file systems Each toolbar button launches a wizard to guide you through the process Types of File Connection Pool A Connection Pool allows connections to JDBC databases and connection properties to be shared amongst multiple datasources Connection Pools are described in the Elixir Data Designer manual DataSource The DataSource is the principal building block in an Elixir Repertoire solution External data may be wrapped as a DataSource and multiple DataSources may be merged and processed by a Composite DataSource Each kind of DataSource is described in the Elixir Data Designer manual JavaScript Elixir Repertoire is an extensible tool allowing users familiar with Java or JavaScript
9. Elixir Repertoire User Manual Release 7 3 Elixir R pertoire Elixir Technology Pte Ltd Elixir Repertoire User Manual Release 7 3 Elixir Technology Pte Ltd Published 2008 Copyright 2007 2008 Elixir Technology Pte Ltd All rights reserved Solaris Java and all Java based trademarks and logos are trademarks or registered trademarks of Sun Microsystems Inc Microsoft and Windows are trademarks of Microsoft Corporation Table of Contents T About Elixir Repertoire ss same Ro Pier aee PO ERR ER PES PI EUR prit 1 ON EE 1 R pertoire Designer Features degen sg ee em Re casa vi reacia 1 Repertoire Remote Designer Features 10 Toolset changes in Repertoire 7 ss 1 ER EEN e eng EE 2 OS DA TS RP rr eh ge ENEE EE ERE FQ OS RENTE PRA ERES 2 Action Balo outre ree rae een er EH IEEE 2 Elixir Reposo Vic dci annie PODES ER Dee diat aimants 4 Ku 4 Types of Filesystem ssion ea raer pe error Ee bns EE ENEE eoo IR dI 5 Working with FileSystems sese HI Heer 5 Working with Files etti rA Ra eC nee nn ORAE ERSTE ES panne NR Pet Sec 7 The Workspaces so interne pete tanins tenue eere repete ge JS RU eut eue eee eau tente 9 3 Elixir Repertoire Remote i ocior beer be posee dhs osea PASSES 10 lesu 10 Launching from the Servet rtp ere ge tpi emet T 10 Launching from the Client ss 10 Using Remote corno pr re teen tn nine EE REESE serre E rene ERR STER re 11 E Blixir Satez cii
10. d The name field allows the jar filesystem to be given a name if you leave it blank it will default to the filename The name should be chosen carefully as all items within the generated jar will be known based on the full path which includes the filesystem name at the start e Remove A file system or folder can be removed from the repository when this menu item is selected Delete A file or folder can be deleted from the filesystem when this menu item is selected Delete actually only hides the file by giving it a bak extension Files and folders with bak extensions are hidden from Repository views but can be restored if you made a mistake by renaming them using operating system commands To permanently delete a file or folder you should Compact after deleting which will remove all bak files The Workspace Each component of Elixir Repertoire consists of one or more views that will display in this area See the documentation for the individual components for a description of the features available from that view Chapter 3 Elixir Repertoire Remote Preparation Before launching the Remote Designer please ensure you have installed a copy of Java version 5 or later This will allow Java WebStart to intercept JNLP files sent from the server which are used to launch and update the tool Launching from the Server To launch Repertoire Remote from Elixir Repertoire Server you need to use your browser to navigate to the
11. dashboards allowing interactive visualization and manipulation of data combining interactive reporting and data analysis One other tool is provided for stand alone use Elixir Report Interactive for rendering reports using an editable snapshot of the data requiring no datasource connection Repertoire Remote Designer Features Elixir Repertoire Remote Designer is a Java WebStart application which can be launched either locally or from the web and uses Elixir Repertoire Server to provide storage generation rendering and scheduling functionality The Remote Designer contains the same components as Repertoire Designer and adds Elixir Schedule Designer for defining jobs and scheduling report rendering and data processing This component uses the Scheduler within Elixir Repertoire Server Toolset changes in Repertoire 7 Elixir Data Designer Dashboard Designer and Schedule Designer were previously separate tools called Elixir Ensemble Perspective and Choreographer respectively With release 7 0 these tools have been integrated to become aspects of a single Repertoire tool Chapter 2 The Elixir Interface Overview On launching an Elixir Repertoire application you will see a window similar to that shown in Figure 2 1 Elixir Repertoire Main Frame The window consists of three parts the Elixir Repository Action Bar and Workspace Figure 2 1 Elixir Repertoire Main Frame P Elixir Repertoire 7 0 0 Elixir Repos
12. eives Last The Last function always replies with the last value that it receives Function Reference Max The Max result is the largest value received This function works for all comparable types including strings and dates as well as numbers Median The median function takes a sequence of values which should have been sorted in increasing order and returns the value in the middle If the number of elements is even then it returns the average of the two values closest to the middle Hence this function only works on numbers and dates For instance if there are numbers 1 2 2 3 3 4 5 6 There is an even number of values so the middle or median is between the first and the second three As they are the same the median is three but if they were different say if the median was between 3 and 4 we would do 3 4 2 3 5 The Min result is the smallest value received This function works for all comparable types including strings and dates as well as numbers Percent The Percent result is the sum of all values received divided by the sum of all values available The result will be a number between 0 and 1 which can be formatted as a percentage for example using the Field Format in Report Percent100 The Percent100 result uses the same algorithm as Percent but the value returned is scaled into the range of 0 to 100 PercentCount The PercentCount result is the count of all values received divided by the count of all va
13. itory ola Lal E ElixirSamples Elixir R pertoire Repertoire Designer 7 0 0 Copyright 2007 Elixir Technology Pte Ltd Registered user The panel on the left is the Elixir Repository The Action Bar is across the top on the right and the Workspace is the area currently filled by the logo and build information below it Action Bar The action bar present at the top of the right panel contains the Expand Collapse Save Save As Properties Global Properties Help Show Console and Close View buttons It also includes a Combo Box and the Progress Indicator The Elixir Interface Expand Collapse The Expand Collapse icon allows you to hide or show the Elixir Repository panel The triangle points left to Collapse and then changes to point right indicating that you can Expand again Save The Save icon will be enabled when the current view has been modified and not saved Save As The Save As option allows you to save the current view under a different name in the repository Subsequent saves will use the new name The original file remains unchanged so this option is useful for versioning Properties The Properties icon is only enabled when a view is open in the workspace On clicking the icon the appropriate wizard appears Global Properties The Global Properties icon allows properties of the toolset to be edited The precise options available will vary based on the combination of Elixir tools and extensions that are
14. lues available The result will be a number between 0 and 1 which can be formatted as a percentage for example using the Field Format in Report PercentCount100 The PercentCount100 result uses the same algorithm as PercentCount but the value returned is scaled into the range of O to 100 Standard Deviation The Standard Deviation is the square root of the Variance see below Sum The Sum result is the summation of all values received The result will always be a double Variance The Variance is the measure of how spread out a distribution is It is computed as the average squared deviation of each number from its mean average For example for the number 1 2 and 3 the mean is 2 and the variance is Function Reference re RAS ner Additional Cube Functions Nested Percent Variants Cube makes available four special functions which are Nested versions of the Percent PercentCount Percent100 and PercentCount100 The functions behave similarly to the basic percent functions but the result is the derived from all values received divided by all values in that group Therefore unlike Percent which will give a percentage out of all records Nested Percent will give the percentage out of all siblings in the same level of the cube Here s an example just looking at one Cube axis Percent Nested Percent USA 100 100 AZ 30 30 Apple 15 50 Orange 10 33 Peet 5 17 WA 70 70 Apple 40 E Orange 20 29 Pear 10 14
15. me must be unique as it forms the base for each repository path For example if a file system called FS contains a datasource called mine ds then the full name of the datasource is FS mine ds Elixir Repository always uses for path separators like URLs regardless of platform Anywhere a URL can be specified you can use the special protocol repository to refer to files For example the URL repository FS mine ds refers to the datasource described above Local FileSystem This file system maps directly to the file system of your operating system Usually this is used while designing the data However for server side deployment other file systems might be preferred as they ease the problem of relative path configuration Jar FileSystem This file system is easier to deploy The design and data is stored either in local or remote machine in a compressed file i e a zip file in Jar format Working with FileSystems Clicking the Add FileSystem icon shows the Add FileSystem wizard which lists the types of FileSystem that can be defined Figure 2 3 Add FileSystem Lx Add FileSystem EJ File System Type val Choose type of file system Jar FileSystem Previou Next Finish Cancel The Elixir Interface Local FileSystem Choose the Local FileSystem option as shown in Figure 2 3 Add FileSystem and click on the Next button to see the screen as shown in Figure 2 4 Add L
16. ni eI EUER UT NEA er TRE IER 12 Introduction reine TUS PRU RE RN e ERE ERU Reto vi qe exo ER CE ERE E RE Cen 12 Using a Safe iste ENEE pers Ee 13 5 Elixir JavaScript Editor rendered reri EE PRESE ERE ERE ERES PRI 14 Introduction iE eed EPI ERI das 14 Function Available PORTE EAE RA 14 Referencing JavaScript aroos A teste noel 14 6 Function Reference iii os e PR E ERR EEN IE tn ren E S 15 a u x nent nt nn Rite ng te en nine 15 General Buet ofge Eet EEN BEE EEN EE ia dE A 15 NEIE O 15 Comma Separated List iss 2 erre terre ete rte Re Po ER ERANT RP SSS 15 Comma Separated Set ec etes entente etes erede dise uoces o eee dps 15 COURT Ss seats rt PRA IR e e ENDURO ses oem eet cu taa a E bg 15 lui P PE 15 Last eiie ced xr e rai n 15 MAX se nn as I C II techie 16 Median iii tre e RR e patine a tant 16 hun E 16 Percent oe ERES EE RPTREER e Pe RE E RES ERE VES ERE EN line Pertes RASE NN 16 PercentI00 4 uot Sette ie aui vei EU TEMA 16 PetcentC EE 16 PercentCountl00 eee BE A ESTE Re ER cO RES 16 Standard DeviatiOn een o cere DR e EPI intense iron eee ERE REN IET 16 SUM LE 16 A ina ntm ME nee ROM EENS EE 16 Additional Cube Functions ses 17 Nested Percent Variants ss ep rm tr PR PEPPER eee TERR Eee 17 111 List of Figures 2 1 Elixir Repertoire Main Frame 52 satire REESE PORE ERR sn ERR ERR RE EEN 2 2 2 Consol Window distant Pt EEN
17. ocal FileSystem On this page alocal directory name can be entered Alternatively by clicking the button on the right of the text field a directory can be chosen from a dialog Upon clicking the Finish button the Local FileSystem will be created and displayed in the Elixir Repository tree Figure 2 4 Add Local FileSystem ET Add FileSystem Local FileSystem Choose local filesystem directory Name required Name Directory Previous i Cancel Jar FileSystem The Jar file system allows read only access to files in either a jar file or a zip file Add a FileSystem and choose the Jar FileSystem option and click on the Next button to see the screen as shown in Figure 2 5 Add Jar FileSystem On this page the name can be entered The directory path of the jar or zip file can be typed in the Jar File text box Alternatively by clicking the button on the right of the text field a jar or zip file can be chosen from a dialog Upon clicking the Finish button the Jar FileSystem will be created and displayed in the Elixir Repository tree The Elixir Interface Figure 2 5 Add Jar FileSystem EX Add FileSystem Jar FileSystem K Choose jar or zip file Name required Name Jar File Previous Next Finish Cancel Working with Files After adding a file system to the Repository different files for example DataSo
18. pplies to file systems not folders On selecting this option the file system will be refreshed and any changes to the files and folders made outside the tool will be visible Compact Only applies to local file systems not folders On selecting this option the file system will be compacted meaning that all backup files bak will be deleted to reclaim disk space Build Jar A jar file can be built using the subtree of files or folders in the repository Select a file system and select Build Jar from the popup menu The Build Jar dialog window opens displaying all the folders and files present in the repository as shown in Figure 2 7 Build Jar The files or folders to be jarred are selected On clicking the browse button the Save dialog box pops up allowing the output jar filename to be defined The Elixir Interface Figure 2 7 Build Jar Du Build Jar Build Jar ess Select the files and folders to jar Jar Name required amp DataSource amp Perspective e Report amp Resources E data f sample_datastore3 bd Jar Filename ke Use Extension Jar FileSystem Name Previous Next Finish Cancel The Extension Jar Filesystem allows a jar to be created with a special loader If this jar file is placed in the Elixir Repertoire ext directory it will be automatically loaded as a filesystem next time the tool is starte
19. server machine For illustration we will call the server www example com and assume the server is running on the default port 8080 In this case the URL you need to enter into your browser is http www example com 8080 index html You will need to login to use the server facilities When this is completed the main menu will provide you an option Remote Click on this link and on the subsequent page choose the Launch button Assuming Java WebStart is installed you should receive a prompt to launch Web Start This will initiate the download of the tool The first time the tool is used it may take a while to download However running the tool again uses the local copy unless the server version has been updated Once the tool has downloaded a warning will appear asking you whether you want to allow the tool to run You should choose to allow the tool to run only if you trust the server from which you obtained it eg www example com Depending on how your WebStart is configured see the Java section of your Control Panel on Microsoft Windows you may get an icon on your desktop to allow launching of the tool without the need to logon to the server first If you run from this shortcut you will need to click the Connect button at the top left of the main frame in order to connect to the server You will need to enter your username and password for authentication Launching from the Client If you have a copy of RepertoireRemote jar on your local
20. tParameters props where pass is the password to unlock the Safe The call to setParameters adds the name value pairs into the report parameter list so they will be passed to datasources etc as required Another benefit of this approach is that it allows you to share a common set of properties across multiple reports and datasources If you don t want to hardcode the password in the script you can get it from another parameter var pass getParameterValue Password var props elxfn getSafeProperties Workspace Data safe pass setParameters props This can either read Pass from the Report parameters or prompt for a dynamic parameter as you choose The Safe is also useful in conjunction with the Remote Designer as you can edit the file on the client and all network traffic and the server will only see the encrypted file contents 13 Chapter 5 Elixir JavaScript Editor Introduction Elixir Repertoire tools include a JavaScript editor connected to a JavaScript engine for immediate testing and evaluation of expressions This editor allows the creation of a library of common JavaScript functions that can be added to any other JavaScript evaluation such as a Report Function Definitions script or a Composite DataSource script The JavaScript editor supports syntax colouring to make it easy to see at a glance the different aspects of the code You can evaluate code using the Popup menu and selecting an option
21. to integrate the tool with their code or customize the tool to meet their own requirements Many parts of the tool allow JavaScript to be embedded however if the same scripts are required in multiple locations it is preferable to create a common JavaScript file in the repository and then to import it into each DataSource Report or Dashboard that requires it This editor is discussed further in Chapter 5 Elixir JavaScript Editor Perspective A Perspective holds the definition for a dashboard a set of interactive views including tables charts reports and data cubes Dashboards are stored in Perspective Markup Language an XML syntax with a file extension pml Perspectives are described in the Elixir Dashboard Designer manual Report Template A Report Template holds the specification for a report including the layout of report components and reference to the datasources needed to provide the data during rendering Reports are stored in Report Markup Language an XML syntax with a file extension rml Report Templates are described in the Elixir Report Designer manual Safe The Elixir Interface A Safe is an encypted text file used for holding valuable text based information such as database passwords etc The Safe is described in Chapter 4 Elixir Safe Text A simple text editor viewer is included for reviewing log files CSV data etc Types of FileSystem Regardless of the type of file system each has a name This na
22. urces Dashboards Reports and Folders can be added to it Each file system folder and file has a popup menu showing the available actions File systems and folders have similar options e Add Using this menu item several kinds of file or a folder can be added Each will invoke a specialized wizard to guide you through the creation process Import Import allows files to be imported into the repository This option is for files that need some migration or extraction to be used in the Repertoire tool Primarily this is for Elixir Report 4 sav and template files Choose a file system or folder into which the data source or template should be imported select Import from the popup menu The Import Wizard appears as shown in Figure 2 6 Import Wizard You can use the browse button to choose the file to be imported On clicking Finish the file gets imported into the repository A sav file contains many datasources so each will become a separate ds file in the chosen location The Elixir Interface Figure 2 6 Import Wizard Du Import Wizard Migrate From An Older File Format Select a file to import into the Repository Filename required Filename Previous Next Finish Cancel Note It is only necessary to import files from Elixir Report prior to version 5 0 Version 5 0 and later files can be read by the tool without any special import extraction migration step Refresh Only a
Download Pdf Manuals
Related Search