Update 1.0 - Sessions.ipynb

Author: umernalla

1. Quick Start/1.0 - Sessions.ipynb

@@ -20,6 +20,31 @@
     "You will also require an App Key that uniquely identifies your application. Please refer to the Refinitiv Data Libraries Quick Start guide's **Access Credentials** section for instructions on creating an App Key."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "c77f2e4c-c19f-4a6c-ac1e-31d1678a28b4",
+   "metadata": {},
+   "source": [
+    "## Set the configuration file location\n",
+    "For ease of use, we offer the option of setting various initialization parameters of the Refinitiv Data Library in the _refinitiv-data.config.json_ configuration file. \n",
+    "\n",
+    "Typically you would place this file in the same folder as your Notebook or Python script.\n",
+    "Alternatively, you can place the file in an alternative folder as specified using the _RD_LIB_CONFIG_PATH_ environment variable. \n",
+    "\n",
+    "As these tutorial Notebooks are in Categorised sub-folders and to avoid the need for multiple config files (in each folder), we will use the _RD_LIB_CONFIG_PATH_ environment variable to point to a single instance of the config file in the top-level ***Configuration*** folder."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "4c9f9a18-4960-43bf-aeeb-9a60ce748084",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"RD_LIB_CONFIG_PATH\"] = \"../../../Configuration\""
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "560d68d9",
@@ -30,7 +55,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "id": "e801bb0e",
    "metadata": {},
    "outputs": [],
@@ -50,8 +75,15 @@
     "* connectivity parameters  \n",
     "\n",
     "for the various session types.   \n",
+    "\n",
+    "### Easiest way to Create & Open a Session\n",
+    "\n",
     "Using the config file, where possible, provides the simplest approach to creating and opening sessions.  \n",
-    "For example, assuming you have specified a 'default' session in the config file, you can create and open the default session as follows:"
+    "For example, assuming you have \n",
+    "* a '*refinitiv-data.config.json*' in the current working directory \n",
+    "* and specified a 'default' session in the config file    \n",
+    "\n",
+    "you can create and open the default session as follows:"
    ]
   },
   {
@@ -89,7 +121,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "rd.open_session(name = 'platform.deployed')"
+    "rd.open_session(name='platform.deployed')"
    ]
   },
   {
@@ -117,7 +149,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "rd.open_session(config_name=\"refinitiv-data.custom.config.json\")"
+    "rd.open_session(config_name=\"../Configuration/refinitiv-data.config.json\")"
    ]
   },
   {
@@ -128,10 +160,10 @@
     "<br>      \n",
     "Alternatively, if you do not wish to use the refinitiv-data config file, you can define sessions by specifying the parameters and session type explicitly - as shown below.\n",
     "\n",
-    "## Define the session of your choice\n",
-    "The following example calls use credentials/connectivity parameters as defined in the **Configuration//credentials.ipynb** file.     \n",
-    "\n",
-    "Please edit **Configuration/credentials.ipynb** to set your credentials and run the next cell before continuing"
+    "## Define the session using your own credentials store\n",
+    "Sessions can be created by explicitly passing in your credentials/connectivity parameters.\n",
+    "For example, the following calls use credentials/connectivity parameters defined inthe cell below.\n",
+    "Please edit the following cell  to set your credentials and execute, before continuing."
    ]
   },
   {
@@ -141,7 +173,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%run ../Configuration/credentials.ipynb"
+    "APP_KEY                     = 'YOUR_APP_KEY'\n",
+    "RDP_LOGIN                   = 'YOUR_REFINITIV_DATA_PLATFORM_LOGIN'\n",
+    "RDP_PASSWORD                = 'YOUR_REFINITIV_DATA_PLATFORM_PASSWORD'\n",
+    "REALTIME_DISTRIBUTION_SERVICE_HOST      = 'THE_HOST:PORT_OF_YOUR_RTDS_HOST'  \n",
+    "REALTIME_DISTRIBUTION_SERVICE_USER_NAME = 'YOUR_USER_NAME_ON_YOUR_RTDS_HOST' "
    ]
   },
   {
@@ -156,7 +192,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "id": "51fad442",
    "metadata": {},
    "outputs": [],
@@ -207,8 +243,8 @@
    "source": [
     "session = rd.session.platform.Definition(\n",
     "    app_key = APP_KEY, \n",
-    "    deployed_platform_host = DEPLOYED_PLATFORM_HOST,\n",
-    "    deployed_platform_username = DEPLOYED_PLATFORM_USER_NAME\n",
+    "    deployed_platform_host = REALTIME_DISTRIBUTION_SERVICE_HOST,\n",
+    "    deployed_platform_username = REALTIME_DISTRIBUTION_SERVICE_USER_NAME\n",
     ").get_session()"
    ]
   },
@@ -237,8 +273,8 @@
     "        username = RDP_LOGIN, \n",
     "        password = RDP_PASSWORD\n",
     "    ),\n",
-    "    deployed_platform_host = DEPLOYED_PLATFORM_HOST,\n",
-    "    deployed_platform_username = DEPLOYED_PLATFORM_USER_NAME\n",
+    "    deployed_platform_host = REALTIME_DISTRIBUTION_SERVICE_HOST,\n",
+    "    deployed_platform_username = REALTIME_DISTRIBUTION_SERVICE_USER_NAME\n",
     ").get_session()"
    ]
   },
@@ -293,21 +329,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": null,
    "id": "f628d577",
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "<SessionState.Closed: 1>"
-      ]
-     },
-     "execution_count": 4,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "session.close()"
    ]
@@ -358,7 +383,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": null,
    "id": "f2bfad89-53d1-4e22-9903-3eba81159252",
    "metadata": {},
    "outputs": [],