Reporting Data Model Documentation€¦ · Introduction This document describes the Clarity...

Reporting Data Model DocumentationGenoLogics, An Illumina Company

Version 1.0.1.288

Table of ContentsIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1. Clarity Reporting View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.1. Submitted Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.2. Derived Sample. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.3. Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.4. Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.5. Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.6. Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.7. Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.8. Step Technician . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.9. Container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.10. Output Container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.11. Instrument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.12. QC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.13. Escalation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2. Clarity In Progress View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3. Clarity Dashboard View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

4. Clarity Audit Trail View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

4.1. General columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

4.2. Audit Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

4.3. Audit Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

5. Clarity Reagents View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

5.1. Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

5.2. Reagent Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

5.3. Reagent Lot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

6. Clarity Account UDF View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

6.1. Clarity Account UDF Pivot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

6.2. Clarity Account UDF Name Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

7. Clarity Artifact UDF View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

7.1. Clarity Artifact UDF Pivot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

7.2. Clarity Artifact UDF Name Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

8. Clarity Client UDF View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

8.1. Clarity Client UDF Pivot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

8.2. Clarity Client UDF Name Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

9. Clarity Container UDF View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

9.1. Clarity Container UDF Pivot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

9.2. Clarity Container UDF Name Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

10. Clarity Project UDF View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

10.1. Clarity Project UDF Pivot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

10.2. Clarity Project UDF Name Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

11. Clarity Sample UDF View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

11.1. Clarity Sample UDF Pivot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

11.2. Clarity Sample UDF Name Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

12. Clarity Step UDF View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

12.1. Clarity Step UDF Pivot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

12.2. Clarity Step UDF Name Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

IntroductionThis document describes the Clarity Reporting Data Model.

1. Clarity Reporting ViewThe clarity_reporting_view gathers information on all steps performed in the LIMS, and relates thatinformation back to a submitted sample.

column description

clarity_reporting_id An internal identifier for a single row in theclarity_reporting_view.

processiotrackerid An internal identifier for step input and output.

Each of the listed entities describe how one row of data in the view is broken down.

1.1. Submitted SampleThe submitted sample is the original sample accessioned in the LIMS. All samples are derived froma submitted sample. Each row in the clarity_reporting_view describes a step being completed on asubmitted sample derivation.

column description

submitted_sample_id An internal identifier of the submitted sample.

submitted_sample_limsid The LIMS identifier of the submitted sample.

submitted_sample_name The name of the submitted sample.

date_sample_submitted The date that the submitted sample was accessioned in the LIMS,or the date that the project was opened.

date_sample_completed The date that the submitted sample was considered complete. Bydefault, this is the date that the project was closed.

1.2. Derived SampleA derived sample is any derivation of a submitted sample. The derived sample inclarity_reporting_view is the sample that was the input to a step.

column description

artifact_id An internal identifier of the derived sample.

derived_sample_limsid The LIMS identifier of the derived sample.

derived_sample_name The name of the derived sample.

1

column description

derived_sample_created_date The date that the derived sample was created.

1.3. ProjectEach submitted sample is associated with a project at the time of accessioning. Every samplederived from that submitted sample is also associated with that project.

column description

project_id An internal identifier of the project.

project_limsid The LIMS identifier of the project.

project_name The name of the project the submitted sample is associated with.

project_open_date The date the project associated with the submitted sample wasopened.

project_close_date The date the project associated with the submitted sample wasclosed.

project_invoice_date The date the project associated with the submitted sample wasinvoiced.

1.4. ClientThe client is the contact person for the project. If the project does not have a client, then all clientfields will be NULL.

column description

client_id An internal identifier of the client.

client_name The full name of the client.

client_username The LIMS username of the client.

client_email The email address of the client.

client_created_date The date that the client was created.

client_account_id An internal identifier of the account the client is a member of.

client_account_name The name of the account the client is a member of.

client_billing_institution The institution of the client’s account billing address.

client_billing_department The department of the client’s account billing address.

client_billing_street The street of the client’s account billing address.

client_billing_city The city of the client’s account billing address.

client_billing_province The province of the client’s account billing address.

2

column description

client_billing_country The country of the client’s account billing address.

client_billing_postal The postal/zip of the client’s account billing address.

client_shipping_institution The institution of the client’s account shipping address.

client_shipping_department The department of the client’s account shipping address.

client_shipping_street The street of the client’s account shipping address.

client_shipping_city The city of the client’s account shipping address.

client_shipping_province The province of the client’s account shipping address.

client_shipping_country The country of the client’s account shipping address.

client_shipping_postal The postal/zip of the client’s shipping address.

1.5. StepThe step that the derived sample was input to.

column description

step_id An internal identifier of the step.

step_limsid The LIMS identifier of the step.

step_name The name of the step.

step_preset_used The name of the step preset used. If no step preset was used, thenthis value is NULL.

date_step_run The date the step was completed.

step_order The index of the step in the protocol.

1.6. ProtocolThe protocol that the step is executing as a part of.

column description

protocol_name The name of the protocol.

protocol_type The type of protocol (e.g. qc, indexing)

protocol_created_date The date that the protocol was created.

protocol_last_modified_date The date the last configuration change was made to the protocol.

protocol_order The index of the protocol in the workflow.

3

1.7. WorkflowThe workflow that the protocol is executing as a part of.

column description

workflow_name The name of the workflow.

workflow_status The current status of the workflow. Possible values for this fieldare: ACTIVE, ARCHIVED.

workflow_created_date The date that the workflow was created.

workflow_last_modified_date The date the last configuration change was made to theworkflow.

1.8. Step TechnicianThe step technician is the LIMS user that completed the step. If the step was escalated, then the steptechnician will be the escalation reviewer.

column description

step_technician_id An internal identifier of the step technician.

step_technician_name The full name of the step technician.

step_technician_username The login username of the step technician.

step_technician_email The email address of the step technician.

step_technician_created_date The date that the step_technician user was created.

step_technician_account_id An internal identifier of the account the step technician is amember of.

step_technician_account_name The name of the account the step technician is a member of.

1.9. ContainerThe container that the derived sample was placed in. This is the input container to the step.

column description

container_id An internal identifier of the container.

container_name The name of the container.

container_limsid The LIMS identifier of the container.

well_x_position The column of the derived sample’s placement position in thecontainer.

well_y_position The row of the derived sample’s placement position in thecontainer.

4

column description

placement_date The date that the derived sample was placed in the container.

container_type The type of container (e.g. Tube, 96 well plate).

1.10. Output ContainerThe output container that the derived sample or measurement was placed in.

column description

output_container_id An internal identifier of the output container.

output_container_name The name of the output container.

output_container_limsid The LIMS identifier of the output container.

output_well_x_position The column of the output derived sample’s or measurement’splacement position in the container.

output_well_y_position The row of the output derived sample’s or measurement’splacement position in the container.

output_placement_date The date that the output derived sample or measurement wasplaced in the container.

output_container_type The type of container (e.g. Tube, 96 well plate).

1.11. InstrumentThe instrument involved in performing the step. If the step is not associated with an instrument,then all instrument fields will be NULL.

column description

instrument_limsid The LIMS identifier of the instrument.

instrument_name The name of the instrument.

instrument_type The type of the instrument.

1.12. QCThe QC flag assigned to the derived sample. There are three possible values for the flag: None: 0;Pass: 1; Fail: 2.

column description

derived_sample_qc The final QC flag set directly on the derived sample. This isusually only set once all the QC on the sample has beencompleted.

5

column description

measurement_qc A QC flag tied to a measurement made as part of a QC step.

1.13. EscalationThe escalation details when a manager review was requested on a step. Depending on the stepconfiguration, either the input or output derived samples will be escalated. If no derived sampleswere escalated in a step, then all escalation values will be NULL.

column description

input_escalated_sample_id The internal identifier of the derived input sample that wasescalated in the step. If the derived input sample was notescalated, then this value is NULL.

output_escalated_sample_id The internal identifier of the derived output sample that wasescalated in the step. If the derived output sample was notescalated, then this value is NULL.

requester_id An internal identifier of the user who escalated the samples inthe step.

requester_name The name of the user who escalated samples in the step.

escalation_date The date that the requester escalated samples in the step.

escalation_comment The comment made by the escalation requester.

reviewer_id An internal identifier of the user who reviewed the escalatedsamples in the step.

reviewer_name The name of the user who reviewed the escalated samples in thestep.

review_date The date that the reviewer completed reviewing the escalatedsamples in the step.

review_comment The comment made by the escalation reviewer.

2. Clarity In Progress ViewThe clarity_in_progress_view represents the steps and the derived samples that are currently inprogress.

The clarity_in_progress_view consists of the following columns:

column description

step_name The name of the step.

step_technician The full name of the step technician.

6

column description

step_status The progress status of the step. The status can be one ofSTARTED, STEP_SETUP, POOLING,ARRANGING, PLACEMENT,INDEXING, RECORD_DETAILS, MOVE_SAMPLES_ON, orUNDER_REVIEW.

step_begin_date The date the step began progress.

derived_sample_name The name of the derived sample.

derived_sample_limsid The LIMS identifier of the derived sample.

3. Clarity Dashboard ViewThe clarity_dashboard_view evaluates the project, workflow, and protocol state for all queued or inprogress derived samples. This information is then presented in terms of the submitted sample.Every row in the clarity_dashboard_view indicates a submitted sample that has any derivedsamples queued or in progress in a protocol. Using the clarity_dashboard_view, one can calculatesample counts similar to the dashboards in the Clarity UI.

column description

workflow_id An internal identifier of the workflow.

workflow_name The name of the workflow.

section_id An internal identifier of the workflow section.

section_index An internal identifier of the workflow section index.

protocol_id An internal identifier of the protocol.

protocol_name The name of the protocol.

project_name The name of the project.

project_client The full name of the client.

account_name The name of the account the client is a member of.

submitted_sample_name The name of the submitted sample. This is the ancestor of thederived sample that is actually being worked on.

sample_count The number of submitted samples that this row corresponds to.This will always be 1 unless there are multiple submittedsamples with the same name.

In order to capture all cases, be sure to calculate sample counts based on the SUM of the sample_countcolumn.

7

SELECT workflow_name, SUM(sample_count) AS sample_countFROM clarity_dashboard_viewGROUP BY workflow_name;

4. Clarity Audit Trail ViewThe clarity_audit_trail_view gathers information about audit events and audit changes associatedwith each audit event into a single view.

4.1. General columnsThese are applicable to both audit changes and audit events.

column description

id An internal identifier for a single row in theclarity_audit_trail_view.

applicationuserid The id of the principal who triggered the audit entry or -1 if itwas made by a tool such as the migrator.

applicationusername The name of the principal who triggered the audit entry or NULLif it was made by a tool such as the migrator.

applicationname The name of application that triggered the audit entry (e.g.ClarityLIMS, OPS, Migrator, omxprops, psql).

Each of the listed entities describe how one row of data in the view is broken down.

4.2. Audit EventsAudit Events are high level actions in Clarity LIMS that get audited. Each audit event will have oneor more audit changes associated with it. There will be a row for each Audit Event / Audit Changepair.

column description

eventid The internal identifier the associated audit event or NULL if therow is for an eventless change.

applicationversion The version of the application that triggered the audit event.

message A full desciption of the event.

eventtype A single word description of the event (e.g. LOGIN, ROUTING,SAMPLE_ADD, STEP_EXECUTE, WORKFLOW_ADD_SAMPLES).

eventdate The date and time the event happened.

8

4.3. Audit ChangesAudit Changes are low level details about changes made to individual tables in Clarity LIMSdatabase. Each audit change is associated with 0 or 1 audit events. The reason it is not one to one isthere are sometimes changes which we cannot tie to a particular event because it had to happen ina separate database transaction.

column description

changeid The internal identifier of the associated audit change.

transactionid The database transaction id that caused the change.

databaseusername The database user name.

schemaname The database schema name.

tablename The name of the table the change is for.

rowpk The internal identifier of the row that was changed.

rowlimsid The LIMS identifier of the item that was changed or null if thetable being changed doesn’t have a limsid column.

changetype The kind of change. Insert(I), Update(U) or Delete(D).

rowdata The before state of all the data in the table row updated orremoved, listed in column/value pairs. Or the after state of all thedata in the case of Inserts.

changedfields The new values for each changed column when the change typewas Update. NULL for Inserts and Deletes.

changedate The date and time of the change.

5. Clarity Reagents ViewThe clarity_reagents_view aggregates information about selected reagent kits and lots in a step intoa single view.

5.1. StepThe step for the reagent kit/lot selection.

column description


5.2. Reagent KitThe reagent kit selected for the step.

9

column description

kit_catalogue_number The catalogue number of the reagent kit.

kit_name The name of the reagent kit.

kit_status The archived status of the reagent kit. Possible values for thisfield are: True (1), False (0).

kit_supplier The supplier of the reagent kit.

kit_website The website of the reagent kit.

5.3. Reagent LotThe reagent lot selected for the step.

column description

lot_number The number of the reagent lot.

lot_expiry_date The expiry date of the reagent lot.

lot_storage_location The storage location of the reagent lot.

lot_limsid The LIMS identifier of the reagent lot.

lot_notes The notes for the reagent lot.

lot_status The current status of the reagent lot. Possible values for this fieldare: PENDING, ACTIVE, ARCHIVED.

lot_created_date The date that the reagent lot was created.

lot_last_modified_date The date the last configuration change was made to the reagentlot.

6. Clarity Account UDF View

6.1. Clarity Account UDF PivotThe account UDF pivot views gather information on all the account user defined field (UDF) valuesfor every account.

By default, a minimum of 10 views are created. The views follow a naming convention ofclarity_act_udf_pivot#_view, where # is the index of the view. Each view contains up to 500 columnswith the first column being the account_id and the remaining 499 columns the values for theaccount UDFs. The number of columns in each view depends on the number of UDFs that aredefined for accounts. If more than 499 UDFs are defined for accounts, then the second pivot viewclarity_act_udf_pivot2_view will contain additional account UDFs. As the number of account UDFsincrease, additional pivot views will be populated. The account pivot views can easily be joined tothe clarity_reporting_view. For example, you can join clarity_reporting_view.client_account_id orclarity_reporting_view.step_technician_account_id on clarity_act_udf_pivot1_view.account_id.

10

column description

account_id An internal identifier of the account.

<account_udf_1_name> The value of <account_udf_1_name> UDF for the account.

… …

6.2. Clarity Account UDF Name MapThe clarity_act_udf_name_map_view is a mapping view that maps the original UDF name to thepivot view in which it is located and its column alias. Column aliases are used to avoid problemswith UDF names that are too long, or that contain special characters and database reserved words.All column aliases have the UDF id as a suffix to prevent duplicate column names.

column description

id An internal identifier for a single row in theclarity_act_udf_name_map_view.

udfid An internal identifier of the UDF.

name The name of the account UDF.

pivottable The name of the pivot view where the account UDF is located.

alias Column alias that maps to the column name of the pivot view.

7. Clarity Artifact UDF View

7.1. Clarity Artifact UDF PivotThe artifact UDF pivot views gather information on all the artifact user defined field (UDF) valuesfor every artifact.

By default, a minimum of 10 views are created. The views follow a naming convention ofclarity_art_udf_pivot#_view, where # is the index of the view. Each view contains up to 500 columnswith the first column being the artifact_id and the remaining 499 columns the values for the artifactUDFs. The number of columns in each view depends on the number of UDFs that are defined forartifacts. If more than 499 UDFs are defined for artifacts, then the second pivot viewclarity_art_udf_pivot2_view will contain additional artifact UDFs. As the number of artifact UDFsincrease, additional pivot views will be populated. The artifact pivot views can easily be joined tothe clarity_reporting_view. For example, you can join clarity_reporting_view.artifact_id onclarity_art_udf_pivot1_view.artifactid.

column description

artifact_id An internal identifier of the artifact.

<artifact_udf_1_name> The value of <artifact_udf_1_name> UDF for the artifact.

11

column description

… …

7.2. Clarity Artifact UDF Name MapThe clarity_art_udf_name_map_view is a mapping view that maps the original UDF name to thepivot view in which it is located and its column alias. Column aliases are used to avoid problemswith UDF names that are too long, or that contain special characters and database reserved words.All column aliases have the UDF id as a suffix to prevent duplicate column names.

column description

id An internal identifier for a single row in theclarity_art_udf_name_map_view.


name The name of the artifact UDF.

pivottable The name of the pivot view where the artifact UDF is located.


8. Clarity Client UDF View

8.1. Clarity Client UDF PivotThe client UDF pivot views gather information on all the client user defined field (UDF) values forevery client.

By default, a minimum of 10 views are created. The views follow a naming convention ofclarity_cli_udf_pivot#_view, where # is the index of the view. Each view contains up to 500 columnswith the first column being the client_id and the remaining 499 columns the values for the clientUDFs. The number of columns in each view depends on the number of UDFs that are defined forclients. If more than 499 UDFs are defined for clients, then the second pivot viewclarity_cli_udf_pivot2_view will contain additional client UDFs. As the number of client UDFsincrease, additional pivot views will be populated. The client pivot views can easily be joined to theclarity_reporting_view. For example, you can join clarity_reporting_view.client_id,clarity_reporting_view.step_technician_id, clarity_reporting_view.requester_id, orclarity_reporting_view.reviewer_id on clarity_cli_udf_pivot1_view.client_id.

column description

client_id An internal identifier of the client.

<client_udf_1_name> The value of <client_udf_1_name> UDF for the client.

… …

12

8.2. Clarity Client UDF Name MapThe clarity_cli_udf_name_map_view is a mapping view that maps the original UDF name to thepivot view it is located in and its column alias. Column aliases are used to avoid problems with UDFnames that are too long, or that contain special characters and database reserved words. Allcolumn aliases have the UDF id as a suffix to prevent duplicate column names.

column description

id An internal identifier for a single row in theclarity_cli_udf_name_map_view.

udfid An internal identifier for the UDF.

name The name of the client UDF.

pivottable The name of the pivot view in which the client UDF is located.


9. Clarity Container UDF View

9.1. Clarity Container UDF PivotThe container UDF pivot views gather information on all the container user defined field (UDF)values for every container.

By default, a minimum of 10 views are created. The views follow a naming convention ofclarity_con_udf_pivot#_view, where # is the index of the view. Each view contains up to 500columns with the first column being the container_id and the remaining 499 columns the values forthe container UDFs. The number of columns in each view depends on the number of UDFs that aredefined for containers. If more than 499 UDFs are defined for containers, then the second pivotview clarity_con_udf_pivot2_view will contain additional container UDFs. As the number ofcontainer UDFs increase, additional pivot views will be populated. The container pivot views caneasily be joined to the clarity_reporting_view. For example, you can joinclarity_reporting_view.container_id on clarity_con_udf_pivot1_view.container_id.

column description

container_id An internal identifier of the container.

<container_udf_1_name> The value of <container_udf_1_name> UDF for the container.

… …

9.2. Clarity Container UDF Name MapThe clarity_con_udf_name_map_view is a mapping view that maps the original UDF name to thepivot view in which it is located and its column alias. Column aliases are used to avoid problemswith UDF names that are too long, or that contain special characters and database reserved words.

13

All column aliases have the UDF id as a suffix to prevent duplicate column names.

column description

id An internal identifier for a single row in theclarity_con_udf_name_map_view.


name The name of the container UDF.

pivottable The name of the pivot view in which the container UDF islocated.


10. Clarity Project UDF View

10.1. Clarity Project UDF PivotThe project UDF pivot views gather information on all the project user defined field (UDF) valuesfor every project.

By default, a minimum of 10 views are created. The views follow a naming convention ofclarity_prj_udf_pivot#_view, where # is the index of the view. Each view contains up to 500 columnswith the first column being the project_id and the remaining 499 columns the values for the projectUDFs. The number of columns in each view depends on the number of UDFs that are defined forprojects. If more than 499 UDFs are defined for projects, then the second pivot viewclarity_prj_udf_pivot2_view will contain additional project UDFs. As the number of project UDFsincrease, additional pivot views will be populated. The project pivot views can easily be joined tothe clarity_reporting_view. For example, you can join clarity_reporting_view.project_id onclarity_prj_udf_pivot1_view.project_id.

column description

project_id An internal identifier of the project.

<project_udf_1_name> The value of <project_udf_1_name> UDF for the project.

… …

10.2. Clarity Project UDF Name MapThe clarity_prj_udf_name_map_view is a mapping view that maps the original UDF name to thepivot view in which it is located and its column alias. Column aliases are used to avoid problemswith UDF names that are too long, or that contain special characters and database reserved words.All column aliases have the UDF id as a suffix to prevent duplicate column names.

14

column description

id An internal identifier for a single row in theclarity_prj_udf_name_map_view.


name The name of the project UDF.

pivottable The name of the pivot view in which the project UDF is located.


11. Clarity Sample UDF ViewThe Clarity Sample UDF View holds information about user defined fields (UDF) for submittedsamples.

11.1. Clarity Sample UDF PivotThe sample UDF pivot views gather information on all the sample user defined field (UDF) valuesfor every sample.

By default, a minimum of 10 views are created. The views follow a naming convention ofclarity_smp_udf_pivot#_view, where # is the index of the view. Each view contains up to 500columns with the first column being the submitted_sample_id and the remaining 499 columns thevalues for the sample UDFs. The number of columns in each view depends on the number of UDFsthat are defined for samples. If more than 499 UDFs are defined for samples, then the second pivotview clarity_smp_udf_pivot2_view will contain additional sample UDFs. As the number of sampleUDFs increase, additional pivot views will be populated. The sample pivot views can easily bejoined to the clarity_reporting_view. For example, you can joinclarity_reporting_view.submitted_sample_id on clarity_smp_udf_pivot1_view.submitted_sample_id.

column description

submitted_sample_id An internal identifier of the submitted sample.

<sample_udf_1_name> The value of <sample_udf_1_name> UDF for the submittedsample.

… …

11.2. Clarity Sample UDF Name MapThe clarity_smp_udf_name_map_view is a mapping view that maps the original UDF name to thepivot view in which it is located and its column alias. Column aliases are used to avoid problemswith UDF names that are too long, or that contain special characters and database reserved words.All column aliases have the UDF id as a suffix to prevent duplicate column names.

15

column description

id An internal identifier for a single row in theclarity_smp_udf_name_map_view.


name The name of the sample UDF.

pivottable The name of the pivot view in which the submitted sample UDFis located.


12. Clarity Step UDF View

12.1. Clarity Step UDF PivotThe step UDF pivot views gather information on all the step user defined field (UDF) values forevery step.

By default, a minimum of 10 views are created. The views follow a naming convention ofclarity_step_udf_pivot#_view, where # is the index of the view. Each view contains up to 500columns with the first column being the step_id and the remaining 499 columns the values for thestep UDFs. The number of columns in each view depends on the number of UDFs that are definedfor steps. If more than 499 UDFs are defined for steps, then the second pivot viewclarity_step_udf_pivot2_view will contain additional step UDFs. As the number of step UDFsincrease, additional pivot views will be populated. The step pivot views can easily be joined to theclarity_reporting_view. For example, you can join clarity_reporting_view.step_id onclarity_step_udf_pivot1_view.step_id.

column description


<step_udf_1_name> The value of <step_udf_1_name> UDF for the step.

… …

12.2. Clarity Step UDF Name MapThe clarity_step_udf_name_map_view is a mapping view that maps the original UDF name to thepivot view in which it is located and its column alias. Column aliases are used to avoid problemswith UDF names that are too long, or that contain special characters and database reserved words.All column aliases have the UDF id as a suffix to prevent duplicate column names.

column description

id An internal identifier for a single row in theclarity_step_udf_name_map_view.

16

column description


name The name of the step UDF.

pivottable The name of the pivot view in which the step UDF is located.


17

Date post:	07-Aug-2020
Category:	Documents
Upload:	others
View:	2 times
Download:	0 times

Reporting Data Model Documentation€¦ · Introduction This document describes the Clarity...

Documents