Setting up a new tmp project

This are instructions for setting up a Temporary data collection project. See Projects for a list of previous ones.

Project Initiation

For external data requests, ask the requestor to fill out File:Request for additional collection.pdf. Additional start-up instructions and a bit of a checklist of what to consider are at Temporary data collection#Information relevant to data users.

When there is serious consideration of a project, follow the instructions in Creating a new project article to establish a central place to document the project even during the consultation and design phase.

Project Design

• If not already done, create a wiki page for the project
• review and keep in mind Checklist when changing or adding a variable or tmp project
• review Entity–attribute–value model of the L Tmp V2 table and decide which data types you will use
  • consider what to label those data types for this project t
• consider Data Integrity Checks; implement them early as Soft checks that only create a warning, and turn them into "hard" checks after a week or two if they have not had false positives
• if dropdown-like functionality is desired, decide the required options (see Dropdown-like user experience for tmp projects)
• document these, and specific collection instructions, on the wiki page for the project
  • ask for input and feedback from collectors on this early and throughout the project to make sure you get the data you want
• consider if the #project will only run at some sites or for one program

Set-up

• add records to the s_tmp table as per #Project Design; these can be added early and s_tmp.active=false until the day of go-live
  • add additional rows with different item/value entries to the s_tmp table if implementing Dropdown-like user experience for tmp projects
  • add field labels and more in s_tmp table for use by the TmpV2 editor
    • labels for how the data type fields in L TmpV2 table will be used , which drives he field labels in
    • a link to the project's wiki page in s_tmp.instruction_url
    • a very brief reminder how to collect the specific variable in s_tmp.Instruction
• document which entries were created in under a == Log == section near the bottom of the project page; entry options and definitions often change over the course of a project as we learn more about the thing we are collecting and a detailed log helps with data analysis later
• follow Rolling out changes to get the project to collectors

Additional info and options

If an entry will need to be added programmatically from VBA eg based on other data and a collector input, use Function GenerUpdate_tmp_entry. For an example of this, consider Overstay2 Overview.

project will only run at some sites or for one program

• To make the project only show up for some sites, enter an (almost) identical line for each site and enter the hospital in s_tmp.site
• If the project should only be collected for one program, enter that program into s_tmp.program; since we only collect two programs additional lines should not be required.

Data Integrity Checks

• If there is data that would benefit from Data Integrity Checks, consider Setting up a new CCMDB Data Integrity Check
  • generically, if the combination of Project/Item has no corresponding Study/Value entry in s_tmp table then query s_tmp_project_item_consistent will flag the query during Pre-send Checker

Automatic Generation of TMP entries

To make it easier for collectors to know what projects are currently collected, starting entries for projects that require an entry for every profile (possibly at a given site/program) are automatically created at profile creation through Automatic Generation of TMP entries.

Checklist when changing or adding a variable or tmp project

We have had some pitfalls over time in getting started with these, see Checklist when changing or adding a variable or tmp project to help avoid repeating them.