Valid from EWA version 1.21.228.0
Created for Daimler AG
1 EWANAPI Descriptions / Examples of DMS Calls
3.4 Direct return codes of EWANAPI
4 Direct access to EWA download area
5.1 Determination of damage code
7.3 WIS Maintenance Service System (MSS) Call
This document describes the call interface in the EWA project. Here, the existing "WISAPI" interface for the "classic" WIS product was used as a basis to define an interface allowing the "WIS/ASRA/EPC" applications to be called up in a way that is very compatible to that of the previous concepts in the "classic" world. Even more it has been extended subsequently and now allows also some control over the EPC client.
Significant stages of development were:
This document focuses on merging the following two files:
The technical details have been removed so that the document basically can be used as an external call reference.
Standard Installations ("Local" and "Central"):
The following files comprise the installation of the call interface in a standard environment ("local" or "central"):
File |
Description |
---|---|
ewanapi.exe |
Call interface program |
ewanapi.ini |
Configuration file |
hpwin32.dll |
System expansion for Win32 functions |
wisapi.exe |
Program identical to "ewanapi.exe", for backwards compatibility to existing calls |
ewanapi.jar | Contains the classes for the external EWANAPI interface. This JAR file is needed by EWANAPI to run specific operational steps. Developers who want to bundle EWANAPI code in their own applications need the JAR file during development and the JAR file plus the DLL in the runtime environment. |
Standalone Installation:
When installed by the WIS standalone installer (i.e. in the STAR DIAGNOSIS environment) following files comprise the installation, but the call interface on the command line is exactly the same:
File |
Description |
---|---|
ewanapi.exe |
Call interface launcher program |
ewanapi.ini |
Configuration file |
hpwin32.dll |
System expansion for Win32 functions |
wisapi.exe |
Program identical to "ewanapi.exe", for backwards compatibility to existing calls |
ewanapi.jar |
JAR file containing the application code |
ewanapi.config |
Config file for the launcher indicating to where the Java Runtime is installed. This is needed as the standalone installation has its own private JRE. |
wisapi.config |
Same as above for the WISAPI.exe launcher program |
External Java EWANAPI Interface:
System integrators who want to make use of a more tight EWA integration via EWANAPI may want to make use of the EWANAPI Java API which is provided within the file ewanapi.jar on the official delivery DVD of EWA. The file can be found in the directory[DVD]:\ewa\Apps_sd\ewanapi_sd\application. Additional technical developer documentation can be requested from the EWA product management team.
In general, the call interface had to be expanded to include the following parameters - all of them are optional, but typically the credential information might be needed to authenticate against a given EWA application server:
Parameters |
Description |
Mandatory/ |
Example |
Hint |
---|---|---|---|---|
-application |
Type of application to be started. Parameter can be used to directly open the EWA download area, too. WIS-Net(for WIS) EPC-Net(for EPC) DOWNLOAD(for EWA download area) |
Optional |
-application EPC-Net |
If not specified, the "WIS-Net" value is internally used for backwards compatibility. Thus for calls to the WIS application this parameter can silently be omitted |
-userid |
User name that must be presented at the EWA AccessGateway. |
Optional |
-userid stollms |
If this is not specified, a login is attempted without a UserID and usually results in failure. But as soon as a client application is already up and running, this parameter can be omitted.
Note:
|
-userdomain |
Windows domain information (if used) |
Optional |
-userdomain localworkshop |
Can be excluded if no domain information is used. |
-userpwd |
User password |
Optional |
-userpwd password |
Without this information, login to the device usually will fail unless SSO is enabled or a background call will be issued.
Note:
|
-smcookievalue | Value of a Siteminder Cookie (if available). | Optional |
-smcookievalue "EHJFGEUWLSHDTWKL/&HF12" |
Note:
|
-smcookiename | Value of a Siteminder Cookie Name (if available). | Optional |
-smcookiename EWA_SMSESSION |
Note:
|
-triggername |
Communication channel on which a DMS system can specify if it wants to be actively notified of a completed call. |
Optional |
-triggername kerridge_pipe_15 |
Note:
|
-debug |
Writes additional information to the console |
Optional |
-debug -debug C:\EWANAPI.log |
Note:
|
-locale |
Specifies the locale to be used when starting the application and creating a session on the application server |
Optional |
-locale de_DE | If not specified EWANAPI automatically sends the current locale settings of the client to the EWA server. |
-processid |
The optional processID is a random number in the form of a UUID formatted as a string. It is a unique instance key used for the Data Exchange Service (SAR-WebParts) integration allowing a running instance [of EPC or WIS] to be uniquely identified from all instances [of WIS or EPC] running on computers anywhere in the world at one time. |
Optional |
-processid f47ac10b-58cc-4372-a567-0e02b2c3d479 | If specified then EPC and WIS save Shopping Lists and Job Order via the Data Exchange Service. |
-server |
Specifies the URL to the EWA-server. It has to be the host-name or ip-address without port or protocol. If specified, this URL will be used to connect to the server, instead of the one specified in EWANAPI.ini or ewanapi.cookie. If no previous configuration exists, the ewanapi.cookie will be created. |
Optional |
-server 16.58.251.4 | |
-port |
Specifies the port of the EWA-server. If specified, this URL will be used to connect to the server, instead of the one specified in EWANAPI.ini or ewanapi.cookie. This parameter will only be used if the -server-parameter has been specified. If no previous configuration exists, the ewanapi.cookie will be created. |
Optional |
-port 9001 | If this parameter is not specified the default value is used: 9000. |
-https |
Specifies the protocol of the EWA-server. If specified, this URL will be used to connect to the server, instead of the one specified in EWANAPI.ini or ewanapi.cookie. This parameter will only be used if the -server-parameter has been specified. If no previous configuration exists, the ewanapi.cookie will be created. |
Optional |
-https true | If this parameter is not specified the default value is used: false. |
-prefercookie |
Specifies whether the host-settings given by the parameters (-server) or by the cookie should be preferred. |
Optional |
-prefercookie | If this parameter is not set, the server-parameter will be preferred (if specified). |
These parameters are always specified in the following calls.
EWANAPI forwards the business request to the correct client application which is responsible to evaluate the call and react correctly. In case of errors or incomplete or even wrong commandlines the clients write error codes into an error file - if an error file has been specified.
But there are cases when EWANAPI cannot even handle the call. In this case it returns specific error codes to the calling application. In a command line you may react on this reading the Windows %errorlevel% command line variable. Within application code the process will return the given code. Following error codes exist:
Error code | Description |
-2 | Parameter parsing error. Invalid commandline specified. Background info: the EWANAPI launcher performs some basic command line consistency checks. Note: Typically this shall not happen within system integration as the end user will have no chance to work around this issue. |
1000 | Configfile could not be found. |
1001 | Incorrect/missing value(s) in config file. |
1002 | Connection to server failed. This can happen if the connection to the AccessGateway is broken/cannot be established. |
1003 | Communication error. Client cannot be found/started. This can happen if the client does not answer on the communication channel, or i.e. Java Webstart could not be found to start the application. |
1004 | Authentication error. AccessGateway denied the access. |
1005 | WebStart or Application Start not possible. |
1006 | Named access authorization already in use. No new access authorization could be allocated. |
1007 | Account has (temporary) been locked. You may try again later. |
1008 | A password change is due for the given account. (The user may try again after having changed his password). |
1009 | Account has been disabled. |
any other code | Error codes provided by a server contacted by EWANAPI.exe which EWANAPI.exe does not know will simply be returned to the command line as error code. I.e. a HTTP server errorcode like 599 from an application server contacted by EWANAPI.exe would be unknown to EWANAPI and returned as error code 599. |
The EWA download area can be directly opened from a command line.
The syntax for accessing the EWA download area is as follows:
ewanapi -application DOWNLOAD -userid <your_userid> -userpwd NEWS:<EWA-token> [-server <server-url>] [-port <server-port>]
Parameter details:
Parameter |
Description |
Mandatory/ |
Example |
Notes |
---|---|---|---|---|
-userpwd NEWS: |
Token generated by EWA TokenGenerator. |
M |
-userpwd NEWS:AQH+g4wLA-346345MD+NwQltdVg2duICFE-345tr+bXGfT7qLsAPKBFdxVy |
The WIS damage code module can be directly called up from a command line. The code determined is written to a file.
The syntax for calling up WIS to determine a damage code is as follows:
ewanapi[1] -S <filename> -t <Model> | -V <VIN> [-F <FGR> [-f <FUG>]]
[-damagedpart <damagedpart> [-damageid <damageid>] [-damagetype <damagetype>] [-repairtype <repairtype>]]
[-err <filename>]
-application WIS-Net
-userid <your_userid>
-userpwd <your_passwd>
-userdomain <your_domain>
The parameters in detail:
Parameters |
Description |
Mandatory/ |
Example |
Notes |
---|---|---|---|---|
-S |
File name for the return of the damage code determined |
M |
-S C:/tmp/ssl.txt |
If WIS shall not store the resulting information into a file, a special value of [null] must be provided. |
-t |
Model type |
M |
-t 202018 |
Either -t or -V must be provided. |
-V
| VIN (17 alphanumeric characters) | M |
-V WDB2102171A354643 | Either -t or -V must be provided. |
-F |
Function group |
O |
-F 10 |
|
-f |
Function subgroup |
O |
-f 30 |
Can only be used in conjunction with function group. |
-damageid | The id of a damage (as fragment of a damage code) | O |
-damageid 1 | Can only be used in conjunction with "-damagedpart" option. |
-damagedpart | A partnumber of a damaged part (as fragment of a damage code) | O |
-damagedpart 54148 | |
-damagetype | The type of a damage (as fragment of a damage code) | O |
-damagetype 78 | Can only be used in conjunction with "-damagedpart" option. |
-repairtype | The repair type of a damage (as fragment of a damage code) | O |
-repairtype 7 | Can only be used in conjunction with "-damagedpart" option. |
-err |
File name for returning the error code |
O |
-err C:/tmp/error.txt |
If a path is not given, the folder from which the module is opened is used. |
In the case of an error, the transfer file contains the text
ERROR:<Error code>
The error code can have the following values:
If a complete damage code has been determined, then on Quit, this key is saved in the output file. In this way the last completely determined damage code is valid. The format of the file is as follows:
Damage_identification_designation_type_of_damage_type_of_repair
whereby the damage identification can have the value 0 (for original equipment fit) and 1 (for replacement part/replacement unit). The identification is a 5-digit code and describes the component (e.g. 05212: inner valve spring). The damage type is represented by a 2-digit code (e.g. 06: broken), the repair type by a one-digit code (e.g. 1: replace unit). All values are separated by a space. As soon as the Damage code 1 screen is left using the F8 button (End), the MB-WIS quits.
ewanapi -S C:\temp\key.txt -t 210035 -F 42 -f 30 -err C:\temp\error.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainThe "Damage code 1" screen appears. The function group 42.30 (ABS) is preselected. Following selection of an image title, the "Determine damage code" button becomes activated. This takes the user to the "Damage code 2" screen, where - following the selection of the component, the type of damage, the damage identification and the type of repair - the damage code is displayed. At the same time the "Apply" button becomes activated; this button is used to select the damage code. After returning to "Damage code 1" using the "Back" button and quitting the application, the following entry is to be found in C:\temp\key.txt:
0 03203 06 7i.e., the connecting rod bolt (03203) is broken (06). This is a replacement of original equipment (0), whereby repair using material (07) is necessary.
ewanapi -S C:\temp\key.txt -t 210 -F 42 -f 30 err C:\temp\error.txt -application WIS-Net -userid stollms -userpwd 478967895 userdomain sampledomainError code 2 is output to the error file, as there is no 6-digit model designation available; as such, it is not possible to determine the damage code.
The specified document is displayed in (and optionally printed from) the WIS "Document display". It is also possible to prepare a document search, i.e. to open "Infothek 1" or "Infothek 2".
The following calls are supported:
ewanapi -D ((-t <type_model_designation> [-m <engine_model_designation>] [-a <major_assembly_model_designation_1>,..,<major_assembly_model_designation_n>]) | ([-t <type_model_designation>] -m <engine_model_designation> [-a <major_assembly_model_designation_1>,..,<major_assembly_model_designation_n>]) | ([-t <type_model_designation>] [-m <engine_model_designation>] -a <major_assembly_model_designation_1> [,..,<major_assembly_model_designation_n>])) [-f <function_group_1>,..,<function_group_n>] [-i <info_type_1>,..,<info_type_n>] [-s <KD logic>] [-err <filename>] [-Z] [-p] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
ewanapi -D -V <VIN> [-f <function_group_1>,..,<function_group_n>] [-i <info_type_1>,..,<info_type_n>] [-s <KD_logic>] [-err <filename>] [-Z] [-p] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
ewanapi -D <doc._no._1>[,..,<doc._no._n>] [-Z] [-T 1] [-p] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
ewanapi [T <vehicle_type>] -t <type_model_designation> [-m <engine_model_designation> -a <major_assembly_model_designation>] A <WU_number> [-err <filename>] [-p] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
ewanapi -D -V <VIN> -A <WU_number> [-err <filename>] [-p] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
If the document search only produces one hit, i.e. only one document is found, then this is displayed immediately.
The parameters for calls 1 to 3 (for variant 4 see below) in detail are:
Parameters |
Format |
Description |
Mandatory/Optional |
Example |
Notes |
---|---|---|---|---|---|
-D |
Alphanumeric |
Document number |
M |
-D BB0040P012500A |
As previously, only separated by comma (also repeated). |
-V |
Exactly 17 alphanumeric characters |
Vehicle ident. number (with WMC) |
M |
-V WDB2102171A354643 |
Either "-V" has to be provided or "-t" (see below) |
-t | 6-digits | Model type | M |
-t 202018 | Either "-t" has to be provided or "-V" (see above) |
-m |
6 digits |
Engine model designation |
O |
-m 611961 |
|
-a |
6 digits |
Major assembly model |
O |
-a 722613,768002 |
Multiple entries separated by commas possible. |
-f |
2 digits or 2 digits + point + 2 digits |
Function group/subgroup |
O |
-f 00,20.10 |
Multiple identification separated by comma. There is a special parameter "ALL" for all function groups. |
-i |
1 to 2 numeric characters |
Info type code |
O |
-i 2,3,4 |
There is a special parameter "ALL" for all information types. All supported information types will be listed in the separate table below. |
-s |
1 digit |
Display logic for special cases |
O |
-s 0 |
Values = {0,1,2} 0 = Popup with question, "Display work instructions for special cases?" 1 = Only display work instructions for special cases. 2 = No display, no popup This parameter is only activated on the input of a complete VIN (similar to Infothek-1). |
-Z |
|
Return option |
O |
-Z |
On the input of Z all screens are placed on the stack. |
-T |
1 character |
Vehicle type code |
O |
-T 1 |
This parameter is only maintained for reasons of compatibility with old systems. It no longer has any functionality and is ignored when entered. |
-p | Print option | O |
-p | If this option is given the retrieved documents will not only be shown in the result list, but also been printed to the default printer. | |
-err |
Dependent on the operating system |
File name for returning the error code |
O |
-err C:/tmp/error.txt |
If a path is not given, the folder from which the module is opened is used. |
Overview of supported infotype values:
Infotype value (integer) | Information type name | Comment |
1 | Current topics | Virtual infotype. Aggregation of infotypes: 2, 3 and 4. Thus a call with parameter "-i 1" is equivalent to "-i 2,3,4" |
2 | Service information | si |
3 | Introduction into Service | sn |
4 | Measures and instructions | sm |
5 | Work information | Virtual infotype. Aggregation of infotypes: 6,7,8,9,10,11 |
6 | General safety information | ah, as |
7 | Care and maintenance | ap |
8 | Troubleshooting | af |
9 | Diagnosis | ad |
10 | Testing/repair work | ar |
11 | Retrofits/conversions | an, az |
12 | Basic knowledge | Virtual infotype. Aggregation of infotypes: 13, 14 |
13 | Functions, config. | gf |
14 | Operating instructions | |
15 | Basic data | Virtual infotype. Aggregation of infotypes: 16 ... 27 |
16 | Test/adjustment values | be |
17 | Tightening torques | ba |
18 | Filling capacities | bf |
19 | Specs for Op. Fluids | bb |
20 | Repair materials | br |
21 | Technical changes | bt |
22 | Circuit diagrams | Virtual infotype. Aggregation of infotypes: 23, 24, 25 |
23 | Electric | pe |
24 | Hydraulic | ph |
25 | Pneumatic | pp |
26 | Tools | ws, wh, wf |
27 | Workshop equipment | we |
28 | Organization | Virtual infotype. Aggregation of infotypes: 29, 30, 31, 32, 33 |
29 | Forms, certificates | of |
30 | Envir. protection cond. | |
31 | Hazardous waste disposal | os |
32 | Warranty manual | |
33 | Administration | ov |
Parameters for variant 4 (document search with WU value) in detail:
Parameters |
Description |
Mandatory/Optional |
Example |
Notes |
---|---|---|---|---|
-T |
Vehicle type code |
M |
-T 1 |
This parameter is only maintained for reasons of compatibility with old systems. It no longer has any functionality and is ignored when entered. |
-t |
Model type |
M |
-t 202018 |
|
-m |
Engine model designation |
O |
-m 102921 |
|
-a |
Major assembly model |
O |
-a 760700 |
|
-A |
Operation number |
M |
-A 421050 |
|
-p | Print indicator | O |
-p | Not only display the documents, but also print them to the default printer. |
-err |
File name for returning the error code |
O |
-err C:/tmp/error.txt |
If a path is not given, the folder from which the module is opened is used. |
Parameters for variant 5 (document search with WU value and VIN) in detail:
Parameters |
Description |
Mandatory/Optional |
Example |
Notes |
---|---|---|---|---|
-V |
Vehicle ident. number (with WMC) |
M |
-V WDB2102171A354643 |
Exactly 17 alphanumeric characters |
-A |
Operation number |
M |
-A 421050 |
|
-Z |
On the input of Z all screens are placed on the stack. |
O |
-Z |
Return option |
-p | Print indicator | O |
-p | Not only display the documents, but also print them to the default printer. |
-err |
File name for returning the error code |
O |
-err C:/tmp/error.txt |
If a path is not given, the folder from which the module is opened is used. |
The return values for these calls are:
ewanapi D si0000p0005c -application WIS-Net -userid stollms -userpwd 478967895 userdomain sampledomainThe document with number Si00.00-P-005C is displayed.
ewanapi D si0000p0005c -p -application WIS-Net -userid stollms -userpwd 478967895 userdomain sampledomainThe document with number Si00.00-P-005C is displayed and printed to the default printer.
ewanapi T 1 t 210217 A 421050 -application WIS-Net -userid stollms -userpwd 478967895 userdomain sampledomainA selection of documents with operation number 42-1050 that correspond to model designation 210.217 is shown.
ewanapi -D -V WDB2020181L0000 -A 421050 -err C:\err.txt -application WIS-Net -userid stollms -userpwd 478967895 userdomain sampledomainA selection of documents with operation number 42-1050 that correspond to VIN WDB2020181L0000 is shown. Error messages are saved to the C:\err.txt file.
Activation of the ASRA retrieval system.
Numerous combinations of parameters are supported:
ewanapi[3] ASRA [-Background] [-V <VIN>] [WMC <WMC>] [ [[-T <type_model_designation>] [-M <engine_model_designation>] [-L <steering/plant>]] [-P <production_number>] ] [A <operation_position_number>[,operation_position_number,...]] [-AN order_number] ] [-D <filename>] [-err <error_file>] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
Parameters |
Description |
Mandatory/Optional |
Example |
Notes |
---|---|---|---|---|
-ASRA |
Flag for activating the ASRA retrieval system |
M |
|
|
-Background |
Flag for activating execution in the background |
O |
Does not allocate any access authorization within EWA, but starts WIS as a background process which terminates directly after this action. The call is made user unspecific: no user credentials have to be provided for this call. Even if another WIS client was up and running already this would not be used for this call. |
|
-WMC |
World Manufacturer Code |
O |
-WMC WDB |
Due to the changed WMC handling in ASRA-ES, it is not necessary to input the WMC. If this parameter is nevertheless input, a check is also made against the specified model. |
-V | Vehicle Identification Number. | O |
-V WDB2102171A354643 | Exactly 17 alphanumeric characters including the WMC. Either model type "-T" or VIN "-V" are allowed at once. WMC is not needed in this case. |
-T |
Model type |
O |
-T 202018 |
Either model type "-T" or VIN "-V" are allowed at once. |
-M | Engine code (6-digit) | O |
-M 111920 | The optional engine designation may help filtering information within ASRA. |
-L |
Steering/plant |
O |
-L 1a |
Can only be used in conjunction with model type. |
-P |
Production progress number |
O |
-P 123456 |
Can only be used in conjunction with model type and steering/plant. |
-A |
Operation item number(s) |
O |
-A 421050,421060 |
Only useful in combination with a fully specified vehicle. |
-AN |
Order number |
O |
-AN 12xx34 |
Only useful in conjunction with operation item number. |
-D |
File name for the return of the list of operation items |
O |
-D C:/tmp/liste.txt |
If a path is not given, the folder from which the module is opened is used. |
-err |
File name for returning the error code |
O |
-err C:/tmp/error.txt |
If a path is not given, the folder from which the module is opened is used. |
The error codes for these calls are:
Error Description | Error Code |
---|---|
No error | 0 |
No access authorization or missing connection to the access authorization manager | -1 |
Invalid WMC (does not exist or digit # < 3) | -101 |
Vehicle was not found | -102 |
Invalid model (digit # < 3) | -103 |
Invalid entry of steering/plant (digit # <> 2) | -104 |
Invalid production number (digit # <> 6) | -105 |
Invalid engine (digit# <>6, engine does not match to model) | -106 |
Invalid operation item (digit # <> 6) | -109 |
Operation item was not found | -110 |
Inconsistent vehicle specification | -111 |
No access authorization for ASRA | -112 |
Invalid output file | -114 |
Background call with ambiguous model type | -115 |
The error field in the job order file can be filled with the following values:
Error Description | Error Code |
---|---|
No changes | 00 |
Vehicle changed | 01 |
Operation items changed | 02 |
ewanapi -ASRA -T 210017 -L 1A -P 123456 -A 421050 -D C:\jobtest.txt -err C:\errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainAfter the call, folder C:\ contains a job order file "jobtest.txt" and a file "errtest.txt", which also contains in addition to the call log, the return value (in this case: 0). If the -D parameter is not given, the user is prompted for the job order name.
ewanapi -ASRA -T 202018 -M 111920 -L 1A -P 123456 -A 421050 -D C:\jobtest.txt -err C:\errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainAfter the call, folder C:\ contains a job order file "jobtest.txt" and a file "errtest.txt", which also contains in addition to the call log, the return value (in this case: 0). If the -D parameter is not given, the user is prompted for the job order name.
ewanapi -ASRA -Background -T 210017 -L 1A -P 123456 -A 421050 -D C:\jobtest.txt -err C:\errtest.txtThe same case as in 2., but there is no interaction with the user (background call).
ewanapi -ASRA -T 202018 -A 00 -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainThe "ASRA vehicle determination" screen appears with specified vehicle context. For the design group "00" (service) is preselected and the design group table of contents indicates the appropriate subgroups.
ewanapi -ASRA -T 21002 -AN 1000ab -D C:\jobtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainA popup screen appears for selecting a model designation. Caution: The order number is not applied in the context, because the vehicle was not completely specified in the call. After <Back>, no job order file is written. If operation items are subsequently selected, a job order with the name given is written when the application quits.
ewanapi -ASRA -T 202018 -D jobtest.txt -err errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-1" is generated.
ewanapi -ASRA -WMC abc -D jobtest.txt -err errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-101" is generated.
ewanapi -ASRA -T 123456 -D jobtest.txt -err errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-102" is generated.
ewanapi -ASRA -T 12 -D jobtest.txt -err errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-103" is generated.
ewanapi -ASRA -T 202018 -L 1 -D jobtest.txt -err errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-104" is generated.
ewanapi -ASRA -T 202018 -L 1a -P 12 -D jobtest.txt -err errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-105" is generated.
ewanapi -ASRA -T 202018 -L 1a -P 123456 -A 00100 -D jobtest.txt -err errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-109" is generated.
ewanapi -ASRA -T 202018 -L 1a -P 123456 -A 001055 -D jobtest.txt -err errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-110" is generated.
ewanapi -ASRA -WMC WDB -P 123456 -D jobtest.txt -err errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-111" is generated.
ewanapi -ASRA -D jobtest.txt -err errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-112" is generated.
ewanapi -ASRA -Background -T 220 -D jobtest.txt -err errtest.txtError code "-115" is generated.
ewanapi -ASRA -T 210017 -M 123456 -L 1A -P 123456 -A 421050 -D C:\jobtest.txt -err C:\errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-106" is generated.
ewanapi -ASRA -T 210017 -M 123 -L 1A -P 123456 -A 421050 -D C:\jobtest.txt -err C:\errtest.txt -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainError code "-106" is generated.
Activation of the ASSYST retrieval system.
Numerous combinations of parameters are supported:
ewanapi[4] -ASSYST -V <FIN> [-s <service_code>] [-w <workshop_code>] [-K <customer_name>] [-A <order_number>] ( [-k <current_km_reading>] | [-M <current_mileage_reading] ) [-r <correctness_service_supervisor>] [-f <completion_date>] [-v <type_of_oil/viscosity>] [-d <dialog_acceptance>] [-h <notes>] [-rt <remaining_time>] [-rd <remaining_distance>] [-D <job_order_filename>] [-err <filename>] [-ssc <service_scope >] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain> -annahmeblatt
ewanapi[5] -ASSYST -t <type_model_designation> -m <engine_model_designation> [-s <service_code>] [-w <workshop_code>] [-S <special_equipment_code>] [-K <customer_name>] [-A <order_number>] ( [-k <current_km_reading>] | [-M <current_mileage_reading] ) [-r <correctness_service_supervisor>] [-f <completion_date>] [-v <type_of_oil/viscosity>] [-d <dialog_acceptance>] [-h <notes>] [-rt <remaining_time>] [-rd <remaining_distance>] [-D <job_order_filename>] [-err <filename>] [-ssc <service_scope >] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain> -annahmeblatt
The parameters for call a. in detail:
Parameters |
Format |
Description |
Mandatory/Optional |
Example |
Notes |
---|---|---|---|---|---|
-V |
Exactly 17 alphanumeric characters |
Vehicle ident. number (with WMC) |
M |
-V WDB2102171A354643 |
|
-s |
2 alphanumeric characters |
Service code |
O |
-s A+ |
|
-w |
1 to 22 alphanumeric characters |
Workshop code |
O |
-w 24E |
|
-K |
1 to 32 alphanumeric characters |
Customer name |
O |
-K "John Smith" |
|
-A |
1 to 15 alphanumeric characters |
Order number |
O |
-A 12345 |
|
-k |
1 to 7 numeric characters |
Current km reading |
O |
-k 25000 |
Not together with the current mileage reading (see also boundary conditions). |
-M |
1 to 7 numeric characters |
Current mileage reading |
O |
-M 12000 |
Not together with the current km reading (see also boundary conditions). |
-r |
1 to 32 alphanumeric characters |
Correctness by service supervisor |
O |
-r "John Smith" |
|
-f |
10 alphanumeric characters |
Completion date |
O |
-f 01.12.2001 |
Format of the date can be transferred country-specific. |
-v |
1 to 15 alphanumeric characters |
Type of oil/viscosity |
O |
-v "SAE 15/40" |
|
-d |
1 numeric character |
Dialog acceptance completed (yes/no) |
O |
-d 1 |
1 = Yes |
-h |
1 to 300 alphanumeric characters |
Note/explanation |
O |
-h "This is a note" |
|
-rt |
numeric value |
The remaining time in days until or past ideal service time. |
O |
-rt 5 |
The value can also be negative to specify that the service-date has already passed. |
-rd |
numeric value |
The remaining distance (in km or miles) until or past ideal service time. |
O |
-rd 2200 |
The value can also be negative to specify that the service-time has already passed. |
-D |
Dependent on the operating system |
File name for the return of the list of operation items |
O |
-D C:/tmp/liste.txt |
If a path is not given, the folder from which the module is opened is used. |
-err |
Dependent on the operating system |
File name for returning |
O |
-err C:/tmp/error.txt |
If a path is not given, the folder from which the module is opened is used. |
-ssc |
1 character |
Service scope to be set |
O |
-ssa A |
Values = {A, B} If the option -ssc has been specified, one of the possible parameter values, A or B, has to be specified also |
-annahmeblatt |
No further parameters |
Print annahmeblatt |
O |
-annahmeblatt |
If the option -annahmeblatt has been specified, the Annahmeblatt is printed along with the Serviceblattes |
The parameters for call b. in detail:
Parameters |
Format |
Description |
Mandatory/Optional |
Example |
Notes |
---|---|---|---|---|---|
-t |
Exactly 6 numeric characters |
Model type |
M |
-t 202018 |
|
-m |
Exactly 6 numeric characters |
Engine model designation |
M |
-m 102921 |
|
-s |
2 alphanumeric characters |
Service code |
O |
-s A+ |
|
-w |
1 to 22 alphanumeric characters |
Workshop code |
O |
-w 24E |
|
-S |
1 to 4 alphanumeric characters |
SA code |
O |
-S 850a |
Is only used to determine the model year, i.e. in the case of this example, the entry has no effect (example 850a describes air conditioner for USA). |
-K |
1 to 32 alphanumeric characters |
Customer name |
O |
-K "John Smith" |
|
-A |
1 to 15 alphanumeric characters |
Order number |
O |
-A 12345 |
|
-k |
1 to 7 numeric characters |
Current km reading |
O |
-k 25000 |
Not together with the current mileage reading (see also boundary conditions). |
-M |
1 to 7 numeric characters |
Current mileage reading |
O |
-M 12000 |
Not together with the current km reading (see also boundary conditions). |
-r |
1 to 32 alphanumeric characters |
Correctness by service supervisor |
O |
-r "John Smith" |
|
-f |
10 alphanumeric characters |
Completion date |
O |
-f 01.12.2001 |
Format of the date can be transferred country-specific. |
-v |
1 to 15 alphanumeric characters |
Type of oil/viscosity |
O |
-v "SAE 15/40" |
|
-d |
1 numeric character |
Dialog acceptance completed (yes/no) |
O |
-d 1 |
1 = Yes |
-h |
1 to 300 alphanumeric characters |
Note/explanation |
O |
-h "This is a note" |
|
-rt |
numeric value |
The remaining time in days until or past ideal service time. |
O |
-rt 5 |
The value can also be negative to specify that the service-date has already passed. |
-rd |
numeric value |
The remaining distance (in km or miles) until or past ideal service time. |
O |
-rd 2200 |
The value can also be negative to specify that the service-time has already passed. |
-D |
Dependent on the operating system |
File name for the return of the list of operation items |
O |
-D C:/tmp/liste.txt |
If a path is not given, the folder from which the module is opened is used. |
-err |
Dependent on the operating system |
File name for returning |
O |
-err C:/tmp/error.txt |
If a path is not given, the folder from which the module is opened is used. |
-ssc |
1 character |
Service scope to be set |
O |
-ssc A |
Values = {A, B} If the option -ssc has been specified, one of the possible parameter values, A or B, has to be specified also |
-annahmeblatt |
No further parameters |
Print annahmeblatt |
O |
-annahmeblatt |
If the option -annahmeblatt has been specified, the Annahmeblatt is printed along with the Serviceblattes |
The error codes for these calls are:
Error Description | Error Code |
---|---|
No error | 0 |
No access authorization or missing connection to the access authorization manager | -1 |
Invalid call parameters | -2 |
Vehicle could not be found in ASRA | -102 |
Not all work positions could be found | -203 |
ewanapi -ASSYST -t 210020 -m 123456 -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainThe "Infothek 1" screen appears with an empty engine model designation table.
ewanapi -ASSYST -t 211004 -m 646951 -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainThe "ASSYST" screen appears with preselected "With service processor".
ewanapi -ASSYST -t 211004 -m 646951 -k 30000 -w 4g3p -application WIS-Net -userid stollms -userpwd 478967895 -userdomain sampledomainThe "ASSYST" screen appears with completed "Current km reading" and "Workshop code" fields. The "Next" button is activated.
ewanapi application WIS-net ASSYST debug userid stollms -userpwd 478967895 -ssc AThe "ASSYST" screen appears with selected service scope A
Activation of the service retrieval system in the background. The service sheet is printed automatically using the default printer in the MS Windows operating system. In addition, the job order file is written automatically.
It is to be noted that the background call is only to be used for vehicles with ASSYST-PLUS (service processor with workshop code). For this reason the workshop code is also a "mandatory" entry. The reason is: only with a workshop code can the additional work be determined without user interaction. In all other cases, as a rule, user interaction is unavoidable, and as a result a background call is then no longer meaningful.
The following combinations of parameters are supported:
ewanapi[6] -ASSYST -Background -V <VIN> [-s <service_code>] -w <workshop_code> ( -k <current_km_reading> | -M <current_mileage_reading]) [-p] [-K <customer_name>] [-A <order_number>] ( [-k <current_km_reading>] | [-M <current_mileage_reading] ) [-r <correctness_service_supervisor>] [-f <completion_date>] [-v <type_of_oil/viscosity>] [-d <dialog_acceptance>] [-h <notes>] [-D <filename>] [-err <filename>] [-ssc <service_scope >] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
ewanapi[7] -ASSYST -Background -t <type_model_designation> -m <engine_model_designation> [-s <service_code>] -w <workshop_code> ( -k <current_km_level> | -M <current_mileage_level]) [-p] [-S <special_equipment_code>] [-K <customer_name>] [-A <order_number>] [-r <correctness_service_supervisor>] [-f <completion_date>] [-v <type_of_oil/viscosity>] [-d <dialog_acceptance>] [-h <notes>] [-D <filename>] [-err <filename>] [-ssc <service_scope >] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
The parameters for call a. in detail:
Parameters |
Format |
Description |
Mandatory/Optional |
Example |
Notes |
---|---|---|---|---|---|
-Background |
No further parameters |
Background execution |
|
Does not allocate any access authorization within EWA, but starts WIS as a background process which terminates after this action. This call is user unspecific which means that no user credentials have to be provided. |
|
-V |
Exactly 17 alphanumeric characters |
Vehicle ident. number (with WMC) |
M |
-V WDB2102171A354643 |
|
-s |
2 alphanumeric characters |
Service code |
O |
-s A+ |
|
-w |
1 to 22 alphanumeric characters |
Workshop code |
M |
-w 24E |
|
-p |
No further parameters |
Print service sheet |
O |
-p |
If parameter given, then the service sheet is printed out on the default printer. |
-K |
1 to 32 alphanumeric characters |
Customer name |
O |
-K "John Smith" |
|
-A |
1 to 15 alphanumeric characters |
Order number |
O |
-A 12345 |
|
-k |
1 to 7 numeric characters |
Current km reading |
M |
-k 25000 |
Not together with the current mileage reading (see also boundary conditions). |
-M |
1 to 7 numeric characters |
Current mileage reading |
M |
-M 12000 |
Not together with the current km reading (see also boundary conditions). |
-r |
1 to 32 alphanumeric characters |
Correctness by service supervisor |
O |
-r "John Smith" |
|
-f |
10 alphanumeric characters |
Completion date |
O |
-f 01.12.2001 |
Format of the date can be transferred country-specific. |
-v |
1 to 15 alphanumeric characters |
Type of oil/viscosity |
O |
-v "SAE 15/40" |
|
-d |
1 numeric character |
Dialog acceptance completed (yes/no) |
O |
-d 1 |
1 = Yes |
-h |
1 to 300 alphanumeric characters |
Note/explanation |
O |
-h "This is a note" |
|
-D |
Dependent on the operating system |
File name for the return of the list of operation items |
O |
-D C:/tmp/liste.txt |
If a path is not given, the folder from which the module is opened is used. |
-err |
Dependent on the operating system |
File name for returning |
O |
-err C:/tmp/error.txt |
If a path is not given, the folder from which the module is opened is used. |
-ssc |
1 character |
Service scope to be set |
O |
-ssa A |
Values = {A, B} If the option -ssc has been specified, one of the possible parameter values, A or B, has to be specified also |
The parameters for call b. in detail:
Parameters |
Format |
Description |
Mandatory/Optional |
Example |
Notes |
---|---|---|---|---|---|
-Background |
No further parameters |
Background execution |
|
Does not allocate any access authorization within EWA, but starts WIS as a background process which terminates after this action. This call is user unspecific which means that no user credentials have to be provided. |
|
-t |
Exactly 6 numeric characters |
Model type |
M |
-t 202018 |
|
-m |
Exactly 6 numeric characters |
Engine model designation |
M |
-m 102921 |
|
-s |
2 alphanumeric characters |
Service code |
O |
-s A+ |
|
-w |
1 to 22 alphanumeric characters |
Workshop code |
M |
-w 24E |
|
-p |
No further parameters |
Print service sheet |
O |
-p |
If parameter given, then the service sheet is printed out on the default printer. |
-S |
1 to 4 alphanumeric characters |
SA code |
O |
-S 850a |
Is only used to determine the model year, i.e. in the case of this example, the entry has no effect (example 850a describes air conditioner for USA). |
-K |
1 to 32 alphanumeric characters |
Customer name |
O |
-K "John Smith" |
|
-A |
1 to 15 alphanumeric characters |
Order number |
O |
-A 12345 |
|
-k |
1 to 7 numeric characters |
Current km reading |
M |
-k 25000 |
Not together with the current mileage reading (see also boundary conditions). |
-M |
1 to 7 numeric characters |
Current mileage reading |
M |
-M 12000 |
Not together with the current km reading (see also boundary conditions). |
-r |
1 to 32 alphanumeric characters |
Correctness by service supervisor |
O |
-r "John Smith" |
|
-f |
10 alphanumeric characters |
Completion date |
O |
-f 01.12.2001 |
Format of the date can be transferred country-specific. |
-v |
1 to 15 alphanumeric characters |
Type of oil/viscosity |
O |
-v "SAE 15/40" |
|
-d |
1 numeric character |
Dialog acceptance completed (yes/no) |
O |
-d 1 |
1 = Yes |
-h |
1 to 300 alphanumeric characters |
Note/explanation |
O |
-h "This is a note" |
|
-D |
Dependent on the operating system |
File name for the return of the list of operation items |
O |
-D C:/tmp/liste.txt |
If a path is not given, the folder from which the module is opened is used. |
-err |
Dependent on the operating system |
File name for returning |
O |
-err C:/tmp/error.txt |
If a path is not given, the folder from which the module is opened is used. |
-ssc |
1 character |
Service scope to be set |
O |
-ssa A |
Values = {A, B} If the option -ssc has been specified, one of the possible parameter values, A or B, has to be specified also |
The error codes for these calls are (similar to ASRA background call):
Error Description | Error Code |
---|---|
No error | 0 |
No access authorization or missing connection to the access authorization manager | -1 |
Invalid call parameters | -2 |
Vehicle could not be found in ASRA | -102 |
No access authorization for ASRA | -112 |
Invalid output file | -114 |
Background call with ambiguous model type | -115 |
Operation items have been removed due to type validity | -203 |
The error code -2 signifies "invalid call parameter". For ASSYST this also includes model type designation or model type designation and engine model designation combinations that do not have "ASSYST PLUS". Thus, if e.g. a workshop code is entered and the model type does not have ASSYST-PLUS, WIS also quits with error code -2.
The error field in the job order file can be filled with the following values:
Error Description | Error Code |
---|---|
No changes | 00 |
Vehicle changed | 01 |
Operation items changed | 02 |
ewanapi -ASSYST -Background -p -t 211004 -m 646951 -k 30000 -w 4g3pThe dynamic service sheet is automatically printed out on the default printer and the job order file created as per the settings on the "System settings" screen.
Activation of the WIS Maintenance Module. An external caller may provide a vehicle context to start the module with by the parameters:
or
The following combinations of parameters are supported:
ewanapi[6] -MSS -V <VIN> [-err <filename>] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
ewanapi[7] -MSS -t <type_model_designation> [-m <engine_model_designation>] [-err <filename>] -application WIS-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
The parameters for call a. in detail:
Parameters |
Format |
Description |
Mandatory/Optional |
Example |
Notes |
---|---|---|---|---|---|
-V |
Exactly 17 alphanumeric characters |
Vehicle ident. number (with WMC) |
M |
-V WDB2102171A354643 |
|
-err |
Dependent on the operating system |
File name for returning |
O |
-err C:/tmp/error.txt |
If a path is not given, the folder from which the module is opened is used. |
The parameters for call b. in detail:
Parameters |
Format |
Description |
Mandatory/Optional |
Example |
Notes |
---|---|---|---|---|---|
-t |
Exactly 6 numeric characters |
Model type |
M |
-t 202018 |
|
-m |
Exactly 6 numeric characters |
Engine model designation |
O |
-m 102921 |
|
-err |
Dependent on the operating system |
File name for returning |
O |
-err C:/tmp/error.txt |
If a path is not given, the folder from which the module is opened is used. |
The error codes for these calls are:
Error Description | Error Code |
---|---|
No error | 0 |
No access authorization or missing connection to the access authorization manager | -1 |
Invalid call parameters | -2 |
Vehicle could not be found in MSS | -102 |
No access authorization for MSS | -112 |
Invalid output file | -114 |
ewanapi -MSS -t 211004 -m 646951
WIS will be startet, the vehicle context will be switched to type "211004". The selected engine will be "646951".
Activation of EPC and writing of a shopping list.
The following number of parameter combinations is supported:
ewanapi [-V <FIN>] [-T <model code>] -S <shoppinglist_file> [-c] [-partslist <partnumber[,partnumber...]>] [-err <error_file>] [-n <navigation path>] -application EPC-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
Parameters |
Description |
Mandatory/Optional |
Example |
Notes |
---|---|---|---|---|
-V |
Specification of the VIN incl. World Manufacturer Code |
O |
-V WDB2020281F333593 |
Either VIN or Model Code can be provided, not both of them |
-T | Model code | O |
-T 202028 | Either VIN or Model Code can be provided, not both of them |
-m | Engine number (6 digits) | O |
-m 104941 | Can only be provided together with "-T" option |
-S |
File name for writing of the shopping list |
M |
S C:\tmp\sl.txt |
|
-c |
Deletion of any existing shopping list is forced |
O |
-c |
|
-partslist | One or more part numbers for parts that shall be added to the current shopping list | O |
-partslist A1089950520,N073379008100 | |
-err |
File name for the error file |
O |
C:\tmp\err.txt |
|
-n |
Navigation path to the message to be shown |
O |
-n navigation_path |
If the option -n has been specified, the parameter navigation_path, has to be specified also |
ewanapi -V WDB2020281F333593 -S C:\tmp\sl.txt -c -err C:\tmp\err.txt -application EPC-Net -userid stollms -userpwd 478967895 -userdomain sampledomain
ewanapi -V WDB2020281F333593 -S C:\tmp\sl.txt -partslist A1089950520,N073379008100 -application EPC-Net -err C:\tmp\err.txt -userid stollms -userpwd 478967895 -userdomain sampledomain
Activation of EPC and searching a given part.
The following number of parameter combinations is supported:
ewanapi [-V <FIN>] -pn <partnumber> [-err <error_file>] -application EPC-Net -userid <your_userid> -userpwd <your_passwd> -userdomain <your_domain>
Parameters | Description | Mandatory/Optional | Example | Notes |
---|---|---|---|---|
-V | Specification of the VIN incl. World Manufacturer Code | M |
-V WDB2020281F333593 | |
-pn | File name for writing of the shopping list | M |
pn A1089950520 | |
-err | File name for the error file | O |
C:\tmp\err.txt |
ewanapi V WDB2020281F333593 -pn A1089950520 -application EPC-Net -userid stollms -userpwd 478967895 userdomain sampledomain err C:\tmp\err.txt
[1] The respective call applies for access to a running WIS; during this process the old context is deleted without a prompt and the open WIS reinitialized with the new parameters. This should on average contribute to significant time savings. If there is no open WIS application, it is started.
[2] This error code is only written to the optional error file (-err).
[3] The respective wisapi call applies for access to a running WIS; during this process the old context is deleted without a prompt and the open WIS reinitialized with the new parameters. This should on average contribute to a significant time savings.
[4] The respective ewanapi call applies for access to a running WIS; during this process the old context is deleted without a prompt and the open WIS reinitialized with the new parameters. This should on average contribute to a significant time savings.
[5] As footnote above!
[6] The respective wisapi call applies for access to a running WIS; during this process the old context is deleted without a prompt and the open WIS reinitialized with the new parameters. This should on average contribute to a significant time savings.
[7] As footnote above!