Question & Answer
Question
What are the environment variables supported by IBM InfoSphere Information Server Pack for SAP BW?
Answer
The table summarizes the environment variables supported by IBM InfoSphere Information Server Pack for SAP BW.
You can define the environment variables in different methods.
A. Engine tier (run time)
A1. Load or Extract components
To verify if the environment variable is set, run the job and check the job log in the InfoSphere DataStage Director. Open the "Environment variable settings: (...)" message and check if the variable and value are present.
You can use any of the following methods to define the environment variables.
- On UNIX, set the environment variables in the dsenv configuration file. You must restart InfoSphere Information Server after you modify the dsenv file. When the environment variable is set in the dsenv file, it is visible for all jobs in all projects. You must add the environment variable at the end of the file. For example:
ASC_BWLOAD_IPAK_TIMEOUT=120; export ASC_BWLOAD_IPAK_TIMEOUT - On Windows, set the environment variable in the Windows system settings. You must restart InfoSphere Information Server after you set the environment variable. When the environment variable is set by using the Windows settings, it is visible for all jobs in all projects. To set the environment variables, go to Control Panel>System>Advanced>Environment variables. Add the environment variables under System variables.
- Add the environment variables in the Project settings. To add the environment variables, open the InfoSphere DataStage Administrator Client, and then select the project. Select Properties>General> Environment. Define the variable in the "User Defined" section. When the environment variables are defined in the Project settings, it is visible for all jobs in the specific project.
Note: You can also define the variable with a default value (eg. ASC_BWLOAD_IPAK_TIMEOUT=360), then add the variable to the jobs for which a different value needs to be specified and override it there (eg. ASC_BWLOAD_IPAK_TIMEOUT=120). - Add the environment variables in the job. You must recompile the job after adding the environment variable. When the environment variable is added in the job, it is visible to the specific job.
To add the environment variable to the job, open the job in the InfoSphere DataStage Designer client, then select Edit>Job Properties>Parameters> Environment Variable. Double click the first line in the tree ("New...") and type the variable name (eg. ASC_BWLOAD_IPAK_TIMEOUT) and prompt (eg. ASC_BWLOAD_IPAK_TIMEOUT) in the dialog window. Click OK. Scroll down the list of variables and select the newly added variable from the User Defined section. In the job parameter list you can add a default value (eg. 1). Recompile the job
A2. RFC Server component
You can use any of the following methods to define the environment variables.
- On UNIX, set the environment variables in the dsenv configuration file. You must restart the RFC Server after you update the dsenv configuration file. You must add the environment variable to the end of the file. Example:DSWARN=1; export DSWARN
- On Windows, set the environment variable in the Windows system settings. You must restart the RFC Server after setting the environment variable. To set the environment variable, select Control Panel>System>Advanced>Environment variables. Add the environment variables under System variables.
B. Client tier (design time)
Set the environment variable in the Windows system settings. You must restart DS Designer after you set the environment variable. To set the environment variable, select Control Panel>System>Advanced>Environment variables. Add the environment variables under System variables.
The supported environment variables are:
| Environment variable | Tier | Component | Description | Example value |
Default value (if not set) | Applies from version* |
| ASC_BWLOAD_IPAK_TIMEOUT | Engine | LOAD | Maximum time in seconds to wait for InfoPackage to be ready for data load. Maximum value is 43200 (12 hours). If the value is set to an invalid value or to a value larger than 12 hours, then it is reset to the default value. | 360 | 120 |
4.2.1
|
| ASC_BWLOAD_PACKETSIZE | Engine | LOAD | Sets the packet size in data records, if it is not available in BW. The maximum size is 100000. | 10000 | Load: 10000 7.x Load: 25000 |
4.2.1
|
| ASC_BWLOAD_PACKETSIZE_OVERRIDE | Engine | LOAD | Overrides the packet size in data records (by default the value is read from BW). The maximum size is 100000. | 10000 | 10000 |
4.2.1
|
| ASC_BWLOAD_PCIPAK_TIMEOUT | Engine | LOAD | Maximum time in seconds to wait for ProcessChain to start InfoPackage. Maximum value is 43200 (12 hours). If the value is set to an invalid value or to a value larger than 12 hours, then it is reset to the default value. | 360 | 120 |
4.2.1
|
| ASC_BWLOAD_NODE_SYNC_TIMEOUT | Engine | LOAD | Maximum time in seconds for all nodes or links to register for a Parallel load. You can increase this value for complex loads. | 60 | 10 |
4.3.2.1
|
| ASC_BWOHEXTRACT_I_ENQUEUE_LOOP_COUNT | Engine | EXTRACT | Modifies the value specified for the parameter I_ENQUEUE_LOOP_COUNT, when calling the SAP function module RSB_API_OHS_DEST_READ_DATA. This indicates the maximum number of attempts allowed for SAP to get a lock on the BW extract request. If the variable is not set, SAP uses the default value 1, and the parameter is not exported. This variable is introduced by APAR JR34428. | 10 | Not set (parameter not exported) |
4.3.1
|
| ASC_BWOHEXTRACT_LITTLE_ENDIAN | Engine | EXTRACT | The possible values are 0 and 1. When set to 1 (default), it indicates the Datastage Engine tier platform supports only Little-Endian numeric values (e.g. Windows, Linux x64). Set to 0 for Big-Endian platforms (e.g. AIX, Solaris, zLinux). | 0 | 1 |
4.2.1
|
| ASC_BWOHEXTRACT_PCIS_TIMEOUT | Engine | EXTRACT | Maximum time in seconds to wait for ProcessChain to Start InfoSpoke. Maximum value is 43200 (12 hours). If the value is set to an invalid value or to a value larger than 12 hours, then it is reset to the default value. | 360 | 900 |
4.2.1
|
| ASC_BWOHEXTRACT_IS_TIMEOUT | Engine | EXTRACT | Maximum time in seconds to wait for InfoSpoke to be ready for extract. Maximum value is 43200 (12 hours). If the value is set to an invalid value or to a value larger than 12 hours, then it is reset to the default value. | 360 | 900 |
4.2.1
|
| ASC_BWOHEXTRACT_SET_BWSTATUS | Engine | RFC Server | The possible values are 0 and 1. If the value is set to 1: when the InfoSphere DataStage extraction job fails, the request status in BW is set to red. By default, the request status is set to green. |
1 | 0 |
4.2.1
|
| ASC_PROCESSCHAIN_START_TIMEOUT | Engine | RFC Server | The maximum time in seconds to wait for the process chain start. The maximum value is 43200 (12 hours). If the value is set to an invalid value, or to a value larger than 12 hours, then it is reset to the default value. | 360 | 120 |
4.2.1
|
| DS_PX_RESET | Engine | LOAD EXTRACT |
If the value is set to 1, the job performs additional cleanup actions during startup. This is implemented in APAR JR38569. Note: In InfoSphere Information Server, version 8.5 and later the variable is set automatically, transparent to the user. For more information, see APAR JR31010. |
1 | 0 |
4.2.1
|
| DSBW_CHAR_CNV_SPACE_TO_NULL | Engine | EXTRACT | Set to 1 to enable conversion of all-space SAP string values to NULL in Datastage. Implemented in APAR JR38569. Available as patch for version 4.3.2.3 | 1 | 0 |
4.3.2.3
|
| DSBW_7XLOAD_INFOPACKAGE_STATUS_CHECK_RETRIES | Engine | 7.x LOAD |
Starting from v4.4, users can check the load request status in SAP BW. Set this variable to the number of retries to get the status (1 second intervals). See footnote for more details *** |
60 | 0 | 4.4.0.0 |
| DSBW_7XLOAD_NUM_OF_JCO_CONNECTIONS | Engine | 7.x LOAD | Number of threads for each node (only when multi-threading is enabled). Theoretically it can be any integer value, but for better performance use values up to 2 times the number of logical processors available on the IS server. | 4 | 1 |
4.3.3
|
| DSBW_7XLOAD_RUNTIME_DISABLE_MULTI_THREADING | Engine | 7.x LOAD | Disable multi-threading for each node in BW7x runtime | 1 | 0 |
4.3.3
|
| DSBW_7XLOAD_STAGE_RUNTIME_STACKTRACE | Engine | 7.x LOAD | To enable stack trace in job log (only for Java developers) | 1 | 0 |
4.3.3
|
| DSBW_7XLOAD_STAGE_TIMEOUT | Engine | 7.x LOAD | Timeout in minutes for BW7xLoad runtime | 25 | 15 |
4.3.3
|
| DSBW_EXTRACT_USE_LEGACY_BAPI | Engine | EXTRACT |
Starting from v4.4, BW Extract stage uses RFM RSB_API_OHS_DEST_READ_DATA_RAW to extract data in binary format from SAP BW. Set this environment variable to 1 to use legacy RFM RSB_API_OHS_DEST_READ_DATA instead; which extracts data in text format. |
1 | 0 | 4.4.0.0 |
| DSBW_LOAD_USE_LEGACY_BAPI | Engine | LOAD | This Environment variable is use to select the Function Module which is use to load the Data in SAP BW. If this Environment variable is set equals to 1, then LEGACY (Text based) BAPI is selected to load the Data; else default BINARY BAPI will use to load Data in SAP BW. |
1 | 0 |
4.3.3
|
| DSBW_MUTEX_TIMEOUT | Engine | LOAD | Controls the mutex timeout (in seconds) for BW Load. Enter a value between 0 and 3600. For more information, see APAR JR40861. |
240 | 180 |
4.3.2.1
|
| DSBW_RFC_SRV_LOCAL_LOGON | Engine | RFC Server | The possible values are 0 and 1. Set the value to 1 to log in to the RFC Server locally. This works only if the BW Pack RFC server and the DataStage engine run on the same machine. | 1 | 0 |
4.3.2.1
|
| DSBW_RFC_SVR_OPTIONAL_PROJ_NAME | Engine | RFC Server | Set to 1 to enable the entry DataStage Project in the 3rd Party Selections tab of the InfoPackage in SAP BW. It allows the user to provide the project name (as the same DS job name can exist in multiple projects). After setting to 1 and re-starting the RFC Server, any newly created InfoPackage will show the entry mentioned, which the user needs to fill manually. | 1 | 0 |
4.3.2
|
| DSSAP_BW_RFC_SVR_TRACE** | Engine | RFC Server | To enable extra level of development traces for the BW RFC Server. Log file with the name <RFC_SERVER_TRACE.log> will be created at the following location: <IIS Installation Directory>\Server\DSBWConnections\<SAP Connection>\<SourceSystem>\Data |
1 | 0 |
4.3.3
|
| DSSAP_STAGE_RUNTIME_TRACE** | Engine | EXTRACT LOAD 7.x LOAD |
To enable development logs with a fixed level of tracing. Possible values are FINE, FINER and FINEST | FINEST | FINE |
4.3.3
|
| DSSAP_STAGE_RUNTIME_TRACE_DIR** | Engine | EXTRACT LOAD 7.x LOAD |
Path of the directory where development log is to be generated (used only when runtime trace is enabled i.e. DSSAP_STAGE_RUNTIME_TRACE = FINE/FINER/FINEST) | C:\Temp | NULL |
4.3.3
|
| DSSAPHOME | Engine | RFC Server | The value specified for this environment variable is used during runtime to construct the location of the SAP Connections directory. | /opt/IBM/ InformationServer /Server |
Not defined |
4.2.1
|
| DSWARN | Engine | RFC Server | The possible values are 0 and 1. When the SAP BW OpenHub Extract job is started by SAP BW, the SAP BW job stops after 50 warning messages are logged. Set this environment variable to 1 to ignore the job warnings. | 1 | 0 |
4.2.1
|
| IIS_SAP_BW_STAGE_CLIENT_TRACE** | Client | EXTRACT LOAD 7.x LOAD |
To enable client (stage design time) development logs. | 1 | 0 |
4.3.3
|
| IIS_SAP_BW_STAGE_CLIENT_TRACE_DIR** | Client | EXTRACT LOAD 7.x LOAD |
Path of the directory where development log is to be generated. | C:\Temp | NULL |
4.3.3
|
* environment variable supported on GA or maintenance release / patch
** to be used only for troubleshooting purpose as recommended by IBM support
*** DSBW_7XLOAD_INFOPACKAGE_STATUS_CHECK_RETRIES - Starting from v4.4, there is a provision in BW 7x Load Stage run time to check the load request status from SAP BW. Once data is pushed from DataStage to BW through BW 7x Load Stage run time, data is further processed in BW server before it gets finally loaded to DataSource(PSA). During the processing, data load request remains in Yellow(Y) status. As soon as it is processed and data loaded successfully, the request turns to Green(G); otherwise the request status turns to Red(R).
You can opt for checking the status of the load request by using this environment variable which sets number of retries for checking the data load status in SAP BW. Each retry is attempted with the interval of 1 sec. Be default its value is 0 and therefore no status is checked for the load request sent to BW.
Note the processing of data in BW may take time depending upon the amount of data you have loaded and other SAP BW performance parameters. Therefore, if you opt to check the status of load request, it may increase the job execution time of your DataStage job and also you may continue to get the yellow(Y) status until the last retry.
Was this topic helpful?
Document Information
Modified date:
21 August 2018
UID
swg21424458