Buildbcos

From BCOeditor Wiki
Revision as of 17:37, 12 July 2023 by ChinweokeO (talk | contribs)
Jump to navigation Jump to search
  1. Click on BCO Builder icon on the Navigation Bar:
    2023-07-12 121634.png
  2. Before creating a BCO, an eTag needs to be generated. To do so, click on the expand arrow in Object Information section, then click GENERATE ETAG. Do not worry about Object ID, it will auto-generate when saving the BCO draft.
    Builder2 22.09.png
  3. To begin filling out the BCO, click on Provenance Domain to expand the section. Fill out the information as needed. Red boxes are required fields, yellow boxes are recommended fields, and plain boxes are optional fields.
  4. Builder3 22.09.png
  5. For information to fill out each domain, please go to Provenance Domain, Usability Domain, Extension Domain, Description Domain, Execution Domain, I/O Domain, Parametric Domain, and Error Domain. Or, click on the question mark icon on each domain for more information.
  6. User can also view/edit the BCO in JSON by clicking on either TREE VIEW JSON or RAW JSON VIEW.
    Builder4 22.09.png
    Builder5 treeview.png
    Builder6 JSON.png
  7. A BCO draft can be saved at any time of editing. In order to save a draft, go to the top of the page, and click on SAVING AND PUBLISHING.
    SAVE1 22.09.png
  8. To save the draft properly, first choose a server to save the draft.
    SAVE2 22.09.png
  9. After choosing the proper server, the BCO prefix field will show up. Enter a specific prefix (e.g. BCO, ARGOS, etc.) based on user groups and permissions. The default prefix is BCO, which can be used by all users.
    Enter a prefix in the BCO Prefix field
  10. Click on CREATE NEW DRAFT. If the entered prefix is not correct, an error message will pop up saying “Create Draft Failed” with a specific reason. Otherwise, the message will say “Create Draft Success”. Click OK on the message to return to the builder page.
    Click on CREATE NEW DRAFT to save the draft
  11. Once the new draft is created, the Builder page will refresh and generate an Object ID, which will show in the Object Information section. Continue to edit the BCO as needed.
  12. Once finish editing or need to save the draft again, go back to the top of the page, click on SAVING AND PUBLISHING, then click SAVE CURRENT DRAFT. A pop-up window will show up and indicate the draft is saved successfully.
  13. Before publishing the draft, users need to validate the draft first. To do this, click on SAVING AND PUBLISHING. Choose Display Validation, then VALIDATE DRAFT. A new window will pop up with validation results.Please see this page for common errors and possible solutions.
    Validate1 22.09.png
  14. If validation results show ‘“number_of_errors”: 0’, this means the draft has passed validation and it’s ready to publish. Go back to the Builder screen, and now the PUBLISH DRAFT button should show up, click on it to publish the draft.
    Publish.png
  15. If any errors were detected during validation, then correct those errors based on the validation results. Revalidation is needed before publishing.
  16. Other options on the Builder page include DOWNLOAD DRAFT in JSON format and DELETE DRAFT permanently.