sap print service
TRANSCRIPT
PUBLIC2021-11-22
SAP Print Service
© 2
021 S
AP S
E or
an
SAP affi
liate
com
pany
. All r
ight
s re
serv
ed.
THE BEST RUN
Content
1 What Is SAP Print Service?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
2 Document History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3 Initial Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4 Developing Applications with SAP Print Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5 Consuming the Service at Application Runtime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
6 Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
7 Auditing and Logging Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
8 Monitoring and Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2 PUBLICSAP Print Service
Content
1 What Is SAP Print Service?
Manage print queues, connect print clients, and monitor print status.
SAP Print service is used in business applications that are based on SAP Business Technology Platform (SAP BTP) as well as other SAP Cloud products across SAP Intelligent Enterprise Suite. Using this service, the business application's development team can easily establish the connection between SAP Print service and the customer’s local printers. This means you can significantly reduce the development effort.
Environment
This service runs on SAP BTP, Cloud Foundry, and Kubernetes provided by the Hyperscaler service provider environment.
Features
Manage Print Queue This service supports creating, changing, pausing, restarting, and deleting a print queue.
Manage Print Queue Items This service lets you stop and restart individual print queue items and reassign particular print queue items to another queue.
Public APIs for Consumer Application
This service offers several public APIs for consuming applications to query print queues and to create print queue items.
NoteA document equals a single file up to a size of 250 KB. For larger files, the number of documents is calculated by dividing the total size of the file by 250. Any leftover is counted as one document. The allowed maximum size for a single document is 1 MB.
Prerequisites
SAP Cloud Print Manager has to be installed in the customer’s local network.
SAP Print ServiceWhat Is SAP Print Service? PUBLIC 3
Scenario
This graphic shows how you as an SAP S/4HANA Cloud customer can use SAP Print service to build your own extension application. It gives you more flexibility because you can implement different data sources, forms, and business process flows.
4 PUBLICSAP Print Service
What Is SAP Print Service?
2 Document History
Provides details about the changes made in each version of this document.
Document Version Date Comment
1.0 2020-02-21 Document created
2.0 2020-06-17 New terminology
● Application plan is replaced with sender plan.
● Client plan is replaced with receiver plan.
SAP Print ServiceDocument History PUBLIC 5
3 Initial Setup
You can get started with SAP Print service by using the standard procedures for SAP BTP, Cloud Foundry.
Prerequisites
You have set up your global account and subaccount. For an overview of the required steps, see Getting Started in the Cloud Foundry Environment.
Enabling the Service
To use the Print service, you need to create a service instance. You can then bind the service instance to your application, or you can create a service key to communicate directly with the service instance. You also have to authorize the print service to communicate with your application and to onboard your SaaS tenant.
For an overview of how to enable services, see About Services in the SAP BTP documentation on SAP Help Portal.
Create the Service InstanceYou can create the service instance and the service binding using either the SAP BTP cockpit or the Command Line Interface (CLI). In both cases, you need to provide the configuration file when you create the service binding.
For more information, see:
● Creating Service Instances● Binding Service Instances to Applications
Subscribe to the SaaS ApplicationIn addition to binding a print service instance to your application, you also have to subscribe to the SaaS application. For details on how to subscribe to the SaaS application, see Administration Guide.
SAP Print Service Offers Two Service Plans1. You use the sender plan to expose the public API to consumers, such as the extension application.2. The receiver plan exposes the interface that is used to establish the connection between SAP Cloud Print
Manager for Pull Integration and the Print service. For more information, see Administration Guide
Create the Sender Service Plan1. Access SAP BTP Cockpit.2. Go to Spaces, choose Create Space, and enter a name, such as DEV.
6 PUBLICSAP Print Service
Initial Setup
3. Select the checkboxes Space Manager and Space Developer, and choose Create.
NoteIf the Space has been created successfully, it’s displayed as a new tile on your launchpad.
4. Select your newly created tile.
5. Go to Services Service Marketplace , and select the Print Service tile.6. In the Instances section, choose New Instance.7. In the dialog that is displayed, choose the service plan sender from the drop-down menu.8. Choose Next.
NoteSpecifying parameters and assigning an application are optional steps. You can skip them by choosing Next.
9. Enter an instance name, such as App and choose Finish.10. Go to Referencing Apps to bind this instance to your application.11. Bind the newly created instance to your extension application.
Create the Receiver Service Plan1. Access SAP BTP Cockpit.2. Go to Spaces, choose Create Space and enter a name, such as DEV.3. Select the checkboxes Space Manager and Space Developer, and choose Create.
NoteIf the Space has been created successfully, it’s displayed as a new tile on your launchpad.
4. Select your newly created tile.
5. Go to Service Service Marketplace and select the Print Service tile.6. In the Instances section, choose New Instance.7. In the dialog that is displayed, choose the service plan receiver.8. Choose Next.
NoteSpecifying parameters and assigning an application are optional steps. You can skip them by choosing Next.
9. Enter an instance name, such as cpm and choose Finish.
NoteThe instance name can include capital letters, lower case, and numbers. It can't exceed 12 characters.
10. Choose the newly created service instance and go to Service Keys, choose Create Service Key and enter a Name.
11. Choose Save. You'll receive credential information, such as service_url, token_url, client_id, client_url, and clientsecret.These credential information are used for SAP Cloud Print Manager for Pull Integration. For more information, see Administration Guide.
SAP Print ServiceInitial Setup PUBLIC 7
NoteTo remove the service instance that is based on the receiver service plan, make sure that there's no print queue assigned. Otherwise, the deletion fails. If you want to terminate this service, you can unsubscribe from the SaaS application. For more information, see Administration Guide.
Once the SAP Print service subscription is removed from SAP BTP, all existing instances for the sender plan and the receiver plan can't be used anymore.
8 PUBLICSAP Print Service
Initial Setup
4 Developing Applications with SAP Print Service
This section describes how to develop an extension application based on SAP Print service. For more information, see Binding Service Instances to Applications.
Prerequisites
You've already created the service instance for the service plan sender.
Using Sample ApplicationsTo speedup customer application development, there is one sample extensibility scenario for applications. Leveraging this content, you receive documentation and sample codes.
Go to SAP S/4HANA Cloud Extensibility Explorer and search for Labeling Printing Sample Scenarios. You can find the sample application that is predelivered from SAP, and the documentation guides you to develop your own applications.
Using SAP API Business HubThere are several public APIs provided by Print service. They are published on SAP API Business Hub. You can search for SAP Print service on the SAP API Business Hub to get information about API references, such as operations, parameters, and responses. For more information, see SAP API Business Hub
SAP Print ServiceDeveloping Applications with SAP Print Service PUBLIC 9
5 Consuming the Service at Application Runtime
This chapter provides relevant information for the application administrator or end user of the consuming application.
In addition to the public API, which is always consumed by the extension applications, SAP Print service also offers one SaaS application that allows you to manage print queues and monitor the printing process. For more information, refer to the end-user guide.
NoteOnce the SAP Print service instances have been created, any other environment or platform can access the service via a public network. There are no technical restrictions for the consumption of the exposed APIs.
10 PUBLICSAP Print Service
Consuming the Service at Application Runtime
6 Security
SAP Print service implements standard security features. For more information, see Security.
Print service uses standard authentication and authorization procedures provided on SAP BTP, Cloud Foundry. For more information, see Administration: Managing Authentication and Authorization.
SAP Print ServiceSecurity PUBLIC 11
7 Auditing and Logging Information
Here you can find a list of the security events that are logged by SAP Print service.
Security events written in audit logs
Event grouping What events are loggedHow to identify related log events Additional information
Download document The user triggers the download of documents from the print queue.
● Download successful:If the user downloads a document successfully, the log is written into the audit log service.
● Download failed:If the download fails, the log is written into the audit log service.
Audit log category:
audit.data-access
Log Data
{
"UserName": "firstname.last[email protected]", "DocumentId": "<ID of the document that is downloaded>", "PrintQueueOwner": "firstname.last[email protected]", "PrintQueueName": "<name of the print queue the document is downloaded from>", "ItemId": "<ID of the item that is downloaded>", "DocumentName": "<name of the document that is downloaded>"
}
Viewing Audit Logs
To view audit logs, please subscribe to and use the Audit Log Viewer app.
Related Information
Audit Log Viewer for the Cloud Foundry EnvironmentAudit Logging in the Cloud Foundry EnvironmentAudit Logging in the Neo Environment
12 PUBLICSAP Print Service
Auditing and Logging Information
8 Monitoring and Troubleshooting
Getting Support
If you encounter an issue with this service, we recommend to follow the procedure below:
Check Guided AnswersIn the SAP Support Portal, check the Guided Answers section for SAP BTP. You can find solutions for general issues as well as for specific services there.
Contact SAP SupportYou can report an incident or error through the SAP Support Portal .
Please use the following component for your incident:
Component Name Component Description
BC-CCM-PRN-OM-SCP SAP Print service
When submitting the incident, we recommend including the following information:
● Region information (Canary, EU10)● Subaccount technical name● The URL of the page where the incident or error occurs● The steps or clicks used to replicate the error● Screenshots, videos, or the code entered
SAP Print ServiceMonitoring and Troubleshooting PUBLIC 13
Important Disclaimers and Legal Information
HyperlinksSome links are classified by an icon and/or a mouseover text. These links provide additional information.About the icons:
● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your agreements with SAP) to this:
● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this information.
Videos Hosted on External PlatformsSome videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within the control or responsibility of SAP.
Beta and Other Experimental FeaturesExperimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use the experimental features in a live operating environment or with data that has not been sufficiently backed up.The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your feedback (e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.
Example CodeAny software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Bias-Free LanguageSAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities, genders, and abilities.
14 PUBLICSAP Print Service
Important Disclaimers and Legal Information
SAP Print ServiceImportant Disclaimers and Legal Information PUBLIC 15
www.sap.com/contactsap
© 2021 SAP SE or an SAP affiliate company. All rights reserved.
No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company. The information contained herein may be changed without prior notice.
Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary.
These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.
SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies.
Please see https://www.sap.com/about/legal/trademark.html for additional trademark information and notices.
THE BEST RUN