Run settings for Query
Some advanced features are on the ribbon Run tab. Others are in the Options box.
Run tab settings
Some of these settings can be changed by the runners. Other settings can be changed only by the script developer.
To lock the specified Sheet, Start Row, or # Records setting so that it cannot be changed by a runner, click the padlock icon that is to the left.
Write Headers
If the Excel data file for a script is not available, you might need to write headers to a new sheet. You can write headers from Studio and also from the Excel Add-in.
Note: If Write Headers is grayed out, click Unlock Headers.
Lookup Values
You can use a lookup value for criteria.
- On the Criteria tab, change the criteria type for the field to Cell. (This applies to both cell-based and column-based mapping.)
- Type a cell in the value box. For example, type G2.
- Click the Run tab, and select the cell.
- Click Lookup Values, log on to SAP if necessary, and then select the value that you want to use for the criteria.
Write Records
Choose how you want Query to write the results in your data file:
Append Data to Result File: Query will start to write new data after the last row of any existing data in the worksheet
Overwrite Data in Result File: Query will overwrite any existing data. However, if downloaded data consists of fewer rows than was in the worksheet, the data in the additional rows will remain. For example, if your worksheet contains 100 rows of data and you run a query that downloads 75 rows of data, the last 25 rows will remain in the sheet.
Clear All Mapped Data from Result File: Starting at the Start Row, Query will clear existing data and write the new downloaded data.
Start Row
Enter a different start row if your data sheet already contains data that you do not want to overwrite.
Auto Logon Credentials
Select the auto logon credential that you want to use to open SAP automatically if you schedule the script to run in the future or to run at regular intervals. This setting is also useful if you do not want to type your logon information each time you run the script.
Save auto logon credentials
- Click Auto Logon Credentials, and then click Add New Auto Logon Credentials.
- In the SAP Logon box, click the Credentials tab.
- Choose your SAP system, and then type your client number, user name, and password.
- Check the Save as auto logon credential box, and type a name for the credential in the Auto logon name box.
The credentials are saved in the wsSAPConnector.xml file, which is stored at C:\Users\<user name>\AppData\Roaming\Winshuttle\Connector\11. If you connect to SAP from other computers, you can copy the file to them.
Require Run Reason
Check this box to open the Run Reason box whenever the script is run. Winshuttle Studio adds some basic information about the script, but the person who starts the run can provide more details.
Run as SAP Background Process
Check this box to reduce the processing impact on the SAP system.
Enable Adaptive Query Throttling
When the Adaptive Query Throttling algorithm is applied, query execution slows as the system load increases; however, without the algorithm, the query executes in constant time and competes for resources with other transactions on the system.
Note: Adaptive Query Throttling is not available for logical databases or for InfoSets and SAP queries.
Important: Although turning off this option can improve query performance, the server might crash if it is already overloaded. For best results, always run queries with this option turned on unless you are certain that the SAP server is not highly loaded.
Data Chunks
This setting can help performance when you are downloading a large number of records. By default, for single-table queries, Studio Query calculates the optimum chunk value for the run based on query characteristics, such as total field length and number of records to download.
When you specify a data chunk value, Studio Query fetches only the number of records for each chunk. The maximum allowed value for chunk size is 450000. A Stop button also appears so that you can stop the download if it is running for too long.
Note: The Data Chunk setting is not available for InfoSets and SAP queries.
Options box settings
Click the File tab, click Options, and then click the following tabs:
Data Settings tab
Save data file
Choose the default instruction for saving the data file: Do not save, Save at end of run, or Save after [n] records, where [n] is the number that you specify.
Warn if data download overwrites existing data
Check this box to ensure a Query download does not overwrite existing values in your data file.
SAP Settings tab
Query execution time out (seconds)
Specify the maximum amount of time between the start of the run and the download of the results. If Query is not able to return the results within that time frame, the Query will automatically be canceled.
Enable Adaptive Query Throttling
If you turn on Adaptive Query Throttling in the Options box, it is set by default for all queries.