In this article
Open a project. Open Data Sources > Data Batches.
Click Import data from Forsta.
-
Depending on your access type, you have two choices:
Forsta HX Platform
Choose Forsta HX Platform.
1: Basics
1.1: API Credentials
When importing data from Survey Designer, API credentials are required. These credentials can be saved on a customer level within Forsta Visualization or added per task. (Please contact your Forsta contact person to set it up on a customer level.) If added manually in each task, a URL, Client ID and Client Secret are needed. This information can be accessed through Forsta Plus support at support@forsta.com
1.2: Survey Details
Click within the dropdown menu and select which survey to connect the project to. Surveys that appear in the dropdown menu are surveys the API user has access to. Regular surveys are shown with a blue icon before their name; Autocombined surveys are shown with a green icon.
1.3: Time Settings
This determines when the data is imported.
Auto: All data will be imported on first import. Future imports will only import new and updated respondents. Uses "New data set" batch type.
Total: All respondents will be imported every time the import is executed. Uses "New data set and updates to existing data sets" batch type.
Static: Imports respondents based on a time range defined in "interview_end" or "interview_start" if the former is unavailable. Uses "New data set" batch type.
2: Advanced
2.1: Batch tag
Batch tags can be created by clicking the Edit tags button, entering a tag name and clicking the Save button. They can then be selected in the dropdown menu. Once created, tags can be used in all types of imports and batches. Tags are useful when deciding which batches to activate or deactivate. They can also be used to search between batches in a project. It is recommended to use tags if multiple Forsta Plus Surveys are being used in a single Forsta Visualizations project. If you are using the "Auto" time setting, each survey requires a unique tag.
2.2: Forsta Plus Settings
Use text as question label
Click this button if you want to use the survey question text as a label in your report.
Note: If your question uses a prompt, the labels formed will be a combination of the question title, text and prompt, depending on what is available.
2.3: Text Analytics
Click this button to import text analytics from SmartHub within Forsta Plus. You are required to select the hub and flow to derive the text analytics from.
Note: When using this feature, the time period will be set as "Total" and no filter options will be available within the import.
2.4: Hierarchy
Use hierarchy from Hierarchy Manager
Click this button to import hierarchy data from Hierarchy management within Forsta Plus and provide the hierarchy ID (name of the “Table lookup/Hierarchy” question within the survey).
Add top level node to hierarchy
Click this button to provide the name of the top level node. If the name doesn't yet exist, a new branch will be created. If the name does exist, the data will be merged into the existing branch.
2.5: Select Questions to be included in import
Include questions marked as "Exclude from reporting"
The "Exclude from reporting" setting is set up in Forsta Plus. If you want to include these questions, click the "Include questions marked as "Exclude from reporting".
Include all survey questions
This feature is enabled by default. By clicking this button to Off, you can pick specific questions to include in the import.
2.6: Additional Filter Expression
By default, only respondents with the answer “Complete” in “Status” are imported. Additional filters can be added using the Additional Filter Expression feature. This is achieved by selecting the question and answer to wish to apply a filter to, which are then included in the filter expression. status='complete' can also be changed. For example, status='incomplete'.
2.7: Meta data settings
Update meta data even if there are no new respondents to import
This option can be used to always ensure the meta data is updated in the case changes have been made to the survey structure within Forsta Plus, but there are no new respondents since last time of import. This update creates no new respondent batches.
Hide (inactivate) missing questions and answers from reporting
Questions and answers that are removed from the survey and should not be reported on can be automatically hidden from reporting. This is done by inactivating the question/answer. After doing this, you can click the Hide (inactivate) missing questions and answers from reporting button to hide them.
Overwrite questions and answer labels in project
Questions within Forsta Visualizations have the capability to share answer lists/blocks. An answer block is created the first time a question belonging to it is imported. This setting will decide how the answer blocks are created. To learn more about the Answer block logic, click here.
2.8: Meta Data transformation
Allow coding of open-ended questions to categorical in Meta data transformation
Click this button to categorize open-ended or numeric questions.
Transformation
Click this button if yotu want to make changes to the structure of the data before it is imported to Forsta Visualizations.
Open end and numeric can be changed to categorical
Make text changes to questions and answers
Change or add mandatory variables
Transformations can be used for different imports within the same project.
Select an existing transformation for the dropdown menu
Create a new transformation
Edit an existing transformation
To learn more about Meta Data transformation, click here.
3: Activation
3.1: Data batch options
Activate data batches after import
To be able to report on the imported data, the batches must be activated within Forsta Visualizations. This can be done manually, or automatically when importing data from Forsta Plus. Depending on Time period settings, different activation logics are used:
Total or Static: The system will inactivate old data batches and activate newly imported ones (if Tags are used, the system will inactivate/activate batches with the same Tag).
Auto: Newly imported data batches will be appended to the already activated data batches.
Delete inactivated data batches
Click this button to delete all inactivated data batches after activation has been executed. This will not consider Tags but will delete all inactivated files.
4: Scheduler
4.1: Scheduler name
This is the name shown on the cards in the main Data page. These names are automatically named after the Survey name. If the same survey is imported to the project in a future import, the name will be the Survey name and a bracketed number. For example, Survey (1)
4.2: Scheduler type
This option defines the frequency of the imports
No scheduler: The default option. Previously named "On Demand". Choosing this means even if you only import one survey one time, a scheduled task is still created in order to save your settings.
Monthly: The import will run on a monthly basis. You can set the day (1-31) and start time.
Weekly: The import will run on a weekly basis. You can set the day of the week and start time.
Daily: The import will run on a daily basis. You can set the start time.
Hourly: The import will run on an hourly basis. You can set the hourly frequency and the start/end time.
4.3: Notifications
Input your email address to receive an email telling you if the Import Completed/Failed, based on what you select.