How to integrate ServiceNow with SAP Crystal Reports
Learn how to quickly and efficiently connect ServiceNow with SAP Crystal Reports for smooth data access.
Read and write ServiceNow data effortlessly. Integrate, manage, and automate incidents, tasks, attachments, and records — almost no coding required. You can do it all using the high-performance ServiceNow ODBC Driver for SAP Crystal Reports (often referred to as the ServiceNow Connector). We'll walk you through the entire setup.
Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.
Create data source using ServiceNow ODBC Driver
Step-by-step instructions
To get data from ServiceNow using SAP Crystal Reports, we first need to create an ODBC data source. We will later read this data in SAP Crystal Reports. Perform these steps:
-
Download and install ODBC PowerPack (if you haven't already).
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
Create a User data source (User DSN) based on the ZappySys API Driver driver:
ZappySys API Driver
- Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
- Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "ServiceNow" from the list of Popular Connectors. If "ServiceNow" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
ServicenowDSNServiceNow
-
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
ServiceNow authentication
Authenticate using ServiceNow instance username and password.
Locate your ServiceNow instance credentials and use them for HTTP authentication:
- Go to https://developer.servicenow.com/dev.do and log in.
- Click on your profile picture.
-
When a menu appears, click on Manage instance password or a similar option:
-
In a new window you will see your HTTP Basic Authentication credentials:
-
Done! Use this username and password when configuring HTTP Authentication parameters.
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
Basic Auth (UserName and Password) [Http] - Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
ServicenowDSNServiceNowBasic Auth (UserName and Password) [Http]https://[$InstanceName$].service-now.com/api/nowRequired Parameters InstanceName (e.g. mycompany) Fill-in the parameter... User name Fill-in the parameter... Password Fill-in the parameter... Optional Parameters ApiVersion v2 RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True Date Time Value Handling
ServiceNow authentication
Authenticate using OAuth 2.0 Authorization Code Flow (3-legged)
Create OAuth application and use it for authentication:
- Login to your instance at https://your-instance-id.service-now.com.
-
Start by clicking on menu item All, then search for oauth, and click Application Registry option:
-
Then click button New:
-
Continue by clicking Create an OAuth API endpoint for external clients option:
-
Move on by naming your OAuth application and entering a Client Secret (or let it be generated automatically).
- Click on the lock icon next to the Redirect URL. Enter
https://zappysys.com/oauth. This is not needed if you use Client Credentials Grant or Password Grant -
Finally give it a final touch by increasing the Refresh Token Lifespan value to
315,360,000(it should last for 10 years):
- Change Default Grant Type as per your need. NOTE: If you prefer to use Client Credentials grant (Service account style access without using real userid-password) then your admin must enable it. Client Credentials is only supported on instances where it is explicitly enabled by the ServiceNow administrator. Its not supported in Dev / Free instance.
-
Done! Now you can use Client ID and Client Secret when configuring OAuth Authentication parameters.
Enable Client Credentials Grant Type
-
Enable the Client Credentials Grant Type:
Go to System Properties > All Properties, create a new property named
glide.oauth.inbound.client.credential.grant_type.enabled, and set it to true. - Configure the OAuth Application: Navigate to System OAuth > Application Registry, click New, and select Create an OAuth API endpoint for external clients. Set the name and save the record. In the Default Grant Type field, select Client Credentials and associate it with the integration user.
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
OAuth Authorization Code Grant (User Creds) [OAuth] - Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Press Generate Token button to generate the tokens.
- Finally, hit OK button:
ServicenowDSNServiceNowOAuth Authorization Code Grant (User Creds) [OAuth]https://[$InstanceName$].service-now.com/api/nowRequired Parameters Redirect URI (***Must match as App Registry Page***) Fill-in the parameter...
ServiceNow authentication
Authenticate using OAuth Client Credentials Grant (Client ID and Client Secret). [API reference]
Create OAuth application and use it for authentication:
- Login to your instance at https://your-instance-id.service-now.com.
-
Start by clicking on menu item All, then search for oauth, and click Application Registry option:
-
Then click button New:
-
Continue by clicking Create an OAuth API endpoint for external clients option:
-
Move on by naming your OAuth application and entering a Client Secret (or let it be generated automatically).
- Click on the lock icon next to the Redirect URL. Enter
https://zappysys.com/oauth. This is not needed if you use Client Credentials Grant or Password Grant -
Finally give it a final touch by increasing the Refresh Token Lifespan value to
315,360,000(it should last for 10 years):
- Change Default Grant Type as per your need. NOTE: If you prefer to use Client Credentials grant (Service account style access without using real userid-password) then your admin must enable it. Client Credentials is only supported on instances where it is explicitly enabled by the ServiceNow administrator. Its not supported in Dev / Free instance.
-
Done! Now you can use Client ID and Client Secret when configuring OAuth Authentication parameters.
Enable Client Credentials Grant Type
-
Enable the Client Credentials Grant Type:
Go to System Properties > All Properties, create a new property named
glide.oauth.inbound.client.credential.grant_type.enabled, and set it to true. - Configure the OAuth Application: Navigate to System OAuth > Application Registry, click New, and select Create an OAuth API endpoint for external clients. Set the name and save the record. In the Default Grant Type field, select Client Credentials and associate it with the integration user.
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
OAuth Client Credentials Grant (Must be enabled by Admin) [OAuth] - Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
ServicenowDSNServiceNowOAuth Client Credentials Grant (Must be enabled by Admin) [OAuth]https://[$InstanceName$].service-now.com/api/nowThere are no parameters to configure.
ServiceNow authentication
Authenticate using OAuth Password Grant (ServiceNow instance username, password, OAuth Client ID, and Client Secret). [API reference]
Create OAuth application and use it for authentication:
- Login to your instance at https://your-instance-id.service-now.com.
-
Start by clicking on menu item All, then search for oauth, and click Application Registry option:
-
Then click button New:
-
Continue by clicking Create an OAuth API endpoint for external clients option:
-
Move on by naming your OAuth application and entering a Client Secret (or let it be generated automatically).
- Click on the lock icon next to the Redirect URL. Enter
https://zappysys.com/oauth. This is not needed if you use Client Credentials Grant or Password Grant -
Finally give it a final touch by increasing the Refresh Token Lifespan value to
315,360,000(it should last for 10 years):
- Change Default Grant Type as per your need. NOTE: If you prefer to use Client Credentials grant (Service account style access without using real userid-password) then your admin must enable it. Client Credentials is only supported on instances where it is explicitly enabled by the ServiceNow administrator. Its not supported in Dev / Free instance.
-
Done! Now you can use Client ID and Client Secret when configuring OAuth Authentication parameters.
Enable Client Credentials Grant Type
-
Enable the Client Credentials Grant Type:
Go to System Properties > All Properties, create a new property named
glide.oauth.inbound.client.credential.grant_type.enabled, and set it to true. - Configure the OAuth Application: Navigate to System OAuth > Application Registry, click New, and select Create an OAuth API endpoint for external clients. Set the name and save the record. In the Default Grant Type field, select Client Credentials and associate it with the integration user.
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
OAuth Password Grant [OAuth] - Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
ServicenowDSNServiceNowOAuth Password Grant [OAuth]https://[$InstanceName$].service-now.com/api/nowRequired Parameters User name Fill-in the parameter... Password Fill-in the parameter...
-
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - ServiceNowRead and write ServiceNow data effortlessly. Integrate, manage, and automate incidents, tasks, attachments, and records — almost no coding required.ServicenowDSN
-
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in SAP Crystal Reports to retrieve data from ServiceNow. Hit OK button to use this query in the next step.
SELECT * FROM incident --Using Primary Key --SELECT * FROM any_table_here WHERE sys_id='109562a3c611227500a7b7ff98cc0dc7' --Primary Key in WHERE clause --OR-- --Use below to query system / hidden tables (faster response - No Table name lookup needed in below) SELECT * FROM get_table_rows WITH(TableName='incident', Query='number=INC0000001') --================================= --Examples: Using Filter Expression --================================= -- Incremental Load Pattern: Load only incidents updated in the last 24 hours (see FUN_TO_DATETIME function help for more information, you can use +/- d, m, y, min,h,s along with now, today, yesterday, weekstart, weekend, monthstart, monthend, yearstart, yearend functions) --SELECT * FROM incident WITH(Query='sys_updated_on>=<<today-1d,FUN_TO_DATETIME>>') --SELECT * FROM incident WITH(Query='number=INC0000001') --Equal condition --SELECT * FROM incident WITH(Query='number!=INC0000001') --Not equal condition --SELECT * FROM incident WITH(Query='numberININC0000001,INC0000002,INC0000003') --IN condition --SELECT * FROM incident WITH(Query='number=INC0000001^state=7') --AND condition --SELECT * FROM incident WITH(Query='number=INC0000001^ORnumber=INC0000002') --OR condition --SELECT * FROM incident WITH(Query='numberLIKE0001') --LIKE condition --SELECT * FROM incident WITH(Query='numberSTARTSWITHINC00') --StartWith condition --SELECT * FROM incident WITH(Query='numberENDSWITH0001') --StartWith condition --SELECT * FROM incident WITH(Query='number=INC0000001^state=7^NQORnumber=INC0000002') --AND / OR MIXED using NQ (NewQuery Operator) -- (number=INC0000001 and state=7) OR (number=INC0000002) --more information about filter here https://docs.servicenow.com/bundle/utah-platform-user-interface/page/use/common-ui-elements/reference/r_OpAvailableFiltersQueries.html -- To read all available tables execute this query: -- SELECT * FROM Tables -- Other common tables: ----------------------- -- SELECT * FROM sys_db_object -- SELECT * FROM sys_dictionary -- SELECT * FROM sys_user -- SELECT * FROM sys_user_has_role -- SELECT * FROM sys_user_grmember -- SELECT * FROM task -- SELECT * FROM task_sla -- SELECT * FROM incident -- SELECT * FROM incident_sla -- SELECT * FROM change_request -- SELECT * FROM cmdb_ci_computer -- SELECT * FROM cmdb_ci_outage -- SELECT * FROM cmdb_ci -- SELECT * FROM sn_customerservice_case -- SELECT * FROM kb_knowledge -- SELECT * FROM kb_use -- SELECT * FROM sc_req_item -- SELECT * FROM sc_request -- SELECT * FROM sc_task
Some parameters configured in this window will be passed to the ServiceNow API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in SAP Crystal Reports:
ZappySys API Driver - ServiceNowRead and write ServiceNow data effortlessly. Integrate, manage, and automate incidents, tasks, attachments, and records — almost no coding required.ServicenowDSNSELECT * FROM incident --Using Primary Key --SELECT * FROM any_table_here WHERE sys_id='109562a3c611227500a7b7ff98cc0dc7' --Primary Key in WHERE clause --OR-- --Use below to query system / hidden tables (faster response - No Table name lookup needed in below) SELECT * FROM get_table_rows WITH(TableName='incident', Query='number=INC0000001') --================================= --Examples: Using Filter Expression --================================= -- Incremental Load Pattern: Load only incidents updated in the last 24 hours (see FUN_TO_DATETIME function help for more information, you can use +/- d, m, y, min,h,s along with now, today, yesterday, weekstart, weekend, monthstart, monthend, yearstart, yearend functions) --SELECT * FROM incident WITH(Query='sys_updated_on>=<<today-1d,FUN_TO_DATETIME>>') --SELECT * FROM incident WITH(Query='number=INC0000001') --Equal condition --SELECT * FROM incident WITH(Query='number!=INC0000001') --Not equal condition --SELECT * FROM incident WITH(Query='numberININC0000001,INC0000002,INC0000003') --IN condition --SELECT * FROM incident WITH(Query='number=INC0000001^state=7') --AND condition --SELECT * FROM incident WITH(Query='number=INC0000001^ORnumber=INC0000002') --OR condition --SELECT * FROM incident WITH(Query='numberLIKE0001') --LIKE condition --SELECT * FROM incident WITH(Query='numberSTARTSWITHINC00') --StartWith condition --SELECT * FROM incident WITH(Query='numberENDSWITH0001') --StartWith condition --SELECT * FROM incident WITH(Query='number=INC0000001^state=7^NQORnumber=INC0000002') --AND / OR MIXED using NQ (NewQuery Operator) -- (number=INC0000001 and state=7) OR (number=INC0000002) --more information about filter here https://docs.servicenow.com/bundle/utah-platform-user-interface/page/use/common-ui-elements/reference/r_OpAvailableFiltersQueries.html -- To read all available tables execute this query: -- SELECT * FROM Tables -- Other common tables: ----------------------- -- SELECT * FROM sys_db_object -- SELECT * FROM sys_dictionary -- SELECT * FROM sys_user -- SELECT * FROM sys_user_has_role -- SELECT * FROM sys_user_grmember -- SELECT * FROM task -- SELECT * FROM task_sla -- SELECT * FROM incident -- SELECT * FROM incident_sla -- SELECT * FROM change_request -- SELECT * FROM cmdb_ci_computer -- SELECT * FROM cmdb_ci_outage -- SELECT * FROM cmdb_ci -- SELECT * FROM sn_customerservice_case -- SELECT * FROM kb_knowledge -- SELECT * FROM kb_use -- SELECT * FROM sc_req_item -- SELECT * FROM sc_request -- SELECT * FROM sc_task
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHEREclause,LIMITkeyword will be performed on the client side, meaning that thewhole result set will be retrieved from the ServiceNow API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in ServiceNow servers). -
Click OK to finish creating the data source.
Video Tutorial
Read data in SAP Crystal Reports from the ODBC data source
-
First of all, open SAP Crystal Reports and create the new Crystal Report.
-
And it will open the new data source selection window. Under ODBC(RDO) double click on the Make New Connection and Select the desired ODBC DSN, in our case we need to select ServicenowDSN which we created in upper section. And Click on Next.
ServicenowDSN
-
Expand the Connection and under the data select the desired table(s) or view(s) and click Add > button and click on Next.
ServicenowDSNServicenowDSN
-
Add the desired Fields to Display in the Reports. Here we are adding all fields and click on Finish.
-
That's it and you will be able to load the data in the Report.
Using ZappySys Driver Custom Views and Stored Procedure in SAP Crystal Report
You can create parameterized Stored Procedure and Virtual Tables on the same Data Source (ODBC DSN or Data Gateway Data Source). Please refer to this article for the same. You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.Using Custom Views in the SAP Crystal Report
After establishing the connection with ServicenowDSN Data Source you can use the custom view in SQL Crystal Report.
Using Custom Stored Procedure in the SAP Crystal Report
-
First of all, create the custom stored procedure in the ZappySys Driver. Please refer to this article to create the custom stored procedure.
-
After establishing the connection with ServicenowDSN Data Source you can use the custom Stored Procedure in SQL Crystal Report. Same way you can write custom queries also in the query box.
ServicenowDSN
Optional: Centralized data access via ZappySys Data Gateway
In some situations, you may need to provide ServiceNow data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.
This configuration provides two primary advantages:
-
Centralized data access
The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
-
Centralized access control
Since all connections route through the gateway, access can be governed or revoked from a single location for all users.
| Data Gateway |
Local ODBC
data source
|
|
|---|---|---|
| Simple configuration | ||
| Installation | Single machine | Per machine |
| Connectivity | Local and remote | Local only |
| Connections limit | Limited by License | Unlimited |
| Central data access | ||
| Central access control | ||
| More flexible cost |
To achieve this, you must first create a data source in the Data Gateway (server-side) and then create an ODBC data source in SAP Crystal Reports (client-side) to connect to it.
Let's not wait and get going!
Create ServiceNow data source in the gateway
In this section we will create a data source for ServiceNow in the Data Gateway. Let's follow these steps to accomplish that:
-
Search for
gatewayin the Windows Start Menu and open ZappySys Data Gateway Configuration:
-
Go to the Users tab and follow these steps to add a Data Gateway user:
- Click the Add button
-
In the Login field enter a username, e.g.,
john - Then enter a Password
- Check the Is Administrator checkbox
- Click OK to save
-
Now we are ready to add a data source:
- Click the Add button
- Give the Data source a name (have it handy for later)
- Then select Native - ZappySys API Driver
- Finally, click OK
ServicenowDSNZappySys API Driver
-
When the ZappySys API Driver configuration window opens, go back to ODBC Data Source Administrator where you already have the ServiceNow ODBC data source created and configured, and follow these steps on how to Import data source configuration into the Gateway:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - ServiceNowRead and write ServiceNow data effortlessly. Integrate, manage, and automate incidents, tasks, attachments, and records — almost no coding required.ServicenowDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then go to Data Gateway configuration and in data source configuration window click Load settings:
ServicenowDSNZappySys API Driver - Configuration [Version: 2.0.1.10418]ZappySys API Driver - ServiceNowRead and write ServiceNow data effortlessly. Integrate, manage, and automate incidents, tasks, attachments, and records — almost no coding required.ServicenowDSN
-
Once a window opens, just paste the settings by pressing
CTRL+Vor by clicking right mouse button and then Paste option.
-
Open ODBC data source configuration and click Copy settings:
-
Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:
- This will initially allow all inbound traffic.
- Click Edit IP filters to restrict access to specific IP addresses or ranges.
-
Crucial Step: After creating or modifying the data source, you must:
- Click the Save button to persist your changes.
- Hit Yes when prompted to restart the Data Gateway service.
This ensures all changes are properly applied:
Skipping this step may cause the new settings to fail, preventing you from connecting to the data source.
Create ODBC data source to connect to the gateway
In this part we will create an ODBC data source to connect to the ZappySys Data Gateway from SAP Crystal Reports. To achieve that, let's perform these steps:
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
Create a User data source (User DSN) based on the ODBC Driver 17 for SQL Server driver:
ODBC Driver 17 for SQL Server
If you don't see the ODBC Driver 17 for SQL Server driver in the list, choose a similar version. -
Then set a Name for the data source (e.g.
Gateway) and the address of the Data Gateway:ZappySysGatewayDSNlocalhost,5000
Make sure you separate the hostname and port with a comma, e.g.localhost,5000. -
Proceed with the authentication part:
- Select SQL Server authentication
-
In the Login ID field enter the user name you created in the Data Gateway, e.g.,
john - Set Password to the one you configured in the Data Gateway
-
Then set the default database property to
ServicenowDSN(the one we used in the Data Gateway):ServicenowDSNServicenowDSN
Make sure to type the data source name manually or copy/paste it directly into the field. Using the dropdown might fail because the Trust server certificate option is not enabled yet (next step). -
Continue by checking the Trust server certificate option:
-
Once you do that, test the connection:
-
If the connection is successful, everything is good:
-
Done!
We are ready to move to the final step. Let's do it!
Access data in SAP Crystal Reports via the gateway
Finally, we are ready to read data from ServiceNow in SAP Crystal Reports via the Data Gateway. Follow these final steps:
-
Go back to SAP Crystal Reports.
-
First of all, open SAP Crystal Reports and create the new Crystal Report.
-
And it will open the new data source selection window. Under ODBC(RDO) double click on the Make New Connection and Select the desired ODBC DSN, in our case we need to select ZappySysGatewayDSN which we created in upper section. And Click on Next.
ZappySysGatewayDSN
-
Read the data the same way we discussed at the beginning of this article.
-
That's it!
Now you can connect to ServiceNow data in SAP Crystal Reports via the Data Gateway.
john and your password.
Supported ServiceNow Connector actions
Got a specific use case in mind? We've mapped out exactly how to perform a variety of essential ServiceNow operations directly in SAP Crystal Reports, so you don't have to figure out the setup from scratch. Check out the step-by-step guides below:
- Delete a Table Row
- Delete Attachment
- Delete table row
- Download Table Attachment (Single - Using Id)
- Download Table Attachments (Multiple - Using Query)
- Download Table Attachments By Parent Row Search
- Get Attachments
- Get Attachments By Parent Row Search
- Get List Of System Tables Admin Use Sys Db Object
- Get List of Tables
- Get List Of Tables Admin Use Sys Db Object
- Get List Of User Tables Admin Use Sys Db Object
- Get Record Labels (Tags)
- Get Table Columns
- Get Table Columns Admin Use Sys Dictionary
- Get Table Row Count
- Get Table Rows
- Test Connection
- Update a Table Row
- Upload Attachment
- Make Generic REST API Request
- Make Generic REST API Request (Bulk Write)
Conclusion
In this article we showed you how to connect to ServiceNow in SAP Crystal Reports and integrate data without writing complex code — all of this was powered by ServiceNow ODBC Driver.
Download ODBC PowerPack now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):