Download a Blank TCT
Understanding the TCT Fields
Upload a TCT
Exporting a Pre-Populated Test Case Template (TCT)

The Test Case Template (TCT)

Crystal Test allows a user to to create test cases by listing them and their properties on an Excel spreadsheet called a Test Case Template (TCT). You can then upload an entire list of test cases from multiple projects at one time. As Crystal Test evolves, more fields may be added to the TCT and therefore it is recommended to always download a new blank TCT each time you create new test cases. Each time the TCT is updated, it is saved with a new datestamp in the filename to ensure you always have the latest file. Let’s create our first TCT.

Download a Blank TCT

To download a blank TCT, follow these steps:
  • Navigate to Admin --> Admin Test Cases
  • On the right column, in the Downloads section, click the link to the CT Test Case Template.
  • Save the template.

You can also download the file from the main Documentation page

Understanding the TCT Fields

Each field on the TCT corresponds to a field in the TestCases table in the Crystal Test database. Read the field descriptions below and create a TCT for one of your projects.

projectAbbreviation The projectAbbreviation and the testCaseId fields are used in conjunction with the testCaseId field to form a unique identity of a test case. For a list of project abbreviations, see the Admin Projects page of Crystal Test. If your project is not in the list, it will need to be added before you can upload test cases to it. See Projects for more information on project names and abbreviations. REQUIRED FIELD (CAN NOT BE BLANK)
testCaseId If you are creating a row in the TCT for inserting a new test cases into Crystal Test, leave the testCaseId and ‘isThisAnUpdate?’ field blank. These fields are only used for updating a test case that already exists in Crystal Test. If the row is to update a test case that already exists in the system, then fill in this field with the test case ID that is being updated. (Only insert the number in this field, not the Project Abbreviation) Also, fill in the ‘isThisAnUpdate?’ field with a 'Yes', "Y", or '1'. REQUIRED for UPDATES ONLY. For new test cases, it is NOT a required field and SHOULD BE LEFT BLANK.
groupTestAbbreviation The groupTestAbbreviation field, is used to put test cases into groups. For more information on groups, see Groups. A test case can belong to more than one group, therefore each group should be separated by a pipe character ( | ). Do not put spaces before or after the pipe character. Groups must be created in Crystal Test before you can upload a test case assigned to a group. To see a list of groups that exist for a project or to create a new one, view the Admin Groups page in Crystal Test. Example: If the Crystal Test project has an Authentication group and its group abbreviation is AUTH, and it also belongs to the regression test group which has an abbreviation of REG, you would enter the following in the groupTestAbbreviation field: AUTH|REG
release The release field, is used to assign test cases to a release. For more information on releases, see Releases. A test case can belong to more than one release, therefore each release should be separated by a pipe character ( | ). Do not put spaces before or after the pipe character. Releases must be created in Crystal Test before you can upload a test case assigned to a release. To see a list of releases that exist for a project or to create a new one, view the Admin Releases page in Crystal Test. Please decide on naming conventions for your project's releases to ensure easy locating and assigning of test cases. A release name is unique and can not be used more than once in the system. Examples: Release 1.4, Release August 24, 2012, 1.4.3.5
sprint The sprint field, is used to assign test cases to a sprint. For more information on releases, see Sprints. A test case can belong to more than one sprint, therefore each sprint should be separated by a pipe character ( | ). Do not put spaces before or after the pipe character. Sprints must be created in Crystal Test before you can upload a test case assigned to a sprint. To see a list of sprints that exist for a project or to create a new one, view the Admin Sprints page in Crystal Test. Please decide on naming conventions for your project's sprints to ensure easy locating and assigning of test cases. A sprint name is unique and can not be used more than once in the system. For this reason I recommend using a year-sprint# combination such as 2012-01. Using a 2 digit sprint# will ensure correct ordering in sprint lists in Crystal Test.
testCaseDescription The testCaseDescription field defines the test. This field describes what is supposed to happen when the test is executed. Before writing test cases for Crystal Test, I recommend reviewing Best Practices for Writing Test Cases for Crystal Test. REQUIRED FIELD (CAN NOT BE BLANK)
active This field is a boolean field (True or False) that flags whether a test case is active or not. Some uses for this field is when a test case has been written but the code has not yet been released. In that case, you would set this field to false. That way it can be included in the test suite but ites statuses and results will not be included in test metrics. Then when the code is released, you can simply switch it to active. Another example would be if functionality has temporarily been removed. You can deactivate it until the functionality returns and can then reactivate it. Fields with active set to false are not included in test metrics.
testCaseOutdated This field is a boolean field (True or False) that flags whether a test case needs to be updated or not. When executing a test manually, a tester should follow the listed steps and expected result. Sometimes, however, we find that the applications functionality has changed and is actually correct even though the test case has not been updated. Instead of marking the test result as failed, this test case should then be marked as outdated. This will cause the test case to be listed on the dashboard page in the Outdated Test Cases section.
testScriptOutdated This field is a boolean field (True or False) that flags whether an automated script needs to be updated or not. This should be marked to true if an automated test is failing but it passes manually.
testCaseSteps The testCaseSteps should be a very detailed, ordered list of steps it takes to perform the test. To create a new line in a cell, press Alt-Enter. Any steps left out or left to be assumed can cause false failures, so please make sure all steps and details are included. REQUIRED FIELD (CAN NOT BE BLANK)
expectedResults Give a detailed explanation of what should happen when the test case steps have been completed. REQUIRED FIELD (CAN NOT BE BLANK)
screenshots Include screenshots of important steps to avoid any confusion. Keep in mind that just because you may think something is easily understandable, doesn't mean all testers will have the same knowledge. For example, if you tell a person to just click a twitter icon, they may not necessarily know which twitter icon to click as there may be several on the page. Screenshots help alleviate ambiguity and save time in having to ask questions or testing the wrong thing. Be sure to include any mocks developers have released. All URLs must end in .jpg, .gif, .bmp, or .png or it will not upload successfully. Seperate screenshot URLs with a pipe character ( | ) as a single test case can have several screenshots. Do not put spaces before or after the pipe character. If the screenshot is saved on your hard drive instead of the web, you can upload it on the test case details page in Crystal Test after the test case has been uploaded or created or on the AddNewTestCase page during creation. Example: http://content.screencast.com/users/jacquelinewalton/folders/Snagit/media/1b1a49e3-7333-4611-8e7a-37be87214f4c/04.02.2014-10.29.png|http://content.screencast.com/users/jacquelinewalton/folders/Snagit/media/4a13a943-5524-4ddf-b211-dfaa5f60c4df/04.02.2014-10.32.png Notice the pipe character between URLs.
screenshotDescriptions This is a list of descriptions that correspond to the screenshots listed in the previous field. For each screenshot listed, there should be a matching description. You can choose to not to add a description, however there needs to be the same amount of spaces, seperated by pipe characters as there are screenshots. Example: Screenshots field: loginscreen.jpg|usernamefield.bmp|passwordfield.png|okbutton.gif If you want to put a description for everything except the username field, you might enter the following in the description field: screenshotDescriptions: Login Screen||Password Field|OK Button Notice the pipe character between image files and the empty place where the username screenshot would be.
testCaseNotes This field is for any information related to the test case such as test data, server information, or other notes.
isThisAnUpdate? If a row has a test case that already exists in Crystal Test, and is being updated, type Yes, Y, or 1 in this field. This will tell the system that the test case already exists and to do an update instead of an ‘add’. Be sure to include the Test Case ID or the upload will fail. Including this field allows us to put both new test cases and updates on the same sheet.
testCategory This tells Crystal Test what type of test case is being uploaded. Each test category has a different way of executing a test. If left blank, it will default to a Functional test. Currently, the only applicable value is Functional, however, future values may be API or Analytics.
autoTestClass The autoTestClass and autoMetaDataRow fields are used to install an automated test script. The autoTestClass field should be the fully-defined technical name of your class. This should be formatted as Namespace.ClassName, AssemblyName Example: ExampleTestScripts.ExampleLogin, Example_TestScripts In this example, the Namespace and the Assembly name are the same. This field will be populated by a QA Automation Engineer. This field affects automation coverage metrics.
autoMetaDataRow The autoTestClass and autoMetaDataRow fields are used to install an automated test script. The autoMetaDataRow field should be populated with the specific row number of the metadata table used to define the automated test case. The table name is defined in the script. This field will be populated by a QA Automation Engineer. This field affects automation coverage metrics.
automated This field should be populated with the value that best describes the test cases's ability to be automated. The following values are valid: Yes - Already directly automated, No - It has been determined that the test case can not be automated, Child - The test case is covered by another test case's script, Future - The test case can be automated but has not as of yet. This field will be populated by a QA Automation Engineer. This field affects automation coverage metrics.
reasonForNotAutomated This field explains why a test is not automated or not able to be automated. This field will be populated by a QA Automation Engineer. reasonForNotAutomated is only REQUIRED if the automated field is 'No' otherwise it SHOULD BE LEFT BLANK. This field affects automation coverage metrics

Upload a TCT

Now that you have created a TCT, we will need to upload it to Crystal Test. Crystal Test will let us know if we have made any mistakes and will not allow the TCT to upload until we fix them. It will tell us exactly what row in the spreadsheet the mistake is on and what the mistake is. Follow the steps below to upload a TCT.
  • Navigate to Admin --> Admin Test Cases
  • In the Upload Test Cases panel, click the browse button and navigate to your test case file.
  • Click the Upload Test Cases button

Upload Test Cases

All Projects, Groups, Sprints, and Releases must be setup in Crystal Test before uploading test cases assigned to them.
Providing there are no data conflicts, you will receive a message that states “File uploaded successfully.” The newly uploaded test cases will be available for viewing on the Test Case List page.

Exporting a Pre-Populated Test Case Template (TCT)

Crystal Test allows you to create a TCT automatically with selected test cases to allow for easy updating. This is also useful to keep an external copy of all test cases for a project or for an entire company. The export file will already have all records marked with the test case ID as well as the ‘isThisAnUpdate?’ field set to True. This allows for quick and easy editing. The exported filename automatically defaults to usernameExport.xls
To export a pre-populated TCT:
  • Click the Testing button on the menu bar. This will open the Test Case List page.
  • Select the checkbox of multiple test cases.
  • Click the Export Test Cases icon in the Icon Menu.

Export
  • When the Save Dialog box appears, choose Save and click OK. Unless configured otherwise, your download will be in your Downloads folder.

Export Test Cases

When you have completed making any adjustments to your test cases on the TCT, follow the steps in Upload a TCT to upload the file to Crystal Test.

Last edited Apr 2, 2014 at 6:15 PM by jacquelinewalton, version 11