Technical Articles
Guidelines for Enabling Outbound API Journal Entry – Change Confirmation (Asynchronous)
In this blog post you will learn how to enable Outbound API Journal Entry – Change Confirmation (Asynchronous), which is the outbound service of API Journal Entry – Change (Asynchronous).
To learn more about Journal Entry – Change API at Guidelines for API Journal Entry – Change (Asynchronous).
1. Usage
API Journal Entry – Change is an asynchronous API, which means that the caller won’t receive the execution result after calling this API. Normally the caller should check the result in App Message Dashboard, read more at Guidelines for Testing Journal Entry API with SOAPUI and Checking Response Message.
This way is not very efficient for the users who want to know the result shortly, therefore we provide the outbound service of Journal Entry – Change API on CE1911. By means of this outbound service, the execution result can be sent to the sender system proactively.
2. Prerequisite
In order to use the outbound service, you need to maintain correctly in Communication System and Communication Arrangement. About how to configure communication arrangement for communication scenario Finance – Posting Integration (SAP_COM_0002). Read more at Guidelines for Configuring Communication Scenario Finance – Posting Integration (SAP_COM_0002)
Here I’d like to highlight some specific setting in Communication System and Communication Arrangement for the outbound service.
2.1 Communication System
In Communication System, you need to maintain Host Name and Business System.
In my understanding, Host Name is the URL of the sender system.
Business System is the logic name for the sender system, which should be unique among all the Communication Systems and will be used in Journal Entry – Change API request.
Then scroll down to maintain the Users for Outbound Communication.
In my understanding, it is the communication user for the sender system.
2.2 Communication Arrangement
In Communication Arrangement, make sure that the Service Status for Journal Entry – Change (Asynchronous) Confirmation is Active and User for Outbound Communication is maintained.
2.3 Journal Entry – Change API request
In the request, you need to fill the field SenderBusinessSystemID with the Business System maintained in Communication System. Otherwise, the backend system cannot identify the sender system then the outbound service will not be triggered.
3. How to Verify If the Outbound Service works
You can use App Message Dashboard to check if the outbound service works or not.
Firstly, you need to assign FINAC_RECT_JECHANGE_IN to your user in App Assign Recipients to Users. Read Section 4.2 at Guidelines for Testing Journal Entry API with SOAPUI and Checking Response Message
Then you can check Change Journal Entry Outbound for AIF in App Message Dashboard.
You can download the XML file for outbound message by clicking Download.
<?xml version="1.0"?>
-<n0:JournalEntryBulkChangeConfirmationMessage xmlns:prx="urn:sap.com:proxy:CC2:/1SAI/TAS1ECA6429B218F654716F:778" xmlns:n0="http://sap.com/xi/SAPSCORE/SFIN">
-<MessageHeader>
<ID>MSG_20190819_Output_S</ID>
<UUID>40f2e9af-c5f9-1ed9-b0c8-2fa72b80e536</UUID>
<ReferenceID>MSG_20190819_Output_S</ReferenceID>
<CreationDateTime>2019-08-19T05:23:34.65898Z</CreationDateTime>
<SenderBusinessSystemID>CC2</SenderBusinessSystemID>
<RecipientBusinessSystemID>SHGMA04</RecipientBusinessSystemID>
</MessageHeader>
-<JournalEntryChangeConfirmation>
-<MessageHeader>
<ID>MSG_Request_1_Header</ID>
<UUID>40f2e9af-c5f9-1ed9-b0c8-2fa72b812536</UUID>
<ReferenceID>MSG_Request_1_Header</ReferenceID>
<CreationDateTime>2019-08-19T05:23:35.017243Z</CreationDateTime>
</MessageHeader>
-<ItemKey>
<AccountingDocument>0100009476</AccountingDocument>
<CompanyCode>1010</CompanyCode>
<FiscalYear>2019</FiscalYear>
</ItemKey>
-<Log>
<MaximumLogItemSeverityCode>1</MaximumLogItemSeverityCode>
-<Item>
<TypeID>102(FINS_FI_POSTING_IF)</TypeID>
<SeverityCode>1</SeverityCode>
<Note>Header line: message ID MSG_Request_1_Header, UUID 00000000000000000000000000000000, and key 010000947610102019 processed successfully</Note>
</Item>
</Log>
</JournalEntryChangeConfirmation>
-<Log>
<MaximumLogItemSeverityCode>1</MaximumLogItemSeverityCode>
</Log>
</n0:JournalEntryBulkChangeConfirmationMessage>
5.How to Deactivate Outbound Service
When you create communication arrangement, the Service Status flag for enabling outbound service is activated by default. In case you do not expect the outbound service, there are 2 options:
- You can deactivate the Service Status flag for outbound service in communication arrangement
2. You do not fill <SenderBusinessSystemID> in payload
6.Appendix
- SAP Help Page
Thanks Wesley!
Hi Wesley, thank you for the very useful information.
Is it possible to configure and trigger this outbound interface from an on-premise SAP system to an external system ?
I found the JournalEntryBulkCreationConfirmation_Out interface in soamanager but do not know how the service is supposed to be triggered once it has been configured.
I would like to provided the external system a status of the journal entries that were received through the asyncronous API, but could not find any documentation if this is feasible using Journal Entry - Post Confirmation api on-premise.
Thank you !