Skip to main content
Solved

Replacement for API Used by Report Designer

  • October 21, 2024
  • 2 replies
  • 43 views

Forum|alt.badge.img+1

I am in the process of building an app to transfer reports between two Acumatica environments in batches using the Service Gate API.  In reviewing the release notes for Acumatica 2024 R2, I see that the Service Gate API has been removed.

Is there any documentation or resources that outline the new API that the 2024 R2 Report Designer tool uses to retrieve and save report data?

Best answer by snikomarov36

Hi ​@stephenbologna39,
New API used by Report Designer currently is considered internal by Acumatica. Thus, it is not documented and there is no guarantee about breaking changes for this API.

The API was made internal to reduce maintenance costs since there were no expected external users.
You can create an idea to make the new API public, if it receives enough traction Acumatica may consider opening this API.

As for now, you can try several workarounds:

  • You can try looking at Report Designer to investigate how the API calls are done. Try looking for PX.Reports.Design.Api.ReportDesignerApiClientFactory.ReportsApiClient
    But this approach contains risks because there are no guarantee about breaking changes in this API.
  • I believe, it’s possible (although a bit hacky and inconvenient) to write a customization package with customization scripts or `CustomizationPlugin` that can prepare reports on one site and upload them to the DB in another one. You can find more on customization plugins here:
    https://help.acumatica.com/(W(13))/Help?ScreenId=ShowWiki&pageid=3ef5784b-1602-4a04-b6b9-52b69c79fe91
    Or perhaps customization may export reports to XML and import from XML in batches.
  • Maybe something can be done with Import/Export Scenarios but I’m not an expert in this area.
View original
Did this topic help you find an answer to your question?

2 replies

snikomarov36
Acumatica Employee
Forum|alt.badge.img
  • Acumatica Employee
  • 54 replies
  • Answer
  • January 22, 2025

Hi ​@stephenbologna39,
New API used by Report Designer currently is considered internal by Acumatica. Thus, it is not documented and there is no guarantee about breaking changes for this API.

The API was made internal to reduce maintenance costs since there were no expected external users.
You can create an idea to make the new API public, if it receives enough traction Acumatica may consider opening this API.

As for now, you can try several workarounds:

  • You can try looking at Report Designer to investigate how the API calls are done. Try looking for PX.Reports.Design.Api.ReportDesignerApiClientFactory.ReportsApiClient
    But this approach contains risks because there are no guarantee about breaking changes in this API.
  • I believe, it’s possible (although a bit hacky and inconvenient) to write a customization package with customization scripts or `CustomizationPlugin` that can prepare reports on one site and upload them to the DB in another one. You can find more on customization plugins here:
    https://help.acumatica.com/(W(13))/Help?ScreenId=ShowWiki&pageid=3ef5784b-1602-4a04-b6b9-52b69c79fe91
    Or perhaps customization may export reports to XML and import from XML in batches.
  • Maybe something can be done with Import/Export Scenarios but I’m not an expert in this area.

Forum|alt.badge.img+1

Thanks ​@snikomarov36 

I assumed this was the case, but thank you for offering some suggestions and workarounds.


Reply


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings