Buildbcos: Difference between revisions

From BCOeditor Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:


#Click on BCO Builder icon on the Navigation Bar:[[File:2023-07-12 12163.png|center|thumb|812x812px]][[File:May 2023 Buider icon.png|center|thumb|800x800px]]
#Click on '''BCO Builder''' icon on the Navigation Bar:[[File:101.png|center|thumb|1056x1056px]]
#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.[[File:Builder2 22.09.png|800px|thumb|center]]
#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, and plain boxes are optional fields. Click '''next''' to advancing to the next section.[[File:102.png|center|thumb|1054x1054px]]
#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.[[File:Builder3 22.09.png|800px|thumb|center]]
#For information to fill out each domain, please refer to these links: [[Provenance-domain|Provenance Domain]], [[Usability-domain|Usability Domain]], [[Extension-domain|Extension Domain]], [[Description-domain|Description Domain]], [[Execution-domain|Execution Domain]], [[Iodomain|I/O Domain]], [[Parametric-domain|Parametric Domain]], and [[Error-domain|Error Domain]]. Or, click on the question mark icon on each domain for more information.
#For information to fill out each domain, please go to [[Provenance-domain|Provenance Domain]], [[Usability-domain|Usability Domain]], [[Extension-domain|Extension Domain]], [[Description-domain|Description Domain]], [[Execution-domain|Execution Domain]], [[Iodomain|I/O Domain]], [[Parametric-domain|Parametric Domain]], and [[Error-domain|Error Domain]]. Or, click on the question mark icon on each domain for more information.
#User can also view/edit the BCO in JSON by clicking '''RAW JSON VIEW'''.[[File:103.png|center|thumb|1073x1073px]]
#User can also view/edit the BCO in JSON by clicking on either '''TREE VIEW JSON''' or '''RAW JSON VIEW'''.[[File:Builder4 22.09.png|800px|thumb|center]][[File:Builder5 treeview.png|800px|thumb|center]][[File:Builder6 JSON.png|800px|thumb|center]]
#A BCO draft can be saved at any time of editing. In order to save a draft, go to the top of the page to choose a server. [[File:104.png|center|thumb|1051x1051px]]
#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'''.[[File:SAVE1 22.09.png|800px|thumb|center]]
#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.[[File:105.png|center|thumb|1014x1014px]]
#To save the draft properly, first choose a server to save the draft. [[File:SAVE2 22.09.png|800px|thumb|center]]
#Click on '''SAVE AS DRAFT''' to make sure all of the data is saved properly before publishing. A pop-up window will show up and indicate the draft is saved successfully.[[File:106.png|center|thumb|1014x1014px]]
#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.[[File:SAVE3 22.09.png|800px|thumb|center|Enter a prefix in the BCO Prefix field]]
#Before publishing the draft, users need to validate the draft first. To do this, click on '''VALIDATE BCO'''. A new window will pop up with validation results. Please see this [[Common_errors|page]] for common errors and possible solutions.[[File:107.png|center|thumb|1032x1032px]]
#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.[[File:SAVE4 22.09.png|800px|thumb|center|Click on CREATE NEW DRAFT to save the draft]]
# 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 turn blue, click on it to publish the draft.[[File:108.png|center|thumb|982x982px]][[File:107.png|center|thumb|1032x1032px]]
#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.
#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.
#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 [[Common_errors|page]] for common errors and possible solutions. [[File:Validate1 22.09.png|800px|thumb|center]]
# 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. [[File:Publish.png|800px|thumb|center]]
#If any errors were detected during validation, then correct those errors based on the validation results. Revalidation is needed before publishing.
#If any errors were detected during validation, then correct those errors based on the validation results. Revalidation is needed before publishing.
#Other options on the Builder page include DOWNLOAD DRAFT in JSON format and DELETE DRAFT permanently.
#Other options on the Builder page include '''DOWNLOAD BCO''' in JSON format and '''UPLOAD''' a BCO.[[File:109.png|center|thumb|1008x1008px]]

Latest revision as of 02:20, 27 November 2023

  1. Click on BCO Builder icon on the Navigation Bar:
    101.png
  2. 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, and plain boxes are optional fields. Click next to advancing to the next section.
    102.png
  3. For information to fill out each domain, please refer to these links: 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.
  4. User can also view/edit the BCO in JSON by clicking RAW JSON VIEW.
    103.png
  5. A BCO draft can be saved at any time of editing. In order to save a draft, go to the top of the page to choose a server.
    104.png
  6. 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.
    105.png
  7. Click on SAVE AS DRAFT to make sure all of the data is saved properly before publishing. A pop-up window will show up and indicate the draft is saved successfully.
    106.png
  8. Before publishing the draft, users need to validate the draft first. To do this, click on VALIDATE BCO. A new window will pop up with validation results. Please see this page for common errors and possible solutions.
    107.png
  9. 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 turn blue, click on it to publish the draft.
    108.png
    107.png
  10. If any errors were detected during validation, then correct those errors based on the validation results. Revalidation is needed before publishing.
  11. Other options on the Builder page include DOWNLOAD BCO in JSON format and UPLOAD a BCO.
    109.png
Retrieved from "https://wiki.biocomputeobject.org/index.php?title=Buildbcos&oldid=511"