Exporting exceptions to HighBond Results
If you use HighBond, you can export exception data in an Analytics table to a table in Results. To export exceptions, you use the standard procedure for exporting data from Analytics, with some minor differences.
Security requirements
The ability to export exception data to a control test requires a specific HighBond role assignment, or administrative privileges:
-
Users with a Professional User or Professional Manager role for a Results collection can export results to any control test in the collection.
Note
Only users with the Professional Manager role can overwrite existing data in a control test.
-
HighBond account admins and Results admins automatically get a Professional Manager role in all collections in the HighBond organization or organizations they administer.
Password requirement
Password not required
You do not need to specify a password to export to Results if you used online activation to activate your copy of Analytics. The password is automatically created and sent to Results based on activation information stored on your computer.
Password required
You do need to specify a password to export to Results if you used offline activation to activate your copy of Analytics. The required password value is a HighBond access token.
To get an access token:
- On the Analytics main menu, select Tools > HighBond Access Token, and then sign in to HighBond.
An access token is returned, which you can copy and paste into the password prompt.
Caution
Safeguard your access token like any account password. It contains information unique to your HighBond account. You should not share access tokens.
Note
A password is also required if you use a script to export to Results, and you run the script in Robots, Analytics Exchange, or the Analysis App window.
Export limits
The limits that apply when exporting to a control test in Results are shown below.
Within these limits, you can export multiple times to the same control test. If data already exists in the control test, you have the option of overwriting it, or appending the new data.
Note
Although you can export up to 100,000 records to a control test, a better approach is to create smaller, more focused exception sets.
Item | Maximum |
---|---|
Records per export | 100,000 |
Records per control test | 100,000 |
Fields per record | 500 |
Characters per field | 256 |
Keeping fields aligned between Analytics and Results
If you are round-tripping data between Results and Analytics, you need to ensure that all field names in the Results table meet the more stringent Analytics field name requirements. If you do not, you risk misaligning your Analytics and Results data.
For example, any special characters in Results field names are automatically converted to underscores when they are imported into Analytics, which means the field names no longer match the original names in Results. If you then export the Analytics data back to the original table in Results, fields are no longer correctly matched.
To avoid this problem with data that you intend to round-trip, make sure that before you upload the data to Results from CSV or Excel files it meets these Analytics field name requirements:
- no special characters or spaces
- does not start with a number
- contains only alphanumeric characters, or the underscore character ( _ )
Note
When you append data to questionnaire fields, the display name of the column in Results remains the name that is specified in the questionnaire configuration, even if you changed the display name in Analytics.
Export exceptions to Results
- Follow the procedure for Exporting data. At the appropriate points, complete the steps listed below.
- In the Export As drop-down list, select HighBond.
- If you want to overwrite any existing data in
the Results table, in Export Options, select Overwrite
table. If you want to append to data that already exists in the table, leave this unselected.
Note
Analytics fields can only be appended to existing Results fields if they have matching physical field names, regardless of their display name in either application. In Analytics, the physical field name is the name in the table layout. Exported fields with field names that do not match the name of a field in Results create new columns in Results.
The order of columns within in the table does not matter.
-
If you want to export column display names to Results, in Export Options, select Include field display name. This will make the column display name and field name in Results the same as they are in Analytics. If you do not select this option, the result depends on whether you are exporting fields or the view:
Exporting Fields Exporting View Include field display name is on Field name in Results is the field name from Analytics. Display name in Results is the display name from Analytics. Include field display name is off Field name and display name in Results are the field name from Analytics. Field name and display name in Results are the display name from Analytics.
Note
If you are appending a view to a Results table you populated by exporting views from Analytics versions older than 14.1, you likely do not want to select Include field display name. Doing so may export columns with different field names, which will create new columns in Results and misalign your data between products.
- Do one of the following:
If you know the ID number of the table you are exporting to:
Enter the number in the To text box.
- Enter the number without any quotation marks – for example, 99
- Enter only the number. Do not enter a file name.
- If you are
exporting to a data center other than North America, you
must also specify the data center code. The control test ID number
and the data center code must be separated by the at sign (@) –
for example, 99@eu.
The data center code specifies which regional HighBond server you are exporting the data to:
- ap – Asia Pacific
- au – Australia
- ca – Canada
- eu – Europe
- us – North America
The North America data center is the default, so specifying @us is optional.
If you do not know the ID number of the table you are exporting to, or if you want to create a new table:
- Click To, and in the Select Destination Test dialog box navigate to the appropriate analysis folder.
- Do one of the following:
- Select an existing table and click OK.
- Enter a name in the New data analytic field and click Create.
You are returned to the Export dialog box and the control test ID number and data center code are prefilled in the To text box.
- Complete any additional steps that you want to perform
in the Export dialog box and click OK.
A progress indicator appears while the exception data is exported to Results. When the export operation is complete, an entry is created in the log.