Behaviour rules:
- Objects can be identified in two ways; by Pub+Issue+Name+Type (and optional the Channel Name) -OR- by object id.
- For CreateAdverts and CreateLayouts, objects are always identified by Pub+Issue+Name+Type (and optional the Channel Name).
- Identification by Pub+Issue+Name+Type (and optional the Channel Name) is always name based (not using internal/database ids)
- When NO object id is given, Publication+Name+Type (and optional the Channel Name) must be given and must exist.
- When object id is given, but any of Pub/Issue/Name/Type is not given, the current values are used (and remains unchanged).
- When Status and/or Section are not given, the first* ones for which the user has write access will be used. *=Respecting the configured order.
- When Issue and/or Section are given, but do not exist, they are created automatically.
- Layouts are NOT removed after DeleteLayouts operation. Instead, they are marked with a flag and message informing user that layout is removed from plan. Adverts ARE removed after DeleteAdverts.
- When the advert/layout is locked and the ModifyLayouts/ModifyAdverts operations fails. Assumed is that the plan system re-schedules the update operation.
- Planned relations (between layouts and adverts) are created/removed by the plan system. Placed relations are maintained by InDesign.
- When a planned layout-advert relation is deleted, and there is no placed relation for that advert, the advert gets deleted implicitly.
- For all layout operations, a flag is set and message is sent to the layout. For adverts operations the same is done, but then to the layout on which the advert is placed.
Note: Using the clientplan.php tool, adverts are randomly positioned and re-shaped on random pages of the layout. This means each update to the adverts becomes always visible.
Parameters:
- The show parameter shows the SOAP requests and responses in different ways.
- The wire option shows SOAP envelopes and DIME attachments.
- The soap option shows SOAP response envelopes only.
- The info option (default) suppresses any SOAP data and shows the info bars of each SOAP request only.
For example, http://localhost/Enterprise/server/wwtest/clientplan?show=wire shows envelopes and attachments.
- The namebased parameter uses names instead of ids to refer to layout and advert objects for all SOAP requests. Layouts are assumed to be in the same publication and issue as the adverts when using names.
It is recommended to use ids since objects can be renamed in the editorial system that can cause your requests to fail when using names. This parameter has no effect on publication/issue values, which are always name based.
- The ip_port parameter is obsoleted. You can change port at HTTP server.
- The act_create parameter performs CreateLayouts and/or CreateAdverts. Supported values are layout, advert, none and all. Default value is all.
- The act_modify parameter performs ModifyLayouts and/or ModifyAdverts. Supported values are layout, advert, none and all. Default value is all.
- The act_delete parameter performs DeleteLayouts and/or DeleteAdverts. Supported values are layout, advert, none and all. Default value is all.
- The no_modify parameter is obsoleted. Use act_modify instead.
- The delete parameter is obsoleted. Use act_delete instead.
- The layout_id parameter points to an existing layout. If you know the object id, you can avoid creating new layouts by specifying this parameter. All modifications are then done to the existing layout.
- The advert_id parameter points to an existing advert. If you know the object id, you can avoid creating new advert by specifying this parameter. All modifications are then done to the existing advert.
- The publication and issue parameters define the location where to create/modify layouts/adverts. Default are resp. 'WW News' and '2nd Issue'.
- The channelName The publication channel of the issue. If the issue does not exist in the channel it is created within the channel.
- The lay_name and adv_name parameters specify name of layout or advert. Default is random name.
- The lay_section and adv_section parameters specify section for layout or advert. Default is empty to let Enterprise choose first found with write access.
- The lay_status and adv_status parameters specify status of layout or advert. Default is empty to let Enterprise choose first found with write access.
- The lay_template parameter define the template name to create layout. Default is 'eklt009'. Template should exist in given publication/issue.
- The lay_editions and adv_editions parameters specify editions for layout or advert. Values are seperated with semi-colons, for example: lay_editions=North;East. Default is empty to let Enterprise choose all editions defined for publication or issue.
- The lay_deadline and adv_deadline parameters specify deadline for layout or advert. Format is: YYYY-MM-DDTHH:MM:SS, for example: lay_deadline=2006-12-31T24:00:00. Default is empty, which means no deadline to meet.
- The pag[pos]_height and pag[pos]_width parameters specify dimensions for the page indicated with [pos]. For example: pag2_height=650 and pagenrs=33,34,35,36 will set page 34(!) to 650 points high. The "pagenrs" parameter is required and the page [pos] must reside in that scope. When no [pos] given, all pages get the same height or width. For example: pag_width=200.
- The pag[pos]_master parameter specifies the master page (of layout template) to use for page indicated with [pos]. For example: pag3_master=Cover and pagenrs=12,13,14,15 will use master page named 'Cover' for page number 14. When not specified or not exists, the default master is taken from template. The "pagenrs" or "pagenrs_edition" parameter is required and the page [pos] must reside in that scope. When no [pos] given, all pages get the same master. For example: pag_master=Appendix.
- The pagenrs and/or pagenrs_edition parameters define the page numbers [1..N] for the layout. Default is random page number with random page count. For example: pagenrs=3,4,5,6
Page numbering can differ per edition. In that case, the same layout pages are used, but numbers differ. For example: pagenrs_North=10,11,12,13.
In that case, the first page has number 3 for all editions, except for 'North' edition for which the page number is 10.
Make sure you specify the same amount of pages for each edition. Also the general amount of pages specified with pagenrs parameters should match all edition specific pages specified with pagenrs_North parameter. Note that the referred edition must be one of the editions specified with lay_editions parameter.
- The num_style allows you to specify an alternative page number style. Supported values are roman and alpha. The default value is arabic. In case of roman page order 1 will become page number I. In case of alpha page order 2 will become page number B.
- The num_prefix allows you to specify a page number prefix. The maximum length is 8 characters. If set to pre page order 1 will be set to page number pre 1.
- The content parameter tells what kind of content is used. Possible values are highresfile, output, preview, plaincontent or description.
- The highresfile option sends file path only. Make sure that the plugins have access to it. Use the "ad_filename" parameter to specify a filename to use.
- The output option sends the highres file as a DIME attachment in the SOAP message. Uses the output1page1.pdf on create and output1page2.pdf on modify.
- The preview option does the same, but now using the lowres file. In the test environment, highres and lowres files are physically the same (only the sent rendition parameter differs). In real life they are different. Uses the preview1page1.jpg on create and preview1page2.jpg on modify.
- The plaincontent option sends advert text though the PlainContent element of the SOAP message. This can be used for sending large text blobs.
- The description option sends just some textual notes (describing the advert) through the Description element of the SOAP messages.
The plugins will show plaincontent or description texts in the advert frame on the layout.
When parameter is not given, the default value preview is used.
- The ad_filename parameter defines the filename that will be used when setting the content parameter to highresfile. Make sure that you have a subfolder wwtest in your high-resolution folder to store the file defined by this parameter. When omitted uses output1page1.pdf on create and output1page2.pdf on modify.
- The left, top, width and height parameters define position/size of the created/modified adverts. Default is random position/size.
- The pagenr parameter define the target page [1..N] on the layout to place/move advert. Default is random page position. This is page position within the layout, not the page number.
- The ad_layer parameter specifies the InDesign layer name for advert.
- The ad_dx parameter moves the advert graphic relatively to frame (not to page) from left to right in points (pt). Use negative values for moves towards the left. Default is random value.
- The ad_dy parameter moves the advert graphic relatively to frame (not to page) from top to bottom in points (pt). Use negative values for moves towards the top. Default is random value.
- The ad_scalex parameter specifies the factor to scale the advert graphic horizontally in its frame. Value 0.15 means 15.2%. 1.0 for 100%. Default is random value.
- The ad_scaley parameter does the same as "ad_scalex" but then vertically.
Example of test scenario: