View source for Introduction to Modeling - Archimate in Qualiware

{{Under construction}}

This guide is intended for SSC architects modeling using ArchiMate in Qualiware.  Currently, it focuses on very high-level business modeling, specifically about SSC Catalog Services.

== Login to QualiWare ==
* If you don’t have access already, request an account for Qualiware from Steve Leslie: [Mailto:steve.leslie@canada.ca].  You will receive an email with instructions.
* Click on your QLM-Desktop RDP icon   [[File:QLM-Desktop.rdp.image.png]] 

* 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:   [[File:QLM-6 icon.png]]   or   [[File:QLM X icon.png]]

* 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 Catalog Service ==
* Click on the “ArchiMate” folder at the bottom left of the screen.
* Select “LayeredViewpoint:ArchiMate”.
** This is where most of the current models and examples exist. 
** We’ve not explored (and probably will not explore in the near future) the other viewpoints listed. 
** The exception is the “CapabilityMapViewpoint:Archimate” template – which, as you would expect, contains the SSC Capability Models.
* Check out the examples:
** Catalog Service: Mobile Device
** Technical Service:  Data Center Facilities Management
* Don’t forget to follow the metamodel:
** Guidance: Content Metamodel
** Guidance: Content Guidelines
*Create a new “LayeredViewpoint: ArchiMate”[[File:ArchiMate Icon.png]]
*Give it a name:   “Catalog Service: YOURFULLSERVICENAMEHERE”.  E.G.:  "Catalog 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.[[File:New Bus Function Archimate.png]]
** 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.

== 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.

== Catalog Service from Blueprint ==
* So, you’ve started your new diagram, and placed the SSC Catalog 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 Catalog 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
* 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 (Archimate) Services does this SSC Service provide?  To what clients?  Represent using BusinessService:Archimate and respectively.
** 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 “Order a new desktop computer”.  What’s the request a client is making?
* 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
* What data is used, created for each function/process?  Where does it come from?  Where does it go?  Represent as BusinessObject:Archimate
** NOTE:  Business Objects should be common terms for the item, not representing format or technology  (e.g.  "Order/Request" not "Word Order Form" or "Database field 26".
* 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?
* What business capabilities are realized/enabled with this SSC Service or any of its sub-functions?

== Connecting and Associating Objects ==
* ''Coming Soon.''
* 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…
* ''[Discussion here about how to ensure that objects are connected for reporting purposes.  What associations are required in particular circumstances, and how to implement them]''
* 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 associationsR:
*# 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
* 

== Tips and Tricks ==
[[Qualiware Tips and Tricks]]
*