Installation‎ > ‎

Setup Your Own Analysis Projects

OpenI uses the concept of projects to define a specific collection of reports, analyses, and even documents. Each project has its own look-and-feel definitions, list of reports, and security hierarchy. In fact, this concept flows over from our own real-life implementation of OpenI – where we serve different clients from a single OpenI instance and each client needs their own space carved out within the OpenI instance. So, for example, when client A accesses the OpenI URL, they only see their projects, while client B sees a completely different list of projects, and so on. We feel that this concept is more universal than just in the case of different clients needing to see separate list of projects. For example, projects can be department-specific, where within an organization, you have an “accounting” project with accounting related reports, a separate “marketing” project with marketing related reports, and so on. That way, you separately setup access rights and administration separately for each project so accounting can’t see marketing reports and vice-versa.

Set Up Sample Project - Foodmart

The default binary distribution contains one project called "foodmart". OpenI automatically creates the sample project contents into "/openi-projects" folder, if it unable to find any project folder specified at startup.

Create a New Project

To create a new project, you can simply make a copy of the "foodmart" folder under "open-projects" and rename it (project name must be unique). Each project has the following contents:
  • project.xml -- this has project-specific properties, most of them are configurable via the "Administration - Manage Project" link on the OpenI site.
  • images -- folder for project-specific image files
  • contents/public -- folder for "public" analyses, i.e. analysis that are visible to all users that have access to the project
  • In addition, there is a folder for each user to store their "private" analyses. These analyses are only visible to the user, and hence are kept under a folder named after the username. For example if user "xyz" logs into OpenI, OpenI will automatically create a private folder for her using her username as the folder name (e.g. contents/users/xyz). Now when this user creates an analysis, and chooses saves it in her private folder, it will be saved in contents/users/xyz folder.
To further configure the new project, access the project by logging into the web interface (http://localhost:8080/openi) as an application admin. You should see the project listed in the main page. Once you are inside the project, click on menu "Preferences->Project Settings" . This enables you to define the following:
  • Project ID: ID of the project (should be unique using valid alphanumeric characters for creating folder names)
  • Project Name: Name of the project for display purposes
  • Project Category : This is an additional grouping of projects, so that when you log into OpenI and you have access to several projects, instead of seeing all projects listed in one place, they are separated under different Project Category sections
  • Stylesheet : Stylesheet to use for project's HTML look and feel
  • Header Message : Header message to display at the top of each analysis
  • Default Analysis Path : This is the first analysis a user will see when they log into the project (unless a dashboard has been defined). This requires setting the default analysis path (for e.g. "/project_id/path/xyz.analysis")
  • Default Chart Color Palette : Defines the color palates to display on the Chart, you can choose various color combinations to display graphs on the report, you can add any number of color choices from project.xml, in project.xml file new color combination is added like this

    see project.xml file which contains predefined color palates.

  • Multiple Filter Selection : Setting multiple filter on will enables selecting multiple values within a filter. By default, this is off, meaning if you have an attribute under "Filter" you can only select one value. For example, let's say you have an analysis that lists a country's population, and there is an attribute called Region under the Filter section, with values East, West, North, and South. The default behavior enables you to see either the entire population, or see the population for a specific region. But what if you wanted to see the combined population of East and West? This is a case where having multiple filters turned on will let you choose multiple values under a Filter attribute.
  • Write Image Maps : Check box to make write images maps on/off. Turning this on will enable the tool tip in the chart view of the analyses, so that when a user hovers over a bar chart or a line graph, the tool tip will show the exact numerical value corresponding to the particular area or point in the chart.
Once the project is set up, you can start defining new data sources and create new reports under the context of that project. More details are available in the User Guide.