Your instance of CodeSmith Insight supports multiple projects. A project inside of Insight represents a particular application, website, or product that is configured to report to Insight.
API Keys
When integrating the Insight Client into your application, you must specify a project specific API Key in order to communicate with the central server. This API Key controls where the data is directed to go inside of the Insight servers, and ensures that your application's data will always be mapped securely to your project. To allow for flexibility, a project may have multiple API keys.
Configuration Wizard
To help make the integration process as easy as possible, Insight provides a Project Configuration Wizard that generates your application's configuration settings for you.
Step 1: Select Project
This selects a tree view of all your projects and their active API keys. Select the project and API that you would like to generate configuration for.
Step 2: Download Client
At this step you are offered the opportunity to download the Insight Client. This download will include the latest versions of all the different client assemblies, as well as sample projects pre-configured to report to your chosen project using your chosen API key.
Step 3: Project Settings
In this step you chose your configuration options; are you configuring a Web or Windows project. And, would you like to configure it using the Configuration File or with Attributes. The permutation that you choose here will determine the output of the next step.
Step 4: Copy Configuration
Here you may copy your configuration from the text area so that you can paste it into your application. Please read what you are copying carefully, as it may not be a single file's worth of data.
Projects Admin Panel
The Project Panel is only available to administrators. To access this settings panel, first you will need to go to the Settings tab on the bottom left side of the application, then click on the Projects node. Once the Projects grid is visible, you can create, delete, or select a project to edit.
Project Properties
Property |
Description |
|---|---|
Project Name |
The name of the project. |
Active |
A check box representing if the project is active or not. When a project is inactive it will not appear in the project drop downs, and applications will be unable to report to it. |
Managing API Keys
The grid in the project panel allows you to manage your project's API keys. From here you can generate new keys, manually add new keys, and delete keys. You can also control if a key is set to active. Like the project itself, a key can be deactivated to prevent applications from using that key to report to the project.
By selecting a row in this grid you can also download the Insight Client and sample projects for that key, as well as open the project configuration wizard having that key preselected.