Difference between revisions of "Introduction to Modeling - Archimate in Qualiware"
John.bain2 (talk | contribs) (Added section for tips and tricks) |
Steve.leslie (talk | contribs) |
||
(12 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | This guide is intended for SSC architects modeling using ArchiMate in Qualiware. Currently, it focuses on very high-level business modeling, specifically about SSC | + | [[File:EA Sticker.png|alt=SSC Enterprise Architecture|right|frameless|225x225px]] |
+ | |||
+ | This guide is intended for SSC architects modeling using ArchiMate in Qualiware. Currently, it focuses on very high-level business modeling, specifically about SSC Services. | ||
== Login to QualiWare == | == Login to QualiWare == | ||
− | * If you don’t have access already, request an account for Qualiware | + | * If you don’t have access already, request an account for Qualiware through this Confluence link: [https://confluence.ssc-spc.gc.ca/display/JIRAINTAKE/New+User+QW+License+Request]. You will receive an email with instructions. |
− | * Click on your QLM-Desktop RDP icon [[File:QLM-Desktop.rdp.image.png]] | + | * Click on your QLM-Desktop RDP icon [[File:QLM-Desktop.rdp.image.png|46x46px]] |
− | |||
* Enter your standard desktop login credentials (email address and usual desktop password) (or follow the email instructions you've been sent above). | * Enter your standard desktop login credentials (email address and usual desktop password) (or follow the email instructions you've been sent above). | ||
− | * Click OK on the warning screen. You will then see a remote desktop instance. | + | * Click OK on the warning screen. You will then see a remote desktop instance. |
− | * Click on the appropriate Qualiware icon to start the Qualiware Lifecycle Manager on the remote instance: | + | * Click on the appropriate Qualiware icon to start the Qualiware Lifecycle Manager on the remote instance: [[File:QLM_X_icon.png|47x47px]] |
− | |||
* If you receive a warning, simply click Run. | * If you receive a warning, simply click Run. | ||
* Select “Windows Authentication” and click “Connect". | * Select “Windows Authentication” and click “Connect". | ||
Line 15: | Line 15: | ||
* Select Configuration "Base Configuration" (the default - in future this may change). | * Select Configuration "Base Configuration" (the default - in future this may change). | ||
− | == Starting a New Model: SSC | + | == Starting a New Model: SSC (Client-facing or Supporting) Service == |
* Click on the “ArchiMate” folder at the bottom left of the screen. | * Click on the “ArchiMate” folder at the bottom left of the screen. | ||
− | * Select | + | * Select “BusinessProcessCoopViewpoint:ArchiMate”. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
* Don’t forget to follow the metamodel: | * Don’t forget to follow the metamodel: | ||
** Guidance: Content Metamodel | ** Guidance: Content Metamodel | ||
** Guidance: Content Guidelines | ** Guidance: Content Guidelines | ||
− | *Create a new | + | *Create a new “BusinessProcessCoopViewpoint: ArchiMate”[[File:ArchiMate Icon.png]] |
− | *Give it a name: | + | *Give it a name: “Client-facing Service: YOURFULLSERVICENAMEHERE”, e.g.: "Client-facing Service: Mobile Devices". |
== Modeling the Service == | == Modeling the Service == | ||
Note: At SSC, we represent SSC Services with ArchiMate Business Functions. | Note: At SSC, we represent SSC Services with ArchiMate Business Functions. | ||
− | * The first object you’ll want to place on your diagram is the function that represents your SSC Catalog Service. This object should already exist in the tool. It will be of type “BusinessFunction:ArchiMate”. | + | * The first object you’ll want to place on your diagram is the function that represents your SSC Catalog Service. '''This object should already exist in the tool'''. It will be of type “BusinessFunction:ArchiMate”. |
* Find the appropriate object by: | * Find the appropriate object by: | ||
**Create a BusinessFunction:ArchiMate object on the diagram, and right-click on the default name of the object. [It’s important to right-click directly on the highlighted “New BusinesFunction:Archimate” text.[[File:New Bus Function Archimate.png]] | **Create a BusinessFunction:ArchiMate object on the diagram, and right-click on the default name of the object. [It’s important to right-click directly on the highlighted “New BusinesFunction:Archimate” text.[[File:New Bus Function Archimate.png]] | ||
Line 46: | Line 40: | ||
*** If you accidentally create a duplicate object, be sure to delete it to prevent others from also using that duplicate object in other models. | *** If you accidentally create a duplicate object, be sure to delete it to prevent others from also using that duplicate object in other models. | ||
− | == | + | == SSC Client-facing Service from Service Blueprint == |
− | * So, you’ve started your new diagram, and placed the SSC | + | * So, you’ve started your new diagram, and placed the SSC Client-facing Service business function on it. |
− | * Now, you’ll need to find your reference material – in this case, an SSC Service Blueprint document for your SSC | + | * Now, you’ll need to find your reference material – in this case, an SSC Service Blueprint document for your SSC Client-facing Service. |
* Many service blueprints can be found here https://gcdocs.gc.ca/ssc-spc/llisapi.dll?func=ll&objId=3595626&objAction=browse | * Many service blueprints can be found here https://gcdocs.gc.ca/ssc-spc/llisapi.dll?func=ll&objId=3595626&objAction=browse | ||
* Description: The Service blueprints cover the main business functions, processes, clients, and high-level service team roles for a service. These are the things you will place on your model. | * Description: The Service blueprints cover the main business functions, processes, clients, and high-level service team roles for a service. These are the things you will place on your model. | ||
== Things to consider/cover in your Model == | == Things to consider/cover in your Model == | ||
− | * Who are the clients for this SSC service? Any Partner, a specific type of partner? Represent with BusinessActor:Archimate | + | * Who are the clients for this SSC service? Any Partner, a specific type of partner? Represent with '''BusinessActor:Archimate''' |
+ | * What things does this service do specifically for those clients? These "exposed business behaviours" are modeled (somewhat confusingly) using '''BusinessService:Archimate''' objects. | ||
+ | ** These services are what, exactly, a client can expect to receive from this service. It’s unlikely to be the name of the SSC service like “Video Conferencing”, but more like “Request a videoconference account”, or “Ordering a new desktop computer”. What’s the request a client is making? | ||
* Does this service use the SSC Enterprise Service Desk? | * Does this service use the SSC Enterprise Service Desk? | ||
** If so, you may wish to drop that Business Function on your diagram as a starting point – it already exists in the system. | ** If so, you may wish to drop that Business Function on your diagram as a starting point – it already exists in the system. | ||
− | * What roles/actors are responsible for this SSC service? These should be assigned to the service and represented as BusinessRole:Archimate objects: | + | * What roles/actors are responsible for this SSC service? These should be assigned to the service and represented as '''BusinessRole:Archimate''' objects: |
** Service Executive Sponsor | ** Service Executive Sponsor | ||
** Service Lead | ** Service Lead | ||
** Service Subject Matter Expert | ** Service Subject Matter Expert | ||
** Service Architect | ** Service Architect | ||
− | + | * What are the main (sub) functions for this SSC service? Represent as BusinessFunction:Archimate. You’re breaking down this “SSC Service” into logical portions. Remember, functions are just groups – they don’t have flow or sequence. | |
− | |||
− | * What are the main (sub) functions for this SSC service? Represent as BusinessFunction:Archimate. You’re breaking down this “SSC Service” into logical portions. Remember, functions are just groups – they don’t have flow or sequence. | ||
* Are there any other SSC Services (catalog/technical/supporting) that are used to realize this SSC Service? | * Are there any other SSC Services (catalog/technical/supporting) that are used to realize this SSC Service? | ||
− | * What are the main business processes for the SSC Service? Remember, processes imply | + | * What are the main business processes for the SSC Service? Remember, processes imply '''flow and/or sequence'''. They also usually involve data flow, use, creation. Represent as '''BusinessProcess:Archimate''' |
− | * What data is used | + | * Processes generally imply data. What data is used or created for each function/process? Where does it come from? Where does it go? Represent as '''BusinessObject:Archimate''' |
− | ** NOTE: Business | + | ** NOTE: Business objects should be common (or business) term for the item, not representing particular format or technology, e.g. "Order/Request" not "Word Order Form" or "Oracle Order Table". |
− | * Who is creating, using, processing this data? BusinessRole:Archimate | + | * Who is creating, using, processing this data? '''BusinessRole:Archimate''' |
− | * What applications do the functions/processes in this SSC service use? (Use Application Layer, ApplicationComponent:ArchiMate to represent these). | + | * What applications do the functions/processes in this SSC service use? (Use Application Layer, '''ApplicationComponent:ArchiMate''' to represent these). |
− | * What interfaces (phone, fax, email, web, physical kiosk…) are being used for the SSC Service or any sub-functions? | + | * What interfaces (phone, fax, email, web, physical kiosk…) are being used for the SSC Service or any sub-functions? These should be associated with the appropriate business services via a '''BusinesInterface:ArchiMate''' object. |
− | * What business capabilities are realized/enabled with this SSC Service or any of its sub-functions? | + | * What business capabilities are realized/enabled with this SSC Service or any of its sub-functions? You should link to any relevant business capabilities using the '''Capability:ArchiMate''' objects. |
+ | ** You should not create a new business capability. Instead, these capabilities should already be pre-populated in the system for you. | ||
− | == Connecting and Associating Objects == | + | == Connecting and Associating Objects == |
− | * '' | + | Full descriptions of how to make relationships between objects can be found in the ArchiMate 3.0.1 Specification. Some key relationships to consider however are: |
− | * | + | * Between processes there is usually a '''flow''' relationship. |
− | * '' | + | * Functions and processes '''access''' business objects (data/information). |
+ | * Roles are '''assigned''' to processes/functions. | ||
+ | * Services '''realize''' functions or processes. | ||
+ | * Processes comprise ('''composition''') functions. | ||
+ | * If you do not know what the most appropriate relationship is between an object, then simply '''associate''' them. Associations will always work. | ||
+ | Note: Graphical associations may not always make the “hard” connections required for all types of reporting. In some cases, we will need to make explicit associations in the tool to ensure that sub-functions are connected to parent functions, etc… These are accomplished in Qualiware by using the properties menu, and inserting objects as "Implements" or "Breaks down to" or other associations within the tool. | ||
+ | |||
+ | Hint: Once you've made your associations in the background, <u>generating a Context View</u> on an object can help you quickly get a visual of the associations: | ||
+ | # Right-click your object and select Properties | ||
+ | # Expand Associate --> select RelationContext | ||
+ | # Near bottom-right, select Create Context View | ||
== Governance == | == Governance == | ||
* Governance roles determine what Governance Actions can be taken based on the user and the state of the diagram | * Governance roles determine what Governance Actions can be taken based on the user and the state of the diagram | ||
Line 88: | Line 93: | ||
[[Qualiware Tips and Tricks]] | [[Qualiware Tips and Tricks]] | ||
* | * | ||
+ | |||
+ | [[Category:Architecture]] | ||
+ | [[Category:Enterprise Architecture]] | ||
+ | [[Category:Modeling]] | ||
+ | [[Category:Qualiware]] |
Latest revision as of 11:27, 13 September 2021
This guide is intended for SSC architects modeling using ArchiMate in Qualiware. Currently, it focuses on very high-level business modeling, specifically about SSC Services.
Login to QualiWare
- If you don’t have access already, request an account for Qualiware through this Confluence link: [1]. You will receive an email with instructions.
- Click on your QLM-Desktop RDP icon
- Enter your standard desktop login credentials (email address and usual desktop password) (or follow the email instructions you've been sent above).
- Click OK on the warning screen. You will then see a remote desktop instance.
- Click on the appropriate Qualiware icon to start the Qualiware Lifecycle Manager on the remote instance:
- If you receive a warning, simply click Run.
- Select “Windows Authentication” and click “Connect".
- Select repository "SSC Dev" (In future, this will be "SSC Prod")
- Select Configuration "Base Configuration" (the default - in future this may change).
Starting a New Model: SSC (Client-facing or Supporting) Service
- Click on the “ArchiMate” folder at the bottom left of the screen.
- Select “BusinessProcessCoopViewpoint:ArchiMate”.
- Don’t forget to follow the metamodel:
- Guidance: Content Metamodel
- Guidance: Content Guidelines
- Create a new “BusinessProcessCoopViewpoint: ArchiMate”
- Give it a name: “Client-facing Service: YOURFULLSERVICENAMEHERE”, e.g.: "Client-facing Service: Mobile Devices".
Modeling the Service
Note: At SSC, we represent SSC Services with ArchiMate Business Functions.
- The first object you’ll want to place on your diagram is the function that represents your SSC Catalog Service. This object should already exist in the tool. It will be of type “BusinessFunction:ArchiMate”.
- Find the appropriate object by:
- Create a BusinessFunction:ArchiMate object on the diagram, and right-click on the default name of the object. [It’s important to right-click directly on the highlighted “New BusinesFunction:Archimate” text.
- Find the Catalog service you want in the dialog box that appears, and select the service.
- Click OK – to reuse that object in your diagram.
- Create a BusinessFunction:ArchiMate object on the diagram, and right-click on the default name of the object. [It’s important to right-click directly on the highlighted “New BusinesFunction:Archimate” text.
Object Reuse
- Cardinal Rule 1: DON’T RECREATE any EXISTING OBJECT.
- ALWAYS search for the object you want before creating a new one. Reuse existing objects, where appropriate, ALWAYS.
- For example, you want to show that a process in your function uses another SSC Service. Place a BusinessFunction on your diagram, and right-click on it before giving it a name. Scroll through the list of existing functions to find that SSC Service.
- That said, it’s OK to create functions of the same name as existing functions if they are indeed unique/different than those existing functions. E.g.: 2 different SSC catalog services may have 2 different functions called “Request Fulfilment”… if indeed they are 2 different request fulfillment processes.
- This reuse of objects is what creates the rich, connected model that we need to produce appropriate reporting and deliverables in future.
- If you accidentally create a duplicate object, be sure to delete it to prevent others from also using that duplicate object in other models.
- ALWAYS search for the object you want before creating a new one. Reuse existing objects, where appropriate, ALWAYS.
SSC Client-facing Service from Service Blueprint
- So, you’ve started your new diagram, and placed the SSC Client-facing Service business function on it.
- Now, you’ll need to find your reference material – in this case, an SSC Service Blueprint document for your SSC Client-facing Service.
- Many service blueprints can be found here https://gcdocs.gc.ca/ssc-spc/llisapi.dll?func=ll&objId=3595626&objAction=browse
- Description: The Service blueprints cover the main business functions, processes, clients, and high-level service team roles for a service. These are the things you will place on your model.
Things to consider/cover in your Model
- Who are the clients for this SSC service? Any Partner, a specific type of partner? Represent with BusinessActor:Archimate
- What things does this service do specifically for those clients? These "exposed business behaviours" are modeled (somewhat confusingly) using BusinessService:Archimate objects.
- These services are what, exactly, a client can expect to receive from this service. It’s unlikely to be the name of the SSC service like “Video Conferencing”, but more like “Request a videoconference account”, or “Ordering a new desktop computer”. What’s the request a client is making?
- Does this service use the SSC Enterprise Service Desk?
- If so, you may wish to drop that Business Function on your diagram as a starting point – it already exists in the system.
- What roles/actors are responsible for this SSC service? These should be assigned to the service and represented as BusinessRole:Archimate objects:
- Service Executive Sponsor
- Service Lead
- Service Subject Matter Expert
- Service Architect
- What are the main (sub) functions for this SSC service? Represent as BusinessFunction:Archimate. You’re breaking down this “SSC Service” into logical portions. Remember, functions are just groups – they don’t have flow or sequence.
- Are there any other SSC Services (catalog/technical/supporting) that are used to realize this SSC Service?
- What are the main business processes for the SSC Service? Remember, processes imply flow and/or sequence. They also usually involve data flow, use, creation. Represent as BusinessProcess:Archimate
- Processes generally imply data. What data is used or created for each function/process? Where does it come from? Where does it go? Represent as BusinessObject:Archimate
- NOTE: Business objects should be common (or business) term for the item, not representing particular format or technology, e.g. "Order/Request" not "Word Order Form" or "Oracle Order Table".
- Who is creating, using, processing this data? BusinessRole:Archimate
- What applications do the functions/processes in this SSC service use? (Use Application Layer, ApplicationComponent:ArchiMate to represent these).
- What interfaces (phone, fax, email, web, physical kiosk…) are being used for the SSC Service or any sub-functions? These should be associated with the appropriate business services via a BusinesInterface:ArchiMate object.
- What business capabilities are realized/enabled with this SSC Service or any of its sub-functions? You should link to any relevant business capabilities using the Capability:ArchiMate objects.
- You should not create a new business capability. Instead, these capabilities should already be pre-populated in the system for you.
Connecting and Associating Objects
Full descriptions of how to make relationships between objects can be found in the ArchiMate 3.0.1 Specification. Some key relationships to consider however are:
- Between processes there is usually a flow relationship.
- Functions and processes access business objects (data/information).
- Roles are assigned to processes/functions.
- Services realize functions or processes.
- Processes comprise (composition) functions.
- If you do not know what the most appropriate relationship is between an object, then simply associate them. Associations will always work.
Note: Graphical associations may not always make the “hard” connections required for all types of reporting. In some cases, we will need to make explicit associations in the tool to ensure that sub-functions are connected to parent functions, etc… These are accomplished in Qualiware by using the properties menu, and inserting objects as "Implements" or "Breaks down to" or other associations within the tool.
Hint: Once you've made your associations in the background, generating a Context View on an object can help you quickly get a visual of the associations:
- Right-click your object and select Properties
- Expand Associate --> select RelationContext
- Near bottom-right, select Create Context View
Governance
- Governance roles determine what Governance Actions can be taken based on the user and the state of the diagram
- In the present context, the Governance Roles will be determined by the content captured in the diagram being governed:
- On the main dialog for the object
- On the Governance -> Circulation dialog for the object