Server

Account creation

To begin using puship a registration is needed, this procedure it’s easy and free of charge: Browse to the member page and click on register

Login

Insert your data and click on create user

Register Populated

A mail containing a confirmation link will be sent t the given email address. Once the registration is confirmed it will be necessary to come back to the login page and insert the chosen Username and Password.
 

Puship application Creation

Clicking on the add new app button a new record representing your application will appear in the table below.

AddNewApp

To configure it, click on the Configure button as shown in the following figure

Configure App

A popup will be shown in which it will be possible to configure each store. It will be generated even the App Code (aka PushipAppId) that will have to be used to configure the PushNotification.js library (I.E.: Puship.PushipAppId = “APKCbOd72fXKVUU”;)

ConfigureAppPopup

At this point it’s possible to configure each platform following the platform-specific guides.
 

Stores Setup

Apple Store

Push notification in an Apple environment are quite tricky to configure and have to be done in Mac OS

AppID Creation

Go to the Provisioning portal from this link.
From the left menu select Identifiers and then click on the + button to create a new application
App IDs
Insert the application name and the chosen Unique Identifier, at the bottom of the page check Push Notification, then click on Continue.
Bundle ID

Enable the push notifications

Find the application that has just been created in the application list, select them and click on the configure edit button
AppConfigure
Click on the Configure button of the Development certificate
Enable Push
Once done it, the following screen requesting to run Keychan Access to generate the certificate will be shown.
Keychan Guide
To create the certificate go to Applications -> Utility
Utility Application
and run Keychain Access
Keychan Access
From the top left menu, click on Keychan Access -> Certificate Assistant -> Request a certificate from a Certificate Authority
Request Certificate
Fill the following form with your email and name leave blank the CA Email Address blank. Click on Save to disk and flag Let me specify key pair information.
Click Continue
Certificate Information
Save the certificated in your preferred location
Save Certificate
Be sure that the setting shown in the screen are the same of those shown in the following figure; click on Continue to complete the certificate creation
KeyPair Information.
Now go back on the Provisioning site and click on Continue; in the next page select the created certificate ancd click on Generate
Submit Request
Download the certificate that has been generated from the Provisioning Portal. Once done just import it as machine certificate. It’s possible to check if the import process has been completed correctly running the Keychain Access and looking at the Certificates section
Certificate Done
After clicking on Done, the push notification facility will be enabled for the IDE
Push Enabled

Export the Puship certificate

In order to generate the certificate needed by Puship, from the Keychan Access, right click on it and select Export “Apple Dev…
Export Certificate
Insert a name for the certificate and store it in the preferred location
Export Save
Insert the password to be applied to the certificate
Certificate Password
If requested, insert also the system password; Now the .p12 certificate will be available to be used with Puship.

Puship Server Configuration

To configure the Puship server:

  1. If the app hasn’t been created yet, follow point 2. If the app is already present, click on its Configure button.
  2. Click on Apple Store TAB:
    ConfigureAppPopup
  3. Flag the Enabled field to enable the Apple Push service.
  4. Select the .p12 certificate created in the previous chapter and insert the password used to export it
  5. Click on Save to complete the configuration. The server is now configured to send push notifications to the registered devices

Provisioning Profile generation

From the Provisioning portal click on the Provisioning and then on the + button
New Profile
In the wizard follow this steps: select the type of distribution you are doing, the application for which you are creating the certificate, the certificates (ie developers) that are associated with this profile and the devices on which you want to run the tests, the following screen for the certificate download will be shown.
Certificate Association
Download the profile and run it double clicking it The Xcode will be shown where the profile would be imported and highlighted
Profile on XCode

Associated the Profile

With XCode project

Now it’s possible to associate the profile to the project under development. Open the Xcode project and select the project root
230_ProjectRoot
Go to the Build Setting tab and in the Code Signing group click on the Any iOS SDK row of the Debug element and select the profile
Select Profile
Compiling the project and Code Sign error could occour. That means that the Build Identifier of the project doesn’t match the profile one
Compile Error
If so, select the project root and choose the target entry and the Info tab. Amend the Bundle Identifier matching the profile one.
Bundle Identifier
Once compiled, the error will be gone. In case it would be still there, clean the project, restart Xcode and compile again.
The configuration is done and everything is now ready to start receiving push notification!

With Phonegap Online Builder

The configuration on the PhoneGap online builder is quite simple and is explained in great detail at this link. Alternatively you can view the video tutorials in this section which explains step by step how to create the project with the phonegap online builder.
 

Blackberry Market

Blackberry force the users to configure the development service and then the production service, both procedures are similar; the only difference lies on the form to use to request the activation of the service:

Enable the service

To enable the Blackberry service:

  1. Open the followingpage to request the development service activation. In case of production service use this page.
  2. The activation mail could take several days to arrive. It will look like the following example:
    ConfigureAppPopup
  3. Take note of the highlighted values. They will have to be user in the Puship server configuration.

Puship Server Configuration

To configure the Puship server:

  1. If the app hasn’t been created yet, follow point 2. If the app is already present, click on its Configure button.
  2. Go to the BB store tab:
    ConfigureAppPopup
  3. Flag the Enabled field to enable the Blackberry BIS service.
  4. Fill the form with the Address, Application ID, Username e Password values present in the Blackberry activation e-mail
  5. Click on Save to complete the configuration. The server is now configured to send push notification to registered devices.

Note: At the moment only the BIS service, is supported (Free service). In order to activate the BES (Enterprise service) a request has to be sent to our customer service
 

Google Play

The Google Play account configuration is quite trivial. Google doesn’t even distinguish between development and production environment.

Google API Project Creation

To create the Google API Project:

  1. Open the Google APIs Console.
  2. If this is the first API project the following page will be shown:
    ConfigureAppPopup
    Note: If this is not the first project, the dashboard will be shown instead. It will be possible to create a new project from the top left button Create project.
  3. Once the project has been created, a page appears that displays your project ID and project number. For example, Project Number: 670330094152.
  4. Copy down your project number. You will use it later on as the sender ID during the Puship Server configuration.

Enable the GCM service

To enable the GCM service:

  1. In the sidebar on the left, select APIs & auth.
  2. In the displayed list of APIs, turn the Google Cloud Messaging for Android toggle to ON.

Obtain the API key

To obtain the API key:

  1. In the sidebar on the left, select APIs & auth > Credentials
  2. Under Public API access, click Create new key, then click Server Key
  3. Leave empty the IP address and click Create
  4. In the refreshed page, take note of the API key value that will be used during the Puship Server configuration.

Puship Server Configuration

To configure the Puship server:

  1. If the app hasn’t been created yet, follow point 2.If the app is already present, click on its Configure button.
  2. Go to the Google Play tab:
    ConfigureAppPopup
  3. Flag the Enabled field to enable the Google Cloud Messaging service.
  4. Fill the form using the Sender ID and the API key generated in the previous chapter
  5. The package name has to be the same of that one specified in the AndroidManifest.xml. You can find this file in your project. IE:
  6. Click Save to complete the configuration. The server is now configured to send push notification to registered devices.

Note: This guide is based on the Google official one that can be found at this address.
 

Windows Phone Store

You do not need any configuration to start sending push notifications. Just configure Puship as shown below.

Puship Server Configuration

To configure the puship server:

  1. If the app hasn’t been created yet, follow point 2. If the app is already present, click on its Configure button.
  2. Go to the Microsoft Market tabt:
    ConfigureAppPopup
  3. Flag the Enabled field to enable the Google Cloud Messaging service.
  4. Click Save to complete the configuration. The server is now configured to send push notification to registered devices.

 

Notifications

Send

To begin to send push notifications, press the button Send Push Notification, as shown in the figure below PushButton

A popup will be shown in which you will be able to choose which are the destination platforms (note that if a platform has not been configured yet it won’t be selectable)

Send Push

Set the message to be sent, the badge to show and the sound you want to be played once the notification reaches the device. In the Tags field, select the tags to be used as filter for sending push notifications. An empty combo box means that no devices have linked tags to this very Application. If no tags are selected, the notification will be sent to all the devices.
The Add geolocation button enable the dispatch to be done based on the last recorded position of the device, in the next screen it’s shown how a notification will be delivered only to those devices registered in Venice

Send Geo Push

Clicking on Params Combo you can attach parameters to the push. You can insert links, numbers, dates or simple text up to 255 characters.

Invia Geo Push

It’s possible to select two different sending mode, the ordinary Pushmode, that send the notification and save the message in the database in order to read it later through Puship services; or the Ship, che non mode, that DON’T send the notification but store the message in the database only. This way could be useful whenever it’s necessary to add messages to the application without notify the user of this action

Push Ship

Once the notification as been sent, a quick resume about how many devices has been reached by the notification will be shown.
 

Historical records management

The Manage Push Notification button let you access to the historical record of push notifications

Manage Push

From this section it’s possible to see in details to which devices the notification was sent, its content and the selected Tags.

To do a quick amendment to the message you just have to perform a double click on the text, edit it and once done, the content will be saved. This operation doesn’t send once again the notification but it only changes its content in the Puship database, therefore changing the section that use it in the devices.
.

Quick Push Modify

As you can see in the screenshot, the last column of the Push messages table contains two buttons:
The one icon allow the deletion of the message from the database, the other allow to view and modify the notification details other than resend it if needed.
 

Devices

Viewing

To view the registered devices list, press the Show registered Devices, button as shown in the following picture, Show devices

A window containing all the registered devices will be shown. For each devices is possible to open a detail box in which all its associated tags can be viewed.

Send Push

With the Set Expired command shown below, it is possible to temporary disable a device (until a new registration occurs).

Disable device
 

Push History by Device

Pressing the Show Push button it is possible to view all the push notifications that have been sent to the device, the same that can be fetched calling the GetPushByDevice method.

Per Device Push command

From the page shown in the picture below it is possible to amend the push notifications already sent to the device, delete them and view how many devices that notification has hit and thus how many devices showed the same notification.

Per Device hystory

Warning! Amendment or deletion of a notification will be reflected on all the devices that share it.
 

Single Push sending

Pressing the Show Push Notification button it is possible to send a push notification to a specific device

Comando Invia Push Singola

The single push sending doesn’t not show any kind of filter, it’s only necessary to input the message to send and press the Push button

Invia Push Singola
 

Statistics

For each application we offer a compact reporting system. To access it just click on the See statistics button as shown in the figure below

Statistics

3 different reports are available:

  • Push Sent by Platform, show the amount of sent push notifications

Push Sent Report

  • Unique access, show the number of unique devices that used Puship methods

Access Report

  • Sent/Access, where the previous report are overlayed to each other to sho the public based on the push notification sent

Push/Sent Report