Lync 2014 4/15/2017 © 2014 Microsoft Corporation. All rights reserved. Microsoft, Windows, and other product names are or may be registered trademarks.

Lync 2014 4/15/2017 © 2014 Microsoft Corporation. All rights reserved. Microsoft, Windows, and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries. The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

Compliance, Message Routing, Filtering and More: Lync Server SDK
Lync Conference 2013 4/15/2017 PLAT400 Compliance, Message Routing, Filtering and More: Lync Server SDK Michael Greenlee Lead UC Architect Clarity Consulting Vijay Manian Senior Development Lead Microsoft Corporation © 2013 Microsoft Corporation. All rights reserved. Microsoft, Windows, and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries. The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

Routing in Lync Server

Session Initiation Protocol (SIP)
Standardized protocol for UC messaging Defined in RFC 3261 Lync adds some extensions for presence, conferencing Can interoperate between Lync and other SIP-based platforms Caveat: Lync does SIP over TCP/TLS rather than UDP

SIP message First line Headers (Name: Value) Body
Can be request or response Request has a method INVITE, REGISTER Response has a code 200, 301, 404

User agent Network endpoint that sends or receives SIP messages on behalf of a user.

User agent User Agent Client (UAC) User Agent Server (UAS)

User agent User Agent Server (UAS) User Agent Client (UAC)

SIP URI

SIP URI vs. Logical Physical

SIP URI vs. Logical Physical sip:mgreenlee@example.com

Proxy server

Proxy server Proxy Location Server Registrar

To/From INVITE sip:mgreenlee@example.com To: sip:mgreenlee@example.com
Request URI INVITE To: From:

To/From INVITE sip:cc2013.example.com@example.com
To: From:

URI parameters

Forking INVITE INVITE 200 OK 200 OK Proxy INVITE CANCEL

Tags INVITE sip:cc2013.example.com@example.com
From: To:

GRUUs Globally Routable User Agent URI Uniquely identifies a specific user agent Routable from anywhere Contains the gruu parameter in the URI

SIP session Also known as “SIP dialog” Tied together by Call-ID header
Uniquely identified by Call-ID plus from and to tags Starts with INVITE, ends with BYE

Message routing walkthrough

INVITE INVITE SIP/2.0 From: To: CSeq: 1 INVITE Call-ID: 474db87e9ee44b ebc8ce6e7 Via: SIP/2.0/TLS :49243 Max-Forwards: 70 Contact: User-Agent: UCCAPI/ OC/ (Microsoft Lync) Supported: ms-dialog-route-set-update Ms-Conversation-ID: Ac6O1+2jz+e9yLIhSESaW5HSxAxLNQ== ms-keep-alive: UAC;hop-hop=yes Allow: INVITE, BYE, ACK, CANCEL, INFO, UPDATE, REFER, NOTIFY, BENOTIFY, OPTIONS ms-subnet: Accept-Language: en-US ms-endpoint-location-data: NetworkScope;ms-media-location-type=Intranet

Front End Services Perform routing and other tasks Route messages to one another using request URI Located in the Server\Core directory

Front End Services ClientVersionFilter TranslationService InboundRouting / DefaultRouting UserServices OutboundRouting Etc.

TranslationService INVITE INVITE SIP/2.0 From: To: CSeq: 1 INVITE Call-ID: 474db87e9ee44b ebc8ce6e7 Via: SIP/2.0/TLS :49243 Max-Forwards: 70 Contact: User-Agent: UCCAPI/ OC/ (Microsoft Lync) Supported: ms-dialog-route-set-update Ms-Conversation-ID: Ac6O1+2jz+e9yLIhSESaW5HSxAxLNQ== ms-keep-alive: UAC;hop-hop=yes Allow: INVITE, BYE, ACK, CANCEL, INFO, UPDATE, REFER, NOTIFY, BENOTIFY, OPTIONS ms-subnet: Accept-Language: en-US ms-endpoint-location-data: NetworkScope;ms-media-location-type=Intranet

UserServices/InterClusterRouting
INVITE INVITE SIP/2.0 From: To: CSeq: 1 INVITE Call-ID: 474db87e9ee44b ebc8ce6e7 Via: SIP/2.0/TLS :49243 Max-Forwards: 70 Contact: User-Agent: UCCAPI/ OC/ (Microsoft Lync) Supported: ms-dialog-route-set-update Ms-Conversation-ID: Ac6O1+2jz+e9yLIhSESaW5HSxAxLNQ== ms-keep-alive: UAC;hop-hop=yes Allow: INVITE, BYE, ACK, CANCEL, INFO, UPDATE, REFER, NOTIFY, BENOTIFY, OPTIONS ms-subnet: Accept-Language: en-US ms-endpoint-location-data: NetworkScope;ms-media-location-type=Intranet

InboundRouting INVITE INVITE SIP/2.0 From: To: CSeq: 1 INVITE Call-ID: 474db87e9ee44b ebc8ce6e7 Via: SIP/2.0/TLS :49243 Max-Forwards: 70 Contact: User-Agent: UCCAPI/ OC/ (Microsoft Lync) Supported: ms-dialog-route-set-update Ms-Conversation-ID: Ac6O1+2jz+e9yLIhSESaW5HSxAxLNQ== ms-keep-alive: UAC;hop-hop=yes Allow: INVITE, BYE, ACK, CANCEL, INFO, UPDATE, REFER, NOTIFY, BENOTIFY, OPTIONS ms-subnet: Accept-Language: en-US ms-endpoint-location-data: NetworkScope;ms-media-location-type=Intranet

InboundRouting 101 Progress Report SIP/ Progress Report From: "Michael To: CSeq: 1 INVITE Call-ID: cfddfdafd a259f506a83ff Authentication-Info: … Content-Length: 0 Via: SIP/2.0/TLS :49243;ms-received-port=49243;ms-received-cid=2400 ms-diagnostics: 13004;reason="Request was proxied to one or more registered endpoints";source="cctest-lync-02.cclab.internal";Count="1";appName="InboundRouting" Server: InboundRouting/

INVITE INVITE sip: :49526;transport=tls;ms-opaque=1ee5c33e9d;ms-received-cid=3F200 From: To: CSeq: 1 INVITE Call-ID: 474db87e9ee44b ebc8ce6e7 Record-Route: <sip:cctest-lyncpool-01.cclab.internal:5061;transport=tls;ms-fe=cctest-lync-02.cclab.internal;opaque=state:T:F:Ci.R3f200;lr;ms-route-sig=aamklZ7YmPrsCecMhQ0J0_9cE6QKHMO9lD1jfGgdRlNlGZyrM4NVmY5gAA>;tag=990C7A A248A9D9BA48C69B3 Via: SIP/2.0/TLS :49243 Via: SIP/2.0/TLS :5061;branch=z9hG4bK0C4264F9.38B3CA99D96E73A7;branched=TRUE Max-Forwards: 69 Contact: User-Agent: UCCAPI/ OC/ (Microsoft Lync) Supported: ms-dialog-route-set-update Ms-Conversation-ID: Ac6O1+2jz+e9yLIhSESaW5HSxAxLNQ== …

Lync Server SDK

Scenarios Filter or block certain traffic Modify message content
Reroute messages to a UCMA application Integrate third-party devices or software Fine-tune PSTN or federation behaviour

Architecture Runs on Front End Server (or Edge Server)
Handles messages as they are being routed Installed/configured using Lync Management Shell Can be script-only or managed

WARNING! You can seriously mess up Lync Server routing with these APIs
Make sure to test in a lab environment for both stability and performance

Two types of applications
Script-only Entirely contained in manifest file Higher performance Cannot delete or modify existing SIP headers Can’t reference external resources (except text file) Best for simple routing tasks Managed Generally deployed as a Windows service Need to be careful of performance impact Can modify, add, remove headers, modify message body Can reference external resources (e.g., database) Best for modifying messages, complex routing, anything that requires external data

Manifest file Text file with .am extension deployed on Front End
Contains XML document with application attributes and script

Manifest file <?xml version="1.0"?> <r:applicationManifest
r:appUri=" xmlns:r=" <r:requestFilter methodNames="INVITE,MESSAGE" strictRoute="true" registrarGenerated="false" domainSupported="false"/> <r:responseFilter reasonCodes="NONE"/> <r:scriptOnly/> <r:splScript> …

Manifest file <requestFilter> <responseFilter>
Determines which SIP requests get handled by the script Can filter by SIP method Supported domain flag Strict route flag <responseFilter> Determines which SIP responses get handled by the script Can filter by SIP response code <scriptOnly> Included if there is no managed code components

Manifest file <?xml version="1.0"?> <r:applicationManifest
r:appUri=" xmlns:r=" <r:requestFilter methodNames="INVITE,MESSAGE" strictRoute="true" registrarGenerated="false" domainSupported="false"/> <r:responseFilter reasonCodes="NONE"/> <r:scriptOnly/> <r:splScript> …

SPL script SPL = SIP Processing Language Also known as MSPL
C#-like syntax with limited set of functions, preset variables Can access the request or response data and perform simple routing functions

SPL script ProxyRequest ProxyResponse BeginFork/Fork/EndFork Respond
Lync 2014 4/15/2017 SPL script ProxyRequest Send a request along Leave parameter blank to send to original destination Include a parameter to send to a specific physical location ProxyResponse Send a response along BeginFork/Fork/EndFork Send a request to multiple locations Only one of the receiving endpoints needs to respond Respond Send a response to the request without proxying it anywhere Can be used to block or forward requests © 2014 Microsoft Corporation. All rights reserved. Microsoft, Windows, and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries. The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

SPL script Log("Debug", false, "");
Log("Debug", false, "Entering ContentModification.am"); index = IndexOfString(sipRequest.Content, "echo"); if (index == -1) { /* * Not found; no-op */ } else sipRequest.Content = Concatenate(sipRequest.Content, " (echo.)"); Log("Debug", false, " Message body matched substring; modified content"); ProxyRequest("");

SPL script Log("Debug", false, "");
Lync 2014 4/15/2017 SPL script Log("Debug", false, ""); Log("Debug", false, "Entering ContentModification.am"); index = IndexOfString(sipRequest.Content, "echo"); if (index == -1) { /* * Not found; no-op */ } else sipRequest.Content = Concatenate(sipRequest.Content, " (echo.)"); Log("Debug", false, " Message body matched substring; modified content"); © 2014 Microsoft Corporation. All rights reserved. Microsoft, Windows, and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries. The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

SIP Application API A.k.a. Managed SPL
.NET API for handling SIP messages en route through the Front End or Edge Superset of the capabilities of SPL Can be slower because it’s a managed code API Must be used in conjunction with an SPL script

SIP Application API – SPL methods
Dispatch Send a message to managed code for an SPL script for further handling Can specify managed code method name and extra parameters DispatchNotification Call a method in managed code with message info, but continue routing the message Good for passing data to managed code for processing without impacting performance

Dispatching to managed code
if (sipRequest.StandardMethod == StandardMethod.Invite) { if (GetParameterValue(sipRequest.To, "tag") != null) return; } queryUri = RequestTarget.Uri; targetAOR = QueryAddressOfRecord(queryUri); fromUserUri = GetUri(sipRequest.From); fromUserAOR = QueryAddressOfRecord(fromUserUri); Dispatch("RequestInviteHandler", targetAOR, fromUserAOR );

Managed SPL public void RequestInviteHandler(object sender, RequestReceivedEventArgs eventArgs) { ServerTransaction srvTran = eventArgs.ServerTransaction; Request request = eventArgs.Request; … string targetAor = eventArgs.Parameters[0] as string; string sourceAor = eventArgs.Parameters[1] as string; if (IsCrossingEthicalWall(sourceAor, targetAor)) Console.Out.WriteLine("Rejecting Request."); Response resp = request.CreateResponse(403); srvTran.SendResponse(resp); return; }

Lync Management Shell Need to set up and enable server application in Lync environment using Management Shell *-CsServerApplication

*-CsServerApplication
Identity Indicates pool the application is on, and application name Uri Must match URI in the manifest file ScriptName For script-only applications, the path to the manifest file Priority Order in which applications get to handle messages – lower numbers get higher priority Critical If true, the Front End service won’t start if this application can’t be loaded

Troubleshooting Script-only Managed
Check script path in Management Shell Make sure application is enabled Make sure URI matches between Management Shell and manifest file Check event log for errors from LS Script-Only Applications Make sure <scriptOnly/> element is present Use APILogger.exe Managed Make sure application is running under the right service account Check service account group assignments and permissions Make sure application is enabled Make sure manifest file is in the right directory Log to the console or the event log in your code Check event log for errors loading your application Collect RTCSPL logs with Lync Server Logging Tool

Demo: Message filtering
Vijay Manian

Demo: Redirect Vijay Manian

Demo: Modifying content
Vijay Manian

Resources MSDN documentation SDK download
SDK download

Thank you

Lync 2014 4/15/2017 © 2014 Microsoft Corporation. All rights reserved. Microsoft, Windows, and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries. The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

Monday, February 17th Exhibit Hall Hours 6:00pm – 8:00pm 6:00pm – 8:00pm Welcome Reception Tuesday, February 18th Exhibit Hall Hours 8:00am – 9:00am (Breakfast), 10:30am – 5:00pm 8:00am – 9:00am Breakfast (Exhibit Hall) 9:00am –10:30am General Session 10:30am – 5:00pm Expo Hall Hours 11:00am – 12:15pm Sessions & Hands-on Labs 12:15pm – 2:00pm Lunch 2:00pm – 5:00pm Sessions & Hands-on Labs 5:00pm – 7:00pm Ask the Experts Wednesday, February 19th Exhibit Hall Hours 10:30am – 4:30pm 7:30am – 8:30am Breakfast 8:30am – 11:30am Sessions & Hands-on Labs 10:30am – 4:30pm Expo Hall Hours 11:30am – 1:00pm Lunch 1:00pm – 5:45pm Sessions & Hands-on Labs 6:30pm – 9:30pm Attendee Party Thursday, February 20th Exhibit Hall Hours 9:00am – 12:00pm 8:00am – 9:00am Breakfast 9:00am – 12:00pm Expo Hall Hours 9:00am – 12:15pm Sessions & Hands-on Labs 12:15pm – 1:30pm Lunch and Departures

Ask the Experts Location: Meal Hall located on Level 1 in Pinyon Ballroom 4-8 Tuesday, February 18 Meet face-to-face with the foremost experts in the Lync field and ask them the questions that have you stumped. TABLE TOPICS: Best Practices, Business Value, Clients & Mobility, Lync Meetings and Video, Lync Online, Networking, Platform, Server & Manageability, Voice, Lync Feedback Sessions

Lync Feedback Location: Breakout rooms located on Level 1 5:00pm-7:00pm Come participate in targeted Feedback Sessions to hear about the high-priority feature asks and help us improve the next release! GROUPS INCLUDE: Manageability – Pinyon 2 Meetings & Web Experiences – Bluethorn 4-6 Mobility – Bluethorn 7-9 Presence & Chat – Pinyon 1 Voice & Video – Bluethorn 1-3 These sessions are meant to be informational, providing an understanding of the workload and conversational, to discuss your user scenarios and desired improvements.

Birds of a Feather Birds of a Feather flock together! Join daily breakfast discussions of relevant topics by sitting in the separately designated areas of the Meal Hall. Seating will be sorted in a different way for each Birds of a Feather breakfast: Wednesday, February 19: Where are you from? Asia/Pacific, Eastern & Central Europe, Latin America, Middle East & Africa, US (West, Central & East) and Canada, Western Europe Thursday, February 20: What is your interest? Best Practices, Business Value, Clients & Mobility, Lync Meetings and Video, Lync Online, Networking, Platform, Server & Manageability, Voice

#LyncConf14 /msftLYNC /microsoft-lync /MSFTLync

Lync Launch Pad You’ve launched Lync. Now Launch this.
MS Pavilion – Expo Hall

Fill out evaluations to win prizes
Lync 2014 4/15/2017 Fill out evaluations to win prizes Fill out evaluations on MyLync or MyLync Mobile. Prizes awarded daily. © 2014 Microsoft Corporation. All rights reserved. Microsoft, Windows, and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries. The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

4/15/2017 4:26 PM © 2014 Microsoft Corporation. All rights reserved. Microsoft, Windows, Windows Vista and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries. The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION. © 2010 Microsoft Corporation. All rights reserved. Microsoft, Windows, Windows Vista and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries. The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

Lync 2014 4/15/2017 © 2014 Microsoft Corporation. All rights reserved. Microsoft, Windows, and other product names are or may be registered trademarks.

Similar presentations

Presentation on theme: "Lync 2014 4/15/2017 © 2014 Microsoft Corporation. All rights reserved. Microsoft, Windows, and other product names are or may be registered trademarks."— Presentation transcript:

Similar presentations

About project

Feedback

Log in

Auth with social network:

Lync 2014 4/15/2017 © 2014 Microsoft Corporation. All rights reserved. Microsoft, Windows, and other product names are or may be registered trademarks.

Similar presentations

Presentation on theme: "Lync 2014 4/15/2017 © 2014 Microsoft Corporation. All rights reserved. Microsoft, Windows, and other product names are or may be registered trademarks."— Presentation transcript:

Similar presentations

About project

Feedback