0% found this document useful (0 votes)
49 views4 pages

Sapi Server Mode Guide

Bloomberg is discontinuing support for Server Mode in SAPI and providing this guide to help clients transition. Server Mode allows requests without presenting an identity. The guide explains what Server Mode is, how to identify if code uses it, and changes needed to pass an identity for each request. Developers should test in Dev SAPI, notify when ready for Server Mode to be disabled, and can get help from Bloomberg.

Uploaded by

khg20052000
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
49 views4 pages

Sapi Server Mode Guide

Bloomberg is discontinuing support for Server Mode in SAPI and providing this guide to help clients transition. Server Mode allows requests without presenting an identity. The guide explains what Server Mode is, how to identify if code uses it, and changes needed to pass an identity for each request. Developers should test in Dev SAPI, notify when ready for Server Mode to be disabled, and can get help from Bloomberg.

Uploaded by

khg20052000
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4

Disabling Server Mode in SAPI

Migration Guide for Developer


Summary
Bloomberg is going to drop support for Server Mode in SAPI. This document is designed to assist
clients through this transition by explaining what Server Mode is, how to identify application
code that should be updated, and what changes are needed. The goal is to make the transition
as seamless as possible.

What is Server Mode?


Server-Mode is a legacy setting in SAPI that allows clients to request and retrieve SAPI data
without presenting an identity of the requester - being a User or Application. Bloomberg is
looking to disable this setting.

How can I tell if my application uses Server Mode?


Review your application code, look for calls to the following methods, check if an Identity
Object argument is passed in:
Session.sendReqest()
Session.subscribe()
For example, the following calls are made without passing in an Identity, this is clear indication
that the requests and/or subscriptions are made in Server Mode:

sendRequest(request)
sendRequest(request, correlationId)
sendRequest(request, correlationId, eventQueue)

subscribe(subscriptionList)
subscribe(subscriptionList, label)

Or a Null (or non-authorize) Identity could be passed in - this has the same effect as not passing
in any Identity:
identity = Null
...
sendRequest(request, identity)
subscribe(subscriptionList, identity)

On the other hand, in SDK 3.15 or later, an identity object may not explicitly be passed in, in this
case the Session’s default identity is assumed. In this case the calls are not made in Server-
mode:

sessionOptions.setSessionIdentityOptions(authOptions)
...
session.sendRequest(request)
session.subscribe(subscriptionList)

I have received the notice, what is next?


Fill out the survey and provide your developer contacts and other information. Your Bloomberg
representative should contact you shortly after.

Next, start making code changes and test your application(s) against Dev SAPI. You have the
option to start making code changes while Server Mode is enabled. Once completed, please
notify your Bloomberg representative to schedule a time for turning off Server Mode in Dev
SAPI so you can start testing.

Alternatively, you may request that Server Mode be turned off in Dev SAPI before making code
change. This should be done in coordination with all your internal SAPI application owners.
In either case, please provide a timeline and the ETA of development and testing.

I do not have, or I cannot locate my Dev SAPI


Bloomberg will gladly assist in providing the IP address and port number of Dev SAPI if it’s up
and running. If Dev SAPI cannot be located, then Bloomberg will assist in installing a new
instance.

How can I change my code?


Please see the Quick Guides to Application and User authentication provided. Review how to
authorize an application identity and pass it in every call to sendRequest() and/or Subscribe() or
set that identity as the session’s default identity.
Bloomberg can set up calls with your application developer to get into details of authentication
and authorization based on your workflow and application architecture.
This is also a good opportunity to consider authenticating and authorizing users as well if not
already done.
This could also be a good opportunity to upgrade the SDK to the latest version (currently 3.19)
to leverage the simplified authentication workflow and many other new enhancements.
Here are some helpful resources:

Authentication Coding

Code change is completed; how can I test my application?


Notify your Bloomberg representative – Mention that you have completed code changes and
are looking to either test against your Dev SAPI, or to roll out to production. Bloomberg will
arrange a call, provide the IP address, and port number of your Dev (or PROD) SAPI, disable
Server Mode setting and then you can start a full test of your application. In case the test could
have failed in one or more application functions, we can roll back the setting if needed.

Rolling out to Production


Once the test is completed against Dev SAPI that has Server Mode disabled, please notify your
representative to disable Server Mode in Prod SAPI. Bloomberg recommends making this
change outside business hours.

Some users are experiencing issues in production


Representatives will be on standby to assist with any unforeseen issues during the first few
days of Production. If the issue was related to the change in Server Mode setting, we will roll
back the setting until the issue is investigated and resolved.

WHAT IS SERVER MODE

1. TEST APP IN DEV SAPI


2. ENABLE LOGGING? DEBUG/TRACE - PROBABLY GIVE BOTH OPTIONS – LOG NON DATA EVENTS
OR SET BLPAPI LOGGING TO DEBUG
3. CLIENT TEST ON DEV ASID AND NO ISSUES – ITEAM NEEDS TO CHECK IF USER AUTH IS BEING
DONE OR NOT.
4. IF YES, GREAT
5. IF NOT, IS IT APP MODE – IF YES, DISABLE SERVER MODE BUT ENTER SDSK TO SEE FOR USER
AUTH ASSISTANCE,

QUESTIONS FOR ITEAM/CLIENT

IS USER MANAGEMENT ENABLED? ARE USERS REGISTERED?

IF USERS REGISTERED – DOES USER ID MATCHES OS LOGON OR EMAIL

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy