Create and Manage Projects The Projects page is your portal to: Create new Kineviz projects, review existing projects, and manage shared projects. Review details of your Kineviz account, link to Kineviz information, send feedback to Kineviz, and access user communities. Project Display The Projects page displays existing projects available to your account. You can open any project simply by clicking on its card or list item. By default, Projects appear as cards in the following sections: Recent Projects, projects you recently opened. My Projects, projects you’ve created, plus a Create tile or button. Shared Projects, the projects other users share with you. Create From Sandbox, pre-configured projects focused on specific workflows. Opening a sandbox project clones it and displays it in the My Projects and Recent Projects sections. Kineviz provides in-app tutorials as Sandbox projects. Each focuses on a particular use case or workflow, and illustrates how to use the Kineviz platform to investigate and communicate useful results. Demo, projects, which may be provided for hands-on exploration. Click the Table icon at the top of the Recent Projects section to display a more compact list of your projects. Create a Project You can create and configure a Kineviz project at any time and optionally connect it to an external or internal database. About Database Connection You can establish a project’s database connection(if any) at any time. You must enter connection details and follow the steps required by the database type you select. You can also Edit the database type and connection details for an existing project. The Database Type options are: None, to create a project with no connected database. You can import and model data in formats such as CSV, SQL and JSON, and import graph data via GXRF files, Snapshot archives, and more. Simply drag and drop files directly, or use the Kineviz Mapping Editor for initial graph modeling. KoreDB or KoreDb via proxy API, to create and connect a default internal KoreDB graph database that you can manage in the Project > Data Store subpanel. You can import and/or model graph data in the project, save and query it internally, and export the entire KoreDB database for archival. One of the following relational or graph database types, to enable full Kineviz property graph visualization and analytics with no need to replicate or move data: Neo4j BigQuery Property Graph Spanner Property Graph Puppygraph Ultipa Graph Memgraph GalaxyBase Nebula Graph Oracle Graph Database Proxy. A generalized proxy built on open-source middleware, designed to securely connect Kineviz to various backend databases. Kineviz Explorer, a basic version of the Kineviz platform for initial visual exploration of big data, is provided through the Google Cloud Platform (GCP) Marketplace. Configuration and connection is exclusively initiated through two GCP Marketplace products: Explorer for Spanner Graph and Explorer for BigQuery Create a New Project To create a new project: Click Create, at the top right of the Projects page. In the Create New Project dialog: Enter a descriptive Project Name in the text box. In Apply Template, either leave the default None, or select a template from the menu. Templates specify colors, icons and other UI configuration settings for easy re-use. Select the Database Type from the dropdown menu and click Confirm. With a Database Type of None or Internal Data Store, the project is automatically created and opened. For connection to an existing external database, the Create New Project dialog shows the additional details needed to confirm connection to your database. Most connection options require: Hostname (or IP) BOLT port - a default is shown for most options. Username Password Database Name You may also need to verify that your external database is running before trying to connect to it. For GCP Spanner and Big Query property graphs, you select the database type abd click Confirm. + + A connection wizard then guides you through a detailed secure deployment process which ends by opening the project. + + image::/v3/01_03_07_CreateBigQueryWizard.png[,520,480,role=text-left] + If you choose the Kineviz Database Proxy, which is designed to securely connect Kineviz to various backend databases, an API url is required. To see that the new project now appears under My Projects, you must exit the project and return to the Projects page. Click the Kineviz logo at the lower left and choose Home. Create a Project from a Sandbox Clicking on a project in the Sandbox section of the Projects page clones the sandbox project and opens it. The new cloned project appears in My Projects and Recent Projects sections. After creating a project from a sandbox, once you leave the project and return to the Projects page, be sure to re-open it in My Projects or Recent Projects, not from the Sandbox section. This returns you to the project as you last left it, instead of creating a new cloned project. A sandbox project includes full Kineviz functionality, including database connection, project styling template, and any saved views, Grove notebooks, and Agent setup. Once configured, the project appears on the Projects home page in the Create from Sandbox section. Work with Existing Projects A tile or list item includes information and tools to review and configure a project: Project name Database badge showing the database type connected to the project (if any), e.g. NEO4J, SPAN (Spanner Graph), PUPPY (Puppygraph), KUZU (for the internal project database), etc. Sandbox badge on pre-configured sandbox projects. Corner badge in the upper right of a card, to display user-defined text. A Settings icon, for a dropdown menu of options to edit and share the project: Edit project name, template, and/ or database type. Clone to create a duplicate of the project, including its views and internal database (if any). Export Project, to export the entire project, downloading it to your system as a .graphxrproject file. UI Configuration, to configure user interface elements the sharing user sees, for example, to limit features to only those needed for collaboration. Share Project to share the project with another user of the Kineviz account. Open Views to open views and generate iframe code that you can include in a report, proposal, or other communication. Enable / Disable Sharing to toggle the project between sharing and non-shared status. Protect from Deletion, to set a flag to prevent project deletion. Delete (trash can), to delete the project, its saved views and internal graph database (but not data in an external connected graph database). The project decription (if any). The date the project was Created, and the date it was last Opened. For Sandbox projects, the Author. Search for a Project To find a specific project, you can: Use the Search bar at the top of the page to find one or more projects by name. Use the dropdown menu to sort projects by Project name Date created Date last opened Select a Demo to open from the dropdown menu. Edit a Project A project is configured according to the template applied (if any), the database type, and other default UI settings. You can change these details at any time. In a Project tile or list item, click its Settings or Actions icon to display the dropdown menu, and select Edit. In the Edit Project dialog change the project name, template, and/ or database type, and click Confirm. Clone a Project In a Project tile or list item, click its Settings or Actions icon to display the dropdown menu, and select Clone. A duplicate of the project is created, optionally including its Grove notebooks. In a Kineviz Server project, views are cloned if the Copy when cloning project checkbox is selected in the view’s About dialog. In Kineviz Desktop, all project files and views are cloned by default. Share a Project You can share a project with other Kineviz users. To collaborate with those who don’t have a Kineviz account, share individual views securely via iframe. In a Project tile or list item, click its Settings or Actions icon to display the dropdown menu, and select Enable Sharing. Now select Share Project Select a sharing user from the dropdown menu, and click Invite. Open Views to Share You can select project views and generate iframe code that you can share in an email, report, proposal, or other communication. In a Project tile or list item, click its Settings or Actions icon to display the dropdown menu, and select Enable Sharing. Click Open Views In the list of project views, either click Open view to open the view in a separate browser window. Generate iframe code, which is copied to the clipboard for sharing with an external user. Configure a Sandbox Project A cloned sandbox project is not itself a sandbox. However, as you work in the project, you could find it worthwhile to configure it as a new sandbox. Configuring a project as a sandbox lets you set up a working environment for specific workflows that can then be used as a starting point for similar follow-on projects. You can either: Configure any open project as a sandbox by going to Project >Settings > Advanced Settings, or Create a new project (choosing a Project Name, Database Type, and optional Template). When the project opens, you can then configure it as a sandbox. To configure a project as a Sandbox: Open the project (or Create a new one). Open the Project panel and Settings subpanel, and click Advanced Settings. Scroll down to see Sandbox configuration options at the bottom of the panel. Click the Sandbox Project checkbox. Set sandbox configuration options: Description text box. Enter a brief description of what the sandbox contains. Protect from deletion checkbox. Grove book display options: Open Grovebook on Load. Enter the Grovebook file key (e.g. my-notebook) Open Grovebook on Load Display Mode. Choose Left to dock your Grovebook to the left menu, or Floating to float it on the canvas. Project Icon. Enter a custom icon for the sandbox. By default, a flask icon (fa-flask) is displayed. Open View on Load. Select one of the project’s saved views from the dropdown menu. Tags. Enter optional tags that indicate intended sandbox usage (e.g. Beginner, Recommended, etc.) Card Preview Image. Click Upload Image or Remove Image to control the preview image (such as a screenshot of one of the project views) that appears on the project tile. Corner Tag. Enter a user-defined tag that will appear at the upper right of the project tile to further specify intended sandbox usage (for example Agent Tools, Native Tools). The configuration is set as soon as you enter the details. Return to the Projects home page to verify that the project now appears in the Create from Sandbox section.