Skip to content

Setup and Run the Project

Jump to bottom
Randhir Kumar Gupta edited this page Apr 13, 2018 · 7 revisions

How to build and run the app

<resources xmlns:tools="http://schemas.android.com/tools" tools:ignore="MissingTranslation">
    <string name="authority_profiles">org.ekstep.ipa.profiles</string>
    <string name="authority_telemetry">org.ekstep.ipa.telemetry</string>
    <string name="authority_partner">org.ekstep.ipa.partner</string>
    <string name="authority_content">org.ekstep.ipa.content</string>
    <string name="authority_summarizer">org.ekstep.ipa.summarizer</string>
</resources>
  • App download the student data from the Google Sheets. Please follow the link for Sample Sheets format Sample Data.
  • Create a Project in Google Console the App and Enable Google Drive & Sheets API. Follow these guides for more Information

Sheets API Drive API

GenieSDK API Keys

GenieSDK needs following values for Internal API calls. All these values passed through apps build.gradle file.

  • PRODUCER_ID: Producer information. Generally, the App which is creating the event. For example: For Partners, it would be <env>.<parnter-ID>.app.
  • PRODUCER_UNIQUE_ID: In case the component is distributed, then which instance of that component.
  • CHANNEL_ID:
  • MOBILE_APP_CONSUMER: This is User-ID/Username.
  • MOBILE_APP_KEY: An unique string identifying the JWT credentials.
  • MOBILE_APP_SECRET: Secret is used to sign JWTs for this credentials as APIs uses JSON Web Tokens(JWT) to authenticate.

Partner Configuration file

The configuration file contains the information need by the Partner Apps. You'll find partner_config.json files under partnerapp/src/main/res/raw path in the app

partner.id - Id used for the Partner (Provided by Ekstep).
partner.public_key - Public Key used by Genie SDK for encrypting the Private data (Provided by Partner).
partner.channel - List of the channel used as a filter for displaying, searching customized content in Genie (Provided by Ekstep, check with the partner do they require this feature).
partner.audience - It'll take two possible values like learner and instructor.
partner.language - Set the display language in the Application.
partner.tag - Create Program Tag using the given information from the array list, used to tag telemetry data with provided partner tag. (By default we use partner ID as a tag, check with the partner if they require any other tags).

{
  "partner": {
    "id": "org.ekstep.ipa.sample",  
    "public_key": "PUBLIC_KEY",  
    "channel": [    
      "channel"
    ],
    "audience": [ 
      "learner"
    ],
    "language": "en",  
    "tag": [       
      {
        "name": "name",
        "desc": "desc",
        "startDate": "2017-05-16",
        "endDate": "2017-05-26"
      }
    ]
  }
}

Clone this wiki locally