Creating Requirements for all BA majors

Owned by Andrew Bredenkamp
Jul 13, 2016
4 min read

This documentation is currently specifically for creating qualifications under the Bachelor of Arts. While it may apply to other degrees, please be aware that this documentation needs to be made more general.

 

PART 1 - Creating the requirements

1. Clone Major "Requirements folder 339854" under the new major.
2. Open requirements importer tool: http://cms.victoria.ac.nz/testing/topicstestingarea/jsapi/enhancedapitest-new
3. Copy requirements for the relevant major from https://victoriauniversity.atlassian.net/wiki/pages/viewpage.action?pageId=24641646 into the text box
4. ENSURE THERE ARE NO MORE THAN 25 REQUIREMENTS IN THE TEXT BOX. If there are more than 25 requirements, break them down into smaller groups and upload them to separate folders. Once you have completed part 2 you can then combine them back into the one folder.
5. Ensure that there are no blank lines, and that the lines are all indented correctly. It should look something like this:



6. Get the asset id of the folder you created in step 1. Paste this into the box Asset Number. Leave all other input boxes as they already are.
7. Press 'Parse Requirements' and keep an eye on output in the terminal to ensure there aren't any issues.
8. After a moment, the page should display "Request snt waiting for response". Wait until this changes again to show the output of the response. Normally something like this:

    0 => [object Object]
        name => Complete four (or five) courses at 100 level:
        id => 359426
        link_id => 574338
    1 => [object Object]
        success => Metadata Schema #322045 successfully applied to Asset #359426
        appliedSchemaid => 322045
        assetid => 359426
    2 => [object Object]
        name => ECON 130
        id => 359427
        link_id => 574339
... etc


9. While this is going on, you can refresh the asset tree in squiz to ensure it has not gotten stuck and started creating an infinite number of assets.
10. Once the requirements have been successfully imported, go to the details of the folder you created in step 1.

Caution If this process takes a long time, and you see that squiz has started creating duplicates of the imported requirements, seek help from Andrew immediately.

11. Change the status of this folder to "Approve and make live". Ensure that this is cascaded as well, by selecting the 'Cascade Status Change' tickbox. A warning should appear that you can safely disregard.
12. Press commit and wait as squiz sets the folder and all the children to live.

PART 2 - Converting the requirements to contain course code names

1. Open this page: http://cms.victoria.ac.nz/testing/topicstestingarea/jsapi/programmerequirementscodenames/_nocache
2. Ensure the javascript terminal is open as well.
3. Once part 1 has fully finished, copy the asset number of the folder you created in part 1 step 1 into the "Asset number" text field on this page. It should look something like this:

 

4. IMPORTANT: Again, ensure that there are no more than 25 assets under the folder when you try this.


5. Press "Get all requirements", and watch the javascript terminal to ensure there are no errors.
        5b : If an error occurs, that means the course code doesn't (or no longer) exists. You should see red text appear in the terminal with a message:

        On the confluence page that this was imported from, highlight the requirement and leave a comment for Paul saying:
        "This course does not appear to exist."

6. Once this is complete check the metadata fields on a couple of the requirements and ensure the HeadingOverride field is set either to the name of the asset, or has a link to the course in the name of the asset.

PART 3 - Inserting the requirements object into the major

1. Right click and press 'preview' the folder you have created with the new requirements
2. Copy and paste all that content into a text editor and parse it so that it is nicely formatted. (I.e. in sublime text, press command+shift+h)
3. Edit the contents of the major that needs the new requirements
4. Create a new text block for the requirements (if one doesn't exist already). Name the block 'Major Requirements Hardcoded'. Paste the nicely formatted content into this block.


Once all these are complete, reload the page on the stage server and ensure the requirements have come through correctly.
If you encounter any issues, feel free to get Andrews attention and get him to help you work it out.