Workspace Dashboard Overview

The Workspace Dashboard is designed to guide new developers in the right direction when learning to use the Studio and to provide experienced developers with a quick way to gain insight into a workspace and its projects. For example, it may point out to a new developer that Data Dictionaries should be created for new tables in a workspace and allow an experienced developer a quick way to find which projects have outstanding To Do items.

As you carry out work in a workspace and on individual projects, the Dashboard will track your progress, filling in section details like adding pieces to a puzzle. At any point along the way, you can use the Dashboard to guide you. For example, as you add tables, DataDictionaries, views and other project components, the Dashboard will automatically track these for you. In addition to this automated tracking, you can take the initiative via To Do items to have the Dashboard guide you towards more personalized goals.

 

Concepts

Workspace

The DataFlex Studio operates within a workspace. A workspace defines the areas where your source files reside. The workspace is the area where you build your projects.  Projects are built by assembling components into a single file. The components will use classes that are known to the workspace. These classes can be defined within the workspace, within libraries used by the workspace, and within the System Library.

Projects

A project is the code that you compile and run.  A project consists of a file (usually a .src file) that uses other components (component files, class files, Data Dictionary files, etc.) to create an executable program. A project can be large (e.g. MyBigApplication.src), containing all of the components and classes within your workspace, or it can be small (e.g. MyTest.src) consisting of a few components that you wish to test.

You can create as few or as many projects within a workspace as you wish. Projects must be registered within a workspace. This is really just a simple process of adding a file to a list that Studio maintains. Projects can easily be added or removed from this list.

Current Project

The Studio, and the Workspace Dashboard, are current project oriented. You are expected to select a current project and then work within this project.  When you tell the Studio to compile, debug or run, it will always operate on the current project. When the Studio provides you with code-sense (interface information) it provides it from the current project’s perspective.

 

Just as the Studio in its entirely, some sections of the dashboard are oriented towards the current project, while others apply to the workspace as a whole. The help for each section explains what that section applies to. In addition, once you understand the Workspace and Current Project concepts explained above, the information on the Dashboard becomes more intuitive.

 

Dashboard Sections

Application development is a fluid process; personal preference and project needs interplay to determine which actions you may take at any given time. Each section of the Dashboard focuses on different groups of actions and information and allows you to focus your attention in any applicable area.

Projects

The Projects section shows the total number of projects, the current project and information about the presence of a test and web application project. The information in this section shows the current project but is not limited to aspects of the current project.

Database

The Database section shows the type of database connection, the number of tables and associated data dictionaries. The information in this section is based on the entire workspace and is not sensitive to the current project.

Components

The Components section shows the total number and type of components used in the current project. The information in this section is completely dependent on the current project.

Open Items

The Open Items section shows the total number of modeling errors and To Do items in the current project. The information in this section is completely dependent on the current project.

Workspace Summary

The Workspace Summary section shows general information about the workspace, including location and any Libraries used.

 

Using the Workspace Dashboard

You can invoke the Workspace Dashboard (or simply bring it to the front) from the Studio Help menu, from the Help Toolbar, or with the Ctrl+Shift+W hotkey combination.

The various sections of the Dashboard will be displayed based on the status of the current workspace and project (if available). Each section has the following basic characteristics:

 

Status Indicator

The circle in the upper-left corner of each section gives you a basic, visual indication of the current state of the workspace or project. Red indicates that action is likely required, Yellow indicates that attention or action may be required and white means all necessary actions have been satisfied.

Hovering the mouse over a Red or Yellow status indicator will display a tool-tip with additional information about the status for that section.

 

Section Heading

The section heading is in bold at the top of each section and clicking on it will initiate the following actions in the Studio:

 

Section Details

Each section will contain detail lines appropriate for that section and current status. The  details will change content, color and even initiate different actions based on the status.

For complete information on the specific section details, please select the appropriate Help topic for that section above.

Note that hovering the mouse over any section detail will display a tool-tip with more information about the status and any action that will be initiated.

 

"Learn more about..." Help Link

Each section has a link to the Studio Help for the appropriate section (the individual pages of this book).

 

See Also

The Studio Desktop