Workflow interface - Studio v10.40

AddObjectLabels

Assigns an existing dossier label to one or more objects it contains.
See CreateObjectLabels header for more info.

Autocomplete

Since 9.1 Autocomplete provider. For a DialogWidget there is a PropertyInfo and a corresponding PropertyUsage.
When the PropertyInfo has a TermEntity defined and the PropertyUsage has a AutocompleteProvider defined, this
service can be requested. It defines how far the end-user has filled in a property that is shown on a dialog.
In the response the Autocomplete provider suggests options how to complete the value.

AutocompleteResponse

ChangeOnlineStatus

v4.1: Take documents (home) to work disconnected or bring back documents for online usage.
Clients should only call this when server returns the KeepCheckedOut feature.

ChangePassword

CheckSpelling

DISCONTINUED since 10.11.

CheckSpellingAndSuggest

DISCONTINUED since 10.11.

CheckSpellingAndSuggestResponse

CheckSpellingResponse

CheckTicket

Since 10.7, lightweight service to check the validity of the ticket.

CheckTicketResponse

CopyObject

CopyObjectResponse

CreateArticleWorkspace

Since v7.4 the xxxWorkspace services are added. Through these services, InDesign
Server can be requested to generate preview files (JPEG) per page or a PDF file that
contains all pages on which the article is placed. These services are called by
the CS editor to create a temporary folder to write an article file (CS5 format)
that is currently being edit. This folder is called 'workspace' and is used by
InDesign Server to write generated preview files (JPEG) and PDF output files that
can be downloaded by end user at any time after calling the PreviewArticleAtWorkspace.
This service returns the generated preview/pdf pages through:
PreviewArticleAtWorkspaceResponse -> Pages -> Page -> Files -> File - FileUrl
These URLs point to the previewindex.php module which returns the real preview/pdf
content and can be fired at any time as long at the workspace is present. When the
article is closed, the workspace must be cleared by client calling DeleteArticleWorkspace.

The list of Elements sent through SaveArticleInWorkspace and PreviewArticleAtWorkspace
services is there for optimization purposes; When only one (or a few) text component(s)
are changed by the user, CS editor can send only those elements. When text components
are added or removed, the Content should always be used. Nevertheless, added components
are not refleced through previews or PDFs since those elements are not placed on layout yet.

The CS editor is responsible to update the text component's -version- GUIDs that are
changed by the user. This is to trigger InDesign Server to reload latest text content
into the corresponding frame. This should be done for Content and Elements. (Obviously,
the text component's GUIDs are there to identify frames and therefor should never change.)

Since 9.5, the Content parameter should be set to nil to have better remote performance.
When Content=nil and ID is set, the server automatically resolves content from filestore.
For new articles set ID=nil but always populate the Content parameter. Both nil is not allowed.

CreateArticleWorkspaceResponse

CreateObjectLabels

Since 9.1 Object Labels. Labels can be created for Dossiers (and Dossier Templates).
Once a label is created, it can be updated (renamed) or deleted for the dossier.
When an object is contained by a dossier, it can be labelled as well. However, that
works quite differently; Only the dossier's labels can be choosen, and they
are tracked on the "contained" object relation (with dossier as parent and the
object as child). For these object types, we speak of 'adding' and 'removing' labels.
These operations work with labels that already exist for the parental dossier.
When a dossier gets created (CreateObjects) it inherits the labels from its template.

CreateObjectLabelsResponse

CreateObjectOperations

v9.8: Creates operations for an object. Only layout objects are supported.
The layout should be locked by caller before, or else the server will try
to obtain a lock during the service call. The operations can only be created
for the latest version of the layout. When the layout is opened in SC, the
operations will be processed on the layout with help of an AutomatedPrintWorkflow
connector. Since new operations can be resolved/changed during creation, the
created operations are returned by this web service.
See ObjectOperation data structure definition for more info.

CreateObjectOperationsResponse

CreateObjectRelations

Create relations between objects, like an article placed on a layout,
or an article planned for a layout, or an image contained by a dossier.

CreateObjectRelationsAsync

CreateObjectRelationsAsyncResponse

CreateObjectRelationsResponse

CreateObjectTargets

v6.0: Assigns objects to targets. For example, to assign a dossier to an issue.

CreateObjectTargetsResponse

v6.0

CreateObjects

Creates new objects (article, image, layout) in the database.

Note for uploading WCML articles: When two articles would share the same Element IDs (GUIDs),
placing these articles together on the same layout could lead into content loss. Therefore,
if a client other than InDesign, InCopy or InDesignServer calls CreateObjects with a WCML
article with Lock=False, WoodWing Studio Server updates the GUIDs of the Elements in the article
and inserts those GUIDs in the new Element IDs in the database. (Note that Elements are also
called stories or text components, which all means the same.)

CreateObjectsResponse

DeleteArticleWorkspace

DeleteObjectLabels

Deletes one or more object labels for a certain dossier. For one request,
only labels for one certain dossier should be provided.
See CreateObjectLabels header for more info.

DeleteObjectRelations

DeleteObjectTargets

v6.0

DeleteObjects

Delete objects (send from Workflow to Trash Can) or Purge objects (permanently remove
from Workflow / Trash Can).

DeleteObjectsResponse

v8.0

DeleteUserSettings

v10.3: Remove user settings in DB for the current client appplication.

GetArticleFromWorkspace

GetArticleFromWorkspaceResponse

GetAuthorizations

v10.7: Returns all authorization profiles of the application server and the authorizations which are enabled per brand.

GetAuthorizationsResponse

GetCreateObjectRelationsAsyncProgress

GetCreateObjectRelationsAsyncProgressResponse

GetCustomProperties

v10.7: Returns the global and publication-specific custom properties.

GetCustomPropertiesResponse

GetDialog

DEPRECATED, see GetDialog2.

GetDialog2

v8.0: GetDialog2 is introduced which supersedes GetDialog.
GetDialog is kept for backward compatibility with v7 clients, but became deprecated.
Retrieve all information to show a workflow dialog to end user.
Clients call this again e.g. when different publication has been selected.

GetDialog2Response

GetDialogResponse

GetMessageList

v10.7: Returns all messages sent to the user.

GetMessageListResponse

GetMessageQueueInfo

v10.7: Returns the definitions of the configured Message Queues that a client can subscribe to.
Note: Each time this service is called new credentials are generated for the RabbitMQ user. Therefore this
service should only be called once under normal circumstances.

GetMessageQueueInfoResponse

GetNamedQueries

v10.7: Returns the named queries as saved in the system or returned by external integrations.

GetNamedQueriesResponse

GetNativeAppAuthenticationInfo

v10.7: Entry point for native applications like Smart Connection to get the required information on how to authenticate, for example to check if is SSO enabled.

GetNativeAppAuthenticationInfoResponse

GetObjectRelations

DEPRECATED, use GetObject instead.

GetObjectRelationsResponse

DEPRECATED, use GetObject instead.

GetObjects

Returns information concerning an object. Also used to place a lock for editing.
The Rendition parameter defines what (functional) kind of file to return or none.

GetObjectsResponse

GetPages

Retrieves page thumbs (or previews) to populate the Publication Overview.
(Typically called after GetPagesInfo.) In the response, file URLs are provided.
Each URL refers to a page thumb (or preview) as copied by the server to the
Transfer Folder for the client to download. Thumbs can be downloaded in parallel
to gain better performance. Once all thumbs are shown, clients are responsible
to remove those files from the Transfer Folder. In subsequent phase, the
GetPages service can be called again to retrieve the page previews.
v6.0: Introduced the GetPages service.
v8.3.3: Performance increased significantly.

GetPagesInfo

Retrieves geometrical information for all pages produced for an issue.
This can be used to compose an outline (grid) for the Publication Overview.
While drawing the outline, GetPages can be called to retrieve the page thumbs.
v6.0: Introduced the GetPagesInfo service.
v8.3.3: Performance increased significantly.

GetPagesInfoResponse

v6.0

GetPagesResponse

v6.0

GetPublications

v10.7: Returns the publication info to which the user has access.

GetPublicationsResponse

GetRelatedPages

v10.4.0

GetRelatedPagesInfo

v10.4.0

GetRelatedPagesInfoResponse

v10.4.0

GetRelatedPagesResponse

v10.4.0

GetServerInfo

v10.7: Returns the application server information.

GetServerInfoResponse

GetServers

Return list of all servers. This message is optional in the sense it won't be called
if the client config file specifies a list of servers.

GetServersResponse

GetStates

Return the next possible workflow statusses for a given object. On client side, this is
just a list, but at server side it can be given a special meaning. The meaning can even
can change from time to time, for example from workflow steps to approve/disapprove.
Once a certain status is reached, the server can take action, as configured (or customized).

GetStatesResponse

GetSuggestions

DISCONTINUED since 10.11.

GetSuggestionsResponse

GetTerms

v10.7: Returns configured application terminology.

GetTermsResponse

GetUserGroups

v10.7: Returns the user groups which have an authorization profile for the same brands of the currently logged in user's group.

GetUserGroupsResponse

GetUserProfile

v10.7: Returns the ticket owner's user profile.

GetUserProfileResponse

GetUserSettings

v10.3: Retrieve the cached user settings stored in DB for the current client appplication.

GetUserSettingsResponse

GetUsers

v10.7: Returns a list of users depending on query parameters. Only users within the same authorization scope will be returned.

GetUsersResponse

GetVersion

Retrieves information of a specified version of a object.

GetVersionResponse

GetWebAppAuthenticationInfo

v10.7: Entry point for web applications like Content Station to get the required information on how to authenticate, for example to check if is SSO enabled.

GetWebAppAuthenticationInfoResponse

InstantiateTemplate

v9.7: Creates new layouts in the database based on a given layout template.

The Objects->Object->MetaData->BasicMetaData->ID should be set to nil
and will be resolved in the response.

The PlaceDossier operation can be set for Objects->Operations.

The Objects->Object->Pages should be set to nil. Pages are derived from the
template and will be resolved in the response.

InstantiateTemplateResponse

ListArticleWorkspaces

ListArticleWorkspacesResponse

ListVersions

ListVersionsResponse

LockObjects

v9.7 Locks objects on the server.
Errors when object already locked or when newer version exists.

LockObjectsResponse

LogOff

LogOn

Check user/pass combination and return a ticket for subsequent calls.

LogOnResponse

MultiSetObjectProperties

Since v9.2. Update properties for multiple objects at once.

MultiSetObjectPropertiesResponse

NamedQuery

Executes a predefined query on the database.

NamedQueryResponse

PreviewArticleAtWorkspace

PreviewArticleAtWorkspaceResponse

PreviewArticlesAtWorkspace

Since 9.4: Preview multiple articles in one workspace at once.

PreviewArticlesAtWorkspaceResponse

QueryObjects

Returns argumented information from the object store based on user defined query parameters.

QueryObjectsResponse

RemoveObjectLabels

Un-assigns an existing dossier label from one or more objects it contains.
See CreateObjectLabels header for more info.

RestoreObjects

v8.0: Retrieve objects from Trash Can (push back into Workflow).

RestoreObjectsResponse

v8.0

RestoreVersion

SaveArticleInWorkspace

SaveObjects

Saves objects into the server. Possibility to unlock and/or to create a new version.

SaveObjectsResponse

SaveUserSettings

v10.3: Store user settings in DB for the current client appplication.

SendMessages

Sends messages to objects or users.

SendMessagesResponse

Since v8.0

SendTo

Sends an object to the next status in the workflow.
If both State and RouteTo are nil the object is sent to the next status and the
object is routed to the configured user or user group (automatic routing).
DEPRECATED since v9.2, use SendToNext instead.

SendToNext

V9.2: Sends an object to the next status in the worfklow.

SendToNextResponse

SendToResponse

SetObjectProperties

SetObjectPropertiesResponse

Suggestions

Since 9.1 Suggestions provider.
DISCONTINUED since 10.11

SuggestionsResponse

UnlockObjects

Unlocks objects on the server.

UnlockObjectsResponse

UpdateObjectLabels

Renames one or more object labels for a certain dossier. For one request,
only labels for one certain dossier should be provided.
See CreateObjectLabels header for more info.

Currently this service isn't implemented. This is a placeholder for future functionality.

UpdateObjectLabelsResponse

UpdateObjectRelations

UpdateObjectRelationsResponse

UpdateObjectTargets

v6.0

UpdateObjectTargetsResponse

v6.0

ActionPropertiesByPublicationId

v10.7

ActionProperty

Defines which properties a show will be prompted with for a specific action like
Create, CheckIn, SetProperty. All of this depends on ObjectType.

AppFeature

v4.2: Application feature (AppFeature) that needs to be enabled or disabled.
When AppFeature element is not listed, then the default Value="Yes" is assumed.
Exception is the ForceTrackChanges feature for which Value="No" is the default.

Supported values for the Name element are:
ApplyParaStyles, EditParaStyles, ApplyParaFormats, ApplyCharStyles, EditCharStyles, ApplyCharFontFamily,
ApplyCharFontStyle, ApplyCharBasicFormats, ApplyCharAdvancedFormats, CopyFit, ApplySwatches, EditSwatches,
EditTags, ChangeLanguage, EditDictionary, ShortCuts, CompositionPrefs, ResizeTFLines, ResizeTF, EditTextMacros,
RestrictedProperties, RenameOnCheckIn, ChangePIS, SaveAs, ForceTrackChanges, EditTrackChanges, ImageSelect,
ImageCropping, ImageScale, Transparency, ColorManagement, OutputPrefs, AnyColor, CreateArticle, CreateImage,
CreateDossier, CreateTask, Publish
Supported values for the Value element are:
- Yes, No (for all features)
- Proportional (only for the ImageScale feature)

ArticleAtWorkspace

Since 9.4. Introduced to preview multiple articles in one workspace at once.

Attachment

AttachmentContent

AutoSuggestProperty

Since 9.1 Used by Autocomplete and Suggestions services

AutoSuggestTag

Since 9.1 Used by Autocomplete and Suggestions services

BasicMetaData

Category

v6.0: formerly called Section

CategoryInfo

v6.0: formerly called SectionInfo

ChildRow

v4.2

ContentMetaData

Dialog

v5.0

DialogButton

v9.0

DialogTab

v5.0

DialogWidget

v5.0

Dictionary

DISCONTINUED since 10.11.

Edition

v4.2

EditionPages

v6.0

EditionRenditionsInfo

v7.5: Indicates which file formats are stored in the database and filestore (for an edition/device).

Element

v4.2: Article's text compoment

EntityTags

Since 9.1 Used by Autocomplete and Suggestions services

ErrorReport

v8.0: Error report generated by server and sent back to client. This is used for
operations on multiple entities (e.g. objects, messages, etc) whereby some could fail,
while others could be successful. The SoapFault can still be raised for fatal operations
(such as an invalid ticket) whereby no action was taken at all. Once started taking action,
but halfway a fatal error occurs (such as SQL error), they get packed in the ErrorReport instead.

ErrorReportEntity

v8.0

ErrorReportEntry

v8.0: An item in the list of reported errors (or warnings). It provides contextual
information about the errors/warnings raised. For each, there is a Message to be
show to end users and a Details to be shown to admin users.

ErrorCode: Server error number (prefixed with 'S') that can be checked by clients to
act on the error. Errors in 1xxx range are workflow errors, and in 2xxx range are
license errors. The code is also in the Message to make support easier receiving screenshots
of error dialogs in foreign languages. Clients should not parse the Message to get the code.

MessageLevel: Warning or Error.
For warnings, the operation was successful, but for errors it failed.
Errors could be fixed (by user) and retried / re-fired. Warnings not (just for info only).

ExtraMetaData

Extra (custom) meta data on top of standard set.

Facet

v7.0

FacetItem

v7.0

Feature

Supported Feature keys. See SERVERFEATURES setting at configserver.php for supported options.

FeatureAccess

v4.2

FeatureAccessListByPublicationId

v10.7

FeatureProfile

v4.2

GetStatesResponse

InDesignArticle

v9.7: Group of frames/placements on a layout. See the 'Article' pallete in Adobe InDesign.
This entity should not be confused with Studio Articles, which is a different concept.
An InDesignArticle may contain any frame on the layout, regardless to which placed object
it belongs, and may contain frames that are no part of any placed Studio object.
It can be a bundle of any kind, including text frames and graphic frames.

Issue

IssueInfo

LayoutObject

v6.0

LogOnParam

v10.7.0: Mainly used to enable external authentication integrations.

Message

For messages, the ObjectID -OR- UserID must be given.

MessageList

List of messages enriched with additional information, such as which messages
are read and which should be deleted. Those messages are either sent (or to be sent)
to an user or an object. When sent along with a client request, the Messages may or
may not be the 'complete' set; In the database there can be more messages than currently
sent. And, the read messages (ReadMessageIDs) should refer to IDs that exist in database,
but they may be missing in the Messages property. When sent along a server response,
the Messages are the last set taken from database and the read messages
(ReadMessageIDs) -are- always referring to existing ones in the Messages property.
When the user has deleted messages, their IDs are sent in DeleteMessageIDs.
The DeleteMessageIDs property is only used in client requests, never in server responses.

MessageQueueConnection

v10.0: Message Queue integrations used for push notifications.
When there are multiple protocols supported, there are multiple connections
defined, so clients should search for a known Instance and Protocol combination.
When the Password is set to nil, the same user password used to logon to
WoodWing Studio Server should also be used to logon to the message queue server.

MetaData

MetaDataValue

v5.0: Property with multiple string values.
v8.0: Choice either array of strings (Values) or array of key-value pairs (PropertyValue).

NamedQueryType

Object

ObjectInfo

v7.0: Describes simple object properties

ObjectLabel

Since 9.1 Object Labels. See CreateObjectLabels header for info.

ObjectOperation

v9.8: Automated Print Workflow feature.
List of parameters to pass into an object operation.
The following operations and parameters are supported:

- Params for PlaceDossier (to auto place candidates):
EditionId (0 when no editions configured)
DossierId (candidates to be auto placed)
InDesignArticleId (UID, frames to place onto)

- Params for PlaceImage (also use for cropping):
EditionId (0 when no editions configured)
ImageId
SplineId (UID, frame to place onto)
ContentDx (optional)
ContentDy (optional)
ScaleX (optional, 1=100%)
ScaleY (optional, 1=100%)

- Params for PlaceArticleElement:
EditionId (0 when no editions configured)
ArticleId
ElementId (GUID, to place)
SplineId (UID, frame to place onto)

- Params for ClearFrameContent
EditionId (0 when no editions configured)
SplineId (UID, frame to clear content)

ObjectPageInfo

v6.0

ObjectTargetsInfo

v7.0

ObjectTypePropertiesByPublicationId

v10.7

ObjectTypeProperty

ObjectVersion

v7.0: Conditionally getting objects; only when newer than version

Page

PageObject

v6.0

Param

Since 9.7.

PlacedObject

v6.0

Placement

PlacementInfo

v6.0

PlacementTile

Property

v6.0: Changed into basic info about property, full into in PropertyInfo.

PropertyInfo

v6.0: Defines all attributes of a property itself. Full definition of a property.
Configured in the Metadata setup by brand admin (or provided by a server plug-in).

PropertyNotification

Since 9.1 For any dialog widget, additional info can be shown (such as tooltip help).

PropertyUsage

Defines how a property widget should behave on a certain dialog.
Configured in the Dialog setup by brand admin (or provided by a server plug-in).

PropertyValue

v8.0

PubChannel

v6.0

PubChannelInfo

v6.0

Publication

PublicationInfo

QueryOrder

QueryParam

Relation

RenditionTypeInfo

v7.5: Indicates which file formats are stored in the database and filestore.

RightsMetaData

RoutingMetaData

Since 9.2. Part of the SendToNext service, to return object status and routeto properties, which may differ per object.

ServerInfo

Information about the application server that can be selected by user to logon.

Setting

Mechanism for client to store any kind of client setting which are NOT interpreted by server.

SourceMetaData

State

StickyInfo

Since v4.2, a Message can be in the form of a StickyNote.
Since v8.0, all StickyNote elements are made nillable, because it is used
in context of create- and update operations, which have different criteria;
For create operations, AnchorX, AnchorY and PageSequence are mandatory.
For update operations, all elements are optional. Only when filled, it gets updated.

Suggestion

DISCONTINUED since 10.11.

Target

v6.0

Term

Terms translation structure to allow terms to be translated to correct UI terminology,
like Publication to anything. Typically this is static implemented on server

User

User / UserGroup

The client has not interest to know relation between users and groups. These lists
are purely used to allow user to select any.

UserGroup

VersionInfo

WorkflowMetaData

Action

AreaType

v8.0: Filter areas applied to object search. Introduced to support Trash Can feature.

FrameType

v9.7: Defines what kind of content can be placed in a frame.

InstanceType

Some instances (such as pages) can be planned or produced or both.
Planned instances are requests for production system to get synchronized.

MessageLevel

MessageStatus

v8.0: Simple workflow statuses followed by messages.

MessageType

ObjectType

The type of workflow object.

OnlineStatusType

OperationType

PreviewType

v7.6: Preview type used in PreviewArticleAtWorkspace to indicate what kind of preview is requested.

PropertyType

PubChannelType

RelationType

RenditionType

Functional file types.

Generated from the "SCEnterprise.wsdl" file.

(c) 1998-2024 WoodWing Software bv. All rights reserved.