How to migrate your existing Application Source Code

You have already created your application. You installed an older version of the starter kit and now wish to update the Starter kit (including framework) to the latest version and integrate your application in it.

For the this scenario, we shall make the following FOUR assumptions:

Your Station IDs are: ABYZ and PQRS

Your application source code resides at:
/Public/a3fa-examples/apps/commonapp/ABYZ/

Your (example) GSID looks like:
https://doi.org/10.666/AB-C911

You are currently using version 1.7.0 or version 1.7.1 of the Broadcaster Starter Kit

You originally decided to make your application folder under /a3fa-examples/apps/common-app.

NOTE: We discourage this approach of making your own application folder under / a3fa-examples/ as this can be over-written or deleted during the update process.

The recommended practice is to always create you application folder outside / a3fa-examples/. Therefore your application folder should reside under: /public/

Instructions

Now that you have updated your existing Broadcaster Starter Kit o the latest version, you will notice that the updated process automatically created a back-up ZIP file of your entire existing / public/ folder.

STEP 1

In your newly installed Start Kit file system, create new folders based on Market / Station model.

If your market name is Detroit, then:

You will create an empty folder called ‘Detroit’ under /public

You will then create an empty folder ‘ABYZ’ under / public/Detroit

STEP 2

Extract the back-up zip file elsewhere. Navigate to your original folder that contained your application source code (/a3fa-examples/apps/common-app/ABYZ).

Copy your entire (existing) application folder (ABYZ)
Paste this folder in /Public/ folder of your newly updated Broadcaster Starter kit file system.

STEP 3

Edit bridge.json file found under (/public/bridge-conf/1.0/). Either edit an existing service or add a new service with your own valid GSID value and point this new service to your own appList.json file. An example snippet for bridge.json is shown below:

"https://doi.org/10.666/AB-C911": {

            "bbandappList": "/detroit/appsList.json",

            "appDefault": {

				"appName": "abyz-trigger",

				"properties": {}

STEP 4

Now ensure that your appsList.json has your trigger application and your main application properly defined. Example snippets of appsList.json are show below:

For your trigger application:

"abyz-trigger": {

                "appRoot": "/run3tv-common/apps/triggers",

                "appEntry": "/cta.html",

                "properties": {

                    "linkApp": "ABYZ",

                    "hidden": false,

                    "timeout": 5,

                    "img": "/detroit/ABYZ/trigger/img/wxyz.png",

                    "hover": "/detroit/ABYZ/trigger/img/wxyz-hover.png"

and for your main application:

"ABYZ": {

                "appRoot": "/run3tv-common/apps/common-app",

                "appEntry": "/index.html",

                "properties": {

                    "back": {"properties": {"hidden": true}},

"menu": "/detroit/ABYZ/common-app/dynamic/menu/default-menu.json",

"settings": "/detroit/ABYZ/common-app/config/default-settings.json",

"menu-settings": "/detroit/ABYZ/common-app/config/menu-settings.json",

                    "style": "/detroit/ABYZ/common-app/css/default.css",

                    "amp": "/detroit/ABYZ/common-app/css/skin.css",
                    "resize": true,
                    "header": {"type": "channel", "title": {"en": "ABYZ", "es": "ABYZ"}, "id": "SRV3", "name": "ID-3", "logo": "/detroit/ABYZ/common-app/img/home-menu/channel.png"},

                    "panels-ttl": 300000,

                    "player-ttl": 15000

},

                "drm": null,

                "allowConfigDRM": true,

                "allowLocalStorage": true,

                "allowFrameworkStorage": true

This concludes the process of migrating your exiting application code into a newly updated Broadcaster Starter Kit.

Viewing in Local Emulator:

In order to view your newly added service in the local emulator, you need to add a new station in the emulator configuration file. Point this newly added station to your service that you just defined in bridge.json file (above).

Edit the atscCmd-2021.mc file found under /emulator/ folder appropriately. An example snippet showing how to add a new station and then point it to your new service is shown below:

        "com.run3tv.query.emulator": {

            "a3fa-appContextId": "tv:a3fa-apps.yottamedialabs.com",

"a3fa-rmp": "https://your-server-url.com/assets/your-video.mp4",

            "a3fa-held": "http://localhost:5001/run3tv-common/"

},

        "org.atsc.query.service": {

            "service": ""https://doi.org/10.666/AB-C911""

},