Skip navigation.

eDocs Home > BEA WebLogic Network Gatekeeper 1.0 Documentation > User's Guide > Mailbox Administration

User's Guide

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

Mailbox Administration

The following sections describe how to administer mailboxes:

 

About Mailbox administration

All messages arriving to BEA WebLogic Network Gatekeeper are stored in a mailbox's inbox before retrieved by the application owning the mailbox. An application can have one or more mailboxes. The application can subscribe to get a notification each time a message arrives in one of its mailboxes. To make this work, one or more mailboxes have to be created for each application using the messaging service. The subscription of notifications is handled by the application.

Mailbox translation

In addition, destination address short codes and message prefixes can be connected to a mailbox. The combination of a mailbox address, destination address short code and message prefix is called a mailbox translation.

A destination address short code is a number that is used by the end user instead of the real mailbox address. The same destination address short code can be used for several mailboxes if it is combined with a message prefix. The message prefix is a string entered by the end user as the first part of the message.

For example, a service provider can have a destination address short code that is used to access all the service provider's messaging based applications. For example 12345. The messages are distributed among the service provider's mailboxes through the use of message prefixes. In this case, each application has its own mailbox. Let's say that the service provider has two applications aimed for a radio show, one for greetings and one for requesting songs. The message prefix for to use can be defined as GREET and SONG.

That is, if an end user wants to request a song, he or she enters 12345 as destination address and starts the actual message with SONG.

In addition, if the service provider wants a general mailbox that is not connected to a specific task, it is possible to define a default mailbox using the same destination address short code (12345). When specifying a default mailbox, no message prefix is specified. This means that all messages sent to 12345 that does not start with GREET or SONG is delivered to the default mailbox.

 

Creating mailboxes

Follow the instruction below to create one or more mailboxes for an application account.

Note: The number of mailboxes created on BEA WebLogic Network Gatekeeper may become very large and thereby may limit the searching possibilities. Therefore it is recommended to keep track of which mailbox address ranges and mailbox passwords are used for each application in a separate file, for example an Excel file.

  1. Identify a free address range to be used for the mailboxes. See the file mentioned in the note above.
  2. Start an Network Gatekeeper Management Tool and log in.
  3. Select a SLEE where the ESPA messaging service is installed.
  4. Double-click the ESPA_messaging service.
  5. Verify that the address range is free, double-click the listMailboxes method.
  6. Enter the first and the last address in the fromAddress and toAddress fields.
  7. Click the Invoke button.

    8. If the address range is free, no mailboxes will be displayed.

  8. Double-click the createMailboxRange method.

    9. If only one mailbox should be created, use the createMailbox method instead.

  9. Enter the following mailbox data.

    Parameter

    Description

    startAddr

    The first address in a range of free internal mailbox addresses in BEA WebLogic Network Gatekeeper. That is, you do not have to enter the service centre address part of the mailbox address.

    Integer (leading zeroes might have to be added to the internal mailbox address. This depends on the address format used).

    endAddr

    The last address in a range of free internal mailbox addresses. Must be greater than the address in startAddr.

    applicationID

    The application account ID of the application using the mailbox.

    serviceProviderID

    The service provider account ID.

    pwd

    A password to be used by the application when accessing the mailboxes.
  10. Click Invoke.

    11. The mailboxes are now created.

  11. Distribute the mailbox addresses and password to the service provider.

 

Deleting mailboxes by address

Follow the instruction below to delete one or more mailboxes based on address. Mailboxes can be deleted for individual addresses or by address range.

  1. Identify the mailbox address or address range in the separate file created to keep track of the used mailbox addresses.
  2. Start an Network Gatekeeper Management Tool and log in.
  3. Select a SLEE where the ESPA messaging service is installed.
  4. Double-click the ESPA_messaging service.
  5. Verify that the address or address range you want to delete exists and that the desired service provider is the owner of all mailboxes to delete. Double-click the listMailboxes method.
  6. Enter the first and the last address in the fromAddress and toAddress fields.
  7. Click the Invoke button.

    8. Verify the addresses in the displayed address range.

  8. Double-click the removeMailboxRange method.

    9. If only one mailbox shall be deleted, use the removeMailbox method instead.

  9. Enter the first address and the last address in the range in the startAddr and endAddr fields.

    10. If only one mailbox shall be deleted, its address is entered in the addr field.

  10. Click Invoke.

    11. The mailbox(es) are now deleted.

 

Deleting mailboxes by owner (application)

Follow the instruction below to delete all mailboxes owned by a specific application.

  1. Identify the mailbox address or addresses in the separate file created to keep track of the used mailbox addresses.
  2. Start an Network Gatekeeper Management Tool and log in.
  3. Select a SLEE where the ESPA messaging service is installed.
  4. Double-click the ESPA_messaging service.
  5. Verify that the address or address range you want to delete. Double-click the listMailboxesByOwner method.
  6. Enter the application account ID and service provider account ID in the applicationId and serviceProviderId fields.
  7. Click the Invoke button.

    8. Verify the addresses.

  8. Double-click the removeMailboxByOwner method.
  9. Enter the application account ID and service provider account ID in the applicationId and serviceProviderId fields.
  10. Click Invoke.

    11. The application's mailbox(es) are now deleted.

 

Adding a message translation

Follow the instruction below to specify a destination address short code and message prefix for a mailbox.

Note: The routing for the destination address short code towards BEA WebLogic Network Gatekeeper must be defined in the network. This is network specific and not covered in this User's Guide.

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

    4. Verify mailbox

  4. Verify the mailbox address you want to add the message translation for. Double-click the listMailboxes method.
  5. Enter the mailbox address in the fromAddress and toAddress fields.
  6. Click the Invoke button.

    7. Verify the displayed address.

    List current translations

  7. List the current translations. Double-click the listMailboxTranslationsForAddress method.
  8. Enter the mailbox address.
  9. Click the Invoke button.

    10. The current translation are displayed.

    Add translation

  10. Double-click the addMailboxTranslation method.
  11. Enter the following mailbox data.

    Parameter

    Description

    destAddr

    The destination address short code to be used instead of the real mailbox address.

    msgPrefix

    The keyword to be entered in the beginning of the message. The message prefix is case sensitive.

    If left empty, this mailbox will be the default mailbox for the destination address short code. That is, it will be used for messages that does not start with a valid message prefix.

    mailbox

    The mailbox address as verified above.
  12. Click the Invoke button.

    13. The message translation is added.

 

Deleting a message translation

Follow the instruction below to delete a message translation for a mailbox.

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

    4. List current translations

  4. List the current translations. Double-click the listMailboxTranslationsForAddress method.
  5. Enter the mailbox address.
  6. Click the Invoke button.

    7. The current translation are displayed.

    Delete translation

  7. Double-click the deleteMailboxTranslation method.
  8. Enter the following translation data.

    Parameter

    Description

    destAddr

    The destination address short code used instead of the real mailbox address.

    msgPrefix

    The keyword to be entered in the beginning of the message. The message prefix is case sensitive.

    If left empty, all message translations related to the destination address short code will be deleted.

  9. Click the Invoke button.

    10. The message translation is deleted.

    Note: The actual mailboxes have to be deleted separately, see Deleting mailboxes by address or Deleting mailboxes by owner (application).

 

Setting maximum message burst size

Follow the instruction below to define the maximum number of notifications on new unread messages that shall be distributed to an application in one burst. The reason for defining this is to prevent applications from being overloaded with notifications on new messages. This setting applies to all mailboxes in the WebLogic Network Gatekeeper.

  1. Start an Network Gatekeeper Management Tool and log in.
  2. Select a SLEE where the ESPA messaging service is installed.
  3. Double-click the ESPA_messaging service.
  4. Double-click the setSelectUnreadMessagesSqlSize method.
  5. Enter the maximum number of messages to be distributed in one burst in the messages field.
  6. Click the Invoke button.

 

Skip navigation bar  Back to Top Previous Next