CaSS Docs

# Framework

A Competency Framework is a structured collection of competencies.

Examples of Competency Frameworks:

Frameworks are typically found in PDFs, Word Docs, spreadsheets, and other formats, schemata, etc. To learn more about frameworks or competencies, visit the CaSS Overview.

CaSS can represent any competency framework as a CaSS Framework.

A CaSS Framework is a directed graph of references to objects which may include (but is not limited to) competencies, the relationships between competencies, and the criterion used to judge individual skill level at those competencies. It might help to think of frameworks as containing competencies as nodes, relations as edges, and additional information in the form of meta data properties on the objects.

CaSS Frameworks may contain versioned references or unversioned references. By default, all operations create unversioned references which refer to the latest version.

All references to competencies, relations, and other objects are represented as URLs. This allows frameworks to refer to competencies in the same repository, in a different framework, or on a different repository.

When processing (for instance, determining if a person holds a competency), you will use Frameworks to contextualize the process, bounding the problem to a set of competencies and relations. This is done both to make processing operate in a reasonable amount of time, and to prevent abuse by individuals who make bogus frameworks and relations.

# Creating a framework

The CaSS Libraries include a framework helper object that extends Framework with additional methods.

var f = new EcFramework();
f.generateId("https://dev.CaSSproject.org/api/");
f.addOwner(EcIdentityManager.ids[0].ppk.toPk());

# Manipulating a framework

# Adding a Competency

var c = new EcCompetency();
c.generateId("https://dev.CaSSproject.org/api/");
c.addOwner(EcIdentityManager.ids[0].ppk.toPk());
c.name = "Competency 1";

f.addCompetency(c.shortId()); // Add the competency such that it will update automatically
// Alternatively...
f.addCompetency(c.id); // Add this particular version of the competency
// Don’t forget to save the framework and/or competency!

# Removing a Competency

This method will also remove relations that involve the competency and levels that refer to the competency.

f.removeCompetency(c.id,function(success){},function(failure){}); //Can also use c.shortId()
// Don’t forget to save the framework and/or delete the competency!

# Adding a Relation

var c1 = new EcCompetency();
c1.generateId("https://dev.CaSSproject.org/api/");
c1.addOwner(EcIdentityManager.ids[0].ppk.toPk());
c1.name = "Competency 1";
var c2 = new EcCompetency();
c2.generateId("https://dev.CaSSproject.org/api/");
c2.addOwner(EcIdentityManager.ids[0].ppk.toPk());
c2.name = "Competency 2";
var r = new EcAlignment(); // Yes, I know. It’s not EcRelation. Coming soon.
r.generateId("https://dev.CaSSproject.org/api/");
r.addOwner(EcIdentityManager.ids[0].ppk.toPk());
r.source = c1.shortId();
r.target = c2.shortId();
r.relationType = Relation.NARROWS;
f.addCompetency(c1.shortId());
f.addCompetency(c2.shortId());
f.addRelation(r.shortId());
//Don’t forget to save these objects!

# Removing a Relation

f.removeRelation(r.shortId());
// Don’t forget to save!

# Adding a Level

var c = new EcCompetency();
c.generateId("https://dev.CaSSproject.org/api/");
c.addOwner(EcIdentityManager.ids[0].ppk.toPk());
c.name = "Running";
var l = new EcLevel();
l.generateId("https://dev.CaSSproject.org/api/");
l.addOwner(EcIdentityManager.ids[0].ppk.toPk());
l.competency = c.shortId();
l.name = "10 mph";
l.description = "The individual can run 10 miles per hour for several seconds.";
l.title = "Runner";
c.addCompetency(c.shortId()); //Add the level such that it will update automatically
f.addLevel(l.shortId()); //Add the level such that it will update automatically
// Don’t forget to save!

# Removing a Level

f.removeLevel(l.id);
// Don’t forget to save the framework and/or delete the level!

# Framework Actions

# Save

EcFramework has a helper method that validates expected fields before saving.

f.save(function(success){},function(failure){});

# Delete

EcFramework has a helper method that deletes the framework. This does not delete any objects referenced by the framework.

f._delete(function(success){},function(failure){});

# Get

EcFramework has a static helper method for retrieving a Framework, automatically decrypting it, automatically encrypting it on save, and casting it to the EcFramework object. The blocking version locks the thread while this occurs.

EcFramework.get(url,function(framework){},function(failure){});

or

var f = EcFramework.getBlocking(url);

EcFramework has a static helper method for searching for Frameworks.

// Searches for frameworks
EcFramework.search(
    repo,
    null,
    function(arrayOfEcFrameworks) {},
    function(failure) {}
);
// Searches for up to 5000 frameworks that have “Workforce” in the name.
EcFramework.search(
    repo,
    "name:Workforce",
    function(arrayOfEcFrameworks) {},
    function(failure) {},
    {size:5000}
);

← Competency →