{"id":21254,"date":"2022-04-11T13:56:06","date_gmt":"2022-04-11T11:56:06","guid":{"rendered":"https:\/\/help.openbee.com\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/documentoutput\/"},"modified":"2026-05-13T09:36:46","modified_gmt":"2026-05-13T07:36:46","slug":"documentoutput","status":"publish","type":"page","link":"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/knowledge-base\/how-to-guides\/scripts-in-capture\/objects\/documentoutput\/","title":{"rendered":"DocumentOutput"},"content":{"rendered":"\n<p>The DocumentOutput type is a return type that indicates the outputs made for a document for each export method: script, windows directory, Open Bee\u2122 Portal.<\/p>\n\n<p>This type is an abstract type that can take several forms depending on the type.<\/p>\n\n<h1 class=\"wp-block-heading\" id=\"DocumentOutput-DocumentOutputDMS\">DocumentOutputDMS<\/h1>\n\n<ul class=\"wp-block-list\"><li><strong>Type <\/strong>: Constant: DocumentOutputDMS<\/li><li><strong>stateToString <\/strong>: The current state of the document relative to this type of output. Securities:<ul><li>SENT: Exported Document<\/li><li>FAILED: The last export attempt failed<\/li><li>WAITING: Document is not yet sent to output<\/li><li>IN_PROGRESS: The document is currently being exported<\/li><\/ul><\/li><li><strong>idDMSDocument<\/strong> : the Open Bee\u2122 Portal identifier of the document (only if the document is already checked in Open Bee\u2122 Portal)<\/li><\/ul>\n\n<h1 class=\"wp-block-heading\" id=\"DocumentOutput-Exemple\">Example<\/h1>\n\n<pre class=\"wp-block-preformatted\">{  \n   \ttype: \"DocumentOutputDMS\",\n   \tstateToString: \"SENT\",\n\tidDMSDocument: \"2569\"\n}<\/pre>\n\n<h1 class=\"wp-block-heading\" id=\"DocumentOutput-DocumentOutputFolder\">DocumentOutputFolder<\/h1>\n\n<ul class=\"wp-block-list\"><li><strong>Type <\/strong>: Constant: DocumentOutputFolder<\/li><li><strong>stateToString <\/strong>: The current state of the document relative to this type of output. Securities:<ul><li>SENT: Exported Document<\/li><li>FAILED: The last export attempt failed<\/li><li>WAITING: Document is not yet sent to output<\/li><li>IN_PROGRESS: The document is currently being exported<\/li><\/ul><\/li><\/ul>\n\n<h1 class=\"wp-block-heading\" id=\"DocumentOutput-Exemple.1\">Example<\/h1>\n\n<pre class=\"wp-block-code\"><code>{  \n   \ttype: \"DocumentOutputFolder\",\n   \tstateToString: \"SENT\"\n}<\/code><\/pre>\n\n<h1 class=\"wp-block-heading\" id=\"DocumentOutput-DocumentOutputScript\">DocumentOutputScript<\/h1>\n\n<ul class=\"wp-block-list\"><li><strong>Type <\/strong>: Constant: DocumentOutputScript<\/li><li><strong>stateToString <\/strong>: The current state of the document relative to this type of output. Securities:<ul><li>SENT: Exported Document<\/li><li>FAILED: The last export attempt failed<\/li><li>WAITING: Document is not yet sent to output<\/li><li>IN_PROGRESS: The document is currently being exported<\/li><\/ul><\/li><\/ul>\n\n<h1 class=\"wp-block-heading\" id=\"DocumentOutput-Exemple.2\">Example<\/h1>\n\n<pre class=\"wp-block-code\"><code>{  \n   \ttype: \"DocumentOutputScript\",\n   \tstateToString: \"SENT\"\n}<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"<p>The DocumentOutput type is a return type that indicates the outputs made for a document for each export method: script, windows directory, Open Bee\u2122 Portal. This type is an abstract type that can take several forms depending on the type. DocumentOutputDMS Type : Constant: DocumentOutputDMS stateToString : The current state of the document relative to [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":21242,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"templates\/ob-help-products.php","meta":{"footnotes":""},"class_list":["post-21254","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21254","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/comments?post=21254"}],"version-history":[{"count":1,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21254\/revisions"}],"predecessor-version":[{"id":21256,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21254\/revisions\/21256"}],"up":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21242"}],"wp:attachment":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/media?parent=21254"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}