As we roll out the UC 54.0 platform including PlantUML, Unified Dictionary, API Access and more, we will be putting in place an initial set of permission-based roles to manage access to the application functionality.
While we are still in the early stages, the goal is to create a small minimal set of roles that could potentially expand as we learn more about customer usage.
Overview
For each of the initial areas: PlantUML, Dictionary, and Glossary we want to grant access in a consistent fashion across those areas We will grant access across all product areas including PlantUML, Glossary, and Dictionary with the following two roles.
Reader - read access to account-owned any content, both private and community and private.Reviewer - all capabilities of Reader, in addition can . Will be able to perform collaborative tasks such as tagging, classification, approving … (most of these functions will come later) along with access to any community contentcommenting and tagging.
Editor - all capabilities of ReviewerReader, in addition can manage content (e.g., create, update, delete, publish …) for all account-owned content.Owner - all capabilities of Editor, in addition can perform organizational aspects such as setting up teams (future functionality)
At a later state we might split out roles by product, but as of now that use case doesn’t seem logical. If a person is an editor of PlantUML diagrams, they will most likely be an editor for Dictionaries.
Note:
community content can be read, commented on, voted on … but not changed unless owned by the account.
The concept of ownership needs to be fully fleshed out (person, account, org …), but not covered here.
The concept of how one can contribute to the community needs to be revisited (e.g. “known person”), but not covered here. Roles will allow the person to be an Editor, but steps still need to become a contributor.
In addition to the product-specific roles, there are two additional administrative roles and a special billing role:
Platform Owner - can delete the account and add additional administrators.
Administrator - manages access - can assign other administrators as well as manage other team members such as inviting others and assigning roles.
Billing Administrator - manages subscriptions and billing.
Note:
the Billing Administrator is a special role where the billing contact will be defined on the subscription page and not assigned as a particular team member since this roll will not have any other functional needs other than to view and update subscription, billing, and usage.
when CCH and Mapper are added, additional roles may be added that focus on the approval process.
Product-specific Access
After analyzing the different jobs-to-be-done (JTBD), we identified the following access requirements:
Visibility: private, community, or both
Ownership: account-owned vs. not-account-owned or both
Actions: create, read, update, delete, tag, classify, publish, comment …
Scope: specific object access (e.g., “glossary A”, “dictionary C”, “PlantUML Diagram 1” …)
Note:
in the short term, we will not implement scope, but will add later.
Discussion topic: Many modern SaaS applications include collaboration aspects where users can individually grant access to specific documents, diagrams … for others to comment on or edit. How does scope Scope and collaboration work together? Or are they may end up being the same thing?.
PlantUML
...
Functional Roles
Description of the two functional roles not taking scope into account at this time.
Role | Description | Visibility | Ownership | Actions | Scope | Comments | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PlantUML Reader | Read access to all account-owned diagrams whether private or community. | Private and Community | Account-owned only | Read | All (any PlantUML diagram) | PlantUML Reviewer | Review access to all account-owned diagrams content (PlantUML, Glossary, Dictionary …) whether private or community. | Read access to all community diagrams. | Private and Community | Both account and community diagrams | Read, comment, approve. | All (any PlantUML diagram) | Their role-specific actions such as comment won’t be available early on which makes this role identical to “reader” | PlantUML Editor | Access to all account-owned diagrams whether private or community Read access to all community diagrams. | Private and Community | Both account and community diagrams | All (create, update, delete, publish …) | All (any PlantUML diagram) | PlantUML Owner | Access to all private and community diagrams | Private and Community | Both account and community diagrams | Collaboration capabilities such as commenting will be added later. | |
Editor | Edit access to all account-owned content (PlantUML, Glossary, Dictionary …) whether private or community. | All (create, update, delete, publish …)All (any PlantUML diagram)Future state may include additional capabilities like managing groups or teams. |
Glossary - Scope
Glossary (as opposed to PlantUML and Dictionary) access must may need to have Scope defined early on to ensure only specific users can access sensitive information.
...
Role
...
Description
...
Visibility
...
Ownership
...
Actions
...
Scope
...
Comments
...
Glossary Reader
...
Must be able access all account-owned glossaries whether private or community as long as have permission to access those glossaries
...
Private and Community
...
Account-owned only
...
Read glossary terms
...
Only those given access to
...
Glossary Reviewer
...
Must be able access all account-owned glossaries whether private or community as long as have permission to access those glossaries.
Read access to all community glossaries.
...
Private and Community
...
Both account and community glossaries
...
Read, comment, and approve terms and glossaries.
...
Only those given access to
...
Their role-specific actions such as comment won’t be available early on which makes this role identical to “reader”.
...
Glossary Editor
...
Must be able access all account-owned glossaries whether private or community and search as long as have permission to access those glossaries.
Read access to all community glossaries.
...
Private and Community
...
Both account and community glossaries
...
Create, read, update, and delete terms within glossaries.
Search third-party dictionaries.
...
Only those given access to
...
Glossary Owner
...
Access to all private and community glossaries including search.
Restricts access to glossaries.
...
Private and Community
...
Both account and community glossaries
...
All
Create and manage glossaries and manage a set of terms in those glossaries.
Manage access to each glossary.
Search third-party dictionaries.
...
All (any glossary)
...
Must be able restrict access to specific glossaries to person, group or team (could start with users)
Dictionary
Dictionary access need not have Scope defined for early access, but might be needed for GA. The hypothesis is that organizations will only have one dictionary that will be “federated” with the compliance dictionary for citation tagging for their private documents.
...
Role
...
Description
...
Visibility
...
Ownership
...
Actions
...
Scope
...
Comments
...
Dictionary Reader
...
Must be able access all account-owned dictionaries whether private or community.
...
Private and Community
...
Account-owned only
...
Read terms.
...
All (any dictionary)
...
Dictionary Reviewer
...
Must be able access all account-owned dictionaries whether private or community.
Read access to all community dictionaries.
...
Private and Community
...
Both account and community dictionaries.
...
Read, comment, and approve terms and dictionaries.
...
All (any dictionary)
...
Their role-specific actions such as comment won’t be available early on which makes this role identical to “reader”.
...
Dictionary Editor
...
Must be able access all account-owned dictionaries whether private or community and search.
Read access to all community dictionaries.
...
Private and Community
...
Both account and community dictionaries.
...
Create, read, update, and delete dictionary terms within a dictionary.
Search third-party dictionaries.
...
All (any dictionary)
...
Dictionary Owner
Access to all private and community dictionaries including search.
Read access to all community dictionaries.
...
Private and Community
...
Both account and community dictionaries.
...
All
Create and manage a compliance dictionary and manage a set of terms in that dictionary
Search third-party dictionaries.
...
All (any dictionary)
...
However, we won’t focus on that yet.
Administrative Roles
Regardless of the products subscribed to, administrators are required to set up the account and grant access to users.
Role | Description | Actions | Comments |
|---|---|---|---|
Platform AdministratorOwner | Manages all IT Infrastructure including SaaS applications. | Delete the account and add/remove other administrators. | |
Administrator | Manages access to the application. | Manage users (invite, revoke, remove …). | |
Billing Administrator | Manages all financial related topics including SaaS subscriptions. | Choose and pay for subscription. |
...
Below are the identified jobs that need to be done with their respective permission-based roles.
PlantUML
Persona | Task Name | Situation | Motivations | Input | Output | Permission-Role | |||||||
Doer Dan | Search for, review, and download PlantUML diagrams | When I help a team with a process that includes compliance steps | I want to make sure we do all the right steps the first time. | Organized set of PlantUML diagrams | Set of files or hyperlinks updated on our SharePoint collaboration site. | PlantUML Reader | |||||||
Analyst Alberta | Organize and help with PlantUML Diagrams | When my superior wants me to assist in organizing and updating process diagrams. | I want to help the team make compliance process diagrams easily accessible for others. | Disorganized set of PlantUML diagrams. | Organized set of PlantUML diagrams.PlantUML Editor | Process Peter | Create and manage PlantUML Diagrams | When I document my organization's processes. | I want to build out a set of diagrams documenting repeatable compliance processes that my director will love. | PlantUML diagrams created by me and othersProcess documentation. Additional information like CCH content including CDOCs, audit questions … that is available in their existing CCH subscription. | Set Organized set of PlantUML diagrams ready for review and approval. | PlantUML Owner | |
Compliance Katherine | Review, comment on, and approve PlantUML diagrams. | When my team is ready for me to review their diagrams. | I want my team to build out repeatable processes for the compliance team to easily follow. | PlantUML diagram(s) ready for my review. | Set of approved and finalized PlantUML diagrams. | PlantUML Reviewer | |||||||
others to use. | Editor |
Glossary
Persona | Task Name | Situation | Motivations | Input | Output | Permission-Role | Employee Edgar | Review terms | When I read through a company policy document | I want ot make sure I understand the terms defined in the policy | A company glossaryAn understanding of the terms | Glossary Reader | |
Doer Dan | Search for, review, and read glossary terms. | When I help a team with any well-defined process | I want to make sure we do all the right steps the first time. | Organized set of glossaries and terms | Set of files or hyperlinks updated on our SharePoint collaboration site. | Glossary Reader | |||||||
Analyst Alberta | Organize glossaries.When my superior wants me to assist in organizing and updating glossaries and terms. | I want to help the team make company glossaries easily accessed for others. | Disorganized set of glossaries and terms. | Organized set of glossaries and terms. | Glossary Editor | Process Peter | Create and manage company glossaries. | When I document my organization's policies. | I want to build a set of repeatable compliance processes that my director will love. | Company policies. | A set of glossaries and terms ready for review and approval. | Glossary Owner | |
Compliance Katherine | Review, comment on, and approve corporate glossaries. | When my team is ready for me to review their corporate glossaries. | I want everyone in the company to have a common understanding of the terms within our policies. | Glossaries and terms ready for my approval. | A set of approved and finalized glossaries and terms. | Glossary Reviewer | |||||||
others to use. | Editor |
Dictionary
Persona | Task Name | Situation | Motivations | Input | Output | Permission-Role | |||||||
Doer Dan | Search for, review, and read dictionary terms. | When I help a team with a process that includes compliance steps. | I want to make sure we do all the right steps the first time. | Organized set of dictionaries and terms. | Set of files or hyperlinks updated on our SharePoint collaboration site. | Dictionary Reader | |||||||
Analyst Alberta | Organize dictionaries. | When my superior wants me to assist in organizing and updating dictionaries and terms.I want to help the team make compliance dictionaries easily accessed for others. | Disorganized set of dictionaries and terms. | Organized set of dictionaries and terms. | Dictionary Editor | Process Peter | Create and manage a compliance dictionary. | When I document my organization's policies. | I want to build a set of repeatable compliance processes that my director will love. | Company policies Other UCF tools and products | My organization's compliance dictionary with terms ready for review and approval. | Dictionary Owner | |
Compliance Katherine | Review, comment on, and approve a compliance dictionary. | When my team is ready for me to review the compliance dictionary. | I want our corporate policies to be mapped to UCF’s common controls. | A compliance dictionary ready for my review and approval. | A reviewed and approved compliance dictionary. | Dictionary Reviewer | |||||||
use in corporate glossaries and in the mapping process. | Editor |
Personas
Note: these will be moved out to the persona pages
Persona | Title | Role | Employee Edgar | Any employee | Any role such as |
Doer Dan | Operations manager | Supports all business departments in their operational tasks. | |||
Analyst Alberta | Compliance Analyst | Junior or senior member of the compliance team. | |||
Process Peter | Compliance Manager | Member of compliance team at fin-tech organization. | |||
Compliance Katherine | Director of Compliance | Leads compliance team at fin-tech organization. |