createWorkflowProof()

Create an automated workflow proof. When calling the createWorkflowProof() method the system generates the first version of the proof. Subsequent versions are created using createWorkflowProofVersion()

Note: in order to make all functionality (such as text selection) available when creating a file proof its important to provide the file name along with it's extension. The "SourceName" parameter is used to determine the extension and file type.

Since version: 14.4

Unlimited only

Proofs with automated workflow are created for new ProofHQ Viewer

Request parameters

* denotes a required field

Parameter

Example

API version

SessionID*

The session Id obtained from doLogin()

string

7viklshodc6cnsh4s5vu75mqk0

OwnerID*

Result code

integer

0 - current user 

ownerOID - see getOwners()

Hash*

File identifier

string

ffc50a5fdd43ff.046772a6b09987aa1

Name*

Proof name

string


SourceName*

Source file name. We allow you to provide a web URL as the source name in order to generate a web captured proof. In addition to this you can supply a set of space character delimited web source names that will automatically be combined into a single proof with multiple pages

string

Proofhq-api.pdf

OR

http://www.myurl1.com http://www.mmyurl2.com

Subject

File subject

string

Custom subject

Message

Message to reviewers. We accept the following formatting tags within the message: 

<a>        href

<i>         italic

<span>   group inline-elements

<div>      defines a division or a section

<p>        paragraph

<font>    specifying a font

 <u>       underline

<br>       new line

string

Email body text inserted here

Stages

The object identifying the stages for this proof

SOAPWorkflowProofStageRequestObjectArray

See SOAPWorkflowProofStageRequestObjectArray

WorkspaceId
Workspace identifier
integer 245 - see getWorkspaces()
EnableSubscriptions
Allows people who are not participants to subscribe themselves to the proof. See help for more information. Default taken from the user's personal settings -> proofing defaults boolean
true
false
EnableSubscriptionsValidation
People subscribing can only access the proof using their personal URL sent in the email. See help for more information. boolean
true
false
DefaultEmailNotifications
Email notification settings for reviewers. It will not override a user's personal setting or the proof-level setting set by a reviewer. See help for more information.
1: All new comments and replies
2: Replies to my comments
3: Daily summary
4: Hourly summary
5: Decisions only
9: Disabled
string 4
DefaultRole
If EnableSubscriptionsValidation is turned on, there is a further setting that you can use, which sets the Role for subscribers. See help for more information on this setting and here for help on roles.
1: Read only
3: Reviewer
4: Approver
5: Reviewer and approver
6: Author
7: Moderator
string 5
AuthorizedOnly
This is the same as the Login Required function on the new proof page.

If used, then EnableSubscriptions must be set tofalse.

See help for more information. Default taken from the user's personal settings -> proofing defaults
boolean true
false
EnableAutoLock
Locks the proof when all required decisions are made. See help for more information. Default taken from the user's personal settings -> proofing defaults boolean true
false
LockAfterFirstDecision
Locks the proof after first decision is made. See help for more information. Default taken from the user's personal settings -> proofing defaults boolean true
false
EnableDownload
Enables download of the source file. Default taken from the user's personal settings -> proofing defaults boolean true
false
EnableTeamURL
Hides or shows the team URL. Default taken from the user's personal settings -> proofing defaults boolean true
false
EnableEmbedPlayer
Shows or hides the embed viewer URL.
boolean true
false (default)
ShowDashboardLink
Shows / hides the navigation link to the dashboard in the proof page. boolean true
false (default)
ShowWorkspaceLink
Shows / hides the navigation link to the workspace in the proof page. boolean true
false (default)
ShowDetailsPageLink
Shows / hides the navigation link to the proof details in the proof page. boolean true
false (default)
ShowVersionsLink
Shows / hides the navigation link to the versions window will be displayed in the proof page.
boolean true
false (default)
ShowHelpLink
Shows / hides the help link in the proof page.
boolean true
false (default)
ShowHelpQuickStartLink
Shows / hides the Getting started link in the proof page. boolean true
false (default)
ShowHelpUserGuideLink
Shows / hides the Knowledgebase link in the proof page. boolean true
false (default)
ShowHelpWelcomeScreenLink
? boolean true
false (default)
ShowHelpForumLink
Shows / hides the forum link. boolean true
false (default)
ShowHelpBlogLink
Show / hides the blog link. boolean true
false (default)
CustomLinkUrl
Allows you to specify a custom URL. string http://www.proofhq.com/
CustomLinkLabel
The label for the CustomLinkUrl string ProofHQ Home
SuppressNewProofNotification
If true the creator will not receive a notification email when the proof has been created. boolean true
false (default)
SWF
When creating an SWF proof, you can specify whether this is an application or animation type. 
See our help for more information. 
string swf-application or swf-animation
ShowDashboardfunctions
Setting this to false will hide all functions that will navigate the user to the ProofHQ application.
This is applicable when proof management is done outside of ProofHQ
boolean true
false (default)
ShowCloseIcon Setting this to false will hide the close icon within the proof viewer boolean true (default)
false
ShowPublishToTheWeb Setting this to false will hide the publish to web option within the proof viewer boolean true (default)
false
ShowPrintComments Setting this to false will hide the print comments option within the proof viewer boolean true (default)
false
ShowEmailAlertSettings Setting this to false will hide the email alert settings within the proof viewer boolean true (default)
false
EnableElectronicSignatures Setting this to true will enable electronic signatures on this proof. If electronic signatures have been enabled on the account then this parameter will be ignored boolean true
false (default)
DisableSubscriptionEmail Determines if the subscription email should be send or not boolean true
false (default)
14.5
DisablePDFSummary Determines if the PDF print summary should be available on the print summary page boolean true
 false (default)
14.17
DisableExcelSummary Determines if the Excel print summary should be available on the print summary page boolean true
false (default)
14.17


Response parameters

SOAPWorkflowProofObjectArrayarray of SOAPWorkflowProofOject

Comments