|
Info: This feature requires the following versions of Studio for InDesign and InCopy (see How to check which version is installed):
|
When making use of a Web application (such as a planning tool or a custom application), users may want to directly open layouts or articles directly from that application into InDesign or InCopy with Studio installed.
This can be made possible by letting the application call a URL with specific parameters.
This article explains the working of this feature.
Functionality
Using this method, the following can be done:
- Open layouts in InDesign or articles in InCopy
- Open multiple layouts or articles with one URL
- Open the files checked-out or as read-only
- Open a template for editing or instantiate a new document from the template
URL parameters
The URL that is passed has the following format:
protocol://<server>&id&readonly&instantiate&dossier
The parameters are described in the following table:
| Parameter | Value | Description | |
|---|---|---|---|
| Protocol |
wsopenicXXXX wsopenidXXXXpr |
Required. Multiple values are not allowed. Defines the application and its version with which the file should be opened. Use 'ic' for InCopy, 'id' for InDesign. Replace XXXX by the Adobe version, such as 2020 or 2021. Use 'pr' for opening a file with an installed pre-release (requires Studio for InDesign and InCopy 16.0.0 or higher). |
|
| server | Server name |
Required. Multiple values are not allowed. The name of Studio Server (as defined in the WWSettings.xml file) from which the files should be opened. Note: Server names may not contain characters other than ASCII and extended ASCII. For extended ASCII, the %** notation should be used. |
|
| id | database ID |
Required. Multiple values are allowed. The IDs of the files that should be opened. |
|
| readonly | true or false |
Not required. Multiple values are not allowed. Defines if the file should be opened as read-only. Default value: false.
|
|
| instantiate | true or false |
Not required. Multiple values are not allowed. Defines if a new document should be instantiated from a template. The referenced file should therefore be a template; the parameter is ignored when the file is a regular layout or article. Default value: true. |
|
| dossier | Dossier ID |
Not required. Multiple values are not allowed. The ID of the default parent Dossier. Only used when instantiating Layout templates or Layout Module templates. Default value: an empty string. |
|
Example: The following URL opens 2 layouts (with ID 123 and 456) as read-only from server 'MyServer' in InDesign 2020: wsopenid2020://server=MyServer&id=123&id=456&readonly=true |
Comment
Do you have corrections or additional information about this article? Leave a comment! Do you have a question about what is described in this article? Please contact Support.
2 comments
Is this documentation correct for the latest versions? I am just starting to use this now (InDesign/InCopy 2024 and Studio Server 10.36) and it seems the 'server' parameter does not do anything. Even if I set that to a meaningless value the InDesign or InCopy file will still open, it seems to just try to open it from whatever server you are currently logged into.
That is a problem if you have multiple Studio servers because the link could be for ServerA, but if you click the link while logged into ServerB and the same document ID exists there- then it will open the wrong file.
Hi Craig,
I have asked our support team to respond to your request. They will contact you directly.
Best regards,
Maarten van Kleinwee
Senior Technical Writer, WoodWing Software
Please sign in to leave a comment.