TELIA OPERATOR SERVICE PLATFORM

Transcription

1 TELIA OPERATOR SERVICE PLATFORM Opaali Portal Guide Copyright 2017 Aepona Limited, and copyright 2017 Telia All rights reserved by respective owners. Revision: 6.1

2 Legal Information Legal Information This document is made available by Telia Sverige AB (Telia) under Delivery contract No: between Telia Sverige AB and Aepona Limited. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document. Telia and Aepona each disclaims all warranties, express and implied, including without limitation, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement, as well as any warranty arising from course of performance, course of dealing, or usage in trade. The products and services described may contain defects or errors which may cause deviations from published specifications. Telia and the Telia logo are trademarks of Telia AB in Nordics and other countries. Aepona and the Aepona logo are trademarks of Aepona in the U.S. and/or other countries. *Other names and brands may be claimed as the property of others. Copyright 2015 Aepona Limited and copyright 2017 Telia. All rights reserved by respective owners. Opaali Portal Guide 2

3 Revision History Revision History Revision Number Description Revision Date 1.0 Initial release for Telia Operator Service Platform Release 2. Customized OSP 2.1 Opaali Portal. 2.0 Updated for Release 3, with Payment type applications case added in the Promote to Production flow. 3.0 Applied template and changed legal and copyright information from the PDF shared by Ray. May 2015 September 2015 November Replaced images from the Opaali Portal and other changes January ASFTS-116 and ASFTS-117 June 13, Final release June 16, Updated for R4 release September, CR0018 changes June, 2017 Opaali Portal Guide 3

4 Contents Contents 1 About this Document About Scope Audience Structure Style Conventions Opaali Portal Overview Opaali Portal Access to Opaali Portal Concepts Keywords Policies Service Contracts Short Codes Web Services Whitelist Using Opaali Portal To Access Opaali Portal Mandatory Input Fields Main Menu Home Dashboard About Resources Forum API Console Opaali Portal Site Map Creating and Managing Profiles Registring with Opaali Portal Dashboard Overview Editing User Profile Managing Invitations Creating Partners Editing Partner Profile Working from Partner Profile Page Opaali Portal Guide 4

5 Contents 5.1 Viewing Partner Numbers Generating Partner Reports User Invitations Sending and Managing Invitations Resending/Cancelling Invitations Managing Partner-User Associations Editing Associations Deleting Associations Working with Applications Creating Applications Editing Application Profile Managing Applications Requesting Application Promotion to Production Managing Notifications Requesting a Number Viewing Number in Pending Request Status Viewing Partner Numbers Assigning a Partner Numbers to an Application Viewing Application Numbers Removing a Partner Number from an Application Working with Keywords Setting Callback Credentials (Option) Creating and Starting Notification Pausing, Restarting and Stopping Notifications Viewing Application Credentials and Endpoints Working with Blogs and Forums Partner Blogs Partner Forums Opaali Portal Guide 5

6 About this Document 1 About this Document 1.1 About This document is a user guide for the Opaali Portal application of the Operator Service Platform (OSP), which is an integrated component of Aepona s API Monetization Platform. 1.2 Scope The purpose of this document is to provide a description of the operations available on the Opaali Portal customized for Telia, including steps for developers and partners to be registered as public users on the platform. This document does not include administrative operations on the Opaali Portal. 1.3 Audience The intended audience for this document is public users of the Opaali Portal, wishing to create TPA (third-party applications) which make use of the services available on the OSP platform, and to manage them from a single application. 1.4 Structure The document is divided into the following chapters: Table 1 Document Structure Chapter Description 1. About this Document Provides an overview of this document, including the intended audience, scope, document structure, and conventions used throughout. 2. Opaali Portal Overview Provides an overview of OSP, its components, and concepts, and essential information on accessing the Opaali Portal. 3. Using Opaali Portal Introductory chapter on the Opaali Portal and its resources. 4. Creating and Managing Profiles Describes the two basic operations on the Opaali Portal to sign in and to set up a partner entity yourself, or/and be associated with another partner and to manage your own profile and your partners. Opaali Portal Guide 6

7 About this Document Chapter 5. Working from Partner Profile Page Description Describes the tasks you can perform in relation to your partners. Includes working with transactions, viewing numbers, purchasing credits, viewing reports, and inviting users and managing associated users. 6. Working with Applications Describes how to create and manage your applications. Includes the steps required to set up notifications of calls received by your application, and to view service endpoints. 7. Working with Blogs and Forums Describes the community features provided by OSP. 1.5 Style Conventions This document uses the following style conventions to denote functions associated with the section of the text. Table 2 Conventions used in this document Type and Formatting Style Code: Courier New font,in shaded box Code Chara: Courier New font Code Chara Italic:{Courier New font Italic within curly or angled brackets) Description and Usage Indicates an element of syntax, reserved word, keyword, filename, computer output, or part of a program example. The text appears in lowercase unless uppercase is significant. Indicates the exact characters you type as input. Also used to highlight the elements of a graphical user interface such as buttons and menu names. Indicates a placeholder for an identifier, an expression, a string, a symbol, or a value. Substitute one of these items for the placeholder. Opaali Portal Guide 7

8 Opaali Portal Overview 2 Opaali Portal Overview The Opaali Portal application and its components are briefly described below. 2.1 Opaali Portal OSP s Opaali Portal is a comprehensive partner management system built on open standards, leveraging industry best practices. One of the main functions of the Opaali Portal is to simplify management and automate business processes between the service provider and a potentially large number of third parties. Within the partner management framework, partners are organized into a hierarchical tree structure that enables easy management and delegation of rights for both the service provider and partners in their own organizations Access to Opaali Portal A partner/developer can gain access to the Opaali Portal in the following ways: Self-registration on Opaali Portal: A user may register as a public user, and add the name of the associated Partner. This user is granted a default range of permissions to create and manage applications. Detailed steps for self-registration are provided in section 4.1. Invitation from another Opaali Portal user: A user with appropriate Partner Access settings can invite other users to be associated with the Partner on the Opaali Portal. As a User created by the Portal administrator: The Portal administrator can add users and furnish them with a role and/or permissions to access the Opaali Portal. The Portal administrator can associate a user with a particular partner or select a user as the primary contact when creating a partner, and adjust Partner Access settings to grant permissions to invite other users to the Opaali Portal or to make changes to partner applications. As the Primary Contact for a partner created by the Portal administrator: The Portal administrator can create a new user as the primary contact for a partner, during the partner creation process. The primary contact user is granted Admin Access to the Opaali Portal, and can work in the Admin area. 2.2 Concepts In order to understand the OSP Portals, it is important to understand the following concepts outlined in this section: Keywords Opaali Portal Guide 8

9 Opaali Portal Overview Policies Service Contracts Short codes Web Services Whitelist Keywords A keyword is a text in an SMS or MMS message up until the first space. When you register a keyword to use with a number set up on the Portal, messages sent to the number start with the keyword, and can, therefore be routed, and the system can generate notifications on the routed results to report back to the application. A keyword is always paired with a number, and the pair must be unique on the platform. Use cases of notifications using keyword criteria include: A newspaper Reader Competition asking you to send a text message to a particular number with a keyword from a list (for example, ROSES, SUNFLOWERS, ORCHIDS ) to denote your answer, followed by your name and address, and so on. A TV voting program asking you to send a text message to a particular number with a particular keyword (VOTEA or VOTEB or VOTEC, and others) indicating your choice. OSP manages system configured usage and syntactical rules, as well as blacklisting checks, to prevent a user from registering an unacceptable keyword or a duplicated keyword and number pair Policies A Policy is a restriction put on the capabilities of a service for a particular application. The OSP platform provides policy enforcement at the core service level. Portal administrators examine and modify the default policy settings for an application. They can also modify the policy information for different services within a service contract. Any application assigned this service contract has the associated policies enforced on it Service Contracts Service contracts apply policies or limitations on a service provided to an application. They are managed by the Portal administrator. Opaali Portal Guide 9

10 Opaali Portal Overview Short Codes Short codes, which are also known as short numbers, are special telephone numbers, significantly shorter than full telephone numbers that you can use to address SMS and MMS messages from mobile phones. Short codes are designed to be easier to read and remember than normal telephone numbers. Like telephone numbers, short codes are unique to each operator. Providers generally have agreements to avoid overlaps. Short codes are widely used for value-added services such as television program voting, ordering ringtones, charity donations, and mobile services. You can bill messages sent to a short code at a higher rate than a standard SMS and may even subscribe a customer to a recurring monthly service to add to their mobile phone bill until they text, such as the word STOP, to terminate the service Web Services Web Services are self-describing software modules, which encapsulate discrete functionality. They are accessible through standard Internet communication protocols like XML, SOAP, and REST, and can be developed in any technologies (like C++, Java,.NET, PHP, Perl, and so on) or used by any technology. This provides for loose coupling between software modules allowing business rationalization through independent development. A Web Service is a software system designed to support interoperable machine-tomachine interaction over a network. A SOAP Web Service has an interface described in a machine-process format, such as WSDL. Other systems interact with the Web service in a manner prescribed by its description using SOAP-messages. Web Services use a standardized industry protocol for the communication. All four layers (Service Transport, XML Messaging, Service Description, and Service Discovery layers) use well-defined protocols in the Web Services stack. This standardization of the protocol stack gives businesses many advantages such as a wide range of choices, reduction in cost due to competition, and increases in the quality of available products. A RESTful web service follows the Representational State Transfer (REST) style of software architecture. It consists of requests and responses which are built around the transfer of representations of resources, each of which is referenced with a global identifier, such as a Opaali Portal Guide 10

11 Opaali Portal Overview URI in HTTP. One of the key characteristics of a RESTful Web Service is the explicit use of HTTP methods in a way that follows the protocol as defined by RFC Whitelist Whitelisting allows the creation of a reserved pool of telephone numbers. On OSP, the list is created for a project, to restrict the numbers that a service can use. You must configure an appropriate whitelist policy for the service to make use of the feature. You initiate whitelist registration from the Opaali Portal, using one of three workflow options set by system configuration - with verification of the number before registration (default), without any verification, or through Portal administrator approval. The sender address whitelist policy restricts the sender address values that are set within the request to the Messaging Service. Similarly, the destination address policy restricts the destination address values set within the request to the Messaging Service. You use the functionality typically for applications in Sandbox status, to facilitate testing before they are promoted to Production. The default workflow requires you to configure a dedicated Messaging service on the system, as OSP generates and sends a PIN by SMS to the requested number for verification. OSP validates the PIN entered on the Opaali Portal screen, before adding the number to the whitelist. Opaali Portal Guide 11

12 Using Opaali Portal 3 Using Opaali Portal Accessing the Opaali Portal is described in section with more details on registering as a public user in section 4.1. This section describes the log in steps for a registered user, and a brief description of the available spaces, followed by a sitemap of the Partners area. 3.1 To Access Opaali Portal By default, Opaali Portal runs at the following address: To Log in to the Opaali portal 1. Enter the URL in the browser. 2. At the upper-right corner of the page, click Login. The Opaali Portal Login page appears. Figure 1 Login page 1. Enter your registered and password. On forgetting the password, the user can click Forgot your password? The system sends an to the address used to register the account, which Opaali Portal Guide 12

13 Using Opaali Portal must be specified by the user. When the user clicks on the link in the , the system prompts for an answer to a security question before resetting the password. The user specifies this security question during the registration process. 2. Click Login. The Partner Dashboard appears, showing your user profile. Figure 2 Opaali Portal landing page Dashboard with User Profile 3.2 Mandatory Input Fields A red asterisk marked against an input field label on the GUI indicates that you must enter a value in the field Main Menu Main menu items appear according to the permissions granted to the currently logged in user and provide quick access to the area. The Dashboard, where you have landed, is the general working space, described in detail in this document. This section provides brief descriptions of the menu areas that are available to the public user. Opaali Portal Guide 13

14 Using Opaali Portal Home Click HOME to return to the Opaali Portal home page. From this page, you can select the display language, and click Edit Profile to be redirected to Edit User Profile page. Editing your user profile is described in section Dashboard The Dashboard is the landing page on initial login and the general workspace of the Opaali Portal. Click Dashboard to return to the landing page as shown in Figure 2. Go to section for details About Click About to view information about the Telia Opaali Portal Resources Click Resources to view links to resources designed to help partners consume service provider APIS and to operate their applications in the live environment. They include: API guides this user guides to the Opaali Portal Sample Java Applications Forum These are interactive spaces for the user community, described in section API Console In the API Console tab the partner can test individual API behavior without creating an application. This tab allows the partner to use the services such as, OMA Messaging, OMA Payment, and OMA Authentication API which are associated with their application. Opaali Portal Guide 14

15 Using Opaali Portal NOTE: Any API request sent by the API console behaves in the same way as if an application had sent them. The API console will be able to make requests to both Sandbox and Production APIs. To use API console 1. On the Dashboard page, click the Manage Partner button corresponding to the partner. The Partner Application page appears. In this page you can see the list of applications associated to the partners. 2. Click the Manage Application button corresponding to the application. The Application Details page appears. Figure 3 Opaali Portal Application details 3. Click API Console link present on the left-hand side pane. The API Console page appears. In this page you can see the services associated with the application. For example, if the application deals with messaging, you can see the services associated to messaging. Figure 4 API Console Opaali Portal Guide 15

16 Using Opaali Portal 4. Click the services to view the API for the services. Figure 5 API Console 5. Click the API and fill up the necessary field of the request and click Send! You should get the response 3.3 Opaali Portal Site Map The sitemap layout below follows the UI structure to show features that are hidden under the top level menu item. For example, if you want to change your password, you can reach the relevant page through the Edit Profile link on the Dashboard. Dashboard Edit Profile > > > > > > > > > > > > > > > > > > Edit User Profile Change Password Change Manage Invitations Change Security Details Create a Partner Manage Partner > Edit Partner Profile View Transactions Partner Numbers Opaali Portal Guide 16

17 Using Opaali Portal Credits Partner Reports, Summary Reports User Invitations Edit/Delete User Association Invite User to Partner Manage Invitations Your Documents Create Manage Application> Edit Application Details Promote To Production Manage Notifications > Request Number Pending Requests Assign Partner Number Create Keyword Create Notification Endpoints Callback Credentials Opaali Portal Guide 17

18 Creating and Managing Profiles 4 Creating and Managing Profiles This chapter describes the initial steps on the Opaali Portal, where you register as a user and access the Dashboard, and create a partner entity. This also includes steps to manage your and your partner s profiles. Signing Up to Opaali Portal - section 4.1 Dashboard - section Editing your profile - section Managing invitations you have received section Creating Partners - section 4.2 Editing partner profile and adding more information section Registring with Opaali Portal When you first sign up to Opaali Portal as a public user, you must enter essential details on the registration form. You must also register the name of your Partner (Content Provider) entity at the same time. You can edit and extend your profile and the profile of the Partner later, as described in section When you submit and accept the registration request, an returns with the login URL for the Opaali Portal, where you can log in with the registered address and password. To sign up and create a new user, and an associated partner by default 1. Click Register Now on the Opaali Portal homepage. The Registration Form appears. 2. Enter the following mandatory details: First Name Last Name - must be unique to the system required to log in to the Opaali Portal Partner Name the name of the Partner you are associated with, or of a new partner you create and enable. Currency select from the drop-down list Display Name your name as it will appear on the Forum and Blogs Opaali Portal Guide 18

19 Creating and Managing Profiles Password when you click in the field, the password requirements are called out Confirm Password re-enter password Security Question select the security question to use if you reset the password Security Response enter the answer to the security question Confirm Security Response re-enter the answer to the security question to ensure it has been entered correctly Country select the country of your address from the drop-down list Locale select your language from the drop-down list Time Zone select your time zone Enter this text enter the letters as shown in the image. If there is difficulty reading the letters, click Refresh Image to view new letters. This is a challenge-response to ensure that the response is not generated by a computer. 3. [Optional] Enter optional registration details, which can be added now or later: Telephone 4. Read the terms and conditions in the Terms and Conditions text box and select I accept the Terms & Conditions checkbox. 5. Click Register. This refreshes the page and a message appears informing that the request has been sent for moderation. The system raises a ticket and sends an to the Portal administrator informing them of the registration request. The Portal administrator can accept or reject the ticket when an returns to the user. The approval includes a link to the Opaali Portal Login page, where you can log in with the password. You get standard user access permissions to the Opaali Portal You also have Admin Access to the partner created by the name you have entered in the registration request and any applications created by the partner. See section for permission details. 6. Open the link and log in with your address and the password you had registered. You gain access to the Opaali Portal Partner Dashboard, where you are registered as a Public User. Opaali Portal Guide 19

20 Creating and Managing Profiles Dashboard Overview From the Dashboard, which is the landing page when you first access the Opaali Portal, as shown in Figure 2, you can click: Edit Profile to edit or add more details to your profile section below Manage Invitations to accept or reject an invitation to become associated with a partner - section Create a Partner, to create a partner entity - section 4.2 Manage Partner to edit partner details - section Editing User Profile You can edit your user profile details, and add additional information after the initial registration. Edit personal information section Edit community options section Change your password section Change your section Change your security details section Editing User Profile Details You can edit the user profile details. To edit your user profile 1. From the Dashboard (Figure 2), click Edit Profile link, either under your image and name or on the banner, in the right side corner of the page. The Dashboard > Edit User Profile page appears, and you can edit or add information for the following fields. Mandatory fields are marked with an asterisk: Personal section fields: First Name* Last Name* Telephone Fax Country* Locale* Opaali Portal Guide 20

21 Creating and Managing Profiles Time Zone* Date of Birth Website Twitter Options section field: Receive communications from Telia? - select check box to receive s Community section fields: Use Custom to use a custom image. For example, click Choose File, browse, and select your image file. Max file size is 500k. Use Gravatar to use your existing Gravatar, click this link to be redirected to en.gravatar.com site to get your Gravatar Use Default to use your default image Display Name* Signature Professional section fields: Company Name Job Title Job Function select from the drop-down list 2. Edit as appropriate and click Update Profile Changing Your Password You can change your password. To change your password to access the Opaali Portal 1. From the Dashboard, click Edit Profile link, either under your image or in the upper-right corner of the page. The Dashboard > Edit User Profile page appears. 2. Click Change Password. The Change Your Password page appears. 3. Enter your current password. 4. Enter your new Password and repeat in the Confirm Password field. 5. Click Change Password. This updates your profile and you return to the Edit User Profile page. Opaali Portal Guide 21

22 Creating and Managing Profiles Changing Your Address You can update your primary address on your user profile. To change your primary address 1. From the Dashboard, click Edit Profile link, either under your image or in the upper-right corner of the page. The Dashboard > Edit User Profile page appears. 2. Click Change . The Change Address page appears. 3. Enter your current password. 4. Enter your new address and repeat the address in the Confirm New Address field. 5. Click Change . This updates your profile and you return to the Edit User Profile page Changing Your Security Details You can change your security question and answer on your user profile. To change your security question and answer 1. From the Dashboard, click Edit Profile link, either under your image or in the upper-right corner of the page. The Dashboard > Edit User Profile page appears. 2. Click Change Security Details. The Security Details page appears. 3. Enter your current password. 4. Select a security question from the drop-down list, enter the Security Response and repeat the response in the Confirm Security Response field. 5. Click Submit. 6. This updates your profile and you return to the Edit User Profile page. 7. At the same time, you receive an on your registered ID, informing you about the details change Managing Invitations If another user has invited you to be associated with a partner, you see the invitations in the Manage Invitations page accessed from your Dashboard. To accept or reject an invitation received 1. From the Dashboard, click Manage Invitations. The Manage Invitations page appears. Opaali Portal Guide 22

23 Creating and Managing Profiles 2. Click Accept or Reject. The system sends an notification of the event to the user who invited you. 4.2 Creating Partners To create an additional partner entity on the Opaali Portal, you must register the essential details from the Create New Partner page. You can edit and later extend the partner profile with optional details, before promoting any of the applications to production. The system assumes that you are the Contact for the partner you are creating. Therefore, the system uses the details of the profile of the current logged in user you to auto-populate the relevant fields. To create a partner on the Opaali Portal 1. From the Partner Dashboard, click Create a Partner. The Create New Partner page appears. 2. Enter the following details: Partner Name Currency (Optional) Telephone By default, this creates and enables the partner Editing Partner Profile You can edit the details of your partner from the Edit Partner Profile page. To edit your partner details 1. Click Dashboard tab to access the Dashboard. 2. Click Manage Partner for the partner you wish to edit. The Partner Profile page appears, with the partner name on the left side panel, as shown in Figure Click Edit Partner Profile link. See Figure 3. The Edit Partner Profile page appears. You cannot edit the partner name and currency. You can add the following details: Telephone add or edit as applicable Support Information Opaali Portal Guide 23

24 Creating and Managing Profiles Support Address Support Telephone Number Primary Address, Billing Address Address Line 1 Address Line 2 City Province/State Country select from the drop-down list Postal/ZIP Code Use primary address as billing address select to skip entering billing address 4. Edit as appropriate and click Update Partner Profile. You return to the Partner Profile page. Opaali Portal Guide 24

25 Working from Partner Profile Page 5 Working from Partner Profile Page The Partner Profile page is the activity base for the partner, from where you can register your application as a project, and engage in various activities related to your project. From the Dashboard, click Manage Partner for the partner to access the page. For example, see Figure 3 about a partner with one application already created, and showing one of the partner reports by default: Figure 3 Partner Profile page From here, you can: Edit Partner Profile to edit/add and update partner details, as described in sections 4.2 and Create and work with applications - described in chapter 6 And view/work with: Transactions section Partner numbers section Reports Live and Summary Partner Reports section Opaali Portal Guide 25

26 Working from Partner Profile Page Inviting users - section Managing Partner-User Associations section Viewing Partner Numbers You can view which short numbers/long numbers have been allocated to the partner. To view the allocated short numbers/long numbers 1. Access the Partner Profile page for the partner (= click through Dashboard tab > Manage Partner for the partner > click Edit Partner Profile link). 2. Click Partner Numbers in the left side panel. The Partner Numbers page appears. The page lists any short numbers/long numbers that have been allocated to the partner, with the network in which they are used, and any associated application, as shown in Figure 4: Figure 4 Partner Short Codes panel The number may have been allocated by the Portal administrator, or by you. See section 6.5 Managing Notifications for more information on partner and application numbers. 5.2 Generating Partner Reports Partners can generate and view a range of reports of two types: live generated from current data, and summary from archived data. To generate and view Partner reports 1. Access the Partner Profile page for the partner (= click through Dashboard tab > Manage Partner for the partner > click Edit Partner Profile link). 2. Click Partner Reports in the left side panel for online/live reports OR Opaali Portal Guide 26

27 Working from Partner Profile Page Click Partner Summary Reports for offline/archived data reports 3. Select the Report from the drop-down list. The page shows the relevant parameter input fields for the particular report selected. For example, Date Range, Application Status (Production, Sandbox, limited-production), and others. Refer the USG_Opaali Portal_Reporting_Supplement_Guide_For_User for more information about the partner report. 4. Enter the parameters as required. 5. For Partner and Partner Summary Reports, select the report format from the drop-down list: HTML, CSV, PDF or XLS. 6. Click Submit. If you have selected the HTML format for the report, the reports generate and shows the report online, in the lower part of the page. The other report formats generate in the form of the download file. 5.3 User Invitations A Partner can send invitations to other users to become associated users. The partner can grant them access to all of their profile, or provide them with a more limited profile, whereby they have access to everything except they cannot send or cancel invitations to other users. Users who have received an invitation can accept or reject it from their Dashboard as described in section Sending and Managing Invitations You can send invitation to the user associated with the partner. To invite a user 1. Access the Partner Profile page for the partner (click through Dashboard tab > Manage Partner for the partner). 2. Click Invite User to Partner in the User Invitations section in the left side panel. 3. Enter the user s address and a Note, a short message to include with the invitation. Opaali Portal Guide 27

28 Working from Partner Profile Page 4. In the Partner Permission section, select the type of access to grant this user. There are two options: NOTE: Standard Access the user can view and update partner details but cannot invite other users to be associated with the partner Admin Access the user can view and update partner details and can also invite other users to be associated with the partner If the user requires access to Request Number which allows a user to create new short codes or long numbers, assign Admin Access. Standard Access users of the partner can associate existing short code/long numbers to their applications but they cannot create a short code or long number. 5. In the Partner Application Permission section, which appears if the partner has any applications, select the type of access to grant this user for each of the partner s applications listed. There are three options: No Access the user cannot view or update any of the partner s application details Standard Access the user can view and update application details, except for the three privileges granted to Admin Access permission Admin Access available for users with Partner Permission - Admin Access only, the user can view and update application details, and also 6. Click Submit. Disable application endpoints Disable an application entirely Remove the service contract for a project This sends an invitation request. The received by the user differs, depending on whether they are already registered on Opaali Portal: If the user already has the Opaali Portal profile, in other words, if the user is already registered the user can click on the link in the to access the Opaali Portal Manage Invitations screen. From there, the user can either accept or reject the invitation. If the user has not got the Opaali Portal profile there will be two hyperlinks in the invitation , which allows the user to either accept or reject the request. If the user accepts the request, the User Registration For Partner page appears in a browser window. To complete the process, the user must add registration details and click Accept. If the user rejects the request, an is sent to the partner to notify them of the rejection. Opaali Portal Guide 28

29 Working from Partner Profile Page If a decision has not been made by the user after a significant amount of time, the partner can resend the invite by clicking on Manage Invitations in the Partner Profile page, and click Resend beside the user, as described in the next section Resending/Cancelling Invitations You can resend or to cancel an invitation to a user to be associated with a Partner. To resend or to cancel an invitation 1. Access the Partner Profile page for the partner (= click through Dashboard tab > Manage Partner for the partner). 2. Click Manage Invitations in the User Invitations section in the left side panel. 3. Click Resend or Cancel. This resends the invitation , or sends an notifying of the invitation cancellation, as applicable. 5.4 Managing Partner-User Associations There are two types of associations that can exist between a Partner, each of his applications, and user: Partner Permission: Standard Access the user has access to all aspects of the Partners Area, except they cannot ask other users to associate with the partner or remove associations. Admin Access the user has access to all aspects of the Partners Area. They can invite other users to associate with the partner, as well as remove associations Partner Application Permission: No Access the user cannot view or update any of the partner s application details Standard Access the user can view and update application details, except for the three privileges granted to Admin Access permission Admin Access available for users with Partner Permission - Admin Access only, the user can view and update application details, and also Disable application endpoints Opaali Portal Guide 29

30 Working from Partner Profile Page Disable an application entirely Remove the service contract for an application Request new Short numbers and Long numbers Editing Associations You can edit the association between a Partner and a user. To edit an association 1. Access the Partner Profile page for the partner (=click through Dashboard tab > Manage Partner for the partner). 2. Select the user from the Users Associated to Partner drop-down list in the User Invitations section in the left side panel. 3. Click Edit Association. 4. Change the type of access granted to the user. 5. Click Submit Deleting Associations You can delete an association between a Partner and user. To delete an association 1. Access the Partner Profile page for the partner (= click through Dashboard tab > Manage Partner for the partner). 2. Select the user from the Users Associated to Partner drop-down list in the User Invitations section in the left side panel. 3. Click Delete Association. 4. Click OK to confirm the removal of the association. Opaali Portal Guide 30

31 Working with Applications 6 Working with Applications You can create an application from the Partner Profile page, which lists the existing applications that you can edit through Manage Application. This section describes how to create applications and edit application profile sections 6.1and 6.2 manage applications from Application Profile page an overview section 6.3 promote applications to production section 6.4 manage notifications section 6.5 requesting number and assigning to application sections to setting keywords section setting callback credentials [optional] section creating and managing notifications section view endpoints and application credentials section Creating Applications You can create new applications for a partner. To create an application 1. Access the Partner Profile page for the partner (= click through Dashboard tab > Manage Partner for the partner). 2. Click Create an Application in the Partner Applications panel. The Create an Application page appears. Fields marked with a red asterisk are mandatory to create the application. 3. Enter your application name as appropriate, in the Application Name field. 4. (Optional) Enter a description for your application in the Description field. 5. Click Create Application. You are redirected to the updated Application Profile page, and you receive an with the application username. Figure 5 Application Profile page application created Opaali Portal Guide 31

32 Working with Applications NOTE: When an application is first created, it is granted Sandbox status. When you go back to the Partner Profile page, you see the application displayed as Enabled. 6.2 Editing Application Profile Application details can be updated whilst the application is in Sandbox or Production state. To edit the details of an existing application for a partner 1. Access the Partner Profile page for the partner (= click through Dashboard tab > Manage Partner for the partner). 2. Access the Application Profile page for the application by clicking Manage Application for the application displayed in the Partner Applications panel. 3. Click Edit Application Details in the left side panel. The Edit Application page for the application appears. You cannot edit the application name. 4. (Optional) Edit the description as required in the Description field. 5. (Optional) Click Application Attributes to open the following fields to enter or select. Validity Period (Minutes) the time Receive-Only Price the amount to charge to the subscriber for an MO message, for an MO message Receive Only service Receive-Only Currency select from the drop-down list QR Balance Check the minimum credit a prepaid subscriber must have, to allow a Query/Response service to proceed QR Balance Check Currency select from the drop-down list Opaali Portal Guide 32

33 Working with Applications NOTE: Push Balance Check the minimum credit a prepaid subscriber must have, to allow a Push service to proceed Push Balance Check Currency select from the drop-down list You can view the VAT Percentage on this page, only if it has been configured in the Application Profile page when the application is promoted to Production status. 6. Edit as appropriate and click Update Application Profile. 6.3 Managing Applications The Application Profile page is the activity base for each application. From here you can edit your application details, view your endpoints, promote your application to production and manage notifications From the Dashboard page, click Manage Partner for the partner, then click Manage Application for the application to access the page. An example page is shown in Figure 5 created Application Profile page application The list of tasks you can perform from this page is listed on page Requesting Application Promotion to Production In order to enable an application to operate in production mode, the partner must first complete four steps in Opaali Portal as described in this section. Then, the system logs a request for promotion and sends an to the Portal administrator. It is then the responsibility of a Portal administrator to approve the promotion. You get notification of the decision by . A visual indicator appears at the top of the Promote to Production page to inform the partner of their progress through the steps, as shown in the screenshot below: Figure 6 Promote To Production page Application Checklist view Opaali Portal Guide 33

34 Working with Applications NOTE: If this is a second or subsequent application to promote to production, the confirmation option does not appear on the visual indicator. TIP: At any point during the promotion process, you can interrupt your work by clicking Complete Later at the bottom of the page. This saves the details you have already entered. To request your application to be promoted to production 1. Click Promote To Production on the Application Profile page Figure 5. If you do not see this link on the page, it may be because there is another application in Pending state, awaiting Promotion. A partner may only have one application awaiting approval for promotion at any one time. The Promote To Production page appears (Figure 6), with a brief description of the promotion process in the Application Checklist section. 2. Read the Application Checklist carefully and click Continue. The Partner Profile view appears. 3. Check your partner profile is correct. 4. Enter any missing information required for the mandatory fields: Telephone Support Information Support Address Support Telephone Number Primary Address Billing Address, unless you select the Use primary address as billing address check box Opaali Portal Guide 34

35 Working with Applications If the Partner Profile details are incorrect to edit them now. It is not possible to update Partner Profile details after an application has been approved for production. For details of the fields on this page, see section 4.2. If this is a second or subsequent application to promote to production, where applicable, fields are pre-populated with the information you had entered in the previous promotion application. 5. Click Continue. The Application Profile view appears. 6. Check your Application Profile is correct, including Application Attributes. The following information is mandatory: 7. Description Add the following information: Application Bundle, the options available in the drop-down list are determined by Telia. For examples, see bundles which may appear in the drop-down list: Basic MT Bulk for each of these selections, when you make the selection, the applicable information appears on the page. For example: Basic MT + MO Receive Only No Charge Basic MT + MO Push No Charge Basic MT+ MO QR No Charge Chargeable MT + MO Push with Charging Chargeable MT + MO QR with Charging Chargeable MT + MO Receive Only with Charging Figure 7 Bulk Selected in Application Bundle Opaali Portal Guide 35

36 Working with Applications NOTE: If the application Type is BULK, QR, or PUSH then the application shows the Charge on Delivery option. If you click on Yes, the application must be authorized by an OSP administrator. 8. (Optional) Add the following information: Payment act law required? - Select Yes/No Request Change To Bundle When you select this option a free text field opens for you to enter the details of the change. For example, if the Application Bundle Description includes a specific TPS, you may wish to request a higher TPS. Examples of available options and associated contract types are as follows. Contract Type Simple Contract Medium Contract 1 Medium Contract 2 High Contract* Bundle Type Bulk SMS Low TPS Bulk SMS High TPS QR Low TPS No Payment Push Low TPS No Payment RO Low TPS No Payment QR High TPS No Payment Push High TPS No Payment RO Low High No Payment QR With Payment Push With Payment RO With Payment If a change to the bundle is requested then the Portal Administrators approval is required for the promote to production request Opaali Portal Guide 36

37 Working with Applications Payment applications only If the application bundle has a core application type of Payment, a drop-down list appears with available Application Restriction Classes for the application (such as Non-Profit, Information, Entertainment, Adult Entertainment). Select the appropriate class and click Confirm. 9. Set the Payment act law required option as Yes or No. 10. Select the Request Change To Bundle check box if the application bundle does not meet your requirement. 11. In the VAT Percentage field, enter the VAT percentage. If you set the VAT Percentage to other than the standard VAT amount the application requires manual Promote to Production. 12. In the Application Attributes section, enter the required information. Figure 8 Promote To Production Application Profile page Opaali Portal Guide 37

38 Working with Applications 7. Click Continue. The Confirmation view appears. 8. Click Promote to Production. NOTE: If this is a second or subsequent application to promote to production the Promote to Production step 11 is not applicable. The project will be done automatically. The partner receives an to confirm that their request to promote the application to production has been initiated and is reviewed by the Portal administrator. The partner receives another after a decision has been made. Opaali Portal Guide 38

39 Working with Applications The status of the application, which is Sandbox when created, now changes to Pending. After approving the promotion, the status changes to Production. The states appear under the application name on the Partner Profile page. The 'Partner Auth Level' describes the type of applications you are allowed to develop based on your contract with Telia. These are summarized in the table below: Partner Auth Level (provisional text) Default Mobiiliviesti MT Mobiiliviesti MT + operaattoririippumaton lyhytnumero Viestirajapinta Mobiililaskutus Applicable Bundle Definition = Application Auth Level n/a First application for Promote to Production. Portal administrator approval is required in all cases. BULK only As above plus Non-Chargeable RO, PUSH, and QR As above plus Chargeable RO, PUSH, and QR As above plus Charging API If, for example, your Partner Auth level is "Mobiiliviesti MT" but you wish to develop an Application with Service Type of "Push with Charging", then you need to set up a new contract before the promotion is complete. The system generates a ticket for Portal administrator review, action and decision. 6.5 Managing Notifications You can set up your application to receive notifications of messages received by the Portal. Messages are identified by their number and associated keyword, as summarized in section The standard workflow consists of: 1. Requesting a number for MO messages to send to - and when approved, assigning it to an application as required 2. Creating a keyword and associating it with a number, to route the messages 3. Creating the notification using the keyword and number, to report notification on the messages containing the keyword This section describes the tasks which you can perform from the Manage Notifications page: Requesting a number to be assigned to the application described in section Viewing numbers pending decision by the Portal administrator section Opaali Portal Guide 39

40 Working with Applications Viewing Partner numbers section Assigning Partner number to Application section Viewing Application numbers section Unassigned a Partner Number from an Application section Creating a keyword and number pair for the notification section De-assigning and reactivating a keyword section Setting callback credentials (option) section Creating notifications section Pausing, restarting and stopping notifications section Requesting a Number NOTE: Only users with Admin Access to the Partner can request new Short Numbers and Long Numbers. Other users can associate existing numbers with the application but cannot request new numbers. A number may be a short number or a long number. You can request a number in either of the models below, to be allocated to your Partner: Shared: from a pool of registered numbers to be shared by multiple Partners. You ask for one to be automatically assigned during the request number step below. You see this number in the approval . Unshared: a number that you can bring to the Portal and request for it to be allocated to your Partner and assigned to your application. You can use it for other applications of the same Partner, but is not available to other partners. When you submit your request as described below, the system raises a ticket, which a Portal administrator can claim and approve or disapprove the request. The decision is ed to you, with the allocated number, if approved. To request a new Short Number or Long number for a Partner 1. Click Manage Partner in the Dashboard page. The Partner Profile page appears. 2. Click Manage Application beside the application for which you require short numbers/long numbers. 3. Click Manage Notifications. The Manage Notifications page appears. See Figure 9: NOTE: The options to create new Keywords and Notifications is not available on the Manage Notifications page until a number is assigned to the application. Opaali Portal Guide 40

41 Working with Applications Figure 9 Manage Notifications page initial view 4. Click Request Number. The Create a New Number page appears. See Figure 10. Figure 10 Request a New Number page initial view 5. Select Short Code or Long Number from the Number Type drop-down list. 6. Select Please assign a number automatically to have a number assigned automatically by the Portal administrator from the pool of numbers registered on the platform. OR Select Please assign a specific number for the application to request a specific number for the application, enter the number in the Number field that appears. This is unique to your applications, called an unshareable number. 7. Click the Countries and Networks in which the requested number is used. Opaali Portal Guide 41

42 Working with Applications A list of networks within the selected country appears, for example: Figure 11 Create a New Number page Network selected view 8. Select the Network in which the requested number is used. NOTE: You can select multiple networks for a Short number, but not for a long number. 9. Click Submit. This sends the request and is in Pending status, which can be viewed as described below Viewing Number in Pending Request Status NOTE: Pending Requests is only available to Portal administrators of the partner. Other users of the partner can associate existing short code/long numbers to their applications but they cannot view pending requests. A number request made in the section remains in the Pending status until a Portal administrator claims the ticket and makes a decision. To view number requests in pending status 1. Click Manage Partner in the Dashboard page. The Partner Profile page appears. 2. Click Manage Application beside the application for which the numbers have been requested. 3. Click Manage Notifications. The Manage Notifications page appears. 4. Click Pending Requests. Opaali Portal Guide 42

43 Working with Applications The Pending Requests page appears, showing Number, Network, and Enabler Type fields. The example screenshot shows the number which had been applied by the partner. If the number is to be allocated by the Portal administrator, the Number field shows TBD: Figure 12 Pending Code Requests panel After the Portal administrator approves the number allocation, the number is available to be viewed as described in section 6.5.3, as Partner Number Viewing Partner Numbers When a number is allocated to a Partner, it appears on the Partner Numbers page, as described in section Any associated applications are also be listed. If a number is associated with an application, it also appears on the Manage Notifications page Assigning a Partner Numbers to an Application You need to actively assign a Partner Number to your application unless you had requested a number from the application. You also need to assign it back, if you have removed it previously from the application. To assign a Partner Number to an application 1. Click Manage Partner in the Dashboard page. The Partner Profile page appears. 2. Click Manage Application beside the application for which you require shortcodes/long numbers. 3. Click Manage Notifications. The Manage Notifications page appears. 4. Click Assign Partner Number. The Assign Partner Numbers to Application page appears. Opaali Portal Guide 43

44 Working with Applications Figure 13 Assign Partner Numbers to Application page 5. Select the Enabler Type for each number to be assigned. 6. Click Assign Partner Number. 7. This refreshes the Manage Notifications page with the number added to the Number Panel Viewing Application Numbers When a number is assigned to your application, it appears on the Manage Notifications page: Figure 14 Partner Numbers added in Manage Notifications page Opaali Portal Guide 44

45 Working with Applications Removing a Partner Number from an Application You can remove a number from your application. To remove a number 1. View application numbers from the Manage Notifications page. The Numbers panel displays any numbers assigned to your application, see Figure Click the red icon at the end of the row for the number you wish to remove. The page will be refreshed with the number removed from the Number panel. The number remains in the Partner Numbers page, described in section but removes the application name from the number row. You can reassign the number to your application using the steps described in section Working with Keywords A keyword is the first text in a message before the first space. It is used as a criterion to route messages sent to a particular number, for notification to the application. Therefore, each keyword and number pair must be unique. Opaali Portal Guide 45

46 Working with Applications Keyword Rules The following rules are used to enforce the uniqueness of each keyword and number pair across the platform If you are using a shared number, you must create a keyword and associate it with the number for use with a notification. If you have more than one notification, you need either a different keyword or a different shared number to use, as each keyword + number pair must be unique in OSP. If you are using an unshared number for your application and have only one notification, you do not need to set a keyword. However, if you are going t to use the same number for more than one notification you will need to set a different keyword for each notification. In either case, the system shows you available choices only. If the keyword you have entered is included on the blacklist the system will return an error message. There is a system limit on the number of keywords you can have in each of RESERVED, ACTIVE, and QUARANTINED states, normally 10. If you try to create one in excess of this number, you may be prompted to purge one from the QUARANTINED state. See section De-assigning/Reactivating/Purging Keywords The following diagram shows the keyword states: Figure 15 Keyword Lifecycle Create & Assign Create Notification Reserved Quarantine Active Stop Notification Reassign Quarantined Purge Opaali Portal Guide 46

47 Working with Applications Creating Keywords You can create a keyword from Create Keyword, as described below. NOTE: Creating Keyword is hidden until a number is assigned to your application. To create a keyword for your notifications 1. Click Manage Partner in the Dashboard page. The Partner Profile page appears. 2. Click Manage Application beside the application for which notifications are required. 3. Click Manage Notifications. The Manage Notifications page appears. 4. Click Create Keyword. The Create Keyword page appears, with the fields as shown in Figure 16. Figure 16 Create Keyword page 5. Specify the number you wish to associate the keyword with, from the Number drop-down list. 6. Enter the Keyword. The system returns an error message if the keyword is in use or blacklisted or if it doesn t conform to any other system rules. 7. Click Create Keyword. This refreshes the Manage Notifications page and shows the keyword created, in RESERVED status, as shown in Figure 17. Figure 17 Keyword created in Manage Notifications page Opaali Portal Guide 47

48 Working with Applications The status changes to ACTIVE when the keyword is in use with a notification. The expiry date is not displayed for RESERVED status, as its system configured expiry period is very long, for example, 180 days. The expiry date for QUARANTINED status, which has a system configured expiry period of 90 days (configurable) Quarantining,Reactivating and Purging Keywords Keywords in RESERVED status can be unassigned from the application and put into QUARANTINED status. The same user who unassigned the keyword (and the Portal administrator) can reactivate it to RESERVED status, or to purge it from the system. To remove a keyword from an application 1. Click Manage Partner in the Dashboard page. The Partner Profile page appears. 2. Click Manage Application beside the application for which notifications are required. 3. Click Manage Notifications. The Manage Notifications page appears. 4. In the Keyword panel, find the keyword you wish to remove. 5. Click. The keyword is now in QUARANTINED status, as shown in Figure 18, and can remain so until expiry (after system configured number of days, for example, 90 days) unless you or the Portal administrator takes action. Figure 18 Keywords in QUARANTINED and RESERVED States Opaali Portal Guide 48

49 Working with Applications 6. [Option] To reactivate the keyword from QUARANTINED to RESERVED status, click. 7. [Option] To purge the keyword, click X Setting Callback Credentials (Option) You can optionally provide Callback Credentials for the Partner, to add an authentication header to callbacks which uses https. If required, you need to set this before creating a notification. To register Callback username and password 1. Click Manage Partner in the Dashboard page. The Partner Profile page appears. 2. Click Manage Application beside the application for which notifications are required. 3. Click Manage Notifications. The Manage Notifications page appears. 4. Click Callback Credentials. The Edit Callback Credentials page for the application appears. 5. Enter the Callback User Name. 6. Enter the Callback Password and repeat this to confirm. Any value up to 255 character length may be used for these fields. 7. Click Update Callback Credentials Creating and Starting Notification Now you can create a notification, which starts immediately when created. Opaali Portal Guide 49

50 Working with Applications To create a notification, using the Partner number assigned to your application and any keywords you have created 1. Click Manage Partner in the Dashboard page. The Partner Profile page appears. 2. Click Manage Application beside the application for which notifications are required. 3. Click Manage Notifications. The Manage Notifications page appears. At this point, you should have an application number and an associated keyword displayed as being available for use for a notification. Figure 19 created Manage Notifications page with Numbers assigned and Keywords TIP: Create Notifications is hidden until a number is assigned to the application. 4. Click Create Notifications. 5. Select the Type of notification from the drop-down list. 6. Select the Number from the drop-down list of available Partner Numbers allocated by the Portal administrator. 7. If a short code is selected as the number, select the Network(s), from the choice which appears on the page. 8. Select the Keyword from the drop-down list. 9. Select the notification model. Opaali Portal Guide 50

51 Working with Applications Table 3 Notification Models Notification Model Polling Message Retrieval Description Cache and collect model. No application callback is required. The application periodically retrieves messages from the platform through the API. When you select this model, a placeholder URL appears in the Callback URL column in the Notifications panel. Push Notification A direct push of notifications. An application callback is required. You need to enter the Callback URL (notifyurl) for your application. NOTE: If the Callback URL has any port number associated, then only ports 80 (for http) and 443 (for https) are supported for notifications of Inbound Messages. If the partner is using any other port then the partner has to raise a support ticket to enable the port. 10. Enter the Callback URL in the field that opens, if you select Push Notification. 3. Click Save.This starts notification. The Manage Notifications page refreshes to show notifications created with its ID. See Figure 20. Figure 20 Notifications created on Manage Notifications page Opaali Portal Guide 51

52 Working with Applications The keywords in use show their status as ACTIVE. In Figure 20, five notifications have been created. The link is the default URL for the Poll option. The other notification in Figure 20, had specified its example.com URL for the Push Notification option during the notification creation step. In the ID column, click the file icon to view the full ID Pausing, Restarting and Stopping Notifications You can pause and restart, and stop a notification from the Manage Notification page. To manage your notification 1. Click Manage Partner in the Dashboard page. The Partner Profile page appears. Opaali Portal Guide 52