Merge branch 'rebrand_rcc'

1. Support Docker
2. Rebrand TRCC to RCC
3. Fix typo errors

Author: wasin-waeosri

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2019 Refinitiv
+Copyright 2020 Refinitiv
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -2,34 +2,34 @@
 - Last update: July 2019
 - Environment: Windows and Linux OS 
 - Compiler: Python
-- Prerequisite: ADS and ADH servers version 3.2.1 and above, TRCC Access Credentials
+- Prerequisite: ADS and ADH servers version 3.2.1 and above, RCC Access Credentials
 
-## TRCC Overview
+## RCC Overview
 
-The Thomson Reuters Contribution Channel (TRCC) is a new service for on-boarding content to the Refinitiv. Depending on the client's needs, access to the service will be fulfilled by one or more of the following products: Contributions Channel for TREP, Contributions Channel for Elektron API, Contributions Channel for Spreadsheet. TRCC aims for replacing the legacy Market Link IP (MLIP) system.
+The Refinitiv Contribution Channel (RCC) (formerly known as TRCC) is a new service for on-boarding content to the Refinitiv. Depending on the client's needs, access to the service will be fulfilled by one or more of the following products: Contributions Channel for TREP, Contributions Channel for Elektron API, Contributions Channel for Spreadsheet. RCC aims for replacing the legacy Market Link IP (MLIP) system.
 
 Data Contribution is a means to send your pricing data directly to Refinitiv , from where it can fan out globally. Leading market participants, such as banks and brokers, use Refinitiv to publish and distribute their information to the community of financial professions, in order to advertise their prices to clients and prospects.
 
 ## Application Overview
 
-This example shows how to writing an application to contribute your data to TRCC using [Elektron WebSocket API](https://developers.refinitiv.com/elektron/websocket-api) through Thomson Reuters Enterprise Platform (TREP). The example just connects to TREP via a WebSocket connection, then sends an off-stream post to contribute item to TRCC server via that TREP. The project are implemented with Python language for both console and Jupyter Notebook applications, but the main concept and post message structures are the same for all technologies. 
+This example shows how to writing an application to contribute your data to RCC using [Elektron WebSocket API](https://developers.refinitiv.com/elektron/websocket-api) through Thomson Reuters Enterprise Platform (TREP). The example just connects to TREP via a WebSocket connection, then sends an off-stream post to contribute item to RCC server via that TREP. The project are implemented with Python language for both console and Jupyter Notebook applications, but the main concept and post message structures are the same for all technologies. 
 
-If you are interested to contribute data using the RSSL connection (with or without TREP), please visit the following series of Elektron SDK and TRCC based on your prefer API: 
-* [Contributing your data to Thomson Reuters article](https://developers.refinitiv.com/article/contributing-your-data-thomson-reuters).
-* [EMA Java Tutorial - Posting data to TR Contribution Channel](https://developers.refinitiv.com/elektron/elektron-sdk-java/learning?content=41885&type=learning_material_item).
-* [EMA C++ Tutorial - Posting data to TR Contribution Channel](https://developers.refinitiv.com/elektron/elektron-sdk-cc/learning?content=26452&type=learning_material_item).
+If you are interested to contribute data using the RSSL connection (with or without TREP), please visit the following series of Elektron SDK and RCC based on your prefer API: 
+* [Contributing your data to Refinitiv article](https://developers.refinitiv.com/article/contributing-your-data-thomson-reuters).
+* [EMA Java Tutorial - Posting data to Contribution Channel](https://developers.refinitiv.com/elektron/elektron-sdk-java/learning?content=41885&type=learning_material_item).
+* [EMA C++ Tutorial - Posting data to Contribution Channel](https://developers.refinitiv.com/elektron/elektron-sdk-cc/learning?content=26452&type=learning_material_item).
 
 If you are not familiar with Elektron WebSocket API Posting concept, please visit [Contributing Data to TREP using the Websocket API](https://developers.refinitiv.com/article/contributing-data-trep-using-websocket-api) article which will give you a full explanation of the WebSocket API Posting mechanisms and process.
 
 *Note:* In an off-stream post, the client application can send a post for an item via a Login stream, regardless of whether a data stream first exists. The route of the post is determined by the TREP (ADS and ADH) configuration.
 
 ## Contribution Setups
 
-The Elektron WebSocket API cannot connect to TRCC server directly (only Elektron SDK C++ and Java APIs support that feature). It requires TREP version 3.2.1 (and above) to take care of the JSON-OMM conversion, TRCC connection and login process for the WebSocket application.
+The Elektron WebSocket API cannot connect to RCC server directly (only Elektron SDK C++ and Java APIs support that feature). It requires TREP version 3.2.1 (and above) to take care of the JSON-OMM conversion, RCC connection and login process for the WebSocket application.
 
-![Figure-1](images/diagram_trcc_ws.png "TRCC Contribution Diagram") 
+![Figure-1](images/diagram_trcc_ws.png "RCC Contribution Diagram") 
 
-The TREP infrastructure connects to TRCC through the delivery direct network via Tunnel Stream Aggregator (TSA) adapter, which is a private network (TLS encrypted) between a client site and Refinitiv. The TSA adapter is already packaged with the ADH version 3.2, and needs to be configured. You can find more detail regarding the TREP-TRCC configurations in [Contributing your data to Thomson Reuters article](https://developers.refinitiv.com/article/contributing-your-data-thomson-reuters) page (*Contribution through TREP* section). This example also contain example ADH-TRCC configurations in *trep_config/rmds_trcc.cnf* file.
+The TREP infrastructure connects to RCC through the delivery direct network via Tunnel Stream Aggregator (TSA) adapter, which is a private network (TLS encrypted) between a client site and Refinitiv. The TSA adapter is already packaged with the ADH version 3.2, and needs to be configured. You can find more detail regarding the TREP-RCC configurations in [Contributing your data to Refinitiv article](https://developers.refinitiv.com/article/contributing-your-data-thomson-reuters) page (*Contribution through TREP* section). This example also contain example ADH-RCC configurations in *trep_config/rmds_trcc.cnf* file.
 
 ## Prerequisite
 This example requires the following dependencies softwares and libraries.
@@ -38,38 +38,57 @@ This example requires the following dependencies softwares and libraries.
 3. Python's [requests 2.x](https://pypi.org/project/requests/) library.
 4. Python's [websocket-client](https://pypi.org/project/websocket-client/) library (*version 0.49 or greater*).
 5. [Jupyter Notebook](https://jupyter.org/) runtime (for the Notebook example application)
-5. TRCC username, password and host list credentials. Please reach out to your Refinitiv sales associate to acquire TRCC access credentials.
+6. [Docker Engine - Community Edition](https://docs.docker.com/install/) (for running the console example in Docker only)
+7. RCC username, password and host list credentials. Please reach out to your Refinitiv sales associate to acquire RCC access credentials.
 
 *Note:* 
 - The Python example has been qualified with Python versions 3.6.8. 
 - Please refer to the [pip installation guide page](https://pip.pypa.io/en/stable/installing/) if your environment does not have the [pip tool](https://pypi.org/project/pip/) installed. 
 - If your environment already have a websocket-client library installed, you can use ```pip list``` command to verify a library version, then use ```pip install --upgrade websocket-client``` command to upgrade websocket-client library. 
 - You can install Jupyter Notebook on your local machine and then test the example on the machine. The alternate choice is a free Jupyter Notebook on cloud environment such as [Azure Notebook](https://notebooks.azure.com/) provided by Microsoft. You can find more details from [this tutorial](https://docs.microsoft.com/en-us/azure/notebooks/tutorial-create-run-jupyter-notebook). If you are not familiar with Jupyter Notebook, the following [tutorial](https://www.datacamp.com/community/tutorials/tutorial-jupyter-notebook) created by DataCamp may help.
-- It is not advisable to change the ADH configuration, if you are not familiar with the configuration procedures. Please consult your Market Data administrator for any questions regarding ADH-TRCC configuration.
+- It is not advisable to change the ADH configuration, if you are not familiar with the configuration procedures. Please consult your Market Data administrator for any questions regarding ADH-RCC configuration.
 
 ## Application Files
 This example project contains the following files and folders
 1. *console_python/trcc_posting.py*: The example application file
-2. *console_python/requirements.txt*: The application dependencies configurationf file
-3. *notebook_python/trcc_posting_notebook.ipynb*: The example Jupyter Notebook application file
-4. *trep_config/rmds_trcc.cnf*: ADH TRCC configurations example file (*not a completed ADH configuration file*)
-5. LICENSE.md: Project's license file
-6. README.md: Project's README file
+2. *console_python/requirements.txt*: The application dependencies configuration file
+3. *console_python/Dockerfile*: The example application Dockerfile
+4. *notebook_python/trcc_posting_notebook.ipynb*: The example Jupyter Notebook application file
+5. *trep_config/rmds_trcc.cnf*: ADH RCC configurations example file (*not a completed ADH configuration file*)
+6. LICENSE.md: Project's license file
+7. README.md: Project's README file
 
 ## How to run this console example
 
-Please be informed that your TREP server (ADS and ADH) should be applied the TRCC configurations and TRCC contribution service should be "Up" before running an example. The TRCC access credentials are required in the connection between ADH server and TRCC server only, not in the application level. 
+Please be informed that your TREP server (ADS and ADH) should be applied the RCC configurations and RCC contribution service should be "Up" before running an example. The RCC access credentials are required in the connection between ADH server and RCC server only, not in the application level. 
 
 ![Figure-2](images/adh_trcc.png "ADH TRCC Service is ready") 
 
 ![Figure-3](images/ads_trcc.png "ADS TRCC Service is ready") 
 
 1. Unzip or download the example project folder into a directory of your choice. 
-2. Run ```$> pip install -r requestments.txt``` in a console to install all the dependencies libraries.
-3. Then you can run trcc_posting.py application with the following command
+2. Enter project *console* folder.
+3. Run ```$> pip install -r requirements.txt``` command in a console to install all the dependencies libraries.
+4. Then you can run trcc_posting.py application with the following command
     ```
     $> python trcc_post.py --hostname <ADS server IP Address/Hostname> --port <WebSocket Port> --item <Contribution item name> --service <ADS Contribution Service name>
     ```
+
+## How to run this console example in Docker
+
+1. Unzip or download the example project folder into a directory of your choice. 
+2. Enter *console* folder.
+3. Run ```$> docker build -t <project tag name> .``` command in a console to build an image from a Dockerfile.
+    ```
+    $> docker build -t esdk_ws_trcc_python .
+    ```
+4. Once the build is success, you can create and run the container with the following command
+    ```
+    $> docker run esdk_ws_trcc_python --hostname <ADS server IP Address/Hostname> --port <WebSocket Port> --item <Contribution item name> --service <ADS Contribution Service name>
+    ```
+
+*Note*: If you want to connect a docker application to your *localhost* ADS server, please refer to this [Stack Overflow answer page](https://stackoverflow.com/questions/24319662/from-inside-of-a-docker-container-how-do-i-connect-to-the-localhost-of-the-mach).
+
 ## Example Results
 ### Initiate and Login to TREP
 ```
@@ -174,14 +193,14 @@ RECEIVED:
 ```
 
 ## References
-* [Refinitiv Elektron SDK Family page](https://developers.refinitiv.com/elektron) on the [Refinitiv Developer Community](https://developers.thomsonreuters.com/) web site.
+* [Refinitiv Elektron SDK Family page](https://developers.refinitiv.com/elektron) on the [Refinitiv Developer Community](https://developers.refinitiv.com/) web site.
 * [Refinitiv Elektron WebSocket API page](https://developers.refinitiv.com/websocket-api).
 * [Developer Webinar Recording: Introduction to Electron WebSocket API](https://www.youtube.com/watch?v=CDKWMsIQfaw).
 * [Contributing Data to TREP using the Websocket API article](https://developers.refinitiv.com/article/contributing-data-trep-using-websocket-api).
-* [Contributing your data to Thomson Reuters article](https://developers.refinitiv.com/article/contributing-your-data-thomson-reuters).
+* [Contributing your data to Refinitiv article](https://developers.refinitiv.com/article/contributing-your-data-thomson-reuters).
 * [Refinitiv Elektron: RIC Search](https://developers.refinitiv.com/elektron/websocket-api/dev-tools?type=ric).
 * [Refinitiv Data Model Discovery page](https://refinitiv.fixspec.com/specserver/specs/reuters): Explore TR data models, content definitions and data update behaviors.
-* [EMA Java Tutorial - Posting data to TR Contribution Channel](https://developers.refinitiv.com/elektron/elektron-sdk-java/learning?content=41885&type=learning_material_item).
-* [EMA C++ Tutorial - Posting data to TR Contribution Channel](https://developers.refinitiv.com/elektron/elektron-sdk-cc/learning?content=26452&type=learning_material_item).
+* [EMA Java Tutorial - Posting data to Contribution Channel](https://developers.refinitiv.com/elektron/elektron-sdk-java/learning?content=41885&type=learning_material_item).
+* [EMA C++ Tutorial - Posting data to Contribution Channel](https://developers.refinitiv.com/elektron/elektron-sdk-cc/learning?content=26452&type=learning_material_item).
 
 For any question related to this example or Elektron WebSocket API, please use the Developer Community [Q&A Forum](https://community.developers.refinitiv.com/spaces/152/websocket-api.html).

console_python/Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.7-alpine
+
+LABEL maintainer="Wasin Waeosri <wasin.waeosri@rifinitiv.com>"
+LABEL build_date="2019-07-30"
+
+# Copy requirements.txt first 
+COPY requirements.txt /
+# instruction to be run during image build
+RUN pip install -r requirements.txt
+
+# then copy the application
+RUN mkdir /app
+COPY trcc_posting.py /app
+#COPY market_price.py /app
+WORKDIR /app
+
+ENTRYPOINT ["python", "-u","/app/trcc_posting.py"]

console_python/trcc_posting.py

@@ -2,12 +2,12 @@
 # |            This source code is provided under the Apache 2.0 license      --
 # |  and is provided AS IS with no warranty or guarantee of fit for purpose.  --
 # |                See the project's LICENSE.md for details.                  --
-# |           Copyright Refinitiv 2019. All rights reserved.                  --
+# |           Copyright Refinitiv 2020. All rights reserved.                  --
 # |-----------------------------------------------------------------------------
 
 
 #!/usr/bin/env python
-""" Simple example of posting Market Price JSON data To TRCC via TREP 3.2.x using Websockets """
+""" Simple example of posting Market Price JSON data To RCC via TREP 3.2.x using Websockets """
 
 import sys
 import time
@@ -76,7 +76,7 @@ def send_market_price_post(ws):
     global bid_value
     global ask_value
     global primact_1_value
-    """ Send a post message contains a market-price content to TRCC """
+    """ Send a post message contains a market-price content to RCC """
 
     """ Contribution fields """
     contribution_fields = {