Creating a Stamp Area

To create a stamp page, you create a stamp area block, stamp templates, and sets of templates using the text editor. You can then identify the measures that can use stamps, which set of stamps each measure uses, the dimensions associated with analysis of the measure, and the QuickView filters.

NOTE: DiveTab clients, such as the iPad and PC, can share stamp page user configurations.

To create a stamp area:

On a DiveTab module with a menu-area block, select the text editor.
In the menu-area block, add an area id and an identification name for the stamp area. For example:
```
  area id = "creating-a-stamp-area"
```
In the areas block, add a stamp-area block and use the same identification name. For example:
```
  stamp-area id = "creating-a-stamp-area"
```
Add a title and icon, and identify the factory-name. For example:
```
  title "Creating a Stamp Area"
  icon "/divetab/images/menu icons/5.png" 
  factory-name "distributor-mf_02"
```
TIP: The factory-name is the name of the Measure Factory project.
Add a stamp tag with a stamp-display-tag, time-range-tag, and text-comparison-tag attributes, and depending on the version, include the following optional attributes:
DiveTab 7.1(25) and later
NOTES:
- The stamp tag identifies the stamp within the script. This text does not appear to the user.
- The stamp-display-tag identifies the type of stamp to use. Options are: text, bar-chart, and line-chart.
- The time-range-tag defines the time range displayed on the stamp. Options include:
  - current-day
  - month-to-date
  - quarter-to-date
  - rolling-months (3/6/12)
  - year-to-date
  The bar-chart and line-chart stamp types are restricted to rolling-months 12 and year-to-date only.
- The text-comparison-tag identifies a time range to compare to the time-range-tag. Options include:
  - previous-year
  - previous
  - versus aux-measure = "A"
  Bar-charts and line-charts can either use previous-year or not use a comparison value. The versus aux-measure comparison compares the current value with the predicted value. The year-to-date time range can use previous or previous-year for the same comparison.
Optional attributes:
- The label attribute is used as an alternate name for the stamp title, time-range-tag, text-comparison-tag, optional comparison values, and middle text.
- The calendar attribute identifies the type of calendar. Standard is the default. Other factory calendars can be used. If this attribute is omitted, the factory default calendar is used.
- The type attribute further specifies the text-comparison-tag. It is only used with the previous and previous-year text-comparison-tag. Options include:
  - same-day
  - complete
  - month-end
  The default is same-day. The month-end option is only used with the month-to-date and year-to-date time-range-tags and the previous or previous-year text-comparison-tag.
- The time-range-tag and text-comparison-tag define two optional values to display: difference and percent-difference. The text-comparison-tag versus aux-measure = "A" also supports an additional comparison value: percent-of-target.
- The optional column-title attribute allows the user to change the name of the value column in the stamp analysis page for the time-range-tag, text-comparison-tag, and the optional values, rather than using the created label on the stamp.
```
  stamp "MTD vs Last Year Complete Month" label = "VS LY MME" { // <- This label is in the title.
    text {
      month-to-date {
        label "Current" {
	   column-title "Current Month"
	 }
      }
      previous-year type = "complete" { // Or type = month-end, both are identical in function for month-to-date time range
        label "vs LY Month" {
	   column-title "Previous"
	 }
        difference {
          label "Delta" {
            column-title "+/-"
          }
        }
        percent-difference {
          label "%Delta" {
            column-title "% +/-"
          }
        }
      }
      label "MTD vs LY MME" // <- This label is the middle text on the stamp.
    }
  }
```
NOTE: Optional comparison values are additional values to a stamp. Text and versus stamps can have up to four values displayed. Bar-chart and line-chart stamps can have up to three values.
DiveTab 7.1(21) through 7.1(24)
NOTES:
- The stamp tag identifies the stamp within the script. This text does not appear to the user.
- The stamp-display-tag identifies the type of stamp to use. Options are: text, bar-chart, and line-chart.
- The time-range-tag defines the time range displayed on the stamp. Options include:
  - current-day
  - month-to-date
  - rolling-months (3/6/12)
  - year-to-date
  The bar-chart and line-chart stamp types are restricted to using rolling-months 12 and year-to-date only.
- The text-comparison-tag identifies a time range to compare to the time-range-tag. Options include:
  - previous-year
  - previous-day
  - total aux-measure = "A"
  The previous-day option is only used with the current-day time-range-tag. Bar-charts and line-charts can either use previous-year or not use a comparison value. The total aux-measure comparison compared the current value with the total predicted aux measure value.
Optional attributes:
- The label attribute attached to the stamp tag is the stamp's alternative name. The user sees this when selecting a stamp type.
- The calendar attribute identifies the type of calendar. Standard is the default. Other factory calendars can be used. If this attribute is omitted, the factory default calendar is used.
- The type attribute further specifies the text-comparison-tag. It is only used with the previous-year text-comparison-tag. Options include: same-day and month-end. The default is same-day. The month-end option is only used with the month-to-date and year-to-date time-range-tags and the previous-year text-comparison-tag.
- The time-range-tag and text-comparison-tag define two optional values to display: difference and percent-difference. The text-comparison-tag total aux-measure = "A" also supports an additional comparison value: percent-of-total.
Example:
```
  stamp "MTD" label = "Month to Date" {
    text {
      calendar "standard"
      month-to-date
      previous-year {
        difference
        percent-difference
      }
    }
  }
```
DiveTab 7.1(20) and earlier
NOTES:
- The stamp tag identifies the stamp within the script. This text does not appear to the user.
- The calendar attribute identifies the type of calendar to use. A Standard Gregorian, calendar is the only option.
- The range and previous attributes work together to show the time ranges applied to the stamp.
- The optional label attribute provides an alternative name for the stamp. The user sees this when selecting a stamp type.
Example:
```
  stamp "MTD" calendar = "standard" range = "month-to-date" previous = "previous-year" label = "Month to Date"
```

Optionally, add an analysis-column tag to the stamp block.

This tag identifies columns from another stamp analysis page within the stamp-area and adds them to the current stamp.

Add stamp-book blocks with a name, and identify the stamps associated with it.

For example:

  stamp-book "All" {
    stamp-book "Year"
    stamp "MTD vs Last Year MTD"
    stamp "R3-to-Date vs LY R3-to-Date"
  }
  stamp-book "Year" {
    stamp "YTD vs Prev Year to Date"
  }

Add measure tags and include the measure names.

For example:

  measure "9L Cases"
  measure "Net Sales"
  measure "Cost"
  measure "Sample Expenses"
  measure "Goal"

Do one or both of the following:
- Add a stamp-book attribute to the measure to identify a specific stamp-book to use.
  
  For example:
```
  measure "9L Cases" stamp-book = "Year"
```
- Add a default-stamp-book tag for all measures without a specified stamp-book.
  
  For example:
```
  default-stamp-book "All"
```
Optionally, add a default-stamps block and default-stamp tag, with measure and stamp attributes, to create default stamps that appear on the stamp page when you first open it on DiveTab.

For example:
```
  default-stamps {
    default-stamp measure = "Net Sales" stamp = "MTD vs Last Year MTD"
    default-stamp measure = "9L Cases" stamp = "YTD vs Prev Year to Date"
  default-stamp measure = "Cost" stamp = "93-to-Date vs LY R3-to-Date"
  }
```
TIP: You can only create default stamps that are specified by the stamp book for the specified measure. In this case, only the YTD vs Prev Year to Date can use the 9L Cases measure.
Add the dimensions block, add the dimension tag inside the block, and specify the dimension you want to use. For example:
```
  dimensions {
    dimension "Product Type"
    dimension "Brand"
    dimension "Sales Representative"
    dimension "Supplier"
    dimension "Group"
  }
```
NOTE: Dimensions appear in the order that they are listed in DiveTab. In this example, Admit Type is the primary dimension, and the rest are switchable dimensions in the dimension context menu with the ability to dive. Some stamps show more or fewer dimensions based on the stamp's given measure.
Optionally, add the filters block, add the filter tag inside the block, and specify the dimension name you want to use as a filter. For example:
```
  filters {
    filter "State"
    filter "City"
  }
```
Optionally, in DiveTab 7.1(21) and later, add the external-central-page id block to create a central page link in the stamp report analysis page.
```
  external-central-page id = "cp-admit-type-details" area-id = "data-area-landing"
```
Optionally, in DiveTab 7.1(21) and later, add the update-time block to show the stamp's update time in the bottom right of the stamp.
```
  update-time aux-measure = "Update Time" format = "MMM D, YYYY"
```