Skip navigation.

eDocs Home > BEA WebLogic Network Gatekeeper 1.0 Documentation > User's Guide > Service Provider and Application Administration

User's Guide

  Previous Next vertical dots separating previous/next from contents/index/pdf Contents View as PDF  
Get
Adobe Reader

Service Provider and Application Administration

The following sections describe hot to administer service providers and applications:

 

About service provider and application administration

Administration model

BEA WebLogic Network Gatekeeper handles service providers and their applications (client applications). The service providers are registered as service provider accounts. The service providers' applications are registered as application accounts. An application account is always tied to specific service provider account. The administration model is shown in Figure 5-1, Service provider and application administration model., on page 5-4.

For each application account, one or more application instance groups have to be created. All application users log in to BEA WebLogic Network Gatekeeper through an application instance group. That is, the application instance group and a password identify the users origin. The application instance groups can be used for separating users from different organizations using the same application (but different instances) to access BEA WebLogic Network Gatekeeper.

An example of this is office type applications where each user has its own installation. Using application instance groups, it is possible to separate the different locations/organizations where the application is used and to regulate how many concurrent users are allowed on each location/organization.

If the application is a network initiated application, the normal case is to have one application instance group for all users.

To simplify the administration, it is possible to group service providers and applications with similar usage and charging characteristics. This is achieved through creating service provider and application groups. A group contains a Service Level Agreement (SLA) that is used by all service providers or applications in the group.

Changes in a group SLA affects all service provider accounts or application accounts in the group. It is also possible to move an account from one group to another and there by change the SLA to be used for the service provider or application.


 

Overall workflow

The main workflow when creating a service provider account with a number of application accounts is outlined below:

  1. Create the service provider group with SLA (optional, only if a suitable service provider group has not already been created)
  2. Create service provider account
  3. Create application groups with SLAs (optional, only if suitable application groups have not already been created)
  4. Create application accounts and application instance groups with SLAs

 

Creating a service provider group

Follow the instruction below to create a service provider group. The service provider group contains a SLA that can be used by one or more service provider accounts.

  1. Star t an Network Gatekeeper Management Tool and log in.
  2. Select a SLEE where the ESPA access service is installed.
  3. Double-click the ESPA_access service.

    4. Decide a suitable service provider group ID

  4. Decide a suitable (descriptive) ID for the service provider group according to your naming conventions.

    5. Verify that the ID is not used

  5. Double-click the getNumberOfServiceProviderGroups method.
  6. Click Invoke.

    7. The total number of service provider groups in the system is displayed.

  7. Double-click the listServiceProviderGroups method.
  8. List a reasonable number of service provider group IDs. Enter the range.
  9. Click Invoke.

    10. The selected number of service provider group IDs are displayed in alphabetic order. If the ID you want to use does not fit within the range, select a new range. When the correct range is displayed, verify that the ID you want to use is not in the list.

    Create service provider group SLA

  10. See Writing Service Level Agreements.

    11. Create service provider group

  11. Double-click the addServiceProviderGroupWithSLAUrl method.
  12. Enter the ID selected for the service provider group and, in the slaContents field, the URL for the SLA file.

    13. Note: Do not enter any OAM properties. OAM properties can only be set from an integrated PRM/CRM system.

  13. Click Invoke.

    14. The service provider group is now created. To add service provider accounts to the service provider group, see Creating a service provider account.

 

Identifying a service provider group

Follow the instruction below to identify a service provider group ID.

  1. Start an Network Gatekeeper Management Tool and log in.
  2. Select a SLEE where the ESPA access service is installed.
  3. Double-click the ESPA_access service.
  4. Double-click the getNumberOfServiceProviderGroups method.
  5. Click Invoke.

    6. The number of service provider groups in the system is displayed.

  6. Double-click the listServiceProviderGroups method.
  7. List a reasonable number of service provider group IDs. Enter the range.
  8. Click Invoke.

    9. The selected number of service provider group IDs are displayed in alphabetic order. If the desired ID is not within the range, select a new range. When the correct range is displayed, verify the ID of the service provider group.

 

Viewing information about a service provider group

Follow the instruction below to view information about a service provider group. The following types of information can be viewed independently of each other:

  1. See Identifying a service provider group.

    2. View data

  2. Double-click the getServiceProviderGroup method.
  3. Enter the service provider group ID.
  4. Click Invoke.

    5. The service provider group's SLA and OAM properties, if any, are displayed.

    View SLA

    Note, it is also possible to view the original XML SLA file.

  5. Double-click the getSLAForServiceProviderGroup method.
  6. Enter the service provider group ID.
  7. Click Invoke.

    8. The service provider group's SLA is displayed.

    List related service provider accounts

  8. Double-click the getNumberOfServiceProvidersInGroup method.
  9. Enter the service provider group ID.
  10. Click Invoke.

    11. The number of service provider accounts related to the service provider group is displayed.

  11. Double-click the listServiceProvidersInGroup method.
  12. List a reasonable number of service provider account IDs. Enter the service provider group ID and the range.
  13. Click Invoke.

    14. The selected number of service provider group IDs are displayed in alphabetic order.

 

Updating the SLA for a service provider group

Follow the instruction below to update the SLA for a service provider group.

Identify the service provider group

  1. See Identifying a service provider group.

    2. View current SLA

    Note, it is also possible to view the original XML SLA file.

  2. Double-click the getServiceProviderGroup method.
  3. Enter the service provider group ID.
  4. Click Invoke.

    5. The service provider group's SLA is displayed.

    Update SLA

  5. Update the SLA, see Writing Service Level Agreements.
  6. Double-click the updateServiceProviderGroupSLAUrl method.
  7. Enter the service provider group ID and, in the slaContents field, the URL for the SLA file.

    8. Note: Do not enter any OAM properties. OAM properties can only be set from an integrated PRM/CRM system.

  8. Click Invoke.

    9. The service provider group's SLA is now updated and in use.

 

Deleting a service provider group

Follow the instruction below to delete a service provider group.

Note: When deleting the service provider group, all related service provider accounts, application accounts and application instance groups will also be deleted.

Identify the service provider group

  1. See Identifying a service provider group.

    2. Delete service provider group

  2. Double-click the deleteServiceProviderGroup method.
  3. Enter the service provider group ID.
  4. Click Invoke.

    5. The service provider group is now deleted.

 

Creating a service provider account

Follow the instruction below to create a service provider account. Note, the service provider group the service provider account shall be connected to must have been created before the service provider account is created.

Identify the service provider group

  1. See Identifying a service provider group.

    2. Decide a suitable service provider account ID

  2. Decide a suitable (descriptive) ID for the service provider account according to your naming conventions.

    3. Verify that the ID is not used

  3. Double-click the getNumberOfServiceProvidersInGroup method.
  4. Enter the service provider group ID.
  5. Click Invoke.

    6. The number of service provider accounts connected to the service provider group is displayed.

  6. Double-click the listServiceProvidersInGroup method.
  7. List a reasonable number of service provider account IDs. Enter the service provider group ID and the range.
  8. Click Invoke.

    9. The selected number of service provider account IDs are displayed in alphabetic order. If the ID you want to use does not fit within the range, select a new range. When the correct range is displayed, verify that the ID you want to use is not in the list.

    Create service provider account

  9. Double-click the addServiceProviderAccount method.
  10. Enter the service provider group ID and the selected service provider account ID.
  11. Click Invoke.

    12. The service provider account is now created. To add application accounts to the service provider account. See Creating an application account.

    The service provider account has to be activated before the service provider's applications can access any services in the network. See Activating a service provider account.

 

Identifying a service provider account ID

Follow the instruction below to identify a service provider account ID.... through the service provider group

  1. Start an Network Gatekeeper Management Tool and log in.
  2. Select a SLEE where the ESPA access service is installed.
  3. Double-click the ESPA_access service.

    4. Identify the service provider group

  4. Double-click the getNumberOfServiceProviderGroups method.
  5. Click Invoke.

    6. The total number of service provider groups in the system is displayed.

  6. Double-click the listServiceProviderGroups method.
  7. List a reasonable number of service provider group IDs. Enter the range.
  8. Click Invoke.

    9. The selected number of service provider group IDs are displayed in alphabetic order. If the desired ID is not within the range, select a new range. When the correct range is displayed, verify the ID of the service provider group.

    Identify the service provider account

  9. Double-click the getNumberOfServiceProvidersInGroup method.
  10. Enter the service provider group ID.
  11. Click Invoke.

    12. The number of service provider accounts related to the service provider group is displayed.

  12. Double-click the listServiceProvidersInGroup method.
  13. List a reasonable number of service provider account IDs. Enter the service provider group ID and the range.
  14. Click Invoke.

    15. The selected number of service provider account IDs are displayed in alphabetic order. If the desired ID is not within the range, select a new range. When the correct range is displayed, verify the ID of the service provider account.

 

Activating a service provider account

Follow the instruction below to activate a service provider account. The service provider account has to be activated before any of its applications can start accessing services in the network.

Identify the service provider account

  1. See Identifying a service provider account ID.

    2. View current state

  2. Double-click the getStateForServiceProviderAccount method.
  3. Enter the service provider account ID.
  4. Click Invoke.

    5. The service provider account's current state is displayed.

    Activate service provider account

  5. Double-click the activateServiceProviderAccount method.
  6. Enter the service provider account ID.
  7. Click Invoke.

    8. The service provider account's state is changed to activated.

 

Viewing information about a service provider account

Follow the instruction below to view information about a service provider account. The following types of information can be viewed independently of each other:

  1. See Identifying a service provider account ID.

    2. View data

  2. Double-click the getServiceProviderAccount method.
  3. Enter the service provider account ID.
  4. Click Invoke.

    5. The related service provider group's ID and the account's OAM properties, if any, are displayed.

    View state

  5. Double-click the getStateForServiceProviderAccount method.
  6. Enter the service provider account ID.
  7. Click Invoke.

    8. The service provider account's current state is displayed.

    View SLA

    The SLA is related to the service provider group. To view the SLA, the service provider group ID is needed. See View data.

    Note, it is also possible to view the original XML SLA file.

  8. Double-click the getSLAForServiceProviderGroup method.
  9. Enter the service provider group ID.
  10. Click Invoke.

    11. The SLA is displayed.

    List related application accounts

  11. Double-click the getNumberOfApplicationsInServiceProvider method.
  12. Enter the service provider account ID.
  13. Click Invoke.

    14. The number of application accounts connected to the service provider account is displayed.

  14. Double-click the listApplicationAccountsForServiceProvider method.
  15. List a reasonable number of application account IDs. Enter the service provider account ID and the range.
  16. Click Invoke.

    17. The selected number of application account IDs are displayed in alphabetic order.

 

Changing data (SLA) for a service provider account

Follow the instruction below to change the service provider group for a service provider account. That is, by changing the service provider group the SLA used for the service provider account is changed.

Identify the service provider account

  1. See Identifying a service provider account ID.

    2. View current service provider account data

  2. Double-click the getServiceProviderAccount method.
  3. Enter the service provider account ID.
  4. Click Invoke.

    5. The related service provider group's ID and the account's OAM properties, if any, are displayed.

    Change service provider account data (SLA)

  5. Double-click the updateServiceProviderAccount method.
  6. Enter the service provider account ID and a new service provider group ID.
  7. Click Invoke.

    8. The related service provider group (SLA) is changed.

 

Logging out a service provider account

Follow the instruction below to log out a service provider account. That is, to log out all application instance group users related to the service provider account.

To log out all application instance group users related to an application account or an application instance group, see Logging out an application account and Logging out an application instance group respectively.

Identify the service provider account

  1. See Identifying a service provider account ID.

    2. Log out service provider account

  2. Double-click the logoutServiceProviderAccount method.
  3. Enter the service provider account ID.
  4. Click Invoke.

    5. All application instance group users related to the service provider account are logged out.

 

Deactivating a service provider account

Follow the instruction below to deactivate a service provider account. That is, to temporarily stop the traffic to/from the service provider's applications.

Identify the service provider account

  1. See Identifying a service provider account ID.

    2. View current state

  2. Double-click the getStateForServiceProviderAccount method.
  3. Enter the service provider account ID.
  4. Click Invoke.

    5. The service provider account's current state is displayed.

    Deactivate service provider account

  5. Double-click the deactivateServiceProviderAccount method.
  6. Enter the service provider account ID.
  7. Click Invoke.

    8. The service provider account's state is changed to deactivated.

 

Deleting a service provider account

Follow the instruction below to delete a service provider account.

Note: When deleting the service provider account, all related application accounts and application instance groups will also be deleted.

Identify the service provider account

  1. See Identifying a service provider account ID.

    2. Delete service provider account

  2. Double-click the deleteServiceProviderAccount method.
  3. Enter the service provider account ID.
  4. Click Invoke.

    5. The service provider account and all related application accounts and application instance groups are deleted.

 

Creating an application group

Follow the instruction below to create an application group. The application group contains a SLA that can be used by one or more application accounts.

  1. Start an Network Gatekeeper Management Tool and log in.
  2. Select a SLEE where the ESPA access service is installed.
  3. Double-click the ESPA_access service.

    4. Decide a suitable application group ID

  4. Decide a suitable (descriptive) ID for the application group according to your naming conventions.

    5. Verify that the ID is not used

  5. Double-click the getNumberOfApplicationGroups method.
  6. Click Invoke.

    7. The number of application groups in the system is displayed.

  7. Double-click the listApplicationGroups method.
  8. List a reasonable number of application group IDs. Enter the range.
  9. Click Invoke.

    10. The selected number of application group IDs are displayed in alphabetic order. If the ID you want to use does not fit within the range, select a new range. When the correct range is displayed, verify that the ID you want to use is not in the list.

    Create application group SLA

  10. See Writing Service Level Agreements.

    11. Create application group

  11. Double-click the addApplicationGroupWithSLAUrl method.
  12. Enter the ID selected for the application group and, in the slaContents field, the URL for the SLA file.

    13. Note: Do not enter any OAM properties. OAM properties can only be set from an integrated PRM/CRM system.

  13. Click Invoke.

    14. The application group is now created. To add application accounts to the application group, see Creating an application account.

 

Identifying an application group

Follow the instruction below to identify an application group ID.

  1. Start an Network Gatekeeper Management Tool and log in.
  2. Select a SLEE where the ESPA access service is installed.
  3. Double-click the ESPA_access service.
  4. Double-click the getNumberOfApplicationGroups method.
  5. Click Invoke.

    6. The number of application groups in the system is displayed.

  6. Double-click the listApplicationGroups method.
  7. List a reasonable number of application group IDs. Enter the range.
  8. Click Invoke.

    9. The selected number of application group IDs are displayed in alphabetic order. If the desired ID is not within the range, select a new range. When the correct range is displayed, verify the ID of the application group.

 

Viewing information about an application group

Follow the instruction below to view information about an application group. The following types of information can be viewed independently of each other:

  1. See Identifying an application group.

    2. View data

  2. Double-click the getApplicationGroup method.
  3. Enter the application group ID.
  4. Click Invoke.

    5. The application group's SLA and OAM properties, if any, are displayed.

    View SLA

    Note, it is also possible to view the original XML SLA file.

  5. Double-click the getSLAForApplicationGroup method.
  6. Enter the application group ID.
  7. Click Invoke.

    8. The application group's SLA is displayed.

    List related application accounts

  8. Double-click the getNumberOfApplicationsInApplicationGroup method.
  9. Click Invoke.

    10. The number of application accounts related to the application group is displayed.

  10. Double-click the listApplicationAccountsInGroup method.
  11. List a reasonable number of application account IDs. Enter the application group ID and the range.
  12. Click Invoke.

    13. The selected number of application account IDs are displayed in alphabetic order.

 

Updating SLA for an application group

Follow the instruction below to update the SLA for a application group.

Identify the application group ID

  1. See Identifying an application group.

    2. View current SLA

    Note, it is also possible to view the original XML SLA file.

  2. Double-click the getApplicationGroup method.
  3. Enter the application group ID.
  4. Click Invoke.

    5. The application group's SLA is displayed.

    Update SLA

  5. Update the SLA, see Writing Service Level Agreements.
  6. Double-click the updateApplicationGroupSLAUrl method.
  7. Enter the application group ID and, in the slaContents field, the URL for the SLA file.

    8. Note: Do not enter any OAM properties. OAM properties can only be set from an integrated PRM/CRM system.

  8. Click Invoke.

    9. The application group's SLA is now updated and in use.

 

Deleting an application group

Follow the instruction below to delete an application group.

Note: When deleting the application group, all related application accounts and application instance groups will also be deleted.

Identify the application group

  1. See Identifying an application group.

    2. Delete application group

  2. Double-click the deleteApplicationGroup method.
  3. Enter the application group ID.
  4. Click Invoke.

    5. The application group and the related application accounts and application instance groups are now deleted.

 

Creating an application account

Follow the instruction below to create an application account. Note, the service provider account and application group the application account shall be connected to must have been created before the application account is created.

In addition you also have to set up the connection with the application, see Application Connection - ESPA Java and Application Connection - Web Services respectively.

Identify the service provider account

  1. Identify the ID of the service provider account you want to connect the application account to. See Identifying a service provider account ID.

    2. Identify the application group

  2. Identify the ID of the application group containing the SLA you want to use for the application account. See Identifying an application group.

    3. Decide a suitable application account ID

  3. Decide a suitable (descriptive) ID for the application account according to your naming conventions.

    4. Verify that the ID is not used

  4. Double-click the getNumberOfApplicationsInServiceProvider method.
  5. Enter the service provider account ID.
  6. Click Invoke.

    7. The number of application accounts connected to the service provider account is displayed.

  7. Double-click the listApplicationAccountsForServiceProvider method.
  8. List a reasonable number of application account IDs. Enter the service provider account ID and the range.
  9. Click Invoke.

    10. The selected number of application account IDs are displayed in alphabetic order. If the ID you want to use does not fit within the range, select a new range. When the correct range is displayed, verify that the ID you want to use is not in the list.

    Create application account

  10. Double-click the addApplicationAccount method.
  11. Enter the service provider account ID, the selected application account ID, and the application group ID.
  12. Click Invoke.

    13. The application account is now created. To add application instance groups to the application account. See Creating an application instance group.

    Parameter

    Description

    keyStorePassword

    The OSA/Parlay keystore password.

    directory

    The path to the directory where the application's user certificate is stored

    Note, only one certificate can be stored in the directory

    alias

    An alias to use for the certificate in the keystore. For example the application ID
    The application account has to be activated before the application account's application instance group users can access any services in the network. See Activating an application account.

    Note: If the application shall access services in the network through an OSA/Parlay gateway, the application account has to be connected to the OSA/Parlay gateway. See Connecting an application (account) to an OSA/Parlay gateway.

 

Connecting an application (account) to an OSA/Parlay gateway

Follow the instruction below to connect an application (account) to an OSA/Parlay gateway. The application account has to be manually connected to the OSA/Parlay gateway before it can start using network services through the OSA/Parlay gateway.

The OSA/Parlay gateway operator has to provide the following information/data:

Note: The WebLogic Network Gatekeeper must have been connected to the OSA/Parlay gateway before any applications can be connected. See OSA Gateway Connection.

Generate user certificate and private key

  1. Create a new directory in the folder where you keep your applications' user certificates and private key. Give the directory a name identifying the application.
  2. Generate a user certificate and private key for the application. See Generating certificates and private keys.

    3. Use the appId (application account ID) and entOpId (service provider account ID) provided by the OSA/Parlay gateway operator.

    Set Path to the directory you created in Step 1.. The application's private key and user certificate will be stored in this directory.

    Create OSA/Parlay client

  3. Start an Network Gatekeeper Management Tool and log in.
  4. Select a SLEE where the OSA access service is installed.
  5. Double-click the OSA_access service.
  6. Double-click the addClient method.
  7. Enter the following application domain data:

    Parameter

    Description

    osaClientAppId

    The application's clientAppId (and alias in the keystore). Entered as Domain ID when generating the user certificate and private key.

    clientKeyFile

    The directory path (including file name) for the private key.

    clientCertFile

    The directory path (including file name) for the user certificate.

    clientKeyPwd

    The client's private key password as defined when the private key was generated.

    keystorePwd

    The keystore's password as defined in when configuring the WebLogic Network Gatekeeper system.
  8. Click Invoke.

    9. The OSA/Parlay client is created.

    Map application account with OSA/Parlay client

    Note: One mapping has to be created for each OSA/Parlay SCS (network service) the application wants to use in the OSA/Parlay gateway.

  9. Double-click the addMapping method.
  10. Enter the following mapping data:

    Parameter

    Description

    serviceProviderID

    The service provider's service provider account ID.

    applicationID

    The application's application account ID.

    serviceType

    The service type of the OSA/Parlay SCS the application shall be mapped with.

    osaClientAppId

    The application's clientAppID.

    properties

    OSA/Parlay service properties to be used in the look up (service discovery) phase when requesting a service (OSA/Parlay SCS) from the OSA/Parlay gateway. The properties are specified as a space separated list in the following way:

    <propname1> <propval1> <propname2> <propval2>

    encryptionMethod

    The method used for encryption. Defined according to OSA/Parlay standard. If not specified, enter P_RSA_1024.

    signingAlgorithm

    The signing algorithm. Defined according to OSA/Parlay standard. If not specified, enter P_MD5_RSA_1024.

    gatewayId

    The OSA/Parlay gateway's ID. As defined when the OSA/Parlay gateway was connected. See OSA Gateway Connection.

    initConnection

    Indicates (TRUE/FALSE) if the connection to OSA/Parlay gateway should be initialized immediately. That is, authentication performed when the addClient method is invoked.

    11. Distribute application (account) user certificate to OSA/Parlay operator

  11. Copy the application's user certificates from its directory, see Step 1. on page 21, and send it to the OSA/Parlay gateway operator. Use the application account's clientAppID (entOpId\appId) as a reference.

    12. Note: There are two files in the directory, a user certificate (.der) and a private key (.key). Only the user certificate shall be sent to the OSA/Parlay gateway operator.

    Optional - Order user interaction announcement recording and installation

  12. If the application uses (is mapped to) the user interaction OSA/Parlay SCS, recording and installation of announcements have to be ordered from the OSA/Parlay gateway operator.

 

Identifying an application account

It is possible to identify a service provider account ID in two ways:

Both methods are described below.

...through the service provider account

Follow the instruction below to identify an application account ID through the service provider account.

Identify the service provider account

  1. See Identifying a service provider account ID.

    2. Identify the application account

  2. Double-click the getNumberOfApplicationsInServiceProvider method.
  3. Enter the service provider account ID.
  4. Click Invoke.

    5. The number of application accounts connected to the service provider account is displayed.

  5. Double-click the listApplicationAccountsForServiceProvider method.
  6. List a reasonable number of application account IDs. Enter the service provider account ID and the range.
  7. Click Invoke.

    8. The selected number of application account IDs are displayed in alphabetic order. If the application account ID is not within the range, select a new range. When the correct range is displayed, verify the ID of the application account.

...through the application group

Follow the instruction below to identify a application account ID through the application group.

Identify the application group

  1. See Identifying an application group.

    2. Identify the application account ID

  2. Double-click the getNumberOfApplicationsInApplicationGroup method.
  3. Enter the application group ID.
  4. Click Invoke.

    5. The number of application accounts related to the application group is displayed.

  5. Double-click the listApplicationAccountsInGroup method.
  6. List a reasonable number of application account IDs. Enter the application group ID and the range.
  7. Click Invoke.

    8. The selected number of application account IDs are displayed in alphabetic order. If the application account ID is not within the range, select a new range. When the correct range is displayed, verify the ID of the application account.

 

Activating an application account

Follow the instruction below to activate an application account. The application account has to be activated before the application can start accessing services in the network.

Identify the application account

  1. See Identifying an application account.

    2. View current state

  2. Double-click the getStateForApplicationAccount method.
  3. Enter the service provider account ID and application account ID.
  4. Click Invoke.

    5. The application account's current state is displayed.

    Activate application account

  5. Double-click the activateApplicationAccount method.
  6. Enter the service provider account ID and application account ID.
  7. Click Invoke.

    8. The application account's state is changed to activated.

 

Viewing information about an application account

Follow the instruction below to view information about an application account. The following types of information can be viewed independently of each other:

  1. See Identifying an application account.

    2. View application account data

  2. Double-click the getApplicationAccount method.
  3. Enter the service provider account ID and application account ID.
  4. Click Invoke.

    5. The related application group's ID and the account's OAM properties, if any, are displayed.

    View state

  5. Double-click the getStateForApplicationAccount method.
  6. Enter the service provider account ID and application account ID.
  7. Click Invoke.

    8. The application account's current state is displayed.

    View SLA

    The SLA is related to the application group. To view the SLA, the application group ID is needed. See Step 2. View application account data.

  8. Double-click the getSLAForApplicationGroup method.
  9. Enter the application group ID.
  10. Click Invoke.

    11. The SLA is displayed.

    List application instance groups

  11. Double-click the getNumberOfApplicationInstanceGroupsInApplications method.
  12. Enter the service provider account ID and application account ID.
  13. Click Invoke.

    14. The number of application instance groups related to the application account is displayed.

  14. Double-click the listApplicationInstanceGroups method.
  15. List a reasonable number of application instance group IDs. Enter the service provider account ID, application account ID and the range.
  16. Click Invoke.

    17. The selected number of application instance group IDs are displayed in alphabetic order.

    List logged in application instance groups

  17. Double-click the getNumberOfLoggedInApplicationInstanceGroups method.
  18. Enter the service provider account ID and application account ID.
  19. Click Invoke.

    20. The number of logged in application instance groups related to the application account is displayed.

  20. Double-click the listLoggedInApplicationInstanceGroups method.
  21. List a reasonable number of logged in application instance group IDs. Enter the service provider account ID, application account ID and the range.
  22. Click Invoke.

    23. The selected number of logged in application instance group IDs are displayed in alphabetic order.

 

Changing data (SLA) for an application account

Follow the instruction below to change the application group for an application account. That is, by changing the application group the SLA used for the application account is changed.

Identify the application account

  1. See Identifying an application account.

    2. View current application account data

  2. Double-click the getApplicationAccount method.
  3. Enter the service provider account ID and application account ID.
  4. Click Invoke.

    5. The related application group's ID and the account's OAM properties, if any, are displayed.

    Change application account data (SLA)

  5. Double-click the updateApplicationAccount method.
  6. Enter the service provider account ID and application account ID and a new application group.
  7. Click Invoke.

    8. The related application group (SLA) is changed.

 

Logging out an application account

Follow the instruction below to log out an application account. That is, to log out all application instance group users related to the application account.

To log out all application instance group users related to an application instance group, see Logging out an application instance group.

Identify the application account

  1. See Identifying an application account.

    2. Log out application account

  2. Double-click the logoutApplicationAccount method.
  3. Enter the service provider account ID and application account ID.
  4. Click Invoke.

    5. All application instance group users related to the application account are logged out.

 

Deactivating an application account

Follow the instruction below to deactivate an application account. That is, to temporarily stop the traffic to/from the application.

Identify the application account

  1. See Identifying an application account.

    2. View current state

  2. Double-click the getStateForApplicationAccount method.
  3. Enter the service provider account ID and application account ID.
  4. Click Invoke.

    5. The application account's current state is displayed.

    Deactivate application account

  5. Double-click the deactivateApplicationAccount method.
  6. Enter the service provider account ID and application account ID.
  7. Click Invoke.

    8. The application account's state is changed to deactivated.

 

Deleting an application account

Follow the instruction below to delete an application account.

Note: When deleting the application account, all related application instance groups will also be deleted.

Identify the application account

  1. See Identifying an application account.

    2. Delete application account

  2. Double-click the deleteApplicationAccount method.
  3. Enter the service provider account ID and application account ID.
  4. Click Invoke.

    5. The application account and all related application instance groups are deleted.

 

Creating an application instance group

Follow the instruction below to create an application instance group. The group contains a SLA specifying how many current users are allowed within the group.

Depending on the type of network services used by the application related to the application instance group, if the application accesses the WebLogic Network Gatekeeper through the Parlay X Web Services interfaces, and if the network access is through an OSA/Parlay gateway some of the following tasks may also have to be performed:

  1. See Identifying an application account. Select the option ...through the service provider account.

    2. Decide a suitable application instance group ID

  2. Decide a suitable (descriptive) ID for the application instance group according to your naming conventions.

    3. Verify that the ID is not used

  3. Double-click the getNumberOfApplicationInstanceGroupsInApplications method.
  4. Enter the service provider account ID and application account ID.
  5. Click Invoke.

    6. The number of application instance groups related to the application account is displayed.

  6. Double-click the listApplicationInstanceGroups method.
  7. List a reasonable number of application instance group IDs. Enter the service provider account ID, application account ID and the range.
  8. Click Invoke.

    9. The selected number of application instance group IDs are displayed in alphabetic order. If the ID you want to use does not fit within the range, select a new range. When the correct range is displayed, verify that the ID you want to use is not in the list.

    Create application instance group

  9. Double-click the addApplicationInstanceGroupSLAString method.
  10. Enter the following data:

    Parameter

    Description

    serviceProviderAccountID

    The service provider's service provider account ID.

    applicationAccountID

    The application's application account ID.

    applicationInstance
    GroupID

    The application instance group ID.

    slaContents

    The number of allowed concurrent users in the application instance group.

    properties

    Note, OAM properties can only be set from an integrated PRM/CRM system.

    password

    The password to be used by the application instance group users when logging in.
  11. Click Invoke.

    12. The application instance group is created. Depending on the type of network services used by the application related to the application instance group and/or the application accesses BEA WebLogic Network Gatekeeper through the Parlay X Web Services interfaces, some of the following below tasks may also have to be performed.

    Optional - Create mailbox(es)

  12. If the application uses messaging, mailbox(es) have to created for the application. See Mailbox Administration.
  13. Distribute the mailbox addresses and password to the service provider.

    14. Optional - Order creation of mailbox(es) in OSA gateway

  14. If the ESPA messaging service is used by the application related to the application instance group, mailboxes have to be ordered from the OSA/Parlay gateway operator.

    15. Optional - Create charging account(s)

  15. If the application related to the application group uses the ESPA charging service you also have to create accounts in your accounts database. This is not covered in this User's Guide.

    16. Optional - Order creation of charging account(s) in OSA gateway

  16. If the application related to the application group uses the ESPA charging service AND is connected to a OSA/Parlay charging SCS in an OSA/Parlay gateway, charging accounts have to be ordered from the OSA/Parlay gateway operator.

    17. Optional - Set application (instance group) properties for Parlay X

    Application properties only have to be set if the application accesses the WebLogic Network Gatekeeper through the Parlay X Web Service interfaces.

  17. Select a SLEE where the SESPA access service is installed.
  18. Double-click the SESPA_access service.
  19. Double-click the setAppProperties method.
  20. Enter the following data:

    Parameter

    Description

    serviceProviderID

    The service provider account ID.

    applicationID

    The application account ID.

    applicationInstanceGroupID

    The application instance group ID.

    appPassword

    Password for the application instance group.

    mailbox

    The mailbox ID to be used for the application instance group.

    Optional, only used when the application uses the SMS or Multimedia Message Parlay X services.

    mailboxPassword

    Password associated with the Parlay mailbox.

    Optional, only used when the application uses the SMS or Multimedia Message Parlay X services.

    merchantId

    The merchant ID for the application instance group.

    Optional, only used when the application uses the Payment Parlay X service.

    accountId

    Account ID for the application instance group, to be used in payment/charging sessions.

    Optional, only used when the application uses the Payment Parlay X service.

    currency

    Currency to be used for amount charging in payment/charging sessions.

    Optional, only used when the application uses the Payment Parlay X service.

    chargeVolumeType

    The unit to be used for volume charging in payment/charging sessions.

    A unit is defined as one of the following:

    0 - undefined

    1 - number of times or events

    2 - octets

    3 - seconds

    4 - minutes

    5 - hours

    6 - days

    Optional, only used when the application related to the application instance group uses the Payment Parlay X service.
  21. Click Invoke.

    22. The Parlay X properties are set for the application instance group.

    Optional - Enable network initiated call notifications for Parlay X

    Follow the instruction below to enable notifications on network triggered calls to an application instance group related to an application using Parlay X third party call.

    The application subscribes for notifications related to an originating number and a destination number, either one of them or a combination of both. This means notifications can be subscribed for either when:

    One registration is needed for each notification to subscribe to.

  22. Select a SLEE where the SESPA call control service is installed.
  23. Double-click the SESPA_call_control service.
  24. Double-click the addParlayXNetworkCallListener method.
  25. Enter the following data.

    Parameter

    Description

    endPoint

    URL to the end point of the callback/notification web service implementation for network triggered calls.

    For example, http://<mywebserver>/<mylistener>.wsdl

    serviceProviderID

    The service provider account ID.

    applicationID

    The application account ID.

    applicationInstanceGroupID

    The application instance group ID.

    aPartyAddressExpression

    A-party address (originating number) expression. For example, 46*.

    The format of the address expressions is explained below the table.

    Note, the application subscribes for notifications related to an originating number and a destination number, either one of them or a combination of both.

    bPartyAddressExpression

    B-party address (destination number) expression. The format of the address expression is similar to that for the A-party.

    Note, the application subscribes for notifications related to an originating number and a destination number, either one of them or a combination of both.

    callEventCriteria

    Call event criteria to trigger, or invoke, the web service. Define one of the following criterias by entering the corresponding number.

    3 An originating call attempt has been made.

    6 The called user was busy.

    7 The called user did not answer.

    8 The call failed for some reason.

    10 A participant was disconnected from the call.

    11 All of the above events.

    The call event criteria are always triggered in mode INTERRUPT allowing the application to control the call processing.

    If there is one or more listeners registered for the identical criteria as this one, and those listeners are registered from the same application domain as this one, the listener will be added to a High Availability and Load Balancing list. This means that the network initiated calls matching this criteria will be distributed using a round robin algorithm between the listeners with identical criteria.

    If the above is false, and there already is a listener registered for an address that overlaps this listener, an exception is raised.

    The application must implement the method corresponding to the CallEventCriteria. If not, the processing of the call is halted.

    serviceCode

    A string identifying the service (application) issuing the request. The information may be used for calculating charging related information. The format is unspecified.

    requesterID

    An ID for the requester of this service, could be a token received during log-in or the full address for the requester. If it's a full address the format shall adhere to the format as specified for the EndUserIdentifier. In other cases the format is unspecified. If the requester is unknown/unspecified an empty string shall be used.

    26. The following rules apply to the addressExpressions:
    Two wildcards are allowed: * which matches zero or more characters and ? which matches exactly one character. For E.164 addresses, * which matches zero or more characters and ? are allowed at the beginning or end.

    Some valid examples for E.164 addresses:

    The following address ranges are illegal:

    Legal occurrences of the '*' and '?' characters in AddrString should be escaped by a '\' character. To specify a '\' character '\\' must be used.

  26. Click Invoke.

    27. The network call listener is registered and an ID for the listener is displayed.

  27. Repeat Steps 24. to 26. for each notification to be enabled.

    28. Optional - Enable incoming message notification for Parlay X SMS and
    MMS

    Follow the instruction below to enable notifications on incoming SMSes and multimedia messages to a Parlay X application. Notifications have to be enabled for each mailbox registered for the application instance group.

  28. Select a SLEE where the SESPA messaging service is installed.
  29. Double-click the SESPA_messaging service.
  30. Double-click the enableMessageNotification method.
  31. Enter the following data.

    Parameter

    Description

    mailbox

    The mailbox for which to enable notifications on incoming messages.

    Format: tel:<mailbox>

    For example: tel:12345

    mailboxPassword

    The password related to the mailbox

    smsEndPoint

    URL to the end point of the callback/notification web service implementation for incoming SMSes.

    For example:
    http://<mywebserver>/<listener>.wsdl

    mmsEndPoint

    URL to the end point of the callback/notification web service implementation for incoming MMSes.

    For example:
    http://<mywebserver>/<listener>.wsdl

    serviceProviderID

    The service provider account ID.

    applicationID

    The application account ID.

    applicationInstanceGroup
    ID

    The application instance group ID.

    serviceCode

    A string identifying the service (application) issuing the request. The information may be used for calculating charging related information. The format is unspecified.

    requesterID

    An ID for the requester of this service, could be a token received during log-in or the full address for the requester. If it's a full address the format shall adhere to the format as specified for the EndUserIdentifier. In other cases the format is unspecified. If the requester is unknown/unspecified an empty string shall be used.
  32. Click Invoke.

    33. The listener is registered and an ID for the listener is displayed.

 

Identifying an application instance group

Follow the procedure below to identify an application instance group.

Identify the application instance group

  1. See Identifying an application account. Select the option ...through the service provider account.

    2. Identify the application instance group ID

  2. Double-click the getNumberOfApplicationInstanceGroupsInApplications method.
  3. Enter the service provider account ID and application account ID.
  4. Click Invoke.

    5. The number of application instance groups connected to the application account is displayed.

  5. Double-click the listApplicationInstanceGroups method.
  6. List a reasonable number of application instance group IDs. Enter the service provider account ID, application account ID and the range.
  7. Click Invoke.

    8. The selected number of application instance group IDs are displayed in alphabetic order. If the application instance group ID is not within the range, select a new range. When the correct range is displayed, verify the ID of the application instance group.

 

Activating an application instance group

Identify the application instance group

  1. See Identifying an application instance group.

    2. View current state

  2. Double-click the getStateForApplicationInstanceGroup method.
  3. Enter the service provider account ID, application ID and application instance group ID.
  4. Click Invoke.

    5. The application instance group's current state is displayed.

    Activate application instance group

  5. Double-click the activateApplicationInstanceGroup method.
  6. Enter the service provider account ID, application ID and application instance group ID.
  7. Click Invoke.

    8. The application instance group's state is changed to activated.

 

Viewing information about an application instance group

Follow the instruction below to view information about an application account. The following types of information can be viewed independently of each other:

  1. See Identifying an application instance group.

    2. View application instance group data

  2. Double-click the getApplicationInstanceGroup method.
  3. Enter the service provider account ID, application ID and application instance group ID.
  4. Click Invoke.

    5. The group's OAM properties, if any, are displayed.

    View state

  5. Double-click the getStateForApplicationInstanceGroup method.
  6. Enter the service provider account ID, application ID and application instance group ID.
  7. Click Invoke.

    8. The application instance group's current state is displayed.

    View SLA

  8. Double-click the getSLAForApplicationInstanceGroup method.
  9. Enter the service provider account ID, application ID and application instance group ID.
  10. Click Invoke.

    11. The SLA (number of allowed concurrent users) is displayed.

 

Updating the SLA for an application instance group

Follow the instruction below to update the SLA (change the number of allowed concurrent users) for an application instance group.

Identify the application instance group

  1. See Identifying an application instance group.

    2. View SLA

  2. Double-click the getSLAForApplicationInstanceGroup method.
  3. Enter the service provider account ID, application ID and application instance group ID.
  4. Click Invoke.

    5. The SLA (number of allowed concurrent users) is displayed.

    Update SLA

  5. Double-click the updateApplicationInstanceGroupSLAString method.
  6. Enter the service provider account ID, application ID and application instance group ID.
  7. Click Invoke.

    8. The application instance group's SLA is now updated and in use.

 

Logging out an application instance group

Follow the instruction below to log out all users related to the application instance group.

Identify the application instance group

  1. See Identifying an application instance group.

    2. Log out application instance group

  2. Double-click the logoutApplicationInstanceGroup method.
  3. Enter the service provider account ID, application ID and application instance group ID.
  4. Click Invoke.

    5. All logged in users in the application instance group are logged out.

 

Unlocking an application instance group

Follow the instruction below to unlock an application instance group that has been locked due to too many failed log in attempts. When unlocking an application instance group, it's state is changed to activated.

Identify the application instance group

  1. See Identifying an application instance group.

    2. View current state

  2. Double-click the getStateForApplicationInstanceGroup method.
  3. Enter the service provider account ID, application ID and application instance group ID.
  4. Click Invoke.

    5. The application instance group's current state is displayed.

    Unlock application instance group

  5. Double-click the unlockApplicationInstanceGroup method.
  6. Enter the service provider account ID, application ID and application instance group ID.
  7. Click Invoke.

    8. The application instance group is unlocked. That is, the state is changed to activated.

 

Changing password for an application instance group

Follow the instruction below to change password for an application instance group.

Identify the application instance group

  1. See Identifying an application instance group.

    2. Change password

  2. Double-click the setPasswordForApplicationInstanceGroup method.
  3. Enter the service provider account ID, application ID, application instance group ID and new password.
  4. Click Invoke.

    5. The application instance group's password is changed.

 

Deactivating an application instance group

Follow the instruction below to deactivate an application instance group. That is, to temporarily stop the application instance group's traffic to/from the application.

Identify the application instance group

  1. See Identifying an application instance group.

    2. View current state

  2. Double-click the getStateForApplicationInstanceGroup method.
  3. Enter the service provider account ID, application ID and application instance group ID.
  4. Click Invoke.

    5. The application instance group's current state is displayed.

    Deactivate application account

  5. Double-click the deactivateApplicationInstanceGroup method.
  6. Enter the service provider account ID, application ID and application instance group ID.
  7. Click Invoke.

    8. The application instance group's state is changed to deactivated.

 

Deleting an application instance group

Follow the instruction below to deactivate an application instance group. That is, to temporarily stop the application instance group's traffic to/from the application.

Identify the application instance group

  1. See Identifying an application instance group.

    2. Delete application instance group

  2. Double-click the deleteApplicationInstanceGroup method.
  3. Enter the service provider account ID, application ID and application instance group ID.
  4. Click Invoke.

    5. The application instance group is now deleted.

    Note: If any mailboxes, charging accounts and Parlay X settings have been created for the application instance group (see Creating an application instance group), these have to be removed separately. Refer to the OAM methods available for the associated SLEE services.

 

Skip navigation bar  Back to Top Previous Next