CdrVerificationConfigurations (Rules Locations)

CdrVerificationConfigurations defines which rules will be used for verification. Additionally, the configuration defines the storage location of the rules, the ticket formatting, and includes reporting criteria.

Syntax

CdrVerificationConfigurations {
    <rulesBlock Identifier> {
      rulesFolderPath = <String>
      ruleNamesForTestcases {
        <rulesCategory Identifier> = [<rulesFile String>, ...]
        ...
      }
      environmentFilePath = <String>
      functionFolderPath = <String>
      converters = {<convertFrom Identifier> = <convertTo String>, ...}

      ticketFormat = <String>
      ticketFilePaths = ["<ticketFilePath>|<format>", ...]      
      ticketOrder = [<String>, ...]
      reportConfigurationFilePaths = [<pathToReportConfiguration String>, ...]

      report {
            outputFileName = <String>
            templateFilePath = <String>
            outputMode = <String>
            smartSummaryThreshold = <Number>
            ticketOrder = [<String>, ...]
            archived = <Boolean>
            generateDataReport = <Boolean>
            requireAllEntriesAreVerified = <Boolean>
            requireAllRulesAreApplied = <Boolean>
            sortOptions = [{property = <String>, order = <OrderType>}, ...]
        }

      }
      ...
}

Parameters

The following rules fields configure the rules to be applied:

• rulesBlock - The name assigned to the lists(s) of rules configured within the block.

• rulesFolderPath - Points to the directory that holds the rules files.

• ruleCategory - The name assigned to a category of rules files.

• rulesFile - The name of the .rules file. Its extension must be omitted.

The following ticket format fields configure the tickets to be applied.

• ticketFormat - Specifies the tickets' formats. Ticket format will be determined in the project-specific file in the project's documentation.

• ticketFilePaths - Points to the folder that contains the tickets being used for the test case.

  • format (Optional) - If tickets should have a different format applied than that specified in the ticketformat configuration, this can be defined by placing a pipe (|) after the ticket directory name, followed by that format. E.g. /02tickets|QITASC2.

• reportConfigurationFilePaths - Points to the file that determines the order of properties within a ticket. This file must be in .repc format.

Optional Parameters

• environmentFilePath - Points to the Excel file where the environmental variables can be set.

• functionFolderPath - Points to the directory that holds Functions for Rules defined for verification.

• convertFrom - The property name of the ticket that will be converted to a new format: Certain tickets may require conversion, which will be specified in their project-specific documentation.

  • convertTo - The new format that the ticket will be converted to. May be one of: DATE, HEX, DECIMAL or ORIGINAL.

The following optional report fields configure the test cases to be verified.

• outputFileName - Defines the report's name. The report's full file name will include the report's name, timestamp and extension. E.g. myverificationreport.html2015-09-07_TC03.html. templateFilePath - Points to the directory where the user-created report template is stored.

• HTML report templates can be created using FreeMarker.

• reportOutputMode - The type of report summary. May be one of:

  • SMART (default) - The full report unless the file is too large. If so, the SUMMARY report will be used instead. When using the SMART option, the reportSmartSummaryThreshold may also be set to specify the the number of tickets, above which the SUMMARY output is used instead of FULL.
  • FULL - The full report.
  • SUMMARY - The summary report.

• reportSmartSummaryThreshold - The number of tickets above which a SUMMARY report will be used in place of a full report when using the SMART setting in reportOutputMode. Default: 100.

• ticketOrder - List of ticket types in order they have to appear in reports.

• archived - If true (default), reports are archived, false otherwise.

• generateDataReport - If true (default) generates json-formatted report for being represented in the Verification client or to be used anywhere else where JSON is more preferable. false otherwise.

• requireAllRulesAreApplied - If true (default) all rules defined must be applied to at least one variable in the test case. This means that if a rule is not applied, the test case will fail. false allows the test case to pass even if certain rules are not applied.

• requireAllEntriesAreVerified - If true (default), checks for all properties to be checked. If some properties of tickets where not checked, verification fails.

• sortOptions - The property and order to sort the tickets in report by. The order may be set to ASC for ascending order or DESC for descending order.

Note: Legacy reporting fields are still backwards compatible with intaQt, but it is recommend to use the fields shown above.

Example

CdrVerificationConfigurations {
    voice {
        rulesFolderPath = "/Users/QiTASC/Projects/config/rules/"
        ruleNamesForTestcases {
          TC_Call = ["voice_basic", "str_1MOC"]
          TC_Call_overdial = ["voice_basic", "str_1MOC_OVD"]
        }

        ticketFormat = "QITASC"
        ticketFilePaths = ["ticket.format1|QITASC", "ticket.format|NONQITASC"]
        functionFolderPath = "/Users/QiTASC/Projects/config/rules/functions/"
        reportConfigurationFilePaths = ["/Users/QiTASC/Projects/config/parameterOrder/order.repc"]

        report {
              outputFileName = "index"
              outputMode = "FULL"
          }
    }
    sms {
        rulesFolderPath = "/Users/QiTASC/Projects/configuration/rules/"
        ruleNamesForTestcases {
          TC_oneSMS = ["sms_basic", "str_1SMS"]
          TC_twoSMS = ["sms_basic", "str_2SMS"]
        }

        report {
              outputFileName = "index"
              outputMode = "SMART"
              smartSummaryThreshold = 500
              ticketOrder = ["MOC", "MTC"]
              archived = true
              generateDataReport = true
              requireAllEntriesAreVerified = true
              requireAllRulesAreApplied = true
              sortOptions = ["eventContractID", order = ASC, property = "currency", order = DESC]
          }
    }
}

Environment File

The environment file is an Excel file containing values to be used throughout the entire project, which might need to be changed. These changes are then applied to rules throughout the project where the value is used.

For example, a the variable timeZone with the value of UTC+1, and changing it to UTC+2 when the time changes one hour forward.

For example, the expression name timeTolerance with the value 20000000 could be applied in a test case as follows:

check "Rules Name" equals ${env.timeTolerance"};