Skip to main content

How to set up Send to Print functionality in Composer

Send-to-print is a button on the Composer Document Actions toolbar that facilitates a manual external third-party print integration with Arc XP.

Arc XP is a digital-only solution and does not provide any capabilities for print. To print, you must integrate the content that you author in Composer to a client print system.

Notes for developers

The send-to-print button in Composer is intended to model a direct print integration. You can configure the print_url value in the application settings, where print_url represents a publicly accessible endpoint that accepts story_id, revision_id, and canonical_url. The Composer application handles errors (non-http 200 responses) as a 500 and passes the value of the 200 response through to the end user as a success.

You should maintain a restful service that this button's action (print_url) can call. When called, it should handle the request parameters to perform the required data transformation and sending to the print system.

  • Clicking the send-to-print button in Composer does not automatically save content to the Draft API. It is recommended users save the content first to generate a new revision_id and then click the send-to-print button.

  • Saving revisions to a story after that story has been sent to print will not re-run the send to print process. You must initiate that process again by clicking send to print.

Using send-to-print

After Arc XP provisions the send-to-print URL, you can then enter the URL into the Arc XP print integration section of the Composer Settings page.

When the user is writing a story and reaches a completed state, they save the story and then click the send-to-print button.

When clicked, the Composer UI generates a request to the Composer app server, which forwards the request to the configured send-to-print URL.

When the send-to-print system responds with a success, the user sees a success message; otherwise, the system presents an error message.

comp_print_system_integration_setting.webp

Implementing send-to-print

Composer org settings has values:

var org_settings = {
    "displaySendToPrint": true,
    "sendToPrintURL": "https://domain.com/path"
}

When displaySendToPrint = true, then the button appears to the user in the Document Actions Toolbar of the Compose page.

When you click the send-to-print button, Composer generates a request to the Composer app server (/composer base path).

GET https://org.arcpublishing.com/composer/api/stp?story_id=ABC&revision_id=123&canonical_url=&print_url=https://domain.com/path
  • story_id is the ID of the currently viewed story in Composer.

  • revision_id is the revision ID of the currently viewed story in Composer.

  • canonical_url is the canonical URL of the currently viewed story in Composer.

Composer forwards the request to the configured print system as follows.

GET https://domain.com/path?story_id=ABC&revision_id=123&canonical_url=URL

Setting permissions

The send-to-print button appears only in Composer when your administrator select the Print System Integration setting within Composer settings. The print button remains hidden when the Print System Integration setting is disabled in Composer. Moreover, the button remains disabled under the following circumstances:

  • You are in read-only mode or you do not own the lock for the story

  • Send-to-print is already initiated and the request is still loading