> For the complete documentation index, see [llms.txt](https://docs.phocassoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.phocassoftware.com/administration/designer.md).

# Designer

Use the Designer to set up the structure of a Phocas database by mapping your source data to dimensions, properties, measures, and dates. You can also build the database and review previous versions.

{% hint style="info" %}
User permissions: Administration > Databases and Sync
{% endhint %}

Designer sits between your source data and the database your users open in Phocas. The way you organize and map the data in Designer determines how it's available for analysis in the database.

The Phocas Implementations team usually sets up your core databases for you, so you'll most often use Designer to review or adjust an existing design. See [Modify a database](/administration/designer/modify-a-database.md). If you want to build an entirely new database yourself, see [Design a database](/administration/designer/design-a-database.md) instead.

## Open Designer

When you [create a database](/administration/designer/design-a-database/create-a-new-database.md), Designer opens automatically.&#x20;

To open Designer for an existing database, go to **Administration** > **Databases**, then use one of these methods:

* Select the database and click **Design**.\
  ![](https://3446572173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvQCmtGTR7MsjcI62Vdki%2Fuploads%2F3VL00aIZGRd52j0vMyZ0%2Fimage.png?alt=media\&token=b72af1c1-6dc4-49cf-b156-8bfae3c8af19)
* Click the database name (blue link) to open the database maintenance page, then click **Design**.<br>

  <figure><img src="https://3446572173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvQCmtGTR7MsjcI62Vdki%2Fuploads%2Fhhg0jdLKT1ve9h2Y2R2i%2Fimage.png?alt=media&amp;token=db8a6317-3ff4-4696-8e93-fadc78d06c48" alt=""><figcaption></figcaption></figure>
* ​[Open the database](https://app.gitbook.com/o/U7I5eMnPmDGlzutOZw9D/sites/site_6bbJf/s/7pj8v25BOyqZTdG5mdD1/getting-started/databases) then click the blue arrow next to the database name and select **Design database**.\
  ![](https://3446572173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvQCmtGTR7MsjcI62Vdki%2Fuploads%2FU76HTT5OOJNftqbFuyu4%2Fimage.png?alt=media\&token=51993f50-4581-40fa-8df1-671909947acc)

## Take a tour of Designer <a href="#designer-keyfunctionsofdesigner" id="designer-keyfunctionsofdesigner"></a>

Get familiar with the main areas of Designer and how a database design is organized.

Designer has three tabs:

* **Design**: Set up and maintain the structure of the database. This tab opens by default.
* [**Build**](/administration/designer/build-a-database.md)**:** Build the database now or schedule a build to occur later.
* [**Versions**](/administration/designer/view-and-revert-to-older-design-versions.md)**:** Review the changes from previous builds, along with any comments that were added. You can also revert to a earlier version.

The **Design** tab has two views, **stream view** and **dimension view**.&#x20;

### Stream view

Stream view opens by default and shows how the transactional data in each stream is mapped to the database.&#x20;

The colored sections help you identify the different types of **database items** that make up the database design.

<figure><img src="https://3446572173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvQCmtGTR7MsjcI62Vdki%2Fuploads%2FgxDF0eyoKHiRCcun5BYc%2Fimage.png?alt=media&amp;token=8631107b-c9c7-46b5-b9ab-5a8e350a1fc4" alt=""><figcaption><p>Database design in summary view</p></figcaption></figure>

#### Dimensions

Dimensions are the main categories you use to organize and analyze your data. For example, a sales database might have Customer, Product, Sales Rep, and Region dimensions.

Related dimensions can be organized into groups. For example, a Product group might contain Product, Product Class, Product Sub Class, and Supplier.

#### Properties

Properties provide additional information about transactions. For example, transaction properties might include Invoice Number and Transaction Number.

When you switch to Dimension view, this section instead contains properties associated with the selected dimension. For example:

* For the Customer dimension, properties might include Name, Code, Address, and Contact Number.
* For the Product dimension, properties might include Name, Description, Unit of Measure, and Weight.

#### Measures

Measures are the values you analyze, typically numeric values such as sales, cost, quantity, hours, or profit.

Measures apply to streams, so this section isn't available in the dimension view.

#### Date

The date is the *moment* at which the activity (transaction) occurred, such as a sale or order. This moment forms the basis for analyzing the stream by time periods, such as Year to Date or This Month. Some databases, such as Stock on Hand, might simply use today's date.

Each stream can have only one date. However, you can add other dates as properties or use different dates in different streams. For example, you might add the same invoice transactions to three streams and map a different date in each one:

* **Order date** to analyze when orders were placed
* **Shipped date** to analyze when orders were shipped
* **Delivered date** to analyze when orders were delivered

Date applies to streams, so this section isn't available in the dimension view.

#### Stream and data items

In the stream view, the section at the bottom is where you define the streams in the database.

A **stream** is a set of transactional data made up of one or more data items that you add from the data sources panel. Because a stream contains the transactions, it's the starting point for designing your database.

You can have multiple streams in a database. Typically, they share the same dimensional structure but contain different transactional data. For example, a Sales database might have **Invoices** and **Budgets** streams. Both use the same Customers, Products, Sales Reps, and other dimensions, but the values change depending on the stream you view.

In the dimension view, the section at the bottom shows the data items that contain the properties for the selected dimension.

### Dimension view

Select a dimension to switch to the dimension view. You can see how the selected dimension is organized, including its dimension group, properties, and data items.

<figure><img src="https://3446572173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvQCmtGTR7MsjcI62Vdki%2Fuploads%2FRc7LIsV48htJ2RFqSZZk%2Fimage.png?alt=media&amp;token=f3a32071-a8fa-4abd-8296-0341ad6526f1" alt=""><figcaption><p>Database design in dimension view</p></figcaption></figure>

### Data sources panel

The data sources panel contains the data items available to use in your database design.&#x20;

Click the arrow on the right of the **Design** tab to expand the panel. Drag the edge of the panel to make it wider and see more of the data item names. Click **Pin** to keep the panel open while you work.

<div align="left"><figure><img src="https://content.gitbook.com/content/vQCmtGTR7MsjcI62Vdki/blobs/qVe6BODKyReYlrCfGoXZ/3272902126.png" alt="" width="563"><figcaption></figcaption></figure></div>

Data items are grouped by **data source**, in the same way as on the [Sync Sources page](/administration/sync-sources.md).  Think of each data source as a folder that you can expand to view its contents. A data item might be a file or a connection to data in a system such as your ERP.

Files you upload display under your personal data source, labeled with your user name. Files uploaded by other users display under **Shared User Uploads**.

You can also use the panel to:

* **Preview data**: Click a data item to preview the data it contains. The total number of rows displays at the bottom of the preview, and you can move through the pages to view more data. Click **Close** to close the preview.
* **Add data items**: Add data items to define streams or provide properties for dimensions.
* **Upload a file**: Upload a data file to your personal data source.
* **Refresh the list**: Refresh the list of data sources and data items.
* **Sync data sources**: Open the **Sync Sources** page.

## Understand how database items appear in Phocas

The database items you set up in Designer determine what you and other users see when you open the database in Phocas and how you can analyze the data.

* **Dimensions** appear in the dimension panel on the left of the grid. Select a dimension to view its data in the grid.
* **Properties** appear as columns in the grid. Use the **Properties** menu to select which properties display.
* **Measures** appear as value columns in the grid. Use the **Measures** menu to select which measures display.
* **Date** determines the periods available in the database. Use the **Period** menu to select a period.
* **Streams** are available for you to view individually or compare. In Analytics, use the **Stream** menu to select a stream. In Financial Statements, use the **Current** and **Budgets** menus.

The colored outlines in the following images match the corresponding sections in Designer.

<figure><img src="https://3446572173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvQCmtGTR7MsjcI62Vdki%2Fuploads%2FbCI0FgTeX1kHuw6eEGMm%2Fimage.png?alt=media&amp;token=fc74527b-39a3-4152-8d53-11841006465f" alt=""><figcaption><p>How database items in Designer correspond to the Flex Modes grid</p></figcaption></figure>

<figure><img src="https://3446572173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvQCmtGTR7MsjcI62Vdki%2Fuploads%2FZPcxJXl8vqH6aKhtShyn%2Fimage.png?alt=media&amp;token=6768d40a-787c-4e31-8880-7ac5ccd54b9f" alt=""><figcaption><p>How database items in Designer correspond to the Financial Statements grid</p></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.phocassoftware.com/administration/designer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
