NowSDK architecture
Summarize
Summary of NowSDK Architecture
The NowSDK is a comprehensive framework within the Mobile SDK class that allows ServiceNow customers to access and utilize various features and services of their ServiceNow instance through mobile applications. To use these services, integration of the NowSDK library is essential, along with core library initialization and configuration.
Show less
Key Features
- SDK Initialization: Configures and initializes the SDK to access its functionalities.
- User Session Handling: Facilitates seamless authorization and management of user sessions.
- Logging Interface: Offers logging capabilities with customizable thresholds and the option to suppress messages.
- NowData: Enables third-party applications to access public REST APIs, simplifying authentication and session handling. Key APIs include:
- NowAPIService: Interacts with publicly exposed REST APIs.
- NowAttachmentService: Manages file attachments within iOS applications.
- NowGraphQLService: Utilizes GraphQL queries for data retrieval.
- NowTableService: Performs CRUD operations on existing tables.
- NowAnalytics: Tracks usage analytics within mobile applications through the NowAnalyticsService.
- NowChat: Embeds a native Virtual Agent chat window, utilizing the NowChatService for chat capabilities.
- NowPush: Sends unsolicited messages to applications, with primary APIs like NowPushPayload and NowPushService for push notification management.
- NowWeb: Loads ServiceNow-hosted web pages in a native view, managing authentication and sessions automatically through the NowWebService.
Key Outcomes
By leveraging the NowSDK, ServiceNow customers can enhance their mobile applications with robust features, streamline data access, improve user interaction through chat and notifications, and gather valuable analytics. This integration ultimately leads to a more cohesive and efficient user experience within the ServiceNow ecosystem.
The NowSDK is the top-level entity of the Mobile SDK class framework.
It contains numerous classes, structures, protocols, type aliases, and functions that enable you to leverage the significant capabilities provided by the Mobile SDK and your ServiceNow instance. This document focuses on describing the primary feature services exposed in the Mobile SDK that enable you to interact with your ServiceNow instance.
To use any of the feature services provided by the Mobile SDK, you must integrate the NowSDK library into your code. You must call the core library to configure and initialize the SDK before using any SDK functionality.
NowSDK provides the following capabilities:
- SDK initialization and settings retrieval and configuration.
- Seamless authorization and user session handling.
- Logging interface. The NowSDK provides logging services to all feature services. By default, log messages are written to system logs using platform-specific functionality. You can control the logging threshold through a
parameter that is part of the call to configure the SDK. There's also an option to suppress all log messages generated by the SDK and its feature services (
log level = none). If you already have your own logging solution in place, the Mobile SDK allows you to use it. - Build and release infrastructure.
- NowData
Enables third party applications to access the public REST APIs exposed by your ServiceNow instance. Development is streamlined because NowData utilizes the authentication and session handling features provided by the NowSDK.
Primary APIs:- NowAPIService: This API provides functionality that enables you to interact with the publicly exposed REST APIs on your ServiceNow instance.
- NowAttachmentService: This API provides functionality to upload and query file attachments on your ServiceNow instance within your iOS application.
- NowGraphQLService: This API provides functionality that enables you to use GraphQL queries to obtain data from tables within your ServiceNow instance using the ServiceNow REST GraphQL API.
- NowTableService: This API provides functionality that enables you to perform create, read, update, and delete (CRUD) operations on existing tables in your ServiceNow instance that are serviced through the ServiceNow REST Table API.
- NowAnalytics
Enables you to gather and track usage analytics within your mobile applications.
Primary API: NowAnalyticsService: This API provides functionality to gather user analytics data and store it within the ServiceNow platform for later analysis and tracking.
- NowChat
Enables you to embed a native Virtual Agent chat window in your applications. This service includes UI/UX features.
Primary API: NowChatService: This API provides Virtual Agent and Live Agent chat capabilities to your iOS applications. Leverage the full-service chat capabilities provided by the ServiceNow platform by simply implementing NowChatService within your application.
- NowPush
Now Push: Enables you to send unsolicited messages to your applications.
Primary APIs:- NowPushPayload: This is a generic protocol that you can use to define a push notification protocol within the
NowSDKframework. - NowPushService: This API provides functions that enable interaction with the Push Notification service.
- NowPushPayload: This is a generic protocol that you can use to define a push notification protocol within the
- NowWeb
Enables you to load web pages hosted on your ServiceNow instance in a native web view, with support for Cabrillo. It automatically handles user authentication and session management instead of forcing users to log in to the instance via a login web page.
Primary API: NowWebService: This API provides functionality that enables the browsing of web pages on your ServiceNow instance.