Planned Episodes

The followings are planned episodes and synopsis.

I see three different types of tutorials. a) Overview; b) Essential; c) Deep dive. The difference between (a) and (b) is subtle and sometimes they could overlap. Type (a) is typically broader than type (b) and (c), both of them are not deep in the tutorial topic. If the deep dive tutorial is going to take longer than 5 mins, then maybe it is a good idea to have an essential tutorial. It is okay if the tutorials are overlapped.

General and BIE Section

1. Overview

   1. Introduce the tool: Give an overview that Score is the generic name of the tool. connectCenter is the OAGi marketed name of the tool. The tool consists of CC, BIE, Business Context, OpenAPI Document, and Code List management. Explain what is CC, BIE, and Code List. The video may explain different types of CCs and BIEs according to CCTS. (a) - https://oagi.atlassian.net/wiki/x/AYAMLAE

   2. Tool deployment: Explain the various instances deployed by OAGi (except the test instance). Explain the on-prem deployment, point to resources to help the interested user deploy the tool, and keep it synced with the latest connectSpec release. Mention the OAUTH connectivity. (a) - https://oagi.atlassian.net/wiki/x/CABCLAE ~ Assigned to @Hakju Oh

2. Essential

   1. User type essential: Explain Score user types, their user management authorization, and their restrictions on important aspects of CC, BIE, and Code List lifecycle. (b) - https://oagi.atlassian.net/wiki/x/DYBDLAE ~ Assigned to @Serm Kulvatunyou

3. Deep Dive

   1. BIE Creation: Explain briefly what the BIE is in relation to the CC. May need to talk about releases as well. Then, cover BIE creation and all parts of Business Context creation from Context Category, Scheme, and Scheme Values creations to the Business Context itself. (c) - https://oagi.atlassian.net/wiki/x/DwBBLAE ~ Assigned to @Hakju Oh

   2. Searching for a BIE deep dive: Go into different search filters on the BIE management page. Emphasize that they have to be on the right branch. ~ Assigned to @Serm Kulvatunyou

   3. BIE Editing features deep dive: Go into detail about BIE editing features, selecting different types of BIE nodes, BIE reuse (but don’t go over how to create a reusable BIE), specifying example, value domain, code list (explain what code list can be available for selection), high unused, expand a few depths, search within the tree. (c) - https://oagi.atlassian.net/wiki/x/A4CSQwE ~ Assigned to @Hakju Oh

   4. Advanced BIE Editing/Viewing functions: Possibly refactor some BIE Editing/Viewing feature from the previous use case into this one. The less use ones like Enable 2, Enable 3, etc. Perhaps talk about the possible BIE Inverse Mode here too.

   5. Reusable BIE: Make BIE reusable, reused it. When is BIE reusable, when it is not, etc. Reuse Report (I (Serm) don’t know how to read it.) - https://oagi.atlassian.net/wiki/x/BwCWQwE ~ Assigned to @Hakju Oh

   6. BIE Expression essential: Explain the popular expression features. - https://oagi.atlassian.net/wiki/x/GADsQwE ~ Assigned to @Hakju Oh

   7. BIE Expression features deep dive: Explain pretty much all the expression options.

   8. BIE/Code List Uplifting essential: Use simple use case

   9. BIE Uplifting deep dive: Use more complicated use case

   10. Business Context Management in Detail: Explain what is a business context. Explain in more detail about Business Context ownership and life cycle. When can BC related entity can be discard. BIE BC can change any time.

   11. Copy BIE: Not just show BIE copying but also suggesting what are the use cases to copy a BIE. ~ Assigned to @Serm Kulvatunyou

CC Section

1. Understanding CC releases: A short video explaining what releases mean. Maybe also briefly talk about what changes can occur across CC releases.

2. Reading the CC tree and its detail: This video serves as introducing in more detail the various types of CC entity including the DT.

3. Creating and editing a new ACC:

4. Searching for and revising a published (released) ACC:

______________________________________ Don’t review content after this ___________________________________________

Ep1. Creating and Revising Standard Core Components Basic

Scenario

1. Introduced Developer role.

2. Need to revise Document Reference to add URL/URI and Title.

3. Lock in as oagis.

4. Search for Document Reference ACC using filter.

5. Use ACC filter and DEN sorting to open Document Reference.

6. Click on Revise. Point out that a developer can revised any published CCs on working branch. The developer would take over the ownership.

7. However, determined that Document Identification Base ACC needs to be revised instead.

8. Click on Open in new Tab.

9. Cancel the revision on the Document Reference.

10. Go back to Document Identification Base ACC to click on Revise.

11. Click on append Property Last.

12. Search for the URI BCCP to add. Fill in Definition Source http://www.openapplications.org/oagis/10 and Definition.

13. Click on append Property Last.

14. Search for the Title BCCP to add. Fill in Definition Source http://www.openapplications.org/oagis/10 and Definition. Point out that default cardinality is 0..n. If you need to change the max or min, you can do it. Change it to 1. And change to unbounded again demonstrating that you can type in -1 or unbounded.

15. Open Document Reference again to show that the URI and Title fields are there. Emphasize the use of double quote.

16. Create Statement Context Base ACC. Set component type to Base. Point out that when Base is selected Abstract is selected by default. There will be a naming rule implemented later.

17. Set base of Statement Context to Identification.

18. Add Document Reference to Statement Context. Filter with ASCCP.

19. Add Contract Reference to Statement Context. Search “Contract Reference”. Show that clicking on the blank space shows the definition. Show that clicking on the name open up the ASCCP in a new tab for detail inspection.

20. Create Statement Context ACC.

21. Set based ACC to Statement Context Base ACC.

22. Invoke Create OAGi Extension.

23. Create Statement Context ASCCP.

24. Log in as sermdev in another window.

25. Create Statement Base ACC. Set based ACC to Identification. Set Component Type to Base.

26. Append Free Form Text Group.

27. Append Statement Context ASCCP. Point out that you can use CC created by another user.

28. Demonstrate moving the association order. Move Statement Context to before Free Form Text Group.

29. Create Statement. Set based ACC to Statement Base ACC.

30. Invoke Create OAGi Extension. Walk through the entities got generated. Point out that Extension is not reusable b/c it is a local element. The name is not unique. Only some properties of Extension components can be edited.

31. End of Demo.

Ep2. Create a standard OAGi BOD

Continued from Ep1.

1. Log in as oagis developer user.

2. Create Substance Declaration Header Base ACC. Set based Type to Header Base.

3. Add Party ASCCP to it.

4. Need to add Statement ASCCP.

5. Create substance Declaration Header ACC. Set Substance Declaration Header Base as based ACC.

6. Invoke Create OAGi Extension Creation.

7. Create Substance Declaration Header ASCCP.

8. Create Substance Declaration Base ACC . Add Substance Declaration Header and Item Master as properties.

9. Create Substance Declaration ACC. Set based ACC to Substance Declaration Base ACC. Invoke Create OAGi Extension

10. Go back to CC page. Invoke Create OAGi BOD.

Ep3. Managing a CC release

Prepare some new and revised CC. Some even though should be in the release are still in WIP or Draft state. Some don’t want in the release that are in WIP, Draft, Candidate, or Deleted state.

1. Explain that a release has 3 states - Initialized, Release Draft, and Published.

2. Log in as a developer user - sermdev.

3. Create a new release.

4. Point out that it is in the Initialized state.

5. Create another release. Point out that there can be multiple releases in the initialized state. But there can be only one release in Release Draft or Published state. Multiple initialized releases are allowed for planning purpose.

6. Release in the Initialized state has no content yet, so it won’t appear on the list of branches of the CC. Go to CC View/Edit page and show that no branches for the releases in the Initialized state.

7. Go back to release page and create a Draft.

8. Assign content to the release. You may choose not to assign some content to the release because it is for a future release or you simply don’t want it, e.g., in Deleted state.

9. Run validation. Show invalidity, like there is a necessary ASCCP in WIP state that is not included.

10. Fix the issue. Validate again.

11. Create the draft release.

12. Show that the draft release now appears on the CC View/Edit page for viewing and reviewing only.

13. At this point people can be invited to review the release and give comments.

14. Point out that more CCs can be added or changed in the Working branch.

15. If all reviews have been gathered and changes need be made to the release draft, the release needs to be taken back to Initialized. Revert to initialized.

16. Now you can go back and add a property to an ACC by taking it back to the WIP state.

17. Create the release draft again. This time published it.

18. Show that now there is the Published release branch on the CC View/Edit page.

19. The end.

Ep4. Managing End User Core Component and BIE Extension

1. The purpose of EUCC is to extend the standard and to be used in BIEs.

2. Explain that End User Core Component (EUCC) is not like Developer/Standard Core Component. It has three states like BIE - WIP, QA, and Production.

3. However, unlike BIE, EUCC can shuttle from Production back to WIP but only backwardly compatible changes can be made.

4. Create a non-standard namespace. EUCC must have non-standard namespace.

5. Create two EUBCCPs, say EUBCCP1 and EUBCCP2. Move EUBCCP1 to QA.

6. Point out that EUCCs are specific to a release just like a BIE. Go to another release to show that EUCCs just created do not show up.

7. Create two EUACCs, say EUACC1 and EUACC2. Each EUACC uses each EUBCCP created earlier and some other standard BCCPs. Set one of the association in EUACC2 to max cardinality 1. Point out that just like developer CC, relationship can be created with EUCC in any state.

8. Create two EUASCCPs, say EUASCCP1 and EUASCCP2, from the EUACC1 and EUACC2, respectively. Add EUASCCP2 to EUACC1.

9. Point out that OAGIS extension cannot be created.

10. Create a BIE. Point out the a BIE cannot be created directly on an EUASCCP in this version of Score. Make sure to select the release correctly - same as the EUCCs were created in.

11. Check some boxes in the BIE and invoke a Localized BIE Extension.

12. Add EUASCCP1 and EUBCCP1, a standard ASCCP, and a standard BCCP to the extension. Point out that EUCC in any state can be used.

13. Go back to the BIE, shows that at this point NOTHING inside the extension can be edited.

14. Move the User Extension Group ACC to Production.

15. Go back to the BIE, point out that now components reused from the standard can be edited. But BIE node based on EUCC cannot be edited b/c the underlying EUCCs are not in the Production state.

16. Move all EUCCs to Production.

17. Go back to the BIE, show that everything in the extension is now editable.

18. Go back to amend ACC2. Add a property. And show that any backwardly incompatible change like changing the unbounded cardinality is not possible. But can change the cardinality from 1 to unbounded. Names cannot be changed. This is so that EUCC amendment will not invalidate published BIEs that already rely on those EUCC.

19. Go back to the BIE, show that ACC2, part of the ACC1, is now not editable.

20. Put ACC2 into Production.

21. Go back to BIE, now BIE nodes based on ACC2 is editable again. And cardinality of the previous existing BIE node can be updated to unbounded b/c the cardinality in the ACC2 were changed.

22. Express the BIE. Note that if end user code list (EUCL) is being amended but it was already used earlier in the BIE, expressed BIE will include new values added during the amendment even if the EUCL is not yet in Production.

23. To revise the extension, invoke the extension again.

Ep5. Managing a developer Code List

This feature is not quite ready yet.

Ep7. Collaborative CC development

Show CC development. Emphasizing the Commenting feature. Transfer ownership. Talk more about states. Talk about Deleted CCs.