Wednesday, 22 March 2017

Parameters involved in Sign In and Login Scripts

Parameters involved in Sign In and Login Scripts

In previous post we have given the details of Generic Identity Sign In. Here we will give details on parameters involved in Sign in with the sample script which helps login functionality.




  •  redirectUrl – the callback URL that the sign-in UI will need to use to redirect the user to the app based on successful or failure login.
  •  projectId – project ID mentioned in On-Demand portal  
  •  appId – the app bundle ID mentioned in projects ettings
  •  appVersion – the version of the Runtime app
  •  uuid – application running device's UUID  


 In the device we need to get the redirectUri, so that we can redirect the user to app home page on login. Below code retrieves the redirectUri and saves it in appData.

 Code to get redirect URL
    var urlParam = window.location.search.substring(1);
    urlParam = decodeURIComponent(urlParam);
    var appData = {};
    if (urlParam !== '') { // fail-safe
         var param, paramList = urlParam.split('&');
         for (var index in paramList)
        {
         param = paramList[index].split('=');  
         if (param.length === 2)
          { // fail-safe  
          appData[param[0]] = param[1];
          }
        }
    }
 
 
  Code for redirect:
 
    function login() {
    //Use a call to your db and check user credentials are valid. If it is success set the user values to a property called 'uservalues'
    function success(uservalues) {
    var authToken = JSON.stringify(uservalues);    // uservalues which is a collection of information to a specific user
    window.location = appData.redirectUri + '?authToken=' + authToken;
        else{
        window.location = appData.redirectUri + '?error="Internal Error"';
        }
    }
 
    Related Posts:
AEM Mobile integration with third party applications
AEMM: How to create custom authentication

Setting up custom analytics in AEM Mobile

Setting up custom analytics in AEM Mobile:

Custom analytics works based on the events transferred during page load/application launches. AEM Mobile apps can be configured to read custom events and send data to Analytics as per our needs.  For eg: AEM Mobile analytics provides the 'count of article views' by default. But it does not provide 'user specific article view' in analytics.

We need to define the custom events through Mobile Marketing Dashboard and its processing rules. Once this is done, we can send these pre-configured custom analytics events from within our AEM Mobile HTML content.

Below diagram shows an over view of custom analytics in AEM Mobile



Basic requirements:

1). License for Mobile Marketing SDK(Part of Digital Marketing Cloud).

2). The user who configures the custom analytics events must be an admin for the report suite in Adobe Analytics (with process rule edit permission).

3). The articles which are sending custom events must be pre configured for extensibility features by default. [On-Demand Portal> Content & Layouts> Content> Article Properties> Article Metadata> Enable Extensibility Features check box selected]


Read related posts

Integrate Analytics with AEM Mobile

Default reports available through AEM Mobile


Steps for Setting up custom analytics

1) Mobile Marketing Dashboard configurations:

In Mobile marketing dashboard (https://mobilemarketing.adobe.com/) Manage App Settings> Manage Variables & Metrics>Custom Metrics.

Custom Metrics: select an event number , enter an event name, and select type 'Whole Number'

Custom Variables: select an evar number, enter an evar name, select Tracking Call for persistence value from the drop-down.
Save the changes, rebuild your app in order for the changes to take place.

2) Configurations on Adobe Analytics (Omniture)

Omniture Step1:
Login to Omniture(https://my.omniture.com/login/), Admin> report suites> select your report suite. Then Edit Settings > Conversion > Success Events.

Click on Add New. Type an event name, and select the type Counter for the newly added event and save the configuration.

Omniture Step2:
Defining processing rules: Once the admin configures the custom analytics events and its evars, next step is adding Processing Rules for the newly created events and evars.

In Omniture Admin> Report Suite > Select the relevant report Suite > Edit Settings > General > Processing Rules

Select an  existing rule and  Add Rule > Add Action. Configure the action to set the custom event to 1 if the condition below is met. Here we are setting action to send user defined string to send the event.
Again Add Rule to create a new rule for evars, Add Action. Then configure the action to overwrite the custom evar with the evar to be used to send the event.

Save the changes, rebuild your app in order for the changes to take place.

3) Adding custom events to HTML content

Once the custom events, its evars, and processing rules are defined, we are done with configurations. Now we need to modify the HTML so that it can handle the analytics configurations.
Ensure extensibility features are enabled for your HTML content in On-Demand Portal.


i) Include the Analytics SDK in your pages. Add below line in your article HTML in the <head> tag.
<script type="text/javascript" src="cordova.js"></script>

ii) Send the Custom Event
Now configure your HTML content to send the custom event, for e.g. if you are sending the login event to analytics,
ADB.trackAction("login", {"evar51":"user-defined value"}, {"user":"testuser","remember":"true"});

The login event uses evar51 with its own set of parameters to recognise the event.

In the Back-end, when an event happens, Processing Rule increment the count of the corresponding event and the previously defined values will be overwritten with the values the user set in evar51.

Debugging the issues:
Analytics may not be appearing due to below reasons:

  • Any change in Mobile Marketing Dashboard, Omniture, needs rebuild of app in order for the changes to take place.
  • Check the extensibility features are enabled for analytics tracking.

Thursday, 9 March 2017

AEM Mobile with Login Functionality

Custom authentication Using Generic Identity Provider in AEM Mobile

AEM Mobile supports different ways of Sign in in to the application. Below are the three methods which can be integrated for AEM Mobile login functionality.

  • SAML 2.0 (Gigya, MFA/OKTA)
  • OAuth 2.0 (Facebook, Google id's)
  • Generic

AEM Mobile fetches authorization tokens from these identity providers, which you can use in your entitlement service to authorize users to content. AEM Mobile provides many APIs for Sign in procedures; For eg 'setAuthToken' 'isAuthenticated', 'launchSignInUI' etc.

Here we are going to understand the Generic identity provider implementation and it supports two types of login. First one is using a separate HTML form which is hosted in internet and second method using Sig in in experience in an AEM Mobile article itself.

Generic Identity Provider Implementation.




When users tap on Sign In button from the AEM Mobile app menu, the users are redirected to the provided sign-in UI. The Sign In HTML will have login functionality written, so that the code calls the DB and verify the user information and if it is a successful login, the user is redirected to app Home page with additional authToken Parameters. The authToken can be any String which holds multiple values related to User like user id, user location, user preferences etc.

The token can be a JSON file(Stringify this before passing to AEM Mobile as authToken) as given below. In AEM Mobile app, we can retrieve this authToken and read values, and use this values if required to set some additional features. For eg. say we need to set articles based on Geo of 'LA', so that only LA user will be able to see this content after login. We can send the authToken with below JSON and check in app for geo location. If it matches the geo 'LA' then display the article.

{
    "UserArray":[{
            "UserName":"user1",
            "userGeo":"LA",
            "userAge":"23",
            "userLastLogIn":"04-04"
        }
        
    ]
}  

Steps involved in setting up Generic Identity Provider.

Step 1: Create Login HTML

Create HTML Page with login functionality. Below given a sample HTML form page.

<html>
<head>
</head>
<body>
<form method="post" onsubmit="login();">

<input type="text" name="username">
<input type="password" id="password">

<input type="submit" value="Login" />

<script>
//You code which will call login functionality and verify the submitted user credentials by invoking DB.
// If login is success set the authToken and redirect the user from Login UI page to app home page.
//A sample code is available in next page of the blog. Parameters involved in Sign In and Login Scripts
</script>
</body>
</html>

Step 2: Host the Login HTML in you internet site.

We can place the login HTML to any internet facing site, so that we will have a new login URL like www.yourdomain.com/login.html. Ensure this is accessible through app.

Step 3: Configure the Identity Provider
Once the Login UI is ready and hosted, get the URL. Go to Master Settings of On-Demand portal > Identity Providers tab

Identity Provider Name: Generic 
Identity Provider Type: Generic

In the next 'Generic setup' screen, provide below details.

Authentication URL *: The URL Where you have hosted the login UI.
Default Session Expiry : You can leave this blank (Number of seconds that a successful sign-in is valid)

Save the configuration.

Step 4: Enable Custom Authentication in On-Demand portal
  • Go to project Settings in On-Demand Portal > Select the project to be edited, click on Edit and go to 'Access' tab.
  • Enable the check box under section 'Custom Authentication'
  • Select identity provider 'Generic'
  • Add a bundle ID under section 'Entitlement & Authentication' (This ID will be sent when apps request entitlement or authentication information)

Step 5: Build the app(not a preflight app) sign it, and test it as described here.

Read : Parameters involved in Sign In and Login Scripts

Authoring AEM Mobile Article from Custom Third party applications.


AEM Mobile on Demand portal allows third party application authoring though the APIs provided. We can have either a CMS plugin(wordpress or joomla) which talks to the API or a complete Web-based authoring solution for the same.



Using the API's services, we can manage:

  1. Articles
  2. Collections
  3. Products
  4. Push notifications

Authoring Orchestrator
Let us see the steps involved in setting up a web based authoring application system (I call it 'Authoring Orchestrator') for AEM Mobile. One of the major condition to run this application is that we need a public hosted server so that our application files can be deployed over internet.

Step 1:
Download the On-Demand Services API files : This set of files contains API Documentation, Examples etc.

Step 2:
Get the API Keys, generate Device ID, Device Token

To access the On-Demand Services API, you need to request an API key through the form specified. If you need further assistance, please let us know thorough the comment section.

Step 3:
Update /aemmobile-api-examples/config/credentials.php for below details

i) Update the values for ‘client_id' (with API Key), 'client_secret';
ii) Update the value for 'device_token', 'device_id' received from the AEX service.
iii) Provide a value for 'client_version' (It can be like 'aemmobile-orchestrator-api-doc-1.0');

Step 4:

Deploy the file folder in hosted server so that files are available over internet. The url could be
www.yourserverpath/aemmobile-api-examples/demo/index.php

Step 5:
Test the set up.
We can call the test file using url www.yourserverpath/aemmobile-api-examples/demo/01_get_access_token.php
This returns back the access token if your set up is correctly configured.

Copy the 'access_token' returned in previous example and update /aemmobile-api-examples/config/credentials.php
Now access www.yourserverpath/aemmobile-api-examples/demo/02_get_user_permissions.php, which returns the project id.
Update /aemmobile-api-examples/config/parameters.php 'publication_id' with previously retrieved project ID.
Now call www.yourserverpath/aemmobile-api-examples/demo/03_update_home_collection.php will return the top-level collections.

We can call all tests provided at www.yourserverpath/aemmobile-api-examples/demo/index.php in a similar manner.

Above tests ensures that we have configured the 'Authoring Orchestrator' correctly.

Step 6: 
Create a form(HTML/PHP) which takes the article details and post it to relevant API.

In this case you need an html or PHP file which takes all article meta data like Article Name, Article Title etc. On submission, you need to post this data by referring relevant API file.

For eg: If we are creating a new article we need to post the data to '/aemmobile-api-examples/article/create_article.php'
Once the article is created, we can have similar operation for image updation and .article file upload for the newly created article.

This 'article' folder contains article operations like

create article, delete article, get article list, get article metadata, publish article, upload article etc.

Similarly there are many directories which helps us to operate on authentication, banner, card, collection, image, layout, project etc.

Facing difficulties in configuration? Let us know through comments.

Angular JS Implementation for AEM Mobile Articles

AngularJS Articles in AEM Mobile

AEM Articles are normal HTML articles and it supports any front end technology, a normal web page supports. Here we will see how can we create an Angular article in AEM Mobile.

What is AngularJS?

Angular JS is a new Javascript technology which can be added to any HTML by adding relevant Angular library inside <script> tag.
Angular adds Directives to HTML page, and binds data to page with Expressions.

How to add AngularJS in an article?
AEM Mobile article structure contains an index.html with js, css, images, lib folders. This structure is used to create .article file using AEM Mobile packager.

Steps to create angular article:


  • Get Angular

We need to get latest AngularJS library from AngularJS website. Download 'angular.min.js' and any required angular additional libraries to your /js directory in article folder.


  • Create Controller

Now create a file controller.js in /js folder and add below code.

<!--Your Controller.js-->


var app = angular.module("myFirstAngular",['ngSanitize'], function ($compileProvider) {

  $compileProvider.aHrefSanitizationWhitelist(/^\s*(https?|ftp|mailto|file):/);

});
app.controller("controller",function($scope,$window,$sce){
 
$scope.personsList =[
                {name:'John',age:'23'},
                {name:'Jannet',age:'24'},
                {name:'Mark',age:'25'}              
                ];
                }
                );
             

  • Update index file of article to involve AngularJS in article  

         
Add angularJS libraries in your index.html. Below we have added sanitizor also which helps to sanitize the urls.              
        <head>          
            <script src="js/angular.min.js"></script>
            <script src="js/angular-sanitize.min.js"></script>
        </head>


  • Define body element which refers the controller and app.      

        <!-- Body-->
        <!-- ng-app defines an AngularJS application below-->
        <!-- ng-controller defines the application controller below-->
        <body ng-app="myFirstAngular" ng-controller="controller">

  • Add AngularJS code (which is of syntax 'ng-')

        <!--Div -->
        <!--ng-repeat repeats a set of HTML, a given number of times-->
        <div ng-repeat="person in personsList">
                        <div class = "your class">
                            <p class="name">{{person.name}}</p>
                            <p class="age" >{{person.age}}</p>
                        </div>                      
        </div>

  • Save and upload to AEM - Ondemand Portal

Save all the files, drag and drop it to AEM Mobile Packager. Your angular .article file is ready. Upload this to AEM - On-demand portal.

When you use AngularJS, you may face issue in adding 'navto' as cross browser call.
Just add 'navto' in aHrefSanitizationWhitelist so that it gets white listed.

Create 'push notifications' in AEM Mobile




Push notifications are used to re-engage passive users to the app again or conveying information about new content or products which are available in app. These push notifications can be created using the On-Demand Portal or through APIs. A separate Marketing Cloud license also provides different way of delivering push notifications through DPS.

We have different delivery options like can send the message only to phone users, or by scheduling a delivery time.

Types of push notifications:
Background notifications: which download a specific item or collection.
Text notifications: Which sends a text message to users to notify something.

Need to create push notifications for Android and iOS independently.

Apple Push Notification Service (APNS) for iOS apps.(Support both text notifications and background notifications)
Google Cloud Messaging (GCM) for Android apps.  (Support only text notifications)


Here we will show how to send push notification through android devices.

There are four steps involved in sending push notification in Android.

Configure your app for Google Cloud Messaging using the Google Developer Console.
Configure notifications section of the On-Demand Portal.
Build the Android app with push notifications enabled.
Send the text notification.


Step 1:
Configure Google Cloud Messaging.
1) Go to https://developers.google.com/mobile/add?platform=android


2) Enter values for option as below 'Create a new app or choose an existing app.'
App Name: A name for your app service
Android Package Name:  package name that you use for Bundle ID in On-Demand services (Project settings>Access>Entitlement & Authentication>Bundle ID)

3) Click 'Choose and Configure Services'

4) Select Cloud Messaging, and then 'Enable Google Cloud Messaging.'


5) Create the config file by selecting 'Generate configuration files.'

6) Keep back up of 'Server API Key' and 'Sender ID' values

7) Download the configuration file by clicking on 'Download google-services.json'



Step 2:
Configure Notification Section

1) Go to 'Notifications.'
2) Select the project which you want to update, and click Push Credentials. Then click the Android tab.
3) Select the Android app you created, and then click Add Credentials.



Specify the Server API Key and Project Number (Which you backed up in previous section step 6).

Step 3:
Building an Android app and sign it.
1) Login to On-Demand Portal and re-check 'Bundle ID' which is configured for 'Step 1, Android package name is matching project's bundle id.
2) Go to on demand Apps> App Details Tab, 'Android Push Notifications', then select 'Enable push notifications '




3) Click Upload, select the JSON file downloaded from the Google Developer Console.
4) Build , Sign, install the app on your android device.

Step 4:
Send the text notifications :


1) Click Notifications, and then click Android > Click Create > Text Notification>Details : mention below details
Destination App ID: The app which you need to send notification for
Text Notification Message: Enter the text notification message which needs to be send to users.

2) Click Delivery Options, and specify the following options:
Notification Audience: At present the options are All users, phone, tablet, users who are not app-online for a month.
Delivery Time: Immediate/ scheduled based on time zone,date time.

3) Click Create to send or schedule the message notification.

The Text notifications appear on any Android device in which the app is installed(user must have opted in to receive push notifications).



 Notes: As of now push notification does not allow linking to a specific collection. Cancel option is available for scheduled push notification, if a scheduled text notification has not yet been sent.
  If we need to send message to users within the app, we can use In-App Messaging(Which is part of Mobile Marketing SDK). In-App Messaging is a premium product. 

AEM Mobile related default reports in Adobe Analytics



Overview:
AEM Mobile analtics data can be configured to Adobe Analytics(SiteCatalyst/ Omniture) & Analytics Essentials(Mobile Marketing). SiteCatalyst provides report generation for all levels of Mobile content. Analytics Essentials provides some additional options like in App message,Acquisition tracking, Location and target etc. Analytics Essentials are part of Adobe Marketing Cloud.

AEM Mobile apps are pre-configured to report analytics information to Adobe data centers. all app related information like life cycle of the application are saved by default.



Each project in AEM Mobile on demand portal will have a report suite is automatically created. Generally mobile app stores information like Path, Dashboards, Favorites, App and Mobile metrics and app-specific items (For e.g. Articles, Collections, Banners).

AS of now the menu is not customizable.In case customization is required, you need to contact your Adobe Analytics Administrator.

Default reports available in Reports & Analytics tool

Article Reports : All article reports like Article Impressions, Article Clicks, Article Views, Article Scroll, and Social Share.

Collection Reports: All information like Collection and Article Impressions, Collection Open, and Article Click.

Social Share Report: Number of social shares.

Social Share Channel Breakdown Report: Device specific social share referral.

Banner Metrics: Banner impressions, clicks.

Overlay Reports: Hyper link clicks are tracked.

Video Engagement Report: Reports like count, percentage of completion, duration , average time on video etc.

Visitor Profile Reports: Visitor reports like unique visitors, overall visitors etc.


Key Metrics Report: App level reports like installation, launches details etc.


Can we get analytics report for Web Viewer?
Yes . But Web Viewer only supports clicks reports not mobile related swiper or taps.


Adobe Analytics integration for AEM Mobile

Create Sign In in AEM Mobile


Usual mobile apps provides a login screen on launching the application. But AEM Mobile provides this as an app menu. Which means, we need to tap on App Menu> Signin to launch the signin screen. The default collection is displayed on launching the app.

People ask in AEM Mobile, is there any way to provide such option a login screen/window that automatically opens after the splash screen upon app launch. AEM Mobile  directly does not provide such option. They have radmap to provide such option in future.

How can we achieve it manually?
Dynamic Banner is one of the option to do this. We need to provide an HTML Dynamic banner in home screen and on tapping this, the launchSignInUI API can be called from backend. Please note, this API works with both Custom Authentication and authentication via a Direct Entitlement Server. And always there will be a Sign In option avaliable in the app menu.

 If the Direct Entitlement APIs authentication is enabled, then the native sign in dialog will display. Custom Authentications like SAML, OAuth2 or Generic Identity Provider, displays a web view with sign in UX. 

How do you create banners
? Read this blog

Another less preferred option is normal HTML Article,
Create an HTML article with SignIn information and set it as the first item in Top Level Collection. The top level means it will always be the first item that gets displayed to users. ANother option could be creating a link/ button on home article clicking on this launches Sign In. But this also requires an API Call and will work with both Custom Authentication and authentication via a Direct Entitlement Server.

Note: Since we are setting this as top level one, place a logic to display this only when the Sin in is not done. Else it can have bad impact on user experience.
 
Read more on Authentication and Login APIs
https://helpx.adobe.com/digital-publishing-solution/help/identity-providers.html
https://helpx.adobe.com/digital-publishing-solution/help/app-runtime-api.html


Adobe Analytics integration with Adobe Campaign

Adobe Analytics integration with Adobe Campaign

Adobe campaign: Adobe Campaign lets you design and orchestrate targeted and personalized campaigns on multiple channels, such as e-mail, direct mail, SMS, Wap Push, search, social etc.
Adobe Analytics: Analytics service provide various levels of views like visitor geo location, what days they come the most frequently, and how long they’re staying as well as several metrics based on e-commerce data, CRM attributes, engagement, etc

Adobe Analytics data can be used to create effective Adobe campaign across channels. Adobe Analytics & Campaign Combined Together can delver following capabilities.
Performance measurement in real time
360-degree qualification and targeting
Highly personalized remarketing

Campaign to Mobile App

The Mobile App Channel lets you use the Adobe Campaign platform to send personalized notifications to iOS and Android terminals via apps. Basically there are two delivery channels available:


  • An iOS channel
  • An Android channel


There are ways to optout it. The NMAC opt-out management (mobileAppOptOutMgt) workflow updates notification unsubscriptions on mobile devices.

Adobe Campaign is compatible with both binary and HTTP/2 APNS.

To use the functionalities of the Adobe Campaign Mobile App Channel, you need to change/adapt your mobile application to integrate it into the Adobe Campaign platform using Two SDKs (one for android , other for iOS)

Steps involved in campaign set up are.

Configure connectors
Collecting information (collect the technical specifications which define the set of parameters that enable Adobe Campaign and the mobile application to communicate, like integration key, variables, urls etc)

Creating the service
Adobe Campaign administrator needs to create and configure a service linked to the mobile application

Push Notification services.

  • APNS (Apple Push Notification Service) for Apple
  • GCM (Google Cloud Messaging) for Android


Adobe Campaign uses two types of APIs:
•    Generic data access APIs for querying the data model data
•    Business specific APIs that let you act on each object: deliveries, workflows, subscriptions, etc.


Collecting data by Campaign
Action, Event activities support below data collection methods

1) The Data loading: The Data loading (RDBMS) activity lets you access this external database directly and to collect only the data required for targeting.

2) The Loading: The Loading (SOAP) activity is used in addition to the data loading (RDBMS) activity when it is not possible to collect data directly via the FDA in an external database.

3) Data loading (file): The Load (File) activity lets you directly access a source of external data and use it in Adobe Campaign. A scheduler can be run to retrieve the file.