Data Analyst Guide (PDF) - s3.amazonaws.com · This document may not be ... Hadoop, HDFS, Avro, Cassandra, Chukwa, HBase, Hive ... Data” tab, click on drop down of Cirro and configure

Data Analyst Guide v2.0

i

Copyright © 2016 Cirro, Inc. Confidential and Proprietary. All Rights Reserved.

Data Analyst Guide For use with v2.0

Document Version 2.0

Document Release: January 28, 2016



i


Table of Contents

1 Document Overview ............................................................................................................................... 1

1.1 Audience .......................................................................................................................................... 1

1.2 Related Documents .......................................................................................................................... 1

1.3 Usage Restrictions and Legal Statements ....................................................................................... 1

1.3.1 Confidential and Proprietary Information ............................................................................ 1

1.3.2 Trademarks ......................................................................................................................... 1

1.4 Cirro Corporate Offices .................................................................................................................... 2

1.5 Getting Help ..................................................................................................................................... 2

2 Installing Cirro Analyst for Excel ............................................................................................................. 3

2.1 System Requirements ...................................................................................................................... 3

2.2 Installation Steps .............................................................................................................................. 3

3 Sample Cirro Analyst for Excel Query .................................................................................................... 5

3.1 Activate the Connection to Cirro ...................................................................................................... 5

3.2 Parse the Source Data ..................................................................................................................... 7

3.3 Manipulate the Data ....................................................................................................................... 10

3.4 Output the Data to the Sheet ......................................................................................................... 12

3.5 Add a New Function and Regenerate Output ................................................................................ 16

4 Cirro Analyst for Excel Menu Options................................................................................................... 20

4.1 Cirro Activate – Pre-Connection .................................................................................................... 20

4.1.1 Activate ............................................................................................................................. 20

4.1.2 Configure ........................................................................................................................... 20

4.1.3 Collect Logs ...................................................................................................................... 21

4.1.4 About ................................................................................................................................. 21

4.2 Cirro Activate – Post-Connection ................................................................................................... 22

4.3 Data Explorer ................................................................................................................................. 22

4.4 Function Wizard ............................................................................................................................. 24

4.5 Refresh ........................................................................................................................................... 26

4.6 Publish View ................................................................................................................................... 28

5 Managing Cirro Analyst for Excel Files in Excel ................................................................................... 30

5.1 Saving Cirro Analyst Files in Excel ................................................................................................ 31

5.2 Adding Rows to an Existing Query ................................................................................................ 31


ii


5.3 Manually Editing Cells in a Query .................................................................................................. 31

6 Document Change History ................................................................................................................... 32


1


1 Document Overview

This document provides usage instructions for Cirro Analyst for ExcelTM

.

1.1 Audience

This document is for data analysts using the Cirro solution and assumes knowledge of any data sources available through Cirro, plus the basics of data management and SQL.

1.2 Related Documents

Cirro provides this documentation suite. Contact your Cirro representative to obtain additional documents.

Cirro Admin Guide: Provides instructions for system administrators who will install, configure, and maintain the Cirro solution.

Cirro SQL Specification: Defines the Cirro SQL language.

Cirro Analyst User Guide: Provides instructions on advanced and ad hoc querying, including using Cirro Analyst for Excel.

Cirro Business Intelligence User Guide: Provides instructions for using third-party business intelligence tools such as Business Objects and Tableau to work with Cirro, as well as installation instructions for the Cirro ODBC and JDBC drivers.

Cirro Functions Guide: Provides definitions for the Cirro pre-defined function library and information on creating custom functions.

1.3 Usage Restrictions and Legal Statements

1.3.1 Confidential and Proprietary Information

This document contains the confidential and proprietary information of Cirro, Inc. This document is submitted on a confidential basis and parties accessing this presentation are required to maintain the confidentiality of all confidential information contained herein. This document may not be distributed or reproduced in whole or in part or shown to any person without the prior consent of Cirro. The information contained herein is believed to be reliable, but no warranty is made as to the accuracy of any such information. Circumstances could change since the date this information was supplied.

1.3.2 Trademarks

The following terms are trademarks of Cirro, Inc.:

Cirro Data Hub, Cirro Analyst for Excel

The following terms are trademarks or registered trademarks of their respective owners and no claims to rights to such marks are made by Cirro, Inc.:

Cognos, Cloudscape, DB2, DB2 Universal Database, DRDA, and IBM are trademarks of International Business Machines Corporation in the United States, other countries, or both.


2


Microsoft, Windows, Windows NT, Excel, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

Apache, Apache Hadoop, Hadoop, HDFS, Avro, Cassandra, Chukwa, HBase, Hive, Mahout, Pig, Zookeeper are trademarks of the Apache Software Foundation.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects Software Ltd. Business Objects is an SAP company.

Tableau is a trademark of Tableau Software in the United States, other countries, or both.

MicroStrategy is a registered trademark or trademark of MicroStrategy Incorporated.

Twitter is a trademark of Twitter Inc. in the United States, other countries, or both.

Additional marks may be included in this document that are the trademarks, trade names, logos, and service marks of their respective owners and no rights to such marks are made by Cirro, Inc.

1.4 Cirro Corporate Offices

Address all questions or comments regarding this documentation to Cirro at:

Cirro, Inc. 120 Vantis, Suite 500 Aliso Viejo, CA 92656 Phone: (949) 373-9600

1.5 Getting Help

For assistance using Cirro products, contact Cirro Support at [email protected].

mailto:[email protected]


3


2 Installing Cirro Analyst for Excel Cirro Analyst for Excel is a Microsoft Excel plug-in which allows access to Cirro data sources through Microsoft Excel.

Cirro Analyst for Excel includes pre-defined functions for data retrieval, manipulation, and output. See the Cirro Functions Guide for information on the Data analyst for Excel functions and their use.

2.1 System Requirements

The system where Cirro Analyst for Excel must meet these requirements prior to starting installation:

Any of these operating systems:

Windows XP (x86) with Service Pack 3, any edition except Starter Edition

Windows Vista (x86 or x64) with Service Pack 2, any edition except Starter Edition Windows 7 (x86 or x64), any edition except Starter Edition

Windows 8 (x86 or x64), any edition except Windows RT

Windows Server 2003 (x86 & x64) with Service Pack 2 and Windows Server 2003 R2 (x86 and x64), any edition

Windows Server 2008 (x86 and x64) with Service Pack 2 and Windows Server 2008 R2 (x64), any editions

Additionally, this software should already be installed:

Microsoft Excel 2010 (either 32-bit or 64-bit) or Microsoft Excel 2013 (either 32-bit or 64-bit). Other versions of Microsoft Excel are not supported and will return an error.

The Cirro ODBC driver. See the Cirro BI User Guide for instructions.

A data source connection created to your Cirro server. See the Cirro BI User Guide for instructions.

Obtain the Cirro Analyst for Excel package file from your Cirro representative.

2.2 Installation Steps

Follow these steps to install Cirro Analyst for Excel. Make sure the system meets the System Requirements listed above before starting.

1. If not already installed on your system, install or upgrade to .NET Framework 4. See http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=17851 for information.

2. During the installation process, some Windows systems will return an error that the .NET Framework 4 is not installed even though it is installed. Also, the .vsto file extension on the Cirro Analyst for Excel install file may not be recognized. In these cases only, install the Visual Studio 2010 Tools for Office Runtime. Go to http://www.microsoft.com/en-us/download/default.aspx and search on “Visual Studio 2010 Tools for Office Runtime”.

3. If upgrading your Cirro Analyst for Excel installation to a newer version, uninstall the older version before continuing.

http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=17851

http://www.microsoft.com/en-us/download/default.aspx


4


4. Unzip the Cirro Analyst for Excel install package to a folder. (The files will not install properly if run from within the zip file.)

5. Run the install.

6. Launch Excel. You may see a Cirro Error with the following message:

“Programmatic access to Visual Basic Project is not trusted”. If you see this error, you need to update a setting on Excel 2010:

a. Under File, select Options, Trust Center, “Trust Center Settings…”, then Macro Settings. b. Under Developer Macro Settings, turn on “Trust access to the VBA project object model.”

Save your settings and restart Excel. 7. On the Excel “Data” tab, click on drop down of Cirro and configure by selecting DSN for your

server. 8. Activate a worksheet. 9. You are now ready to use the Analyst with Cirro.


5


3 Sample Cirro Analyst for Excel Query

These steps create and run a simple query using Cirro Analyst for Excel. This query retrieves twitter data, filters it for twitter texts containing the word “Paris” only, and then outputs the query results to the current spreadsheet.

These steps assume that the Cirro Plug-In has been installed, the ODBC driver has been installed, and a connection to a Cirro Data Hub with available twitter source data has been created.

3.1 Activate the Connection to Cirro

Load a new/blank Excel spreadsheet. Go to the Data menu, and find the “CIRRO Activate” button. Click the down arrow and click the “Configure” option.

All of the configured ODBC connections are listed here. Choose the desired connection.

The “Large Data Warning Limit” setting is the number of rows returned that will generate a warning to the user that a large data set has been requested.

The “Log Level” allows you to specify how much information is captured in logs. Leave this value at the default setting unless directed to change it by Cirro Support or another Cirro representative.

Use “Number of Mappers” and “Number of Reducers” to specify how many mappers and reducers the Cirro server will use when processing requests. Leave these values at the default settings unless directed


6


to change them by a Cirro representative or else if you are sure how to change these settings to optimize query processing.

Use “Number of Scoop” to set the number of Scoop connectors. Do not change this value unless directed to do so by your Cirro representative.

Do not modify the “Hide Meta-data on Server” setting unless directed to do so by a Cirro representative.

Click “OK” to save your connection settings.

Then click the “CIRRO Activate” button near the cloud icon to establish a connection to this Cirro Data Hub.

Once your connection is established, you will see all of the Cirro menu options under the Data tab. (See “4 Cirro Analyst for Excel Menu Options” on page 20 for an explanation of these options.)


7


3.2 Parse the Source Data

Use the Cirro_Twitter_Parse function to retrieve the twitter source data. Click on a cell in the Excel spreadsheet. Then click “Function Wizard” in the Data menu.

Choose the Cirro_Twitter_Parse function. Click “OK”.


8


After selecting the function, click on the search icon next to the InputPath field. Choose the twitter source from the selection tree.


9


Once the data source has been selected, click on the search icon next to the Columns field and choose the desired columns. For this example, we will select the id, created_at, tweet_text, and user__name columns.

Click “OK” to save your columns.


10


Click “OK” to save your Cirro_Twitter_Parse settings.

The spreadsheet cell now displays the Cirro_Twitter_Parse function, your data source, and selected columns.

3.3 Manipulate the Data

Once the data has been selected as shown above, use the Cirro_Contains function to return only rows that include the word ‘Paris’ in the tweet_text field.

Click on a blank cell in the spreadsheet and type the word Paris. This is the word we will check the twitter_text against.

Click on a blank cell in the spreadsheet and then open the Function Wizard and select the Cirro_Contains function.


11


Click inside the InputPath field, then click the Cirro_Twitter_Parse cell. The field will populate with the location you specified.

In the Column field, click the column selection button to the right and select the twitter_text field. Click “OK” to continue.


12


In the Words field, click the cell containing the word “Paris’.

Click OK to save the Cirro_Contains function. Your spreadsheet now shows the Cirro_Twitter_Parse function, the cell containing the word “Paris”, and the Cirro_Contains function to filter results.

3.4 Output the Data to the Sheet

The data is ready for output.


13


To show the result set in the Excel spreadsheet, use the Cirro_To_Sheet function.

Click an empty cell in the spreadsheet and then open the Function Wizard. Select the Cirro_To_Sheet function.

For the inputSrc field, click the Cirro_Contains cell.

For the outputLoc field, place the cursor inside the field and then highlight the desired number of blank rows in the spreadsheet. The number of rows selected acts as a LIMIT or TOP qualifier in a SELECT statement. The number of columns selected does not restrict the number of columns returned.

For this example, ten rows how been selected, as shown below. This means the output will return the first ten rows of data. We have not used an ordering function, so the ten rows selected will not be based on any sorting order.


14


Click “OK” to save the Cirro_To_Sheet function.

Click the Refresh button to run the query and generate results to this spreadsheet.

This query could take several minutes, depending on the size of the source data. To see the status of the processing, click “Status” on the Refresh button.


15


When processing is complete, the results are shown in this spreadsheet.

Resize the columns to see all data. Format the id column in Excel so that it displays as an integer. Notice that the twitter_text values all include the word “Paris”.


16


3.5 Add a New Function and Regenerate Output

One row of data in this example contains carriage returns in the twitter_text field. The Cirro_Clean function could be used to strip these characters before output.

Click on the cell after Cirro_Contains and before Cirro_To_Sheet. (If necessary, use Excel functions to add a row above Cirro_To_Sheet.) Click the function wizard, and choose the Cirro_Clean function.


17


In the InputPath field, click on the cell containing the Cirro_Contains function. For SourceColumn, select tweet_text.

For TargetColumn, you could specify the tweet_text column. In that case, the results will replace current values in the tweet_text column.

For this example, type tweet_text_clean for TargetColumn so that the cleaned data will output in a new column and can be compared to the original values.

Click “OK” to save the Cirro_Clean function.


18


The Cirro_To_Sheet function is still set to retrieve source data from the Cirro_Contains function, skipping the new Cirro_Clean function.

Either manually edit the Cirro_To_Sheet cell to retrieve source data from the Cirro_Clean cell, or click the cell, then Function Wizard and make the change.

Click “Refresh” to rerun the query with the Cirro_Clean function.

The results include a tweet_text_clean column, with carriage returns removed from data.


19


Since an ordering function was not used, this result set may differ from the previous output.


20


4 Cirro Analyst for Excel Menu Options

This section describes the menu options available in Cirro Analyst for Excel.

4.1 Cirro Activate – Pre-Connection

Each time you open a new spreadsheet, you will need to activate the Cirro Plug-In before it can be used. The “Cirro Activate” button is the only Cirro button available on the Data tab until the Plug-In is activated with an active connection to a Cirro Data Hub.

4.1.1 Activate

To activate the Plug-In with a live connect, either:

1. Click the “Cirro Activate” button. If only one connection has been configured, the tool will use that connection. If more than one connection has been configured, the tool will attempt to reconnect to the most recently selected connection.

2. Click the down arrow in the “Cirro Activate” button and select “Configure”. Select the desired connection from the drop-down list. You can also choose the row number threshold at which a “large data set” error will be returned.

4.1.2 Configure

The configure option allows you to choose which Cirro system to connect to (if more than one is present) and also set connection parameters.


21


The configuration options are:

Select Cirro ODBC Source: Choose the Cirro ODBC source from the list. If the needed source is not shown, create it or correct is following the instructions for ODBC Driver Installation in the Cirro Business Intelligence User Guide.

Large Data Warning Limit: The number of returned rows at which the interface with provide a warning to the user.

For all other configuration options, please contact Cirro Support for assistance.

4.1.3 Collect Logs

The “Collect Logs” button allows you to save the auto-generated log files to a zip archive, when sending an error report to Cirro Support. Clicking this option opens a dialogue box where you should specify the location to save the logs.

4.1.4 About

To view information about the Cirro Plug-In, including the installed version, select the “About” option in the menu.


22


4.2 Cirro Activate – Post-Connection

After an active connection is established, the “Cirro Activate” button disappears and the four Cirro buttons listed below are available.

4.3 Data Explorer

The Data Explorer shows/hides the data sources available through the active connection.

Click on a data source name or click the “+” and “-“ buttons to expand and collapse the source tree.

Right click on a data source name to refresh the data source, or go directly to a Cirro function.


23


4.3.1 Local Tables in the Data Explorer

When local tables are available for use as Cirro data sources, they are shown in the "Local" branch of Data Explorer. (See 5 "Using Excel Tables as Data Sources" on page 30 for information on local table support.)

When right-clicking on a local table, only the "Refresh" and "Go to Cirro Function" options are available, as shown below.


24


4.3.2 Hadoop Data in the Data Explorer

Working with Hadoop data, additional options are available when right-clicking the data source in the Data Explorer.

Using these options, you can:

Refresh the Data Explorer tree.

Select a Cirro Function using this data source.

Rename a file or folder.

Copy/Paste the file or folder to a new location.

Create a New Folder/directory.

Drop or Delete the file or folder.

View object properties, including the size, permissions, and last update date.

4.4 Function Wizard

The Functions Wizard provides quick access to each of the available functions. (See the Cirro Functions Guide for information on the Cirro-provided functions and how to create custom functions.)


25


The options are:

Function Wizard: Load the Function Wizard, which allows you to select any of the functions.

Cirro_Select: Choose the Cirro_Select function.

Cirro_Match: Choose the Cirro_Match function.

Cirro_To_Sheet: Choose the Cirro_To_Sheet function.

Cirro_To_Pivot: Choose the Cirro_To_Pivot function.

To select a function using the Function Wizard, either select it from the alphabetical list, or first choose a category, and then select the function.

Click “OK” to continue.


26


A pop-up which is unique to the requirements of the function is shown. See the Cirro Functions Guide for the usage instructions for each function.

4.5 Refresh

The Refresh button allows you to refresh the result set. This button is used when generating initial results, and any time a change is made to the functions in the query.

While results are being processed, the Refresh button changes to Status. Click the Status button to view a status window of processing results.


27


The Refresh button includes these additional options:

Refresh / Refresh All Sheets: Clicking the Refresh button refreshes the current open sheet only. Clicking Refresh All Sheets refreshes all open Cirro Analyst for Excel worksheets.

Status: Shows the status of the refresh operation.

Show SQL: Displays the SQL query being processed. Example:

SELECT * FROM

CirroFunctions.Cirro.Cirro_Top(CirroFunctions.Cirro.Cirro_Twitter_Parse

('hdfs://HADOOP/user/twitter/sample','id,created_at,retweet_count,user_

_name,user__followers_count'),'id,created_at,retweet_count,user__name,u

ser__followers_count',5,'') limit 12

Set Preview Area

Preview

Clear Preview Area

Configure: Loads the configuration pop-up box for the current connection. See the Cirro Activate button description above for information on this box.


28


Function Library Update: Use this feature to update your function library. Contact Cirro Support for more information.

The “Collect Logs” button allows you to save the auto-generated log files to a zip archive, when sending an error report to Cirro Support.

About: Provides information about the Cirro Analyst for Excel Plug-In, including the installed version.

4.6 Publish View

Use Publish View to publish your query results back to Cirro for accessibility through other tools, including BI tools.

Click Publish View and select “Publish View” or "Publish Table" from the drop-down list.

4.6.1 Publish View

Publishing a view creates a non-materialized view from a data set.

In the "Cell to Publish" field, specify the cell containing the result to publish. The function in this cell should be a parse or data manipulation function, not a Cirro_To_Sheet or other output function.

Use the "Publish Name" field to specify the location and name for the view. If a full multi-part name is not provided, the view will be published on the Cirro Data Hub in the "home" database and "views" schema. Specify other locations with four-part names, using the syntax "system"."database"."schema"."viewName". For example, "HUB"."qa"."views"."HR2016" will create a view named "HR2016" on system "HUB", in the "qa" database and "views" schema.

Views can only be published to Cirro Data Hubs.


29


4.6.2 Publish Table

Publishing a table creates a table from a data set. The table will be created on a Cirro system, at a location and with a name specified by you.

In the pop-up box "Cell to Publish" field, specify the cell containing the result to publish. The function in this cell should be a parse or data manipulation function, not a Cirro_To_Sheet or other output function.

In the "Fully Qualified Name" field, enter the four-part name for the location where the table will be created. Use the form "system"."database"."schema"."table". (If a table by this name and at this location already exists, an error will be returned.)


30


5 Using Excel Tables as Data Sources

Local Excel spreadsheet tables can be used as Cirro data sources.

These local tables can be used in the same way that other data source data is used with Cirro Analyst for Excel functions and can be joined to other Cirro data sources.

In order to use a local table as a data source, you must first insert the table and add the data in Excel. Then use the Cirro_Excel_DataSource function to reference the local table as a data source.

See the Cirro_Excel_DataSource section of the Cirro Functions Guide for information on how to insert your table and use it with the function.


31


6 Managing Cirro Analyst for Excel Files in Excel

Follow these guidelines for working with Cirro Analyst for Excel files.

6.1 Saving Cirro Analyst Files in Excel

Always save Cirro Analyst for Excel files as type “Excel Macro-Enabled Workbook” (.xlsm). Cirro Analyst for Excel files cannot be saved as ordinary Excel Workbook files (.xlsx) without losing important file information.

6.2 Adding Rows to an Existing Query

If you need to add rows to an existing query, do so using the standard Excel add row functionalities. The Cirro Analyst cell references will automatically update to the new cell locations.

6.3 Manually Editing Cells in a Query

Cirro Analyst functions can be edited by editing the Excel cells. Make sure, however, to save any changes or cancel any edits before clicking the “Refresh” button to regenerate results. Clicking “Refresh” while a cell is in edit mode will result in an error processing the query.


32


7 Document Change History

This section lists recent changes to this document.

Document Version Release Date Description of Change(s)

2.0 January 28, 2016 Version 2.0 document.