How CIS autogenerates page keys and block keys in the Clintrial software
If you do not specify the page key and block key for a data mapping, CIS uses form and visit RefNames to generate page keys and block keys during synchronization. It processes these RefNames differently based on whether they contain a double underscore:
- No double underscore—A visit RefName resolves to a Clintrial block key, and a form RefName resolves to a Clintrial page key. For example, a visit with the RefName VISIT1 synchronizes to a data table in which the block key column value is VISIT1, and the VITALS form synchronizes to a data table in which the page key column value is VITALS.
You can safely let CIS autogenerate page keys and block keys in this way if all of the following are true in your Clintrial protocol:
- Pages are unique within a trial book.
- You use the same naming conventions when assigning RefNames with the InForm Architect application and when assigning page key item values in the Clintrial software.
- The page key column has an alphanumeric data type if the RefNames assigned in the InForm Architect application are textual.
- Double underscore—To handle the case where page keys are not unique within a trial book in the Clintrial protocol design, CIS uses a special RefName format in which the RefName is concatenated with the page key item value, separated by a double underscore. For example, the RefName used to map the VITALS form to data tables representing a Clintrial VITALS trial page with a page key item value of 61 would be VITALS__61. During synchronization, the VITALS form synchronizes to a data table in which the page key column is 61.
When you import a Clintrial protocol to a CIS library, CIS automatically generates mappings with RefNames in this format. Additionally, it assigns the value following the double underscore to the BlockKey Value or PageKey Value property of each generated control path mapping definition.
When you create mappings from the InForm Architect application to a previously defined Clintrial protocol in which the naming convention uses different page key item values and page names, you must do one of the following:
- Before generating mappings—Manually update visit and form RefNames to include the corresponding block key and page key item value before generating mapping definitions. Use the format RefName__page-key-item-value.
- After generating mappings—Specify the appropriate block key and page key values as properties of the control path mapping definitions. For more information, see Customizing page keys and block keys.