A–D

Find reference information on document elements of the Control Chart Package, letters A to D.

Advanced rules

This section contains a single advanced rule by default. Expand the node to add or view information. You can delete this rule and/or add other advanced rules from the Creatable elements pane. You can also add the same rule several times and use each with separate values.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 optional none

Context:

/Control chart/Rule sets/Rule set/Control rules/

All data series

Select this option if you want to display all data series of this chart in the sidechart.

Tip: To display a specific data series instead, select the Select data series option from the drop-down list.

This element has the following attributes:

Data type Multiplicity Usage Default value
Empty 1...1 optional none

Context:

/Control chart/Charts/Chart/Elements/Sidechart/choice/

Allow subfolder

Note: The Allow subfolder setting only applies if you also specify a folder in the Folder key element.

Select the 'true' option from the drop-down list to require referenced documents be elements of the specified folder or one of its subfolders. Otherwise, subfolders are excluded.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:boolean 0...1 optional none

Context:

/Control chart/Data table/choice/Column: Document reference/

Allow subfolders

Note: The Allow subfolders setting only applies if you also specify a folder in the Folder key element.

Select the

True

option from the drop-down list to require referenced documents be elements of the specified folder or one of its subfolders. Otherwise, subfolders are excluded.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:boolean 0...1 optional none

Context:

/Control chart/Charts/Chart/Comment/Linked document/Config/

/Control chart/Comment/Linked document/Config/

Applied rule sets

This section allows you to reference the rules sets you want to apply to the data of this data series in the current chart.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 optional none

Context:

/Control chart/Charts/Chart/Elements/Data series/

Author

Automatically inserts the user name of the current user when the Author element is created. You can enter a different name.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 1...1 required none

Context:

/Control chart/Charts/Chart/Comment/

/Control chart/Comment/

Chart

This section allows you to define an individual chart, which allows you to plot and and monitor one or more data series (Charts > Chart > Elements > Data series). Expand the node to add or view information.

The Chart section contains an Elements section and a Graphic settings section by default. You can add one or more Subcharts sections and Comment sections. Use the Elements subsection to:

  • Specify one or more Data series to be plotted and monitored in the chart.
  • Define one or two sidecharts to have statistical characteristics, such as mean and standard deviation of data series, displayed next to the main chart.
  • Set up one or more Intervals sections to have confidence intervals displayed for every individual data point in the chart.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 1...unbounded required none

Context:

/Control chart/Charts/

Charts

This section allows you to define the chart(s) of this Control chart document. For each chart you want to use to monitor data in this document, you set up a separate Chart element. By default, the Charts section contains a single Chart element, but you can add as many as you need. For each chart, you select the data series to be monitored, rule sets to be applied, additional information, such as confidence intervals or sidecharts, to be displayed, and graphics settings. You can also divide charts into subcharts to improve readability.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 1...1 required none

Context:

/Control chart/

Color

Select the color you want to assign to data points with this value. When you create a Color mapping element, a color is automatically assigned. Select the color field to display controls that allow you to change the color.

This element has the following attributes:

Data type Multiplicity Usage Default value
1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/Color: defined by Value/Color mappings/Color mapping/

Color

Select the color to be used to mark this event in the charts of this document. When you create an event, a color is automatically assigned. Select the color field to display controls that allow you to change the color.

This element has the following attributes:

Data type Multiplicity Usage Default value
1...1 required none

Context:

/Control chart/Events/Event/

Color

Select the color to be used to display data points of this data series in the chart. When you create a Data series element, a color is automatically assigned. Select the color field to display controls that allow you to change the color.

Tip: You can select a single color to be applied to all data points of the data series, or you can color-code data points of the series by data values or thresholds.

This element has the following attributes:

Data type Multiplicity Usage Default value
1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/

Color

Select the color to be used to display representations of these intervals in the current chart. When you add an Intervals element from the Creatable elements pane, a color is automatically assigned. Select the color field to display controls that allow you to change the color.

This element has the following attributes:

Data type Multiplicity Usage Default value
1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Intervals/

Color above threshold

Select the color you want to assign to data points whose values are greater than the threshold. Select the color field to display controls that allow you to change the color.

This element has the following attributes:

Data type Multiplicity Usage Default value
1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/Color: defined by threshold/

Color below threshold

Select the color you want to assign to data points whose values are equal to or lower than the threshold. Select the color field to display controls that allow you to change the color.

This element has the following attributes:

Data type Multiplicity Usage Default value
1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/Color: defined by threshold/

Color beyond thresholds

Select the color you want to assign to data points whose values lie outside of the value range defined by the upper and lower threshold. Select the color field to display controls that allow you to change the color.

This element has the following attributes:

Data type Multiplicity Usage Default value
1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/Color: defined by interval/

Color: defined by interval

Color-code data points according to the values of an attribute provided in a floating-point number column of the dataset/ Data table. You have to assign two colors, one color each for the ranges of values inside and outside the thresholds you specify.

Tip: You can select a single color to be applied to all data points of the data series, or you can color-code data points of the series by data values or thresholds.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/

Color: defined by threshold

Color-code data points according to the values of an attribute provided in a floating-point number column of the dataset/ Data table. You have to assign two colors, one color each for the ranges of values above and below the threshold you specify.

Tip: You can select a single color to be applied to all data points of the data series, or you can color-code data points of the series by data values or thresholds.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/

Color: defined by value

Color-code data points according to the values of an attribute provided in a single-line text column of the dataset/ Data table. You have to assign a separate color for each value of the attribute.

Tip: You can select a single color to be applied to all data points of the data series, or you can color-code data points of the series by data values or thresholds.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/

Color mapping

Enter the value and select the color you want to assign to the data points.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 1...unbounded required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/Color: defined by Value/Color mappings/

Color mappings

Color-code data points according to the values of the Dataset column you selected.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/Color: defined by Value/

Color of limits

Select the color to be used to display the limits of this rule set in the charts of this document. When you create a rule set, a color is automatically assigned. Select the color field to display controls that allow you to change the color.

This element has the following attributes:

Data type Multiplicity Usage Default value
1...1 required none

Context:

/Control chart/Rule sets/Rule set/

Color of rule violation marker

Select the color to be used to indicate rule set violations in this document. Data points that violate rules are marked by a circle in this color.

This element has the following attributes:

Data type Multiplicity Usage Default value
1...1 required none

Context:

/Control chart/Rule sets/

Color within thresholds

Select the color you want to assign to data points whose values lie within the value range defined by the upper and lower threshold. Select the color field to display controls that allow you to change the color.

This element has the following attributes:

Data type Multiplicity Usage Default value
1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/Color: defined by interval/

Column: Date/time

Define a column that allows you to associate each observation with a date and time.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 optional none

Context:

/Control chart/Data table/choice/

Column: Document reference

Configure the document reference column. Expand the node to add or view information.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 optional none

Context:

/Control chart/Data table/choice/

Column: Document title

Expand the node to add or view information.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 optional none

Context:

/Control chart/Data table/choice/

Column: Exclude from analysis

Provides a column to flag technical outliers in the data table.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 optional none

Context:

/Control chart/Data table/choice/

Column: Floating-point number

Define a column that allows you to associate each observation with a value of double-precision floating-point number format.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...unbounded optional none

Context:

/Control chart/Data table/choice/

Column: Identification

Define a column that allows you to identify specific observations in the report.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 optional none

Context:

/Control chart/Data table/choice/

Column Key

Cannot be changed for this column. Column keys are required for defining a sort order considering this column.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 1...1 required none

Context:

/Control chart/Data table/choice/Column: Exclude from analysis/

Column key

Enter a key for this column.

Note: The key is required to define a sort order based on this column.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 0...1 optional none

Context:

/Control chart/Data table/choice/Column: Identification/

Column key

Displays the Column key.

Note: You cannot change the key of this column.
Note: The key is required to define a sort order based on this column.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 1...1 required none

Context:

/Control chart/Data table/choice/Column: Document reference/

Column key

Enter a key for this column.

Note: The key is required to define a sort order based on this column.
Tip: Add additional column keys to refine the sort order if several columns have the same values.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 1...unbounded required none

Context:

/Control chart/Data table/Row order/

Column: Section

Configure the document sections from which the data should be aggregated.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 optional none

Context:

/Control chart/Data table/choice/

Column: Text

Define a column that allows you to associate each observation with a single-line text.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...unbounded optional none

Context:

/Control chart/Data table/choice/

Comment

Enter a comment, or add a reference to a comment document.

Tip: You can add several Comment elements. And to each Comment element, you can add a Subject element, Text elements, and Linked document elements.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...unbounded optional none

Context:

/Control chart/Charts/Chart/

Config

Set up the details of the linked document and the data you want to import.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 optional none

Context:

/Control chart/Charts/Chart/Comment/Linked document/

/Control chart/Comment/Linked document/

Connecting lines

Enable this setting to have the graphical representations of data points connected by lines. This setting applies to all data points in the current data series for the current chart.

Tip: You can adjust the color of connecting lines below under Line color.
Note: The Connecting lines element is optional. But if you do not add it to the document structure and the number of references is greater than or equal to 100, data points are still represented by lines rather than circles to ensure readability.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/

Control chart

The Control chart document type enables you to closely monitor data produced by assay documents. You can draw data series from a range of assay documents such as those of the Biological Assays, Dose-Response Analysis, and Microbial Assays for Antibiotics Packages.

Major features, such as Shewhart I-charts, WECO and Nelson rules, and the methods provided to calculate standard deviations, allow you to closely follow the guidelines laid out in Chapter <1010>, Appendix 1 of the United States Pharmacopeia. Our control charts also provide considerable flexibility. You can freely combine individual standard rules into custom rule sets and define your own individual custom rules.

Other features allow you to add pertinent information to charts or improve their readability. You can add one or two 'sidecharts' that are displayed just to the right of the control chart and provide statistical characteristics such as mean and standard deviation of the data series. You can display confidence intervals. You can color-code an individual attribute of data points to indicate, for example, who produced particular observations. You can plot several data series in a single chart. And you can split control charts into any number of 'subcharts' to improve the readability of large data series.

Navigate the document structure to enter settings you require for this Control chart document:

1. Expand the node to add or view information. The second level of the document structure displays the Name and Date elements of the document. It also provides access to the Charts and Data table sections.

2. Double-click the Comment element in the Creatable elements pane to add a Comment section to the document.

Tip: You can add several Comment sections. And to each Comment section, you can add a Subject element, Text elements, and Linked document elements.
Note: To delete an element from the document, right-click the element in the document structure and select the Delete element option from the context menu.

3. Double-click the Events or Rule sets element in the Creatable elements pane to add an Events or Rule sets section to the document.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 1...1 required none

Context:

Top level

Control limit

This section allows you to set both an Upper limit and a Lower limit for this rule set. Expand the node to add or view information.

Tip: You can add as many Control limit elements to the Control limits section of this rule set as you need.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 1...unbounded required none

Context:

/Control chart/Rule sets/Rule set/Control limits/

Control limits

This section allows you to set control limits for this rule set.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 optional none

Context:

/Control chart/Rule sets/Rule set/

Control rules

This section allows you to select the method to calculate the mean and standard deviation, add standard WECO and Nelson rules, and define Advanced rules for this rule set.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...1 optional none

Context:

/Control chart/Rule sets/Rule set/

Data series

Select the data series you want to display in the sidechart.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 1...unbounded required none

Context:

/Control chart/Charts/Chart/Elements/Sidechart/choice/Select data series/

Data series

This section allows you to specify a data series to be plotted and monitored in this chart. To specify the data series, you select a single column of the dataset/ Data table from the Dataset drop-down list in this section. You can view Data table columns in the References editor (Observation source: Aggregation) or in the Observations editor (Observation source: User input).

Tip: You can have more than one data series in this chart. Add additional Data series elements from the Creatable elements pane.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...unbounded optional none

Context:

/Control chart/Charts/Chart/Elements/

Data table

This section allows you to adjust the dataset structure used to draw data from assay documents and monitor data in this Control chart document. You define which data is drawn into the document, how it is updated, and how it is displayed in the References editor.

Tip: You can also set the Control chart document for manual data input. For this purpose, select the User input option from the Observation source drop-down list. And then adjust the dataset structure to accomodate your manual data input and display your data in the Observations editor.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 1...1 required none

Context:

/Control chart/

Dataset column

Select the floating-point number column whose factors you want to use for coloring.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:integer 1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/Color: defined by threshold/

Dataset column

Select the single-line text column whose factors you want to use for coloring.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:integer 1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/choice/Color: defined by Value/

Dataset column

Select the floating-point number column whose values you want to use as data series.

Tip: You can have more than one data series in this chart. Add additional Data series elements from the Creatable elements pane.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:integer 1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Data series/

Date

Automatically inserts the current date and time when the Date element is created. You can enter a different date and time.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:dateTime 1...1 required none

Context:

/Control chart/Charts/Chart/Comment/

/Control chart/Comment/

Date

Automatically inserts the current date and time when the document is created. You can enter a different date and time.

Tip: Use the date for sorting in aggregation documents.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:dateTime 1...1 required none

Context:

/Control chart/

Days per subchart

Enter the number of days to be included in a subchart. If observations are available for more dates than the number you define, multiple subcharts are created.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:positiveInteger 1...1 required none

Context:

/Control chart/Charts/Chart/Subcharts/choice/

Direction

Select the sort order you want to apply to the data rows.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:string 1...1 required none

Context:

/Control chart/Data table/Row order/

Display horizontal lines

Select the 'yes' option from the drop-down list to add horizontal grid lines to your plots.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 1...1 required none

Context:

/Control chart/Charts/Chart/Graphics settings/

Display rule set line labels

Select the 'yes' option from the drop-down list to add labels to the rule set lines of your plots.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 1...1 required none

Context:

/Control chart/Charts/Chart/Graphics settings/

Display style

Select the display style you want to use from the drop-down list.

The following options are available:

  • bars: The intervals are displayed with bars.
  • area: The intervals are displayed as transparent-colored areas.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Intervals/

Display vertical lines

Select the 'yes' option from the drop-down list to add vertical grid lines to your plots.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 1...1 required none

Context:

/Control chart/Charts/Chart/Graphics settings/

Document mode

Select a Document mode from the drop-down list to require referenced documents match this mode.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 0...1 optional none

Context:

/Control chart/Charts/Chart/Comment/Linked document/Config/

/Control chart/Comment/Linked document/Config/

Document property filter

Define a filter based on a document property to require referenced documents match this property.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...unbounded optional none

Context:

/Control chart/Charts/Chart/Comment/Linked document/Config/

/Control chart/Comment/Linked document/Config/

Document property import

Define the document property you want to import.

This element has the following attributes:

Data type Multiplicity Usage Default value
Node 0...unbounded optional none

Context:

/Control chart/Charts/Chart/Comment/Linked document/Config/

/Control chart/Comment/Linked document/Config/

Document type

Select the document type of the documents to be referenced.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 0...1 optional none

Context:

/Control chart/Charts/Chart/Comment/Linked document/Config/

/Control chart/Comment/Linked document/Config/

Draw event marker

Select the 'yes' option from the drop-down list to visualize this event in charts that use rule sets with this event.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 1...1 required none

Context:

/Control chart/Events/Event/

Draw horizontal lines

Select the 'yes' option from the drop-down list to display the characteristic values of the sidechart in the chart. For boxplots, these are median, first and third quantile, and whiskers. For mean and SD, these are the mean and standard deviation values, multiplied by the SD factors you entered.

This element has the following attributes:

Data type Multiplicity Usage Default value
xs:token 1...1 required none

Context:

/Control chart/Charts/Chart/Elements/Sidechart/