{"id":20492,"date":"2024-02-19T12:37:41","date_gmt":"2024-02-19T11:37:41","guid":{"rendered":"https:\/\/help.openbee.com\/open-bee-portal\/administrators-guide\/automatically-write-properties-to-microsoft-office-documents\/"},"modified":"2024-02-19T12:37:41","modified_gmt":"2024-02-19T11:37:41","slug":"automatically-write-properties-to-microsoft-office-documents","status":"publish","type":"page","link":"https:\/\/help.openbee.com\/en\/open-bee-portal\/administrators-guide\/automatically-write-properties-to-microsoft-office-documents\/","title":{"rendered":"Automatically Write Properties to Microsoft Office Documents"},"content":{"rendered":"
\n

Problematic<\/h2>\n

Open Bee\u2122 Portal has metadata <\/a>and information attached to documents. It is sometimes interesting to be able to display this information directly in working documents, such as a date of validation of the document in a workflow or simply a metadata of the document.<\/p>\n

Principle of operation<\/h2>\n

Open Bee\u2122 Portal can edit custom<\/span> properties of MS Office documents.<\/p>\n

Refer to the Microsoft documentation on “Custom Properties”<\/em> of MS Office Documents.<\/p>\n

Workflow output<\/u><\/p>\n

If the “Adding validation information in Office documents<\/strong>” check box is selected in the workflow configuration. In this case, the following custom properties<\/span> will be automatically added or updated in the document when it exits the workflow:<\/p>\n

    \n
  • “VERSION”<\/strong>: The version number is auto-incremented each time the workflow is released.<\/li>\n
  • “VALIDATED_BY<\/strong>” or “REJECTED_BY<\/strong>“: name of the last user to approve or reject the document before it was released from the workflow<\/li>\n
  • “VALIDATED_ON<\/strong>” or “REJECTED_ON<\/strong>“: Workflow release date in case of approval or rejection<\/li>\n<\/ul>\n

    Each time the metadata is changed, <\/u><\/p>\n

    If the “Adding<\/strong> properties in Office documents” located in the “General Configuration Administration><\/strong>” screen is checked, each time the Open Bee Portal metadata of an MS Office document is changed, custom properties are created in the document with the same names and values as the Open Bee\u2122\u2122 Portal metadata. <\/span><\/p>\n

    <\/span><\/p>\n

    <\/span><\/p>\n

    Use case<\/h2>\n

    To illustrate the possibilities of this feature, let’s take as an example a document describing a procedure.<\/p>\n

    This procedure goes through an Open Bee\u2122 Portal validation circuit each time it is modified.<\/p>\n

    Each time a new version of the procedure is validated in the validation process, we want to automatically modify inside the Word document:<\/p>\n

      \n
    • version number<\/li>\n
    • the date of validation<\/li>\n
    • The name of the last person to validate the document.<\/li>\n<\/ul>\n

      This data will be presented, in the Word document, in the form of a table as follows:<\/p>\n

      <\/p>\n

      We’ll start by creating 3 custom properties in our Word document with the following names:<\/p>\n

        \n
      • VERSION<\/li>\n
      • VALIDATED_BY<\/li>\n
      • VALIDATED_ON<\/li>\n<\/ul>\n

        And then we’re going to insert these custom properties in the appropriate places in the document.<\/p>\n

        Setting properties screen in Word:<\/p>\n

        <\/p>\n

        Field insertion screen, allowing us to insert our custom properties into the document:<\/p>\n

        <\/p>\n

        In the end, the first version of our document looks like this:<\/p>\n

        <\/p>\n

        Our base document is now ready to go into a Workflow, like this one below for example.<\/p>\n

        <\/p>\n

        Once the document is approved, the properties in the workflow are changed and the content of the document is as follows:<\/p>\n

        <\/p>\n<\/div>\n","protected":false},"excerpt":{"rendered":"

        Problematic Open Bee\u2122 Portal has metadata and information attached to documents. It is sometimes interesting to be able to display this information directly in working documents, such as a date of validation of the document in a workflow or simply a metadata of the document. Principle of operation Open Bee\u2122 Portal can edit custom properties […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":20157,"menu_order":31,"comment_status":"closed","ping_status":"closed","template":"templates\/ob-help-products.php","meta":{"footnotes":""},"class_list":["post-20492","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/20492","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\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/comments?post=20492"}],"version-history":[{"count":0,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/20492\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/20157"}],"wp:attachment":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/media?parent=20492"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}