Skip to main content

Appendix II. Cloud Notes

Creating a Note​

There are several ways to create a cloud note:

  1. Using a .csv Template: Download the template here or create a .csv file from scratch.
  2. Using the Google Sheet Template: Access the template here.
  3. Creating a Custom Note in Bookmap and Exporting It:
    • This method is less preferable because cloud notes and custom notes are not identical.
    • Cloud notes include a Diameter column, while custom notes do not.

Note Column Description​

Let’s review the key features of cloud notes. Each note includes the following columns:

  • Automap command:
    This command is optional and enables the use of the notes file for the same instrument across different data providers. Refer to the section below for more details.
  • Symbol:
    The symbol for which the note will be displayed.
    • Use the full alias (e.g., ESH5.CME@RITHMIC) for accuracy, or just the symbol (ESH5) if automapping is enabled.
  • Price Level:
    The price level the note corresponds to.
  • Note:
    The text content of the note.
  • Foreground Color:
    The text color in hexadecimal (e.g., #FFFFFF for white).
  • Background Color:
    The background color in hexadecimal (e.g.,#000000 for black).
  • Diameter:
    Specifies how many levels the note spans. For example:
    • A diameter of 3 means the note spans 3 levels (1 level above and 1 below the specified level).
    • An even diameter (e.g., 4) results in more levels below than above (e.g., 1 level up and 2 levels down).
  • Text Alignment:
    Align the text as left, center, or right.
  • Draw Note Price Horizontal Line:
    If set to TRUE, a horizontal line will be drawn at the specified price level.

Important Considerations When Creating a Note​

  • Ensure the file is in CSV format, with values separated by commas (not semicolons or other separators).
  • Use a dot as the decimal separator.
    • Microsoft Office may use regional settings, which could cause issues. Verify the file format by opening it as text.
  • The symbol and price level in the file must match the format on your platform and the Bookmap chart.
  • Optional fields (e.g., foreground color, background color, text alignment) will use default values if left unspecified.
  • Color values can be provided as hex codes (e.g., #FFFFFF) or as names (e.g., "white").
  • Consider archiving your note in .gz format (GZIP) which Bookmap automatically recognizes. Archiving is recommended when a file contains more than a few dozen lines and is distributed over a network.

Using Automap command​

Automap is useful if you want to import or share your notes for the same instrument across different data providers. Instead of listing the same instrument from different data providers, as shown below:

Symbol,Price Level,Note,Foreground Color,Background Color,Text Alignment,Diameter,Draw Note Price Horizontal Line
ESH5.CME@BMD,5980,Sell,#ffffff,#FF0000,left,,  
ESH5.CME@RITHMIC,5940,Buy,#ffffff,#FF0000,left,,  
ESH5.CME@BMD,5980,Sell,#ffffff,#FF0000,left,,`  
ESH5.CME@RITHMIC,5940,Buy,#ffffff,#FF0000,left,,

You can shorten it using #automap like this:

#automap RITHMIC,,,,,,,
Symbol,Price Level,Note,Foreground Color,Background Color,Text Alignment,Diameter,Draw Note Price Horizontal Line
ESH5,5980,Sell,#ffffff,#FF0000,left,,  
ESH5,5940,Buy,#ffffff,#FF0000,left,,

Notes for Using Automap:

  • It’s better to use data providers included in the Bookmap installation package (e.g., RITHMIC or DxFeed). For separately installed providers the name will look like this EXT:com.bookmap.datadelivery.client.BookmapDataProvider and you need to ensure that the corresponding data adapter is installed by your users..
  • Only the data providers that identify instruments by symbol alone are supported (e.g. IB can not be used as it identifies instruments by symbol+exchange+type). 
  • If automapping is enabled, you should use symbol name that corresponds to that platform in symbol column (e.g. ESH5, not ESH5.CME). 
  • Automapping is based on a symbol list maintained by Bookmap. Contact support if anything is missing.
  • Symbols that do not exist for the platform specified in the automap directive will not be remapped.

Uploading a .csv File​

After creating the file, upload it to your preferred cloud location. Below are some methods:

  1. Using Your Own VPS or Hosting:
    1. This method is reliable but requires proper configuration. Ensure the server allows direct links and supports Java clients.
  2. Using GitHub:
    1. Create a repository, upload the file, and obtain the raw link by clicking the appropriate button (e.g., https://raw.githubusercontent.com/svyatoslav-toder/cloud-notes-test/main/notes.csv).
    2. GitHub is more developer-friendly compared to OneDrive or Google Drive, making it a reliable option.
  3. Using Google Drive:
    1. Upload the file, set the permissions, and copy the link to the file.
    2. Use this service to generate the direct link.

Notes:

  • Upload files to servers that provide direct links. A direct link immediately downloads the file without redirection. For example:
  • An http→https link will redirect counts as a redirection. Use the https link if the server automatically redirects.
  • Ensure proper file permissions to avoid access issues.
  • Be aware that Google may block links under certain conditions, making this method less than 100% reliable.

Using Google Sheets​

You can create a note using Google Sheets by following this example template:

  1. Go to File > Share > Publish to Web.
  2. Select .csv from the drop-down menu for the entire document.
  3. Click Publish to generate a direct link.

Notes:

Be aware that Google may block links under certain conditions, making this method less than 100% reliable.

Last updated on