This document describes the User Interface of the Hewlett Packard User Management (HP User Management) System. The Interface is provided by a Web based application allowing to perform lots of administrative tasks within EWA, like setting up workshops, groups and users as well as entering access authorization information or performing a backup/restore of the user database. The administrative user interface is embedded into the generic Web application of EWA. Based on a role model for users it is determined during logon what rights the user has in the EWA application. Accordingly distinct masks will be hidden or displayed.

3.2 Introduction

This chapter introduces some basic concepts of the EWA User Management.

3.2.1 User Roles

EWA supports different user roles. All of them can start the client applications WIS and EPC. The use of such user roles within the client applications will evolve over the time. These user roles will be used within the EWA User Management.

Workshop User:
This is the standard role for users working with the system. They have only access to the start screen and some basic self-administration tasks like cleaning their VIN Cache, modifying specifics of their account data, access the download area,...
Workshop Administrator:
Users of this role have all the rights a Workshop User has, but within the Workshop they have even administrative rights to maintain users of this specific Workshop, like deleting users, creating new users. They may also free access authorization accidentally locked in this workshop.
Server Administrator:
Users of this role have all the rights for administrative tasks within EWA. They can create, modify and delete workshops (if the support for multiple workshops is switched on), backup/restore the user management database, import a bunch of groups and users via XML, maintain parts pricelists,...
When you start EWA the first time there is already one user setup: the root server administrator. This user cannot be removed and many attributes like the workshop and group he belongs to or the user role cannot be changed.

Note:
Once you login to the system the first time on a clean and fresh installed system, you can only login as the server administrator - the only user currently known in EWA. You will be asked for a new password for this user. We highly recommend that you immediately after a successful login additionally change the properties of this administrator (like real name, email address,...). You should also modify the Workshop number of the default workshop to the correct one of your physical workshop and might also like to change the name of the default group in the system.

The HP user management makes use of its own database for authentication and authorization tasks. Depending on the type of EWA installation ("local" or "central") the chosen DBMS might differ. But the data model is always the same. All User Management related database tables begin their table name with "UM_".

The entity relationship for the most important data objects is:

USER belongs to exactly one GROUP belongs to exactly one WORKSHOP.

3.2.2 Licensing Model

EWA with the HP User Management runs a so called "Named access authorization" model. This means:

each user gets one access authorization assigned for each application he has potentially access to
you will not be able to setup more (active) users per application than the server access authorization from Daimler foresees.
each user can start each type of application only once (exception: background calls in EWANAPI).
the system checks violations against the access authorization model permanently. It checks whether
1) the number of access authorizations assigned on workshop level still matches the server access authorization
2) the number of users setup per workshop do not exceed the limits

3.2.2.1 Examples and Tips:

Your server access authorizations from Daimler provide 100 user access authorizations for WIS and 200 user access authorizations for EPC. Assuming you run EWA out of the box, there will be one single workshop allowing access to both applications without any restriction. Assuming you make use of groups, but all the groups allow full access to both EPC and WIS you can only setup up to 100 users.
Why? As all users potentially have access to both applications, but there are only 100 user access authorizations for WIS, you would violate the access authorization integrity when setting up user number 101.
Same case, but now you make use of the grouping functionality. You setup one group for users which shall only have access to EPC named i.e. "EPC" and another one with access to both applications (named "EPC and WIS"). Now setting up 100 users in the group "EPC" is possible and setting up another 100 users in the group "EPC and WIS" is also possible. Now you make full use of the server access authorizations.
Users marked "inactive" in the database can never start applications and thus do not consume access authorizations. This fact might be useful if you want to import a bunch of users but you do not yet have access authorizations for them. Then you can later on subsequently switch users active once you have server access authorizations from Daimler with enough user access authorizations.
Once one type of client (i.e. WIS) has been started on one machine you will not be able to start the same client with the same user on a different PC or on the same PC again. EWA in this case will ask you what you want to do:
1) Kill the old session and start the client on the new PC
2) Disallow starting a new client and allow you to go back to the original session to i.e. save your work
Of course you can start different WIS and EPC at one time, assuming you have the rights to do this.

3.2.3 Cascaded Workshops

By default when you install EWA the system will run in a simple administration mode which restricts you to exactly one workshop. This workshop automatically mirrors all the access rights from the Daimler server access authorizations. You can change some attributes (like Workshop No., Description,...), but that's it basically. This workshop of course can contain an infinite number of groups which allow you to distribute fine grained access rights to users in these groups.

There is a more sophisticated feature available once you switch your server into the so called "Cascaded Workshop Administration". This is especially helpful for hosters which host several different workshops. If this mode is activated you will notice that you can

Setup more than one workshop
Fine grained distribute your user access authorizations from the server access authorization to the workshops
Delegate administration of workshops to individual administrators within these workshops (by use of the role Workshop Administrator)

In this case you might find it helpful that all the screens show statistic information about the number of access authorizations assigned to users and workshop. This should help you make the best out your Daimler server access authorizations.

3.3 Administrative Functionality and the User Roles

A lot of administrative functionality is available in EWA. The following matrix shows in detail, which operation can be performed by which user role.

Function	Server Admin	Workshop Admin	Workshop User	Comment
Login	x	x	x	Same for all user roles
Get new password	x	x	x	Same for all user roles
Start Menu	x	x	x	All Administrators will also be able to start applications, depending of the group/workshop rights they have.
My Profile -> Preferences	x	x	x	Same for all user roles
My Profile -> Advanced	x	x	x	Same for all user roles
My Profile -> My Messages	x	x	x	Same for all user roles
Server Management -> Edit Server access authorization	x	(x)		Only access authorization pool activity for the Workshop Admin and only scoped to his workshop
Server Management -> Show Management Console	x			Only for server administrators
Server Management -> Backup and Restore	x			Only for server administrators
Server Management -> Import Users, Groups and Workshops	x			Only for server administrators
Server Management -> Parts Pricelist Administration	x			Only for server administrators
Server Management -> Server Configuration	x			Only for server administrators
Workshop	x			Only for server administrators
Group	x	(x)		Restricted for workshop admins to groups only within their own workshop
User	x	(x)		Restricted for workshop admins to users only within their own workshop
Messaging	x	(x)		Workshop admins can send messages only to users of their own workshop
Download	x	x	(x)	Workshop Users can only see the download files of spoolers if they have the user right to do so. Only server administrators have access to application related access statistics
Documentation -> Administrative Doc	x	x		Only for Server and Workshop administrators
Documentation -> User Doc	x	x	x	End user documentation is visible for all user roles
About EWA	x	x	x	Same for all user roles
Log off	x	x	x	Same for all user roles

3.4 Configuration

The HP-UM can be configured via a related XML-file, called "um_cfg.xml". Here the type of user management is chosen, the connection data to i.e. an LDAP server is set up and some important properties for the behavior of the EWA application will be defined. For details please refer to the OperationManual.

Some parts of this configuration can be performed by the server administrator after a login and then navigating with the menu bar on the left side to "Server -> Edit server configuration".

4 Basic administrative tasks - start here

4.1 Login

The first task an administrator must do is to login to the HP User Management admin console. If a workshop user logs in he will only see a subset of the tasks an administrator has access to.

By default after a new installation the User Management will run in "Own" authentication mode which means that is is fully independent of any other user directory. See your favorites in the Internet Explorer and follow the link to "EWA" or directly enter in the URL field of your browser:

http://<server>:<port>/EWA-net/ , for example:

http://localhost:9000/EWA-net/

You should be presented a screen like this:

Note:
Depending on the setup you will see or not see a box above the login field called "System Check". This check, if enabled, tells you for the system you are running the browser on, whether it is capable of running EWA correctly. This check is based on Windows Active/X scripting. It may happen that local security policies do not allow to run this script (this is what happened in the screenshot above). The box visualizes mainly following states:
- Grey: Indicates that the check could not be run at all
- Green: Your system is fine regarding the Java requirements and should run without problems
- Orange: Your system has Java and Java WebStart installed but not in the supported versions. There's still a good chance of running EWA successfully, but it is not officially supported.
- Red: Your system does not fulfill the basic requirements and therefore is expected not to run the EWA clients correctly.

You can find more information on how to switch this check on or off in the login screen here.

Here you must enter the admin login / password pair. After running a clean new installation of EWA, there is one server administrator in the database with the credentials:

Username: admin
Password: admin

To avoid that this simple password will remain and to minimize security risks, after a first successful login to the system as administrator you will be forced to immediately change this password.

The same password will not be accepted again and it must comply to the password policy of EWA: it must be at least 4 characters in length and may not be the same as the previous password.

If the login does not match, you get an error message on the same page. After a successful login you are directed to the main menu.

4.2 Main Menu

Right after logging in you will see the start screen of EWA. And you will be faced with the general screen design within the EWA user management:

A common header bar displaying the EWA logo, the name of the user and some status information
A so called banner bar indicating
- major system problems in regards to licensing in red color
- normal and important information messages (only the 3 most recent ones) in yellow color
The main navigation on the left side

None of your applications can be started right now, as an error is displayed in the banner bar clearly indicating that the server has not yet any access authorizations installed. In this case you will not be able to start any application. Also many administrative tasks cannot be performed in this state.

The left side shows the menu bar in which you can navigate for performing your task.

To get your system up and running in a correct way, you should now perform the following tasks to modify the standard installation to one that is appropriate for you. This is a short overview, we will learn soon how to perform this tasks:

Choose "Administration -> Server Management -> Edit Server access authorization" and enter the access authorizations provided by Daimler.
It is highly recommended to do this as a first step. If you do not have a access authorization available, wait until you received it from Daimler.
If you do not have a StartKey ordered, go into the screen and tell Daimler about your special LAN-ID which is required for the creation of your personal access authorization.
Choose "Administration -> Server Management -> Server Configuration" to modify important system attributes. You should at least enter correct values for your email server to allow the basic messaging within EWA.
Choose "Administration -> Workshop" to correct the attributes of the installed default workshop. You must change the following attributes that match your environment:
- Workshop No. This must be the one officially provided by Daimler. This field allows 1-20 alphanumeric characters.
- Description: A short text that describes this workshop.
- Country: Select the country your workshop resides in.
Click on "Update" to store your changes.
Choose "Administration -> Permission Group" to correct the attributes of the installed default group. Basically change the attributes:
- Name
- Description
As you now have at least one valid server access authorization installed, you may also modify the access rights for the applications for users of this group. If you do not have any access authorizations you will see that you can only update the group by disabling the access authorizations.
Choose "Administration -> User". Click on the user "admin" to correct and complete your profile data. Feel free to change as many attributes as you like to, but most of all you should at least set the attributes for:
- First Name
- Last Name
- EMail address. This is especially needed for all the messaging parts throughout EWA.
Click on "Update" to store your changes.

4.3 Enter EWA server StartKeys

As recommended above one of the first steps to be performed on a clean system is to install the valid server access authorization you received from Daimler.

If you do not have access authorizations you will need to provide a unique ID of your system called "LAN-ID". By use of the main menu just click on "Server" and then on "Edit the access authorization".

The screen shows the LAN-ID of your system. This ID has to be provided to Daimler if you need to request a access authorization which is valid for your system.

Once you have your StartKeys , you can simply enter them here and press on the button "Save". If your StartKeys are valid, the screen will be refreshed and the access authorization attributes will be visible. Furthermore, the error message in the banner bar has gone.

You can now see:

Whether your StartKey is valid at all
What the expiration date of your access authorization is
What the internal access rights string is inside your access authorization
What type of access authorization you have: local or central. The local one has networking restrictions in it and is aimed for small installations.
How many users are allowed to be setup in total on this system per application. Each of these users may also run any application he has a access authorization for only once! It is not allowed to run more than one instance per application and user

Following actions are allowed on this screen:

View access authorization:
Display the real content of the access rights in a human readable manner.
View access authorization Pool:
Display the current pool of access authorizations and free allocated access authorizations if needed. A server administrator can modify the access authorization pool of the whole server, a workshop administrator can only cope with access authorizations of his own workshop.

4.4 Server Configuration

The most flexible but also most complex way of configuring EWA is by editing the XML based configuration files. To ease up the basic setup for the smaller "local" EWA installations the Server Configuration mask should help to get the most typical properties configured quickly. After storing the new configuration you simply have to restart the server to activate the changes.

The first sections deal with basic services of EWA like the Email Service. Many components rely on this service to be configured correctly, so fill these fields correctly. The lower part of the screen allows you to change some basic operation modes of the User Management, i.e. whether you want the login name to be checked case sensitive or not.

Note:
You may want the Email Service to make use of clear text sender names like "EWA access authorization Reminder". To achieve this you may use email addresses like:
EWA access authorization Reminder <noreply@ewa.your.company.com>
instead of simply using i.e.
noreply@ewa.your.company.com

As mentioned, after applying all your changes, you have to restart the server. A confirmation dialog will tell you about it. The easiest way to do this is by use of the AdminTool.

4.5 Manage EWA Workshops

With a standard installation of EWA, only one workshop will be supported and can be maintained. This workshop inherits all the rights and limitations from the server access authorizations, i.e. the number of active users per application that may be setup as well as the top level access rights for the applications.

So, if you are running EWA only for one workshop, the management is quite easy. You can just update the basic properties of the workshop as already learned. The screen below shows how the "Edit Workshop" screen looks like.

Note:
As long as no access authorizations are installed or the integrity of the licensing is not ensured, you will see a warning. If at least one correct access authorization has been installed those warnings will have gone.

Once you changed the mode (see the configuration for "Cascaded Workshop Administration") and restarted the server, you will see that multiple workshops will be supported now. The handling now also changed slightly.

4.5.1 Working with multiple workshops

You can now:

Search for workshops based on different criteria
Create new workshops
Update workshops
Delete workshops (the default workshop can not be deleted)
Define access rights for a whole workshop based on the server access authorization
Import several workshops along with groups and users in one go

The properties of an individual workshop now have been extended slightly:

Each workshop allocates a distinct number of user access authorizations from the server access authorization per application individually. If the sum of all workshops allocates more access authorizations than the server access authorization provides, the integrity checks will alert this and you might not be able to start applications anymore.
The access rights from the server access authorization can be restricted further on this workshop level

4.5.2 Search for Workshops

Note:
This functionality is only available if you have activated "cascaded workshop administration".

Whenever you get into the Workshop administration masks and have support for multiple workshops switched on, you will see a list of workshops. If you get into this screen the first time, you will see a list of all available workshops. Once you performed a search, your search criteria will be used - until you click on Clear search criteria or perform a new search.

You can enter criteria like this:

If you leave all fields empty you get all entries from the database
If you fill out one field, for example "Description", all workshops with exactly the given text will be found.
If you fill out several fields only workshops will be retrieved which exactly match all of the given fields.
Wildcard "*" and "?" are allowed as placeholders like in Windows file system operations:
* is a placeholder for any text of any length
? is a placeholder for exactly one character

4.5.3 Create a new Workshop

Clicking into the Workshop menu will guide you into the workshops overview screen. Here you may create a new Workshop by clicking on Create.

To create a valid workshop you will have to fill out at least the required attributes. For the Workshop No. only an official Daimler workshop number will be allowed which is 1-20 alphanumeric characters in length.

For the workshop you may also (like for the Permission Groups later on) decide whether groups and users of this workshop

get the access rights from the Server access authorization
get restricted rights derived from the Server access authorization
have no rights to access a given application
This gives you a lot of flexibility, as even a group in a workshop can again have a permission set which even more restricts users of this group.

Note:
EWA will only count access authorizations per each user really having the chance to start an application and being marked "active" in the User Management. If you for example setup a user in a group or workshop which has WIS disabled then the WIS access authorization counter will not count this user.
This is the default setting for the Server Administrator right after installation.

After filling out the form correctly you will see a success screen and will be redirected to the workshop overview screen.

4.5.4 Edit an existing Workshop

If you have simple workshop administration switched on then after clicking in the workshop menu you will directly be presented the Workshop administration mask for the single workshop you are allowed to maintain.

If you have the "cascaded workshop administration" switched on you will see the list of currently available workshops in the system. To edit a workshop you may click on the workshop number, description or on the appropriate action icon on the right side of the overview list within the "Actions" column. The red section in the screen shots below shows you were you might click into.

4.5.5 Delete an existing Workshop

From the list of workshops you may delete an existing workshop simply by clicking on the delete button in the "Actions" column. This operation will not be possible (and thus no such icon will appear) for the default workshop which has been installed by EWA and hosts the main server administrator.

If the current user is a workshop administrator or a server administrator and part of this workshop, the workshop may not be deleted. If the workshop will be deleted, all groups inside this workshop as well as all users of the groups of this workshop will be deleted.

4.6 Manage EWA Permission Groups

Permission Groups are a way to group users for different aspects of work within EWA. As the name already indicated Groups may furthermore restrict the access within the applications WIS and EPC depending on how such a groups will be setup.

In general the same operations/actions exist like for the workshops:
- search for groups
- create a new group
- modify an existing group
- maintain access levels for groups
- delete an existing group
Entering the Permission Groups screen via the main menu on the left side, will display the current list of groups within the EWA database. From here the existing groups might be modified, deleted or new ones can be created.

The list of actions in the right most column shows you which operations you might perform on the listed group. As for the workshops you cannot delete the "root" group which hosts the default server administrator account.

The screen also informs about the total number of users which have been created inside this group (including the non-active ones) and also lists the number of user access authorizations per application.

A statistic overview just above the table sums up all the assigned user access authorization for the listed groups per each application which might help to distribute a given number of server access authorizations to your workshops and groups.

4.6.1 Search for Permission Groups

The search mask allows to either search for all groups or to restrict the search to only those groups, who fulfill the criteria entered in the search fields above. The same search rules apply as for searching a Workshop (see previous chapter).

4.6.2 Create a new Permission Group

You may create permission groups at any time you like and in any amount you like. Permission Groups themselves do not make use of any access authorizations, only the users in those groups do.

You will be asked for all attributes, but you will notice that the access rights administration (bottom part of the mask) will only be visible after you selected a valid workshop. Why? Because the workshop already has access rights assigned which can be used or further restricted by the group.

Fill in the required attributes which are:
- The Group Short Name. This must be a unique name. You will get an error message trying to create the same again.
- A description
- The workshop this group shall belong to
Furthermore you can modify the access rights within the applications WIS and EPC for all users of this group. Three modes allow you a fine grained setting:
- As Workshop access authorization
  This results that users of this group have all the rights that the workshop provides. This could be the whole rights of the server access authorization or a access authorizationtion of the server access authorization
- Limited access authorization
  Restrict the permissions for the individual application, using the Edit button you have the possibility to modify certain permissions. You can only further restrict the workshop access authorization, you cannot extend it.
- Disabled
  This will block the use of the application for the user. No access authorizations will be counted for this application and users in this group.
When trying to insert an already existing group, you get an error message that the group already exists.

After having successfully submitted the form, you are again presented with the results of the create operation and a short overview of the values you provided..

4.6.3 Edit an existing Group

Similar to creating you can also edit an existing group by clicking on the Edit button in the Actions column of the groups overview or by clicking on the hyperlinks in the overview table. This will provide basically the same mask as for creating new groups.

4.6.4 Delete an existing Group

You can also delete a group from the User Management by first searching for it (or finding it in the overview table) and then clicking the "Delete" button within the Actions column.

Note:
If you are member of that group you will not be able to remove it.

Note:
The system generated default group cannot be deleted.

4.7 Manage EWA Users

When the admin activates the Users menu, he will be presented the user list:

There are several options available for single and miltiple user manipulation and we will explain each of them in the following paragraphs.

The user table can be split into multiple pages if the user count is too big. By default only 15 users will be shown in one page, but this can be changed in the application config files. When there are more than one page of users, the navigation buttons will appear above the table and will allow you to browse the table page by page. Additionally there is a quick navigation that allows you to jump directly to a desired page. This can be done by entering the page number in the Go to Page input field and clicking the Go button.

Single user manipulation can be done by either clicking on its name, or by using one of the three buttons in the rightmost column of the user table. Clicking the first button is basically the same as clicking the user's name and will open the Edit User screen for that user. The second button will allow you to make a copy of the user and will basically send you to the Create User screen with some predefined data. The third button will allow you to delete the chosen user from the system.

Multiple user manipulation can be performed by using the checkboxes in the leftmost column of the user table. The top checkbox will select/deselect all the users on the current page. Additionally, you can select as many users as you like across different pages of the table. Once ready, you can use one of the three buttons above the table in the cathegory Action for selected user(s). These are Move, Enable/Disable and Delete.

4.7.1 Moving multiple Users

This option will allow you to move multiple users to another Group and/or Workshop. The following screen will be presented to you, showing you the selected users and allowing you to choose the destination Workshop and Group before continuing.

After that you will be asked once more for confirmation, before the system executes your order.

4.7.2 Enabling and Disabling multiple Users

This option will allow you to either enable or disable multiple users. The following screen will be presented to you, showing you the selected users and allowing you to choose the desired action.

After that you will be asked once more for confirmation, before the system executes your order.

4.7.3 Deleting multiple Users

This option will allow you to delete multiple users at the same time. You will be asked once for confirmation, before the system executes your order.

Note:
An error message will appear if only not deletable users are selected.

4.7.4 Search for Users

You can get into the search mask by clicking on the Search button right above the users overview.

The search mask allows to either search for all users or to restrict the search to only those users, who fulfill the criteria entered in the search fields above. The search rules are the same as described for the workshops.

4.7.5 Create a new User

Right from the user overview table you can create a new user by clicking on the Create button.

There may be cirumstances where you are not allowed to create a new user, i.e.:
- No valid server access authorization is installed (not installed, expired, invalid,...)
- All access authorizations are already assigned to other users in the system
The first screen when creating a new user will ask you whether you want to make use of an existing so called template user or begin with a clean profile. When you choose to make use of a profile template you may additionally select which application data shall be copied as well.

Note:
This screen will automatically skipped if there is no user being marked as "template User".

The next screen then allows you to really fill in the user profile data. The required attributes will be marked with a red asterisk again.

Note:
Administrators (Server Administrator, Workshop Administrator) will have to provide a valid email address. Though recommended this is not required for workshop users.

Note:
Additional sections may appear in this screen which are related to enabling of special functions within the EWA user management.

The length of the login name and password field have to match the EWA requirements, i.e. Login name minimal length is at least one character, Password minimal length is five characters.

The two buttons View Workshop and View Group will become active once a Workshop and respectively a Group has been selected in the comboboxes. The first one will send you directly to the Edit Workshop screen for the selected Workshop. The second will send you directly to the Edit Group screen for the selected Group.

Note:
Using either of these buttons will send you to another screen and all the data entered so far in the current screen will be lost!

When trying to create an already existing user, you get an error message that the user already exists.

After having successfully submitted the form, you are again presented with the results of the creation.

4.7.6 Edit an existing User

Similar to creating users you can also edit an existing user by clicking on the Edit action or the hyperlinks of the appropriate user in the user overview list.

You'll see a similar input form like the one you already know from creating users:

Other operations available by the Actions menu in the overview are:
- Copy a user:
  This helps you setting up a new user from a given one
- Delete a user:
  Remove the user along with all his data from the system.
  This operation is not available for the default server administrator or any user marked as not deletable.
- Clean the VIN Cache:
  Remove the VIN history of this user. This might help should problems within the applications arise which are related to VINs in the user's history.
4.7.7 Delete an existing User

You can also delete a user from the UM-database by first searching for it and then clicking the Delete button. After confirming a security dialog the user and his data will be removed from the local database.

4.7.8 Client Performance Logging

The client performance logging feature allows to log performance relevant information from WIS and EPC. This information can be used to identify possible problems or performance bottlenecks.

The logging can be configured for every user on an individual basis.

Configuration is done in the web client performance logging dialog or via webservice. The web dialog is startable by clicking on the 'CPL Settings' button on the edit users screen.

The following information can be logged:
Java version: The on the client side used java virtual machine
Operating system: The on the client side used Operating system including the patchlevel
ClientLanguage: The systems language
Client architecture: The processors architecture
Free disk space: The free diskspace on client side. Please note that this is not an exact value. This is caused be restriction by Java 1.4. This will be fixed if this version of java isn't supported anymore.
Bandwith: The average download bandwith in kb/sec
Downloaded bytes: The download-volume caused by the client
The on client side logged information has to be transfered to the server. It is important that this information is not transfered with every request to save some bandwith.

Therefore is the logging information is accumulated and send after a specific time interval has passed. This intervall can be configured on the servers core_cfg.xml. The default is set to 5 minutes.

Please note that setting a too small value can cause increased bandwith-usage and additional load on the database.
```
    <SECTION name="Client_Performance_Logging">
    
    <PARAMETER name="LoggingInterval">5</PARAMETER>
    </SECTION>
   
```
Client performance logging can be configured with a webservice interface as well. The Web Service interface is disabled by default. To enable the interface, open the configuration file [EWA_HOME]\config\core_cfg.xml and change the value of the parameter portalServiceEnabled to be "true". You need to restart the EWA server to activate the interface.

4.7.9 Client performance web service methods

This section documents which Web Services methods will be exposed and how they will be exposed (method name, parameter list, ...). In order to allow a generic approach, the Web Service methods are making use of the standard Web Services data types like "int", "string", ... wherever possible. In some methods it was not possible to use simple types so some complex types were introduced.

4.7.9.1 getActiveLoggingUsers
```
xsd:String[] getActiveLoggingUsers()
                         throws PortalDisabledFault,
                                AuthenticationFault
```
Returns the logins for all actively logging users
Returns:

Array containing the logins of users with activate client performance logging

4.7.9.2 saveClientPerformanceSettings

xsd:boolean saveClientPerformanceSettings(xsd:ClientPerformanceSettingsBean clientPerformanceSettingsBean)
                         throws PortalDisabledFault,
                                AuthenticationFault

Saves the client performance logging settings for a specific user. Performance Settings Bean with all parameters set to false has to be supplied to deactivate the logging for a specific user.

Parameters:: ClientPerformanceSettingsBean: Complex structure holding the information about the user and the type of information which should be logged.

Returns:

True if the logging parameters where saved successfully

4.7.9.3 getClientPerformanceSettings

xsd:ClientPerformanceSettingsBean getClientPerformanceSettings(xsd:String login)
                         throws PortalDisabledFault,
                                AuthenticationFault

Get the client performance logging settings for a specific user.

Parameters:: Login: The login name of the user which client performance settings should be examined

Returns:

A ClientPerformanceSettingsBean holding the logged client performance data for the specified user.

4.7.9.4 getClientPerformanceLoggingResults

xsd:ClientPerformanceLoggingResultsBean getClientPerformanceLoggingResults(xsd:String login)
                                 throws PortalDisabledFault,
                                        AuthenticationFault

Get the logged data for a specific user

Parameters:: login: The login name of the user which logged data should be examined

Returns:: A ClientPerformanceLoggingResultsBean holding the information for the specified user.

4.7.10 4.7.11 Complex Types

The following complex types are used in the Client Performance logging interface:

Type Name	WSDL Definition	Description / Use
ClientPerformanceSettingsBean	<complexType name="ClientPerformanceSettingsBean"> <sequence> <element name="logClientArchitecture" type="xsd:boolean"/> <element name="logClientLanguage" type="xsd:boolean"/> <element name="logDownloadBandwith" type="xsd:boolean"/> <element name="logFreeDiskSpace" type="xsd:boolean"/> <element name="logJavaVersion" type="xsd:boolean"/> <element name="logNumberOfRequests" type="xsd:boolean"/> <element name="logOperatingSystem" type="xsd:boolean"/> <element name="logReceivedBytes" type="xsd:boolean"/> <element name="logResponseTime" type="xsd:boolean"/> <element name="logSendBytes" type="xsd:boolean"/> <element name="logUploadBandwith" type="xsd:boolean"/> <element name="login" nillable="false" type="soapenc:string"/> </sequence> </complexType>	Holds the login and the parameters which should be logged
ClientPerformanceLoggingResultsBean	<complexType name="ClientPerformanceLoggingResultsBean"> <sequence> <element name="architecture" nillable="true" type="soapenc:string"/> <element name="averageResponseTime" type="xsd:long"/> <element name="clientLanguage" nillable="true" type="soapenc:string"/> <element name="downloadBandwith" type="xsd:long"/> <element name="freeDiskSpace" nillable="true" type="soapenc:string"/> <element name="javaVersion" nillable="true" type="soapenc:string"/> <element name="login" nillable="true" type="soapenc:string"/> <element name="numberOfRecievedBytes" type="xsd:long"/> <element name="numberOfRequests" type="xsd:long"/> <element name="numberOfSendBytes" type="xsd:long"/> <element name="operatingSystem" nillable="true" type="soapenc:string"/> </sequence> </complexType>	Holds the logged parameters for a user

Type Name

WSDL Definition

Description / Use

ClientPerformanceSettingsBean

<complexType name="ClientPerformanceSettingsBean">
<sequence>
<element name="logClientArchitecture" type="xsd:boolean"/>
<element name="logClientLanguage" type="xsd:boolean"/>
<element name="logDownloadBandwith" type="xsd:boolean"/>
<element name="logFreeDiskSpace" type="xsd:boolean"/>
<element name="logJavaVersion" type="xsd:boolean"/>
<element name="logNumberOfRequests" type="xsd:boolean"/>
<element name="logOperatingSystem" type="xsd:boolean"/>
<element name="logReceivedBytes" type="xsd:boolean"/>
<element name="logResponseTime" type="xsd:boolean"/>
<element name="logSendBytes" type="xsd:boolean"/>
<element name="logUploadBandwith" type="xsd:boolean"/>
<element name="login" nillable="false" type="soapenc:string"/>
</sequence>
</complexType>

Holds the login and the parameters which should be logged

ClientPerformanceLoggingResultsBean

<complexType name="ClientPerformanceLoggingResultsBean">
<sequence>
<element name="architecture" nillable="true" type="soapenc:string"/>
<element name="averageResponseTime" type="xsd:long"/>
<element name="clientLanguage" nillable="true" type="soapenc:string"/>
<element name="downloadBandwith" type="xsd:long"/>
<element name="freeDiskSpace" nillable="true" type="soapenc:string"/>
<element name="javaVersion" nillable="true" type="soapenc:string"/>
<element name="login" nillable="true" type="soapenc:string"/>
<element name="numberOfRecievedBytes" type="xsd:long"/>
<element name="numberOfRequests" type="xsd:long"/>
<element name="numberOfSendBytes" type="xsd:long"/>
<element name="operatingSystem" nillable="true" type="soapenc:string"/>
</sequence>
</complexType>

Holds the logged parameters for a user

4.8 4.9 Import of Market Specific Notes

EPC provides a functionality to show market specific notes in parts lists and part images. Depending on your market you may be able to receive market notes to import them into your EWA installation. Please contact your market responsible EWA coordinator to check for Market Notes.

The Market Notes which are displayed in EPC need to be imported into the user management using the "Maintain Market Notes" screen. To open the screen, log in as server administrator and go to the menu "Administration -> Server -> Manage market notes".

The Market Notes maintenance screen has the following options:

See which Market Notes are currently available on the system
Upload new Market Notes
Remove existing Market Notes

Note:
Market Notes are mapped to countries. Each user sees market notes depending on his configured user country. If your server installation provides EWA for multiple countries, you need to import the Market Notes depending on the country.

The screen lists all available and imported Market Notes in a table. For each available set of Market Notes the screen also shows the date of import and the edition date of the Notes content.

To upload new Market Notes, use the lower part of the screen. Click on browse and locate the market notes file which was sent to you. Optional if you want to import the notes for a different market / country, please select the correct country from the list of countries. Click on "Upload" to start uploading.

Note:
It is only possible to keep one set of Market Notes per Market. If you upload notes for the same market / country again, the old notes will be overwritten.

To remove Market Notes from the system, use the rubber icon on the right side.

4.10 4.11 Messaging

EWA provides advanced messaging functionality for the users. It features three types of messages, validity, priority, target roles and groups, and templates. All of these will be explained in more detail in the following chapters. You can access the messaging screen by going to menu "Administration -> Message".

4.11.1 Configuring the messaging service

When you enter EWA for the first time you usually have to configure a few things before you can use the messaging service. This is indicated by a warning box on top in the message screen:

If this is the case, you should make some configuration changes in EWA. Go to "Administration -> Server -> Edit server configuration ". In that screen enable the "Started" checkbox and enter the required information. If you are unsure what the correct data is, please contact your system administrator.

After you are done "Save" the entered data by clicking the button at the bottom of the screen. You will see a message that you have to restart the EWA server for the new configurations to become effective. Ignore it for now and go to the menu "My profile -> Basic preferences -> Edit basic preferences ". In the required fields (marked by red star) enter your data and "Save" it using the button below. After you are done restart the EWA server in order to activate the changes.

4.11.2 Sending a message

When you open the messaging screen, you should see this:

Note the two red stars. They mean that only the "Subject" and "Valid until" fields are required to create a new message. The rest are useful however if you want to create something more specific. Each field will be described and explained below.

Subject - The title of the message. This is a required field.
Content - The body of the message can be used to enter more detailed information.
Type of message - You can select one or more possible types for the message. "Instant message" will send rightaway a popup to all active programs. "E-mail" will send an e-mail to all selected recipients. "Message as banner" will display the message as a banner in EWA. "Message to EPC" will display the message within EPC. "Message to WIS" will display the message within WIS.
Valid from/until - These two fields define the validity period of the message. Only "Valid until" is required. If "Valid from" is left blank, the current date and time will be selected.
Priority - This sets the message priority. The two possible choices are "Normal" and "High", where "Normal" is the default one. In addition you can choose a date and time where the priority changes from one to the other.
Message recipients - This is used to set the message recipients. You can either leave the default "All users" which will send the message to all users in your system, or you can select one or more user groups from the list which will send the message only to the users that belong to these groups. You can furthermore select users from specific countries.
User roles - Here you can specify which user roles is the message targeting. Possible choices are one or more from three: "System administrators", "Workshop administrators " and "User".

Once you enter all the data you want you have to click the "Send" button at the bottom of the screen to send the message. If the message is sent successfully, you should see the following confirmation:

Note that the "Reset" button will clear all entered data and reset the screen.

4.11.3 Using templates

New in EWA 1.11 is the message templates functionality. It is now possible to save a message as template and load it any time again. This will save time and effort for system administrators and users alike, making possible the creation of a repository with unlimited number of prepared messages. Unneeded templates can be deleted to keep the list tidy.

1. Creating a template: Prepare a message the usual way and then select the checkbox at the bottom named "Save message as template". When you send the message, it will be automatically saved and named with the message subject. No templates will be overridden even if the name already exists in the template database. Instead the new template's name will end with "v2", "v3" and so on.

2. Loading a template: To load saved template open the drop down menu located in the top frame. Then select a template name from the list. The data will be automatically loaded in the message fields overriding anything already there. Once loaded, the data still can be modified before the message is sent.

3. Deleting a template: To delete a message template, you first have to load it (see 2. above). Once loaded, the "Delete selected template button" is enabled and has to be pressed.

A popup window opens asking for confirmation. Clicking on "Yes" will delete the template. It cannot be recovered! Clicking on "No" will simply close the popup and return you to the message page.

4.12

5 Advanced Administration

This chapter introduces the more advanced features of the EWA User Management console.

5.1 Easy import Users, Groups and Workshops

In this document we learned how to setup Users, Groups and Workshops manually. If it comes to a large number of such objects to be created and maintained it might be much more easy for you to create a so called import file for EWA.

To perform this action, simply navigate via the menu to "Server Management -> Import Users, Groups, Workshops".

The mask for importing files allows you to import XML files from any client you like via the "Browse" button which opens a file dialog allowing you to find your prepared import file. After selection of your file simply click on "Import". Should problems occur during import the error messages will tell you about the cause.

Possible causes are:

Your file is not correctly formatted according to the DTD. You might want to make use of an XML capable text editor to at least ensure that the document is well formatted.
Required attributes are missing in the file.
You make use of duplicate keys. I.e. Login name of users must be unique.

The file format to be used for such an import is XML. EWA makes use of its own DTD to verify the overall format of the XML file if you try to load such a file. The DTD looks like this:

   <!ELEMENT ewanet (EWA_VERSIONINFO, UM_WORKSHOP*, UM_GROUP*, UM_USER*)>
<!ELEMENT EWA_VERSIONINFO EMPTY>
<!ELEMENT UM_WORKSHOP EMPTY>
<!ELEMENT UM_GROUP EMPTY>
<!ELEMENT UM_USER EMPTY>

<!ATTLIST EWA_VERSIONINFO CurrentVersion CDATA "1.3.0.0">

<!ATTLIST UM_WORKSHOP WorkshopNumber CDATA #REQUIRED>
<!ATTLIST UM_WORKSHOP Description CDATA #REQUIRED>
<!ATTLIST UM_WORKSHOP WISLicense CDATA #IMPLIED>
<!ATTLIST UM_WORKSHOP EPCLicense CDATA #IMPLIED>
<!ATTLIST UM_WORKSHOP WISEnabled (0|1) #IMPLIED>
<!ATTLIST UM_WORKSHOP EPCEnabled (0|1) #IMPLIED>
<!ATTLIST UM_WORKSHOP NumWISLicenses CDATA #IMPLIED>
<!ATTLIST UM_WORKSHOP NumEPCLicenses CDATA #IMPLIED>
<!ATTLIST UM_WORKSHOP Country CDATA #REQUIRED>

<!ATTLIST UM_GROUP WorkshopNumberRef CDATA #REQUIRED>
<!ATTLIST UM_GROUP GroupName CDATA #REQUIRED>
<!ATTLIST UM_GROUP Description CDATA #REQUIRED>
<!ATTLIST UM_GROUP WISLicense CDATA #IMPLIED>
<!ATTLIST UM_GROUP EPCLicense CDATA #IMPLIED>
<!ATTLIST UM_GROUP WISEnabled (0|1) #IMPLIED>
<!ATTLIST UM_GROUP EPCEnabled (0|1) #IMPLIED>

<!ATTLIST UM_USER GroupNameRef CDATA #REQUIRED>
<!ATTLIST UM_USER Login CDATA #REQUIRED>
<!ATTLIST UM_USER Passwd CDATA #REQUIRED>
<!ATTLIST UM_USER Lastname CDATA #REQUIRED>
<!ATTLIST UM_USER Firstname CDATA #REQUIRED>
<!ATTLIST UM_USER Email CDATA #IMPLIED>
<!ATTLIST UM_USER Department CDATA #IMPLIED>
<!ATTLIST UM_USER Phone CDATA #IMPLIED>
<!ATTLIST UM_USER Fax CDATA #IMPLIED>
<!ATTLIST UM_USER UserRole CDATA #REQUIRED>
<!ATTLIST UM_USER isActive (0|1) #REQUIRED>
<!ATTLIST UM_USER isTemplateUser (0|1) #REQUIRED>
<!ATTLIST UM_USER Country CDATA #IMPLIED>
<!ATTLIST UM_USER ActivationStartDate CDATA #IMPLIED>
<!ATTLIST UM_USER ActivationPeriod CDATA #IMPLIED>

The DTD shows you which XML objects have to provided. The VERSIONINFO object does not have to be provided in the XML file by you. It is implicitly checked against the internal database version to ensure you import only compliant files.

Note:
All attributes have to be quoted. Furthermore XML is case sensitive.

Object	Attributes	Required	Comment
UM_WORKSHOP			A workshop object. Note: You may only load further workshops if you have "cascaded workshop administration" turned on. If additional workshops are loaded when cascaded administration is not enabled, the users in these workashops will not be visible and not be able to log in!
	WorkshopNumber	Yes	The unique 1-20 alphanumeric characters of the official Daimler workshop number
	Description	Yes	A descriptive text for this workshop
	WISEnabled		"1" if WIS should be available to users in this workshop. "0" if not
	WISLicense		If WIS is enabled you can restrict the server license by providing a modified bit string of the 80 access bits
	NumWISLicenses		If WIS is enabled how many users should be able to get access to WIS
	EPCEnabled		"1" if EPC should be available to users in this workshop. "0" if not
	EPCLicense		If EPC is enabled you can restrict the server access authorization by providing a modified bit string of the 80 access bits
	NumEPCLicenses		If EPC is enabled how many users should be able to get access to EPC
	Country	Yes	The number code of the country this workshop resides in. Valid Daimler country codes can be found in the file [EWA_HOME]\config\country_codex.xml
UM_GROUP			A group object.
	WorkshopNumberRef	Yes	Reference Number of a just imported or already existing workshop.
	GroupName	Yes	Unique name of the group. A short name for the group.
	Description	Yes	Some descriptive text about the group
	WISEnabled		"1" if WIS should be available to users in this workshop. "0" if not
	WISLicense		If WIS is enabled you can restrict the server access authorization by providing a modified bit string of the 80 access bits
	EPCEnabled		"1" if EPC should be available to users in this workshop. "0" if not
	EPCLicense		If EPC is enabled you can restrict the server access authorization by providing a modified bit string of the 80 access bits
UM_USER			Creates a new user object
	GroupNameRef	Yes	Reference to the group name in which to insert this user. This group must already been imported or must have been loaded some lines before in the same XML file.
	Login	Yes	Login name of the user. Must not conflict with an existing one. Must be at least 1 characters in length.
	Passwd	Yes	Password of the user. Must be at least 5 characters in length. The password can be plain or with the EWA supported crypting algorithm SHA-1 encrypted.
	Lastname	Yes	Last name of the user
	Firstname	Yes	First name of the user
	Email	(Yes) for administrators	EMail address. Must be provided if the the user is in the admin role.
	Department		Department name
	Phone		Phone number
	Fax		Fax number
	UserRole	Yes	Role of the user. This is a text field which needs to contain at least the role value and can have several further attributes. If multiple values are specified, they must be separated by comma (","). Needs to be one of: WorkshopUser WorkshopAdmin ServerAdmin Can additionally be one of (Depending if feature is enabled): MarketNotesEditor DownloadUser ManuscriptReader LicenseBillingContact And can be one of (For licensing reporting, depending on installation): TypeCustomer (=Default if not specified) TypeTest TypeDevelopment TypeTestLab TypeDemonstration TypeTraining TypeInternal
	isActive	Yes	"1" if the user shall be able to work with EWA, "0" else.
	isTemplateUser	Yes	"1" if the user profile shall be available as template profile during the creation of other users, "0" else.
	Country		Only in restricted user expiration timer mode: Country code overriding any setting on the workshop level. Valid Daimler country codes can be found in the file [EWA_HOME]\config\country_codex.xml
	ActivationStartDate		Only in restricted user expiration timer mode: When does the activation start for this user? The date format is the one configured for the locale you are using. I.e. "DD.MM.YYYY" for german locales.
	ActivationPeriod		Only in restricted user expiration timer mode: How many milliseconds does it take till the account expires?

The following file gives you an example of a simple import file. You might use this information to build a template file which you fill by batch processes. The password in the given example is the crypted version of the text "password".

<ewanet>
  <UM_GROUP WorkshopNumberRef="000000" GroupName="Sample Group"
    Description="A sample group to test imports" WISEnabled="1" EPCEnabled="1" />

  <UM_USER GroupNameRef="Sample Group" Login="user001" Passwd="5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8"
    Lastname="Doe" Firstname="John" Department="" Phone="" Fax="" UserRole="ServerAdmin"
    isActive="1" isTemplateUser="0"/>
</ewanet>

The following file gives you an example of an import file including a additional workshop. You might use this information to build a template file which you fill by batch processes. The password in the given example is the crypted version of the text "password".

<ewanet>
  <!-- NOTE: Only add a UM_WORKSHOP here if cascaded administration is enabled! -->
  <UM_WORKSHOP WorkshopNumber="012345" Description="A sample workshop to test imports"
    Country="200" WISEnabled="1" EPCEnabled="1" NumWISLicenses="1" NumEPCLicenses="1" />

  <UM_GROUP WorkshopNumberRef="012345" GroupName="Sample Group"
    Description="A sample group to test imports" WISEnabled="1" EPCEnabled="1" />

  <UM_USER GroupNameRef="Sample Group" Login="user001" Passwd="5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8"
    Lastname="Doe" Firstname="John" Department="" Phone="" Fax="" UserRole="ServerAdmin"
    isActive="1" isTemplateUser="0"/>
</ewanet>

Note:
Again: you may only make use of the "UM_WORKSHOP" entities in your import file if you make use of the so called "cascadedAdministration" and thus are allowed to create workshops.
If you run your server in the simple mode - which only allows on workshop - you may not add further workshops. Then you may only add further groups and/or users to the already existing single workshop.

5.2 User Management Administration via Web Services

5.2.1 Introduction

Besides the manual user creation and the import possibilities, EWA user management can also be maintained using Web Services.

The Web Service interface for user administration is disabled by default. To enable the interface, open the configuration file [EWA_HOME]\config\core_cfg.xml and change the value of the parameter portalServiceEnabled to be "true". You need to restart the EWA server to activate the interface.

   <!-- Settings for the External Portal interface -->
        <SECTION name="PortalInterface">
                <!-- Flag if the external web service interface is enabled -->
                <!-- Valid options: "true" or "false" -->
                <PARAMETER name="portalServiceEnabled">true</PARAMETER>

5.2.2 Accessibility

The EWA Web Services interface for user administration is available with the following URL: http://<server>:9000/EWA-net/ws/PortalService

The complete WSDL-description of the Web Service to generate client stub code is available with the following URL: http://<server>:9000/EWA-net/ws/PortalService?wsdl

5.2.3 Example Web Service Administration Web Implementation

To test functionality of the implemented Web Service an example web remote administration application has been generated. To deploy this application you need to modify the EWA application server and copy the required files to the EWA server installation.

If you are familar with deploying web applications, just deploy the WAR file which is contained on the EWA installation medium called <DVD>:\ewa\Apps\ewacore\application\example-wsmgmt.war.

If you are not familiar with deploying WAR files, you can proceed with the following steps to test the integration:

Extract the example-wsmgmt.war file to [EWA_HOME]\webapps\example-wsmgmt\ folder. Create the folder as it might not exist.

Open the file [EWA_HOME]\server\conf\server.xml in a text editor and add the following section at the end of the XML file beside the other similar entries before the token </Host>.

                       <Context cookies="false"
                                crossContext="true"
                                docBase="example-wsmgmt"
                                path="/example-wsmgmt"
                                privileged="false"
                                reloadable="false"
                                swallowOutput="true"
                                useNaming="true">
                        </Context>

Restart the EWA Server.

Now you can open the following URL in the web browser and try to use the example implementation: http://localhost:9000/example-wsmgmt/

Note:
This example implementation is just a proof that the Web Services are running, it is not recommended to use this in a production environment. It is highly recommended to implement a secure application for managing users remotely!

5.2.4 Service Methods

This section documents which Web Services methods will be exposed and how they will be exposed (method name, parameter list, ...). In order to allow a generic approach, the Web Service methods are making use of the standard Web Services data types like "int", "string", ... wherever possible. In some methods it was not possible to use simple types so some complex types were needed to be introduced.

5.2.4.1 authenticateUser

xsd:boolean authenticateUser(xsd:string login,
                         xsd:string password)
                         throws PortalDisabledFault,
                                AuthenticationFault

Checks the authentication of the user

Parameters:: login - Valid login name of the user; password - Encrypted password of the user to check.
Returns:: true if the authentication is valid, false if invalid or user not existing
Throws:: PortalDisabledFault - Not actually thrown - just for declaration purposes if portal interface is disabled; AuthenticationFault - If authentication can not be processed

5.2.4.2 startApplication

xsd:string startApplication(xsd:string login,
                                  xsd:string password,
                                  xsd:int applicationID)
                                  throws PortalDisabledFault,
                                         AuthenticationFault,
                                         AuthenticationInvalidFault,
                                         NoPermissionFault,
                                         UserNotActiveFault,
                                         UserActivationExpiredFault,
                                         ApplicationStartFault,
                                         NoLicenseAvailableFault

Processes the login request of the user

Parameters:: login - Valid login name of the user; password - Encrypted password of the user to check.; applicationID - The provided id must be from the current set of EWA application IDs. The value must be 50 for WIS or 150 for EPC.
Returns:: JNLP file which has to be sent to the client's browser.
Throws:: PortalDisabledFault - Not actually thrown - just for declaration purposes if portal interface is disabled; AuthenticationFault - Problems during authentication, details contained in the fault string; AuthenticationInvalidFault - Authentication is invalid; NoPermissionFault - User has no permissions for application; UserNotActiveFault - Activation of user has not started yet; UserActivationExpiredFault - Activation of user has expired or is invalid; ApplicationStartFault - If the application start can not be processed; NoLicenseAvailableFault - If the application start can not be processed because there is a problem with the license

5.2.4.3 createUser

xsd:boolean createUser(xsd:string adminLogin,
                   xsd:string adminPassword,
                   xsd:string newLogin,
                   xsd:string newPassword,
                   xsd:string groupName,
                   xsd:string workshopName,
                   xsd:string firstName,
                   xsd:string lastName,
                   xsd:string email,
                   xsd:string phone,
                   xsd:string fax,
                   xsd:int countryCode,
                   xsd:string department,
                   xsd:dateTime activationStart,
                   xsd:long activationDuration,
                   xsd:int activationType,
                   xsd:string templateLogin)
                   throws PortalDisabledFault,
                          AuthenticationFault,
                          AuthenticationInvalidFault,
                          UserExistsFault,
                          GroupDoesNotExistFault,
                          WorkshopDoesNotExistFault,
                          ServerLicenseExhaustedFault,
                          InvalidArgumentsFault,
                          UserManagementFault

The portal needs a remote method to create a user with a set of given attributes within the EWA user database.

Parameters:

adminLogin - Valid Administrator login to authenticate the web service call against the server instance

adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance

Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.

newLogin - New login name to create

newPassword - New password of the user to set

groupName - Name of permission group to add the user to. The specified permission group needs to exist on the server already

workshopName - Name of workshop to add the user to. The specified workshop needs to exist on the server already

firstName - First name of the user to create

lastName - Last name of the user to create

email - Email address of the user to create

phone - Phone of the user to create

fax - Fax of the user to create

countryCode - Country code of the user. Note: This needs to be a country code from the list of Daimler valid country codes!

department - Department description or comments for the user

activationStart - Start date of license activation, can be null depending on activation type.

activationDuration - Duration (measured in milliseconds) how long the user access authorization is activated.

activationType - Type of activation period which is used for the new user. Valid options are:

0 = Immediate activation (Duration is required, Start is used from current system time)
1 = Activation on first application start (Duration is required)
2 = Use Parameters (Start+Duration is required)
3 = User is not activated (Start+Duration are ignored)

templateLogin - Login name of template user from which the settings should be copied, can be empty.

Returns:

result; true: Success, the user was successfully created

Throws:

PortalDisabledFault - Portal interface is disabled by configuration

AuthenticationFault - Problem during authentication of Administrator

AuthenticationInvalidFault - Administrator Authentication is invalid

UserExistsFault - The specified user ID already exists, can not be created

GroupDoesNotExistFault - The specified group does not exist

WorkshopDoesNotExistFault - The specified group does not exist

ServerLicenseExhaustedFault - Server access authorization is exhausted

InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable

UserManagementFault - in user management, creation not possible

5.2.4.4 createUser2

xsd:boolean createUser2(xsd:string adminLogin,
                    xsd:string adminPassword,
                    xsd:string newLogin,
                    xsd:string newPassword,
                    xsd:string groupName,
                    xsd:string workshopName,
                    xsd:string firstName,
                    xsd:string lastName,
                    xsd:string email,
                    xsd:string phone,
                    xsd:string fax,
                    xsd:string department,
                    xsd:string templateLogin)
                    throws PortalDisabledFault,
                           AuthenticationFault,
                           AuthenticationInvalidFault,
                           UserExistsFault,
                           GroupDoesNotExistFault,
                           WorkshopDoesNotExistFault,
                           ServerLicenseExhaustedFault,
                           InvalidArgumentsFault,
                           UserManagementFault

Besides the

#createUser(xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:dateTime, xsd:long, xsd:int, xsd:string)

method, this method allows creation of user without usage of expiration timers within the EWA user database.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; newLogin - New login name to create; newPassword - New password of the user to set; groupName - Name of permission group to add the user to. The specified permission group needs to exist on the server already; workshopName - Name of workshop to add the user to. The specified workshop needs to exist on the server already; firstName - First name of the user to create; lastName - Last name of the user to create; email - Email address of the user to create; phone - Phone of the user to create; fax - Fax of the user to create; department - Department description or comments for the user; templateLogin - Login name of template user from which the settings should be copied, can be empty.
Returns:: result; true: Success, the user was successfully created
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserExistsFault - The specified user ID already exists, can not be created; GroupDoesNotExistFault - The specified group does not exist; WorkshopDoesNotExistFault - The specified group does not exist; ServerLicenseExhaustedFault - Server access authorization is exhausted; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - in user management, creation not possible

5.2.4.5 getLicenseTypes

com.hp.tis.ewo.portal.beans.LicenseTypeDetailsBean[] getLicenseTypes(xsd:string adminLogin,
                                                                     xsd:string adminPassword)
                                                                     throws PortalDisabledFault,
                                                                            AuthenticationFault,
                                                                            AuthenticationInvalidFault,
                                                                            UserManagementFault

The portal needs to know which access authorization types are configured in the user management as permission groups.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.
Returns:: Array of access authorization type information
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible

5.2.4.6 getLicenseDurations

com.hp.tis.ewo.portal.beans.LicenseDurationDetailsBean[] getLicenseDurations(xsd:string adminLogin,
                                                                             xsd:string adminPassword,
                                                                             xsd:string languageCode)
                                                                             throws PortalDisabledFault,
                                                                                    AuthenticationFault,
                                                                                    AuthenticationInvalidFault,
                                                                                    UserManagementFault,
                                                                                    InvalidArgumentsFault

The portal needs to know which access authorization durations are acceptable for the creation of users and configured by the administrators.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; languageCode - Language code for which the country labels of the list are returned. e.g. "en_US" or "de".
Returns:: Array of access authorization duration information
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible; InvalidArgumentsFault - If the provided locale is not valid

5.2.4.7 getActivationOptions

com.hp.tis.ewo.portal.beans.ActivationOptionDetailsBean[] getActivationOptions(xsd:string adminLogin,
                                                                               xsd:string adminPassword,
                                                                               xsd:string languageCode)
                                                                               throws PortalDisabledFault,
                                                                                      AuthenticationFault,
                                                                                      AuthenticationInvalidFault,
                                                                                      UserManagementFault,
                                                                                      InvalidArgumentsFault

The portal needs to know which activation options are valid when creating and updating users. Only the returned list of activation options is valid when using this external interface.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; languageCode - Language code for which the country labels of the list are returned. e.g. "en_US" or "de".
Returns:: Array of valid activation options
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible; InvalidArgumentsFault - If the provided locale is not valid

5.2.4.8 getCountryCodes

com.hp.tis.ewo.portal.beans.CountryDetailsBean[] getCountryCodes(xsd:string adminLogin,
                                                                 xsd:string adminPassword,
                                                                 xsd:string languageCode)
                                                                 throws PortalDisabledFault,
                                                                        AuthenticationFault,
                                                                        AuthenticationInvalidFault,
                                                                        InvalidArgumentsFault,
                                                                        UserManagementFault

The portal needs to be able to retrieve a list of valid country codes when creating a user.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; languageCode - Language code for which the country labels of the list are returned. e.g. "en_US" or "de".
Returns:: Array of country codes which are valid when creating and/or updating users
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - in user management, creation not possible

5.2.4.9 getUser

com.hp.tis.ewo.portal.beans.UserDetailsBean getUser(xsd:string adminLogin,
                                                    xsd:string adminPassword,
                                                    xsd:string login)
                                                    throws PortalDisabledFault,
                                                           AuthenticationFault,
                                                           AuthenticationInvalidFault,
                                                           UserNotExistFault,
                                                           InvalidArgumentsFault,
                                                           UserManagementFault

The portal needs to be able to read out the state of a current user

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; login - User login to retrieve from user management database
Returns:: Bean with user information from the requested login name.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserNotExistFault - The specified user ID does not exist, can not be fetched; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - Problem in user management, fetch not possible

5.2.4.10 updateUser

xsd:boolean updateUser(xsd:string adminLogin,
                   xsd:string adminPassword,
                   xsd:string login,
                   xsd:string newPassword,
                   xsd:string groupName,
                   xsd:string workshopName,
                   xsd:string firstName,
                   xsd:string lastName,
                   xsd:string email,
                   xsd:string phone,
                   xsd:string fax,
                   xsd:int countryCode,
                   xsd:string department,
                   xsd:dateTime activationStart,
                   xsd:long activationDuration,
                   xsd:int activationType)
                   throws PortalDisabledFault,
                          AuthenticationFault,
                          AuthenticationInvalidFault,
                          UserNotExistFault,
                          GroupDoesNotExistFault,
                          WorkshopDoesNotExistFault,
                          ServerLicenseExhaustedFault,
                          InvalidArgumentsFault,
                          UserManagementFault

The portal needs a remote method to update an existing a user with a set of given attributes within the EWA user database.

Parameters:

adminLogin - Valid Administrator login to authenticate the web service call against the server instance

adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.

login - Existing login name to update

newPassword - OPTIONAL: New password of the user to set. If null, the password will not be changed

groupName - Name of permission group to add the user to. The specified permission group needs to exist on the server already

workshopName - Name of workshop to add the user to. The specified workshop needs to exist on the server already

firstName - First name of the user to create

lastName - Last name of the user to create

email - Email address of the user to create

phone - Phone of the user to create

fax - Fax of the user to create

countryCode - Country code of the user. Note: This needs to be a country code from the list of Daimler valid country codes!

department - Department description or comments for the user

activationStart - Start date of access authorization activation, can be null depending on activation type.

activationDuration - Duration (measured in milliseconds) how long the user access authorization is activated.

activationType - Type of activation period which is used for the new user. Valid options are:

0 = Immediate activation (Duration is required, Start is used from current system time)
1 = Activation on first application start (Duration is required)
2 = Use Parameters (Start+Duration is required)
3 = User is not activated (Start+Duration are ignored)

Returns:

result; true: Success, the user was successfully updated

Throws:

PortalDisabledFault - Portal interface is disabled by configuration

AuthenticationFault - Problem during authentication of Administrator

AuthenticationInvalidFault - Administrator Authentication is invalid

UserNotExistFault - The specified user ID already exists, can not be created

GroupDoesNotExistFault - The specified group does not exist

WorkshopDoesNotExistFault - The specified group does not exist

ServerLicenseExhaustedFault - Server access authorization is exhausted

InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable

UserManagementFault - in user management, creation not possible

5.2.4.11 updateUser2

xsd:boolean updateUser2(xsd:string adminLogin,
                    xsd:string adminPassword,
                    xsd:string login,
                    xsd:string newPassword,
                    xsd:string groupName,
                    xsd:string workshopName,
                    xsd:string firstName,
                    xsd:string lastName,
                    xsd:string email,
                    xsd:string phone,
                    xsd:string fax,
                    xsd:string department)
                    throws PortalDisabledFault,
                           AuthenticationFault,
                           AuthenticationInvalidFault,
                           UserNotExistFault,
                           GroupDoesNotExistFault,
                           WorkshopDoesNotExistFault,
                           ServerLicenseExhaustedFault,
                           InvalidArgumentsFault,
                           UserManagementFault

Besides the

#updateUser(xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:string, xsd:dateTime, xsd:long, xsd:int)

method this additional update method is updating the user details in the case when no expiration timers are being used within the EWA user database.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; login - Existing login name to update; newPassword - OPTIONAL: New password of the user to set. If null, the password will not be changed; groupName - Name of permission group to add the user to. The specified permission group needs to exist on the server already; workshopName - Name of workshop to add the user to. The specified workshop needs to exist on the server already; firstName - First name of the user to create; lastName - Last name of the user to create; email - Email address of the user to create; phone - Phone of the user to create; fax - Fax of the user to create; department - Department description or comments for the user
Returns:: result; true: Success, the user was successfully updated
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserNotExistFault - The specified user ID already exists, can not be created; GroupDoesNotExistFault - The specified group does not exist; WorkshopDoesNotExistFault - The specified group does not exist; ServerLicenseExhaustedFault - Server access authorization is exhausted; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - in user management, creation not possible

5.2.4.12 updatePassword

xsd:boolean updatePassword(xsd:string adminLogin,
                       xsd:string adminPassword,
                       xsd:string login,
                       xsd:string newPassword)
                       throws PortalDisabledFault,
                              AuthenticationFault,
                              AuthenticationInvalidFault,
                              UserNotExistFault,
                              InvalidArgumentsFault,
                              UserManagementFault

The portal needs a remote method to update an existing a user password within the EWA user database.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; login - Existing login name to update; newPassword - New password of the user to set.
Returns:: result; true: Success, the user was successfully updated
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserNotExistFault - The specified user ID already exists, can not be created; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - in user management, update not possible

5.2.4.13 deleteUser

xsd:boolean deleteUser(xsd:string adminLogin,
                   xsd:string adminPassword,
                   xsd:string login)
                   throws PortalDisabledFault,
                          AuthenticationFault,
                          AuthenticationInvalidFault,
                          UserNotExistFault,
                          InvalidArgumentsFault,
                          UserManagementFault

The portal needs a remote method to delete a user with a set of given attributes within the EWA user database.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; login - Login name to remove
Returns:: result; true: Success, the user was successfully deleted
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserNotExistFault - The specified user ID does not exist, can not be deleted; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - in user management, creation not possible

5.2.4.14 getUsers

xsd:string[] getUsers(xsd:string adminLogin,
                            xsd:string adminPassword)
                            throws PortalDisabledFault,
                                   AuthenticationFault,
                                   AuthenticationInvalidFault,
                                   UserManagementFault

The portal needs a remote method to retrieve a list of existing users within the EWA user database

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.
Returns:: result list of login names.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible

5.2.4.15 findUsers

xsd:string[] findUsers(xsd:string adminLogin,
                             xsd:string adminPassword,
                             xsd:string loginPattern)
                             throws PortalDisabledFault,
                                    AuthenticationFault,
                                    AuthenticationInvalidFault,
                                    UserManagementFault,
                                    InvalidArgumentsFault

The portal needs a remote method to retrieve a list of existing users within the EWA user database

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; loginPattern - User name pattern to use to find users in the user management. Pattern can contain "?" for simple character replacements and "*" for optional characters, e.g. "?oo" and "f*" will find "foo".
Returns:: result list of login names.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable

5.2.4.16 findUsersByGroup

xsd:string[] findUsersByGroup(xsd:string adminLogin,
                                    xsd:string adminPassword,
                                    xsd:string groupName)
                                    throws PortalDisabledFault,
                                           AuthenticationFault,
                                           AuthenticationInvalidFault,
                                           UserManagementFault,
                                           GroupDoesNotExistFault,
                                           InvalidArgumentsFault

The portal needs a remote method to retrieve a list of existing users within a group of the EWA user database

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; groupName - Group name as search criteria to find users.
Returns:: result list of login names.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible; GroupDoesNotExistFault - The group which is defined as search criteria is not existing in EWA; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable

5.2.4.17 isUserActivated

xsd:boolean isUserActivated(xsd:string adminLogin,
                        xsd:string adminPassword,
                        xsd:string login)
                        throws PortalDisabledFault,
                               AuthenticationFault,
                               AuthenticationInvalidFault,
                               UserNotExistFault,
                               InvalidArgumentsFault,
                               UserManagementFault

The portal needs a remote method to check whether an existing a user within the EWA user database is activated. (or in other case: if the access authorization needs to be renewed)

Parameters:

adminLogin - Valid Administrator login to authenticate the web service call against the server instance

login - Login name to check

Returns:

result.

true: The user has a valid access authorization at the moment of check
false: The user is inactive or the user access authorization has expired

Throws:

PortalDisabledFault - Portal interface is disabled by configuration

AuthenticationFault - Problem during authentication of Administrator

AuthenticationInvalidFault - Administrator Authentication is invalid

UserNotExistFault - The specified user ID already exists, can not be created

InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable

UserManagementFault - in user management, creation not possible

5.2.4.18 createGroup

xsd:boolean createGroup(xsd:string adminLogin,
                    xsd:string adminPassword,
                    xsd:string groupName,
                    xsd:string groupDescription,
                    xsd:string workshopNumber,
                    xsd:boolean epcEnabled,
                    xsd:string epcPermissions,
                    xsd:boolean wisEnabled,
                    xsd:string wisPermissions)
                    throws PortalDisabledFault,
                           AuthenticationFault,
                           AuthenticationInvalidFault,
                           GroupExistFault,
                           WorkshopDoesNotExistFault,
                           InvalidArgumentsFault,
                           UserManagementFault

The portal needs a remote method to create a group with a set of given attributes within the EWA user database.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; groupName - Name of the group to create; groupDescription - Description of the new group; workshopNumber - Name of workshop to add the group to. The specified workshop needs to exist on the server already; epcEnabled - Flag if EPC should be enabled for this group; epcPermissions - String with permissions as bit set to restrict permissions, can be null if group permissions should not be restricted. If permissions are defined, it must be a string having at least 80 characters and consists only of "0" and "1" characters representing the bit permissions.; wisEnabled - Flag if EPC should be enabled for this group; wisPermissions - String with permissions as bit set to restrict permissions, can be null if group permissions should not be restricted. If permissions are defined, it must be a string having at least 80 characters and consists only of "0" and "1" characters representing the bit permissions.
Returns:: result; true: Success, the group was successfully created
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; GroupExistFault - The specified group already exists, can not be created; WorkshopDoesNotExistFault - The specified group does not exist; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - in user management, creation not possible

5.2.4.19 deleteGroup

xsd:boolean deleteGroup(xsd:string adminLogin,
                    xsd:string adminPassword,
                    xsd:string groupName)
                    throws PortalDisabledFault,
                           AuthenticationFault,
                           AuthenticationInvalidFault,
                           GroupDoesNotExistFault,
                           InvalidArgumentsFault,
                           UserManagementFault,
                           GroupNotEmptyFault

The portal needs a remote method to delete a group with a set of given attributes within the EWA user database.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; groupName - Name of the group to delete
Returns:: result; true: Success, the user was successfully deleted
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; GroupDoesNotExistFault - The specified group does not exist, can not be deleted; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - in user management, creation not possible; GroupNotEmptyFault - Group contains users, can not be deleted

5.2.4.20 updateGroup

xsd:boolean updateGroup(xsd:string adminLogin,
                    xsd:string adminPassword,
                    xsd:string groupName,
                    xsd:string groupDescription,
                    xsd:string workshopNumber,
                    xsd:boolean epcEnabled,
                    xsd:string epcPermissions,
                    xsd:boolean wisEnabled,
                    xsd:string wisPermissions)
                    throws PortalDisabledFault,
                           AuthenticationFault,
                           AuthenticationInvalidFault,
                           GroupDoesNotExistFault,
                           WorkshopDoesNotExistFault,
                           InvalidArgumentsFault,
                           UserManagementFault

The portal needs a remote method to update a group with a set of given attributes within the EWA user database.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; groupName - Name of the group to update; groupDescription - New description of the new group; workshopNumber - Name of workshop to move the group to. The specified workshop needs to exist on the server already; epcEnabled - Flag if EPC should be enabled for this group; epcPermissions - String with permissions as bit set to restrict permissions, can be null if group permissions should not be restricted. If permissions are defined, it must be a string having at least 80 characters and consists only of "0" and "1" characters representing the bit permissions.; wisEnabled - Flag if EPC should be enabled for this group; wisPermissions - String with permissions as bit set to restrict permissions, can be null if group permissions should not be restricted. If permissions are defined, it must be a string having at least 80 characters and consists only of "0" and "1" characters representing the bit permissions.
Returns:: result; true: Success, the group was successfully updated
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; GroupDoesNotExistFault - The specified group is not existing, can not be updated; WorkshopDoesNotExistFault - The specified group does not exist; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - in user management, creation not possible

5.2.4.21 getGroup

com.hp.tis.ewo.portal.beans.GroupDetailsBean getGroup(xsd:string adminLogin,
                                                      xsd:string adminPassword,
                                                      xsd:string groupName)
                                                      throws PortalDisabledFault,
                                                             AuthenticationFault,
                                                             AuthenticationInvalidFault,
                                                             GroupDoesNotExistFault,
                                                             InvalidArgumentsFault,
                                                             UserManagementFault

The portal needs to be able to read out the state of a existing group

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; groupName - Group name to retrieve from user management database
Returns:: Bean with group information from the requested group name.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; GroupDoesNotExistFault - The specified user ID does not exist, can not be fetched; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - Problem in user management, fetch not possible

5.2.4.22 getGroups

xsd:string[] getGroups(xsd:string adminLogin,
                             xsd:string adminPassword)
                             throws PortalDisabledFault,
                                    AuthenticationFault,
                                    AuthenticationInvalidFault,
                                    UserManagementFault

The portal needs a remote method to retrieve a list of existing groups within the EWA user database

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.
Returns:: result list of group names.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible

5.2.4.23 findGroups

xsd:string[] findGroups(xsd:string adminLogin,
                              xsd:string adminPassword,
                              xsd:string groupNamePattern)
                              throws PortalDisabledFault,
                                     AuthenticationFault,
                                     AuthenticationInvalidFault,
                                     UserManagementFault,
                                     InvalidArgumentsFault

The portal needs a remote method to retrieve a list of existing groups within the EWA user database

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; groupNamePattern - Group name pattern to use to find groups in the user management. Pattern can contain "?" for simple character replacements and "*" for optional characters, e.g. "?oo" and "f*" will find "foo".
Returns:: result list of group names.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable

5.2.4.24 findGroupsByWorkshop

xsd:string[] findGroupsByWorkshop(xsd:string adminLogin,
                                        xsd:string adminPassword,
                                        xsd:string workshopNumber)
                                        throws PortalDisabledFault,
                                               AuthenticationFault,
                                               AuthenticationInvalidFault,
                                               UserManagementFault,
                                               WorkshopDoesNotExistFault,
                                               InvalidArgumentsFault

The portal needs a remote method to retrieve a list of existing groups within a workshop in the EWA user database

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; workshopNumber - Workshop number for which groups are searched.
Returns:: result list of group names.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible; WorkshopDoesNotExistFault - The workshop which is defined as search parameter is not existing in EWA.; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable

5.2.4.25 createWorkshop

xsd:boolean createWorkshop(xsd:string adminLogin,
                       xsd:string adminPassword,
                       xsd:string workshopNumber,
                       xsd:string workshopDescription,
                       xsd:int countryCode,
                       xsd:string partsPricelistName,
                       xsd:int numEpcLicenses,
                       xsd:boolean epcEnabled,
                       xsd:string epcPermissions,
                       xsd:int numWisLicenses,
                       xsd:boolean wisEnabled,
                       xsd:string wisPermissions)
                       throws PortalDisabledFault,
                              AuthenticationFault,
                              AuthenticationInvalidFault,
                              WorkshopExistFault,
                              InvalidArgumentsFault,
                              UserManagementFault

The portal needs a remote method to create a workshop with a set of given attributes within the EWA user database.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; workshopNumber - Name of the group to create; workshopDescription - Description of the new workshop; countryCode - Country code in which this workshop is being created; partsPricelistName - Name of the price-list which should be used by the workshop, can be null.; numEpcLicenses - Number of EPC access authorizations to assign to this workshop; epcEnabled - Flag if EPC should be enabled for this workshop; epcPermissions - String with permissions as bit set to restrict permissions, can be null if workshop permissions should not be restricted. If permissions are defined, it must be a string having at least 80 characters and consists only of "0" and "1" characters representing the bit permissions.; numWisLicenses - Number of WIS access authorizations to assign to this workshop; wisEnabled - Flag if EPC should be enabled for this workshop; wisPermissions - String with permissions as bit set to restrict permissions, can be null if workshop permissions should not be restricted. If permissions are defined, it must be a string having at least 80 characters and consists only of "0" and "1" characters representing the bit permissions.
Returns:: result; true: Success, the workshop was successfully created
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; WorkshopExistFault - The specified workshop already exists, can not be created; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - in user management, creation not possible

5.2.4.26 deleteWorkshop

xsd:boolean deleteWorkshop(xsd:string adminLogin,
                       xsd:string adminPassword,
                       xsd:string workshopNumber)
                       throws PortalDisabledFault,
                              AuthenticationFault,
                              AuthenticationInvalidFault,
                              WorkshopDoesNotExistFault,
                              InvalidArgumentsFault,
                              UserManagementFault,
                              WorkshopNotEmptyFault

The portal needs a remote method to delete a workshop with a set of given attributes within the EWA user database.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; workshopNumber - Name of the workshop to delete
Returns:: result; true: Success, the workshop was successfully deleted
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; WorkshopDoesNotExistFault - The specified workshop does not exist, can not be deleted; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - in user management, creation not possible; WorkshopNotEmptyFault - Groups are still present in the workshop, workshop can not be deleted

5.2.4.27 updateWorkshop

xsd:boolean updateWorkshop(xsd:string adminLogin,
                       xsd:string adminPassword,
                       xsd:string workshopNumber,
                       xsd:string workshopDescription,
                       xsd:int countryCode,
                       xsd:string partsPricelistName,
                       xsd:int numEpcLicenses,
                       xsd:boolean epcEnabled,
                       xsd:string epcPermissions,
                       xsd:int numWisLicenses,
                       xsd:boolean wisEnabled,
                       xsd:string wisPermissions)
                       throws PortalDisabledFault,
                              AuthenticationFault,
                              AuthenticationInvalidFault,
                              WorkshopDoesNotExistFault,
                              InvalidArgumentsFault,
                              UserManagementFault

The portal needs a remote method to update a workshop with a set of given attributes within the EWA user database.

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; workshopNumber - Name of the group to update; workshopDescription - Description of the new workshop; countryCode - Country code in which this workshop is being updated; partsPricelistName - Name of the price-list which should be used by the workshop, can be null.; numEpcLicenses - Number of EPC access authorizations to assign to the workshop; epcEnabled - Flag if EPC should be enabled for this workshop; epcPermissions - String with permissions as bit set to restrict permissions, can be null if workshop permissions should not be restricted. If permissions are defined, it must be a string having at least 80 characters and consists only of "0" and "1" characters representing the bit permissions.; numWisLicenses - Number of WIS access authorizations to assign to the workshop; wisEnabled - Flag if EPC should be enabled for this workshop; wisPermissions - String with permissions as bit set to restrict permissions, can be null if workshop permissions should not be restricted. If permissions are defined, it must be a string having at least 80 characters and consists only of "0" and "1" characters representing the bit permissions.
Returns:: result; true: Success, the group was successfully updated
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; WorkshopDoesNotExistFault - The specified workshop is not existing, can not be updated; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - in user management, creation not possible

5.2.4.28 getWorkshop

com.hp.tis.ewo.portal.beans.WorkshopDetailsBean getWorkshop(xsd:string adminLogin,
                                                            xsd:string adminPassword,
                                                            xsd:string workshopNumber)
                                                            throws PortalDisabledFault,
                                                                   AuthenticationFault,
                                                                   AuthenticationInvalidFault,
                                                                   WorkshopDoesNotExistFault,
                                                                   InvalidArgumentsFault,
                                                                   UserManagementFault

The portal needs to be able to read out the state of a existing workshop

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; workshopNumber - Workshop name to retrieve from user management database
Returns:: Bean with workshop information from the requested workshop number.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; WorkshopDoesNotExistFault - The specified user ID does not exist, can not be fetched; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable; UserManagementFault - Problem in user management, fetch not possible

5.2.4.29 getWorkshops

xsd:string[] getWorkshops(xsd:string adminLogin,
                                xsd:string adminPassword)
                                throws PortalDisabledFault,
                                       AuthenticationFault,
                                       AuthenticationInvalidFault,
                                       UserManagementFault

The portal needs a remote method to retrieve a list of existing workshops within the EWA user database

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.
Returns:: result list of workshop numbers.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible

5.2.4.30 findWorkshops

xsd:string[] findWorkshops(xsd:string adminLogin,
                                 xsd:string adminPassword,
                                 xsd:string workshopNumberPattern)
                                 throws PortalDisabledFault,
                                        AuthenticationFault,
                                        AuthenticationInvalidFault,
                                        UserManagementFault,
                                        InvalidArgumentsFault

The portal needs a remote method to retrieve a list of existing workshops within the EWA user database

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance
Note:
This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; workshopNumberPattern - Workshop number pattern to use to find groups in the user management. Pattern can contain "?" for simple character replacements and "*" for optional characters, e.g. "?oo" and "f*" will find "foo".
Returns:: result list of workshop numbers.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable

5.2.5

5.2.5.1 terminateUserSession

xsd:boolean terminateUserSession(xsd:string adminLogin,
                                 xsd:string adminPassword,
                                 xsd:string userLogin,
                                 xsd:int applicationID)
                                 throws PortalDisabledFault,
                                        AuthenticationFault,
                                        AuthenticationInvalidFault,
                                        UserManagementFault,
                                        InvalidArgumentsFault

This method terminates an open WIS or EPC session for a perticular user

Parameters:: adminLogin - Valid Administrator login to authenticate the web service call against the server instance; adminPassword - Corresponding password of the administrator account which is required to authenticate this call against the server instance; Note: This must be an already encrypted password for this user (encrypted by use of the EWA password encryption). Plain passwords in this call will not succeed.; userLogin - The users login which Session should be terminated; applicationID - The application which should be terminated. The value must be 50 for WIS or 150 for EPC

Returns:: result list of workshop numbers.
Throws:: PortalDisabledFault - Portal interface is disabled by configuration; AuthenticationFault - Problem during authentication of Administrator; AuthenticationInvalidFault - Administrator Authentication is invalid; UserManagementFault - in user management, creation not possible; InvalidArgumentsFault - Submitted parameters are not complete, provided information is not acceptable

5.2.6 5.2.7 Complex Types

The following complex types were required to be defined in the interface:

Type Name	WSDL Definition	Description / Use
activationOptionDetails	<complexType name="activationOptionDetails"> <sequence> <element name="description" nillable="true" type="xsd:string"/> <element name="displayLabel" nillable="true" type="xsd:string"/> <element name="id" type="xsd:int"/> </sequence> </complexType>	Return value for getActivationOptions method.
countryDetails	<complexType name="countryDetails"> <sequence> <element name="ISO3166Code" nillable="true" type="xsd:string"/> <element name="countryCode" type="xsd:int"/> <element name="localizedCountryName" nillable="true" type="xsd:string"/> <element name="originalCountryName" nillable="true" type="xsd:string"/> </sequence> </complexType>	Return value for getCountryCodes method.
licenseDurationDetails	<complexType name="licenseDurationDetails"> <sequence> <element name="displayLabel" nillable="true" type="xsd:string"/> <element name="duration" type="xsd:long"/> </sequence> </complexType>	Return value for getLicenseDurations method.
licenseTypeDetails	<complexType name="licenseTypeDetails"> <sequence> <element name="display" nillable="true" type="xsd:string"/> <element name="name" nillable="true" type="xsd:string"/> </sequence> </complexType>	Return value for getLicenseTypes method.
user	<complexType name="user"> <sequence> <element name="activationDuration" type="xsd:long"/> <element name="activationStart" nillable="true" type="xsd:dateTime"/> <element name="countryCode" type="xsd:int"/> <element name="department" nillable="true" type="xsd:string"/> <element name="email" nillable="true" type="xsd:string"/> <element name="fax" nillable="true" type="xsd:string"/> <element name="firstName" nillable="true" type="xsd:string"/> <element name="groupName" nillable="true" type="xsd:string"/> <element name="lastName" nillable="true" type="xsd:string"/> <element name="login" nillable="true" type="xsd:string"/> <element name="password" nillable="true" type="xsd:string"/> <element name="phone" nillable="true" type="xsd:string"/> <element name="workshopNumber" nillable="true" type="xsd:string"/> </sequence> </complexType>	Return value for getUser method.
group	<complexType name="group"> <sequence> <element name="description" nillable="true" type="xsd:string"/> <element name="epcEnabled" type="xsd:boolean"/> <element name="epcPermissions" nillable="true" type="xsd:string"/> <element name="groupName" nillable="true" type="xsd:string"/> <element name="wisEnabled" type="xsd:boolean"/> <element name="wisPermissions" nillable="true" type="xsd:string"/> <element name="workshopNumber" nillable="true" type="xsd:string"/> </sequence> </complexType>	Return value for getGroup method.
workshop	<complexType name="workshop"> <sequence> <element name="countryCode" type="xsd:int"/> <element name="description" nillable="true" type="soapenc:string"/> <element name="epcEnabled" type="xsd:boolean"/> <element name="epcPermissions" nillable="true" type="soapenc:string"/> <element name="numEpcLicenses" type="xsd:int"/> <element name="numWisLicenses" type="xsd:int"/> <element name="partsPricelist" nillable="true" type="soapenc:string"/> <element name="wisEnabled" type="xsd:boolean"/> <element name="wisPermissions" nillable="true" type="soapenc:string"/> <element name="workshopNumber" nillable="true" type="soapenc:string"/> </sequence> </complexType>	Return value for getWorkshop method.

5.2.8 Faults

The following faults are defined and returned by the Web Services interface:

Fault Name	WSDL Definition	Description / Use
ApplicationStartFault	<complexType name="ApplicationStartFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	Application start could not be processed, maybe WIS or EPC are not working correctly.
AuthenticationFault	<complexType name="AuthenticationFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	Problems during authentication, details contained in the fault string
AuthenticationInvalidFault	<complexType name="AuthenticationInvalidFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	Problems during authentication, details contained in the fault string
GroupDoesNotExistFault	<complexType name="GroupDoesNotExistFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	The specified group does not exist
GroupExistFault	<complexType name="GroupExistFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	The specified group exists and can not be created again
GroupNotEmptyFault	<complexType name="GroupNotEmptyFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	The specified group contains users and can not be deleted
InvalidArgumentsFault	<complexType name="InvalidArgumentsFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	Submitted parameters are not complete, provided information is not acceptable
NoLicenseAvailableFault	<complexType name="NoLicenseAvailableFault"> <complexContent> <extension base="impl:PortalFault"> <sequence> <element name="lockedHost" nillable="true" type="xsd:string" /> <element name="lockedTime" type="xsd:long" /> <element name="reasonCode" type="xsd:int" /> </sequence> </extension> </complexContent> </complexType>	The Application could not be started because of a problem with the license. The reason code contains one of the following IDs: Workshop is over-allocated, so a license can not be locked Server license pool is over-allocated, no new application session is allowed to start User has already an application session running, he is not allowed to start a new instance. The lockedHost if the hostname or IP of the host which previously locked the license and lockedTime is the time (milliseconds after 1 Jan 1970) when the license was locked License can not be locked in License pool as license pool connectivity is broken
NoPermissionFault	<complexType name="NoPermissionFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	User has no permissions for application
PortalDisabledFault	<complexType name="PortalDisabledFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	Portal interface is disabled by configuration
PortalFault	<complexType abstract="true" name="PortalFault"> <sequence> <element name="cause" nillable="true" type="xsd:anyType"/> <element name="message" nillable="true" type="xsd:string"/> </sequence> </complexType>	Base abstract fault which every detailed fault is based on.
ServerLicenseExhaustedFault	<complexType name=""> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	Server access authorization is exhausted
UserActivationExpiredFault	<complexType name="UserActivationExpiredFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	Activation of user has expired or is invalid
UserExistsFault	<complexType name="UserExistsFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	The specified user ID already exists, can not be created
UserManagementFault	<complexType name="UserManagementFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	Problem in user management, e.g. User Management database not available
UserNotActiveFault	<complexType name="UserNotActiveFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	Activation of user has not started yet
UserNotExistFault	<complexType name="UserNotExistFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	The specified user ID does not exist, can not be changed
WorkshopDoesNotExistFault	<complexType name="WorkshopDoesNotExistFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	The specified workshop does not exist
WorkshopExistFault	<complexType name="WorkshopExistFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	The specified workshop exists, can not be created again
WorkshopNotEmptyFault	<complexType name="WorkshopNotEmptyFault"> <complexContent> <extension base="impl:PortalFault"> <sequence/> </extension> </complexContent> </complexType>	The specified workshop contains groups and can not be deleted

5.3 Backup and Restore the user management database

To perform this action, simply navigate via the menu to "Server Management -> Backup and Restore Core Database".

EWA allows you to easily backup the current content (not the data model) of your user management database which is mainly your user data and data that the client applications use (like shopping lists, user notes,...)

Note:
The backup cannot and will not replace backups you make on the DBMS level or the Operation System level. It only saves content of the user management database which can only be restored as long as you have a valid database schema setup.

Note:
Due to the large sizes the Parts Pricelists can grow to, these will not be part of backups. They simply will not be affected by the Backup and Restore functionality. This in turn means that after a successful restore of a database you will have to at least re-assign existing old Parts Pricelists to Workshops or even re-import and assign Pricelists to workshops again.

This functionality is available via the menu Server -> Backup and restore user database. You can (optionally) provide a short name and a description for this backup which makes it easier for you to find out, what the content of the backup really is.

Backup data will be stored by default into the directory. Each backup set has its own directory below this.

[EWA_HOME]\ewa_backup

You can save the data away from here.

If you have backups already available they will be shown in the lower list (as can seen in the screen above). Just click on "Restore" for the data you would like to restore.

Note:
You will only be able to restore backup data from the same database schema version. The "Restore" button will indicate whether a restore will be possible. Data from previous database versions cannot be imported due to changes in the data model.

5.4 Parts Pricelist Administration

EPC allows the display of price information for parts once

a pricelist has been loaded by an administrator
it has been assigned to one or more workshops (or it has been assigned the "default" pricelist)
the user has the pricelist functionality enabled within EPC (see EPC's "options" menu).

EWA allows following file formats to be imported:

5.4.1 Files exported from official Daimler price CD

This format - according to Daimler in Germany - was already used for EPC FP. It could be created by a conversion tool from the official price CDs from Daimler. EWA can basically read this export, but a currency information has to be applied to the first line of the file.

The format of such a pricelist file is ASCII and internally formatted like this:

First line:
This line contains just the currency that the price tags have to be interpreted with.
Simply a line could look like this: "US$"
All subsequent lines have the same format, where the price tags must have a , (comma) character as the decimal separator e.g. $6.54 should be written as "6,54"
"<PartNo>";"<Description>";"<Price 1>";"<Discount Group>";"<Price 2>";"<Price 3>"
The PartNo and the Price 1 tags are required. Price 2 and Price 3 tags will be used if present but can be empty. If left empty the semicolon still has to be provided as item separator.
The Description and Discount Group may be filled with data or left empty. If left empty the semicolon still has to be provided as item separator. Either way the Description and Discount Group values are NOT used in the EWA internal pricelists and will be ignored.
e.g. A minimal record for PartNo A0000003303 and Price 1 63.90 would look like this "A0000003303";;"63,9";;;

Note: Descriptions including the " (quotes) character must mark-up this character by placing an extra " (quotes) charater before it e.g. for the Description The "red" button you would have to write "The ""red"" button" As described above the Description value will be ignored anyway however if present it must still conform to this rule.

Thus a valid extract of a file could look like this:

US$
"A0000003303";"DAEMPFUNG 1500X1000X25 M";"63,9";"1";;
"A0000007903";"SCHIENE DOPPEL C-PROFIL 1";"13,7";"1";;
"A0000003304";"DAEMPFUNG 1500X1000X30 M";"67,7";"1";;
"A0000006404";"PVC-BODENBELAG TARABUS PL";"63";"1";;
"A0000005207";"HINWEISSCHILD";"1,48";"1";;
"A0000007411";"PUMPE";"541,97";"1";;
"A0000007618";"LINSEN-FLANSCHKOPFSCHRAU";"0,39";"1";;
"A0000007525";"THERMO-VENTIL";"123,5";"1";;
"A1990000227";"GETRIEBEHALTER";"530";"3";;
"A0000006034";"SCHWEISS-SCHNUR CR 40 RE";"31,76";"1";;
"A6270000035";"LU ANTRIEBSACHSE/PORTALAC";"17360";"2";;
"A6270000335";"LU ANTRIEBSACHSE/PORTALAC";"13740";"2";;
"A6270000435";"LU ANTRIEBSACHSE/PORTALAC";"17920";"2";;

5.4.2 Files exported from SPICS

Additionally to the file format specified above the files exported from SPICS can be read directly without further modification. It is recommended that you give the files the extension ".spics". Files with this extension are known to EWA and allow EWA to check for a currency information within the filename if the file is not intended for the currency Euro (€).

Note:
SPICS files allow to provide a currency information for each line. But EWA needs the currency information per a whole pricelist file. Thus EWA determines the currency from the first line of a SPICS file.

Note:
SPICS provides a very simple currency information only. Either the prices are in Euro (€) - then a distinct record in a line shows the character "E". Or it is a country specific currency which the file gives no information about - then the currency indicator is simply blank.
In the latter case you can easily provide the currency information to EWA by a simple naming scheme for the file. Just name your file like this:

<somefilename without '.'>.<currency-symbol>.spics

An example for Britisch Pound will be:

uk_pricelist.UK₤.spics

EWA supports SPICS files (8 Bit ASCII) with record length 150 (the official format), 68 and 53 (both of the latter found i.e. in the UK).

In SPICS files only the PartNo, Price1 and Currency data will be evaluated.

Samples of such SPICS price files are as follows:

Example file with record length 150:

A1660310171        00000004001PX0000410000000S   00201BOUT                     SCHRAUBE C84                                      1     E73181569000001
A1350320004        0000001836SPP1500410000000    00201POELIE                   RIEMENSCHEIBE                                     0     E84835080000006
A6400330101  52    00000006391PX0000410000000S   00201LAGERHELFT               KW-LAGERHAELFTE                                   0     E84833080000000
A6400330101  54    00000006741PX0000410000000S   00201LAGERHELFT               KW-LAGERHAELFTE                                    0     E84833080000000
A6400330101  56    00000006741PX0000410000000S   00201LAGERHELFT               KW-LAGERHAELFTE                                    0     E84833080000000
A6400331202  52    00000011301PX0000410000000S   00201LAGERHELFT               KW-LAGERHAELFTE                                   0     E84833080000000

For records with line length 150 the following are evaluated:

Characters at positions 1-19 (The first 19 characters characters of the line) are the PartNo
Characters at positions 20-29 (10 characters) are Price 1
The Character at position 136 is the Currency

Example file with record length 68:

A0000006323        000000006401WELLSCHLAUCH   200000 WELLSCHLAUCH  
A1580001381        000000000001BRAND-NEW-PART 100000 BRAND-NEW-PART
A4540001599        000002285732OPERATING INSTRSPZB4P OPERATING INSTR
A4540001699        000003837832GUMMED LABEL   SPZB4D GUMMED LABEL  
A4540001799        000001341932HELICAL SPRING SPZB4D HELICAL SPRING

For records with line length 68 or line length 53 the following are evaluated:

Characters at positions 1-19 (The first 19 characters characters of the line) are the PartNo
Characters at positions 20-29 (10 characters) are Price 1
The Character at position 53 is the Currency

Note:
Part numbers in the price list files must be unique. If the same part number appears multiple times in the file the import cannot and will not succeed!

The maintenance screen can be reached by navigation in the menu "Server Management -> Parts Pricelist Administration".

The screen is split into two areas:

Already imported and available Parts Pricelists in the upper area
Parts Pricelists which are available in the import section of your server for Parts Pricelists in the lower area.
The directory which will be scanned by EWA for importable Parts Pricelists is
[EWA_HOME]\ewa_pricelists

Once you have created (and adjusted) a Pricelist file, simply put it into the pricelist directory of your server. Once their refresh the screen and your will see that the file will be listed. In the colum named "Action" you will see a button named "Import" (Icon: ). This indicates that no other Pricelist with that name has been imported into EWA up to now. So click on it now and import it. A message box will warn you that you should not interrupt this process once started. It may take several minutes for a large file.

As soon as this process finished successfully you will get a success message and you will be redirected again to the screen above. Now you see that in the top level area your pricelist file will be listed as imported. In the lower area it will still be found as it was not removed by the import. But the "Action" now has changed from "Import" to "Update" (Icon: ). Why? Because the Pricelist with this name is now known to EWA and if you want to perform updates on this Pricelist, just change the content of the file and re-import it. The assignment of this pricelist to any workshop does not have to be changed.

The toplevel area allows some other actions on the already imported pricelists:

Delete:
Allows you to delete the given Pricelist. You will be asked for confirmation.
Make Default:
By clicking on the radio button next to an imported pricelist you can Make the given pricelist the default one for all workshops which have no pricelist explicitly assigned. You will be asked for confirmation. Only one pricelist can be the default.
Unset Default:
By clicking an already selected radion button again you may remove the "default" property from a pricelist. After this operation no pricelist will be the default and workshops which have no pricelist assigned will not have any pricing information for parts. You will be asked for confirmation.
Delete all Parts Pricelists:
Remove all the current imported Parts Pricelists from the database. You will be asked for confirmation.

Once you completed this step you may want to explicitly assign Pricelists to Workshops. This can be achieved for each Workshop individually by use of the Workshop Administration mask.

5.5 Access to application's statistic data

EWA allows access to some statistical data. Currently WIS traces access to documents in the core database. On a regular cycle this information will be removed from the database.

Administrators have access to a file download of the current statistic data via the Downloads section. Just click on the link to start the download. A file format "comma separated values" (CSV) will be sent to the browser which will in turn offer you to download or open it. If you have Microsoft Excel installed you will be prompted to open it directly in Excel.

The page looks like this:

5.6 Editorial Support for Market Notes

Besides the import for Market Notes it is also possible to edit Market Notes in EPC. Only specia users are able to edit these notes. If you just want to import Market Notes into your EWA system, please take a look to Import of Market Specific Notes chapter.

Editorial support for Market Notes is usually disabled by configuration. This feature needs to be manually enabled. This configuration option resides in [EWA_HOME]\config\um_cfg.xml. Please change the following setting:

   <SECTION name="General">
        (...)
                <!-- MPC Notes Editorial Support, valid options are true/false -->
                <PARAMETER name="marketNotesEditorialSupport">true</PARAMETER>
        (...)

This setting changes the following behavior in the system:

It is possible to define special users which are allowed to edit Market Notes
It is possible to export Market Notes

To enable special Market Notes edit users you need to enable Market Notes Editorial support as described above. After the server has been restarted, you will notice that the options of each user have further possibilities to mark the role of the user. You need to place a checkmark in the "Maintain Market Notes" selection.

Note:
Each user which is able to maintain Market Notes will just be able to edit Market Notes. The usual User Notes interface will be re-used to edit Market Notes. Please take a look to the EPC online help for further details. Each user which has the permission to edit Market Notes is editing the notes of country where the user is assigned to.

To export Market Notes for distribution to EWA installation sites you need to go to the Market Notes maintenance screen located at "Administration -> Server -> Maintain Market Notes". With the Market Notes editorial support option enabled you'll see a additional column in the overview table to export the market notes data. click on the export icon to export the data as XML file.

You need to distribute the Market Notes export files to all EWA locations manually and the run a import.

5.7 Show server log files

Typically an EWA administrator in recent versions of EWA only had access to the server log files when working on the server itself having file access to the filesystem. EWA now also allows all users with user role "ServerAdmin" to display server logfiles via the menu item "Administration -> Server -> Show server log files". This option lists all the files available below the directory [EWA_HOME]\logs. A click on a file name will open it within a separate browser window. If you want to download a file to your local filesystem just right click on the name and choose "Save as..." from the browser context menu.

5.8 Logoff / Session timeout / Automatic Logoff

On any page the administrator can choose to logoff by clicking the "Logoff" button of the menu. The user will be logged off from the system and must re-logon to continue performing tasks.

You may notice that it happens that you click on some menu item after a period of incactivity and the following screen appears:

This indicates that the system has been idle for more than the configured timeout of the application. This is a security mechanism as HTTP is a stateless protocol and thus the server will not be able to determine whether you are still active or you already have gone away, but missed to close your browser or simply forgot to log off.

The timeout period is set to 30 minutes by default, but can be configured if desired by editing the file
[EWA_HOME]\webapps\EWA-net\WEB-INF\web.xml.

Note:
This is not an officially supported configuration item and will be overridden by each an every update of the EWA software.

Here is the relevant item to be changed (values are in minutes, "0" means that no session timeout will occur - which is not recommended!):

  <session-config>
    <session-timeout>30</session-timeout>
  </session-config>