Authoring a Vocabulary

Websphere Business Services Fabric v7.0
Contact us...

1. Authoring a Vocabulary
1. Pre-requisites
2. Create a change set
3. Create a vocabulary
1. Add Channels
2. Add Roles
3. Add Business Concepts
1. How to Add/Edit Business Concepts
2. Add/Edit object concept
4. Completed Vocabulary Details
4. Related links

Authoring a Vocabulary

A vocabulary is a glossary of concepts used to represent the business domain. A concept can have a name, description, external links, synonyms, acronyms, and relationships to other concepts.

A glossary serves two roles:

1. It provides an agreed upon human-consumable definition for elements in the business domain. This information can be valuable for the overall lifecycle of an application to keep business and technical people aligned around the definition of key concepts.
2. It provides a “language” for writing policies in the sense that a concept—once defined in the vocabulary—may be used as part of the condition or result of a policy.

An application or business service may refer to concepts from any number of vocabularies and a vocabulary can be reused across multiple applications.

Pre-requisites

1. Start WID
2. Start the server (Websphere Dynamic Process Edition Server v7.0) ().
   Right-click the server and select Start.
3. Launch Business Space ().
   After the server starts successfully, right-click the server and select Launch\Business Space.
4. Log-in ().
   After you launch the business space, a log-in window appears.  Enter your userID and password and click Login (your userID must belong to FabricAdministrators group).

5. Choose a Fabric Authoring Space ().

   In the Space Manager window, click a Fabric Authoring space (i.e Loans Origination Authoring Space).

Create a change set

You have to create a change set before doing fabric space work.

All changes made in the Fabric spaces are tracked by the system using change sets. A change set is a group of related changes to objects in the system. When creating or editing objects, the system will ask what change set the changes should go into.

A change set starts out in Draft state. When the changes are complete and ready to be approved, the user can submit the changes with an optional comment. An administrator or the owner of this space may approve and publish the changes, or reject the changes which would return the change set to draft state. A change set can be canceled at any time. Cancelling a change set returns all of the objects that were changed to their original state.

Special constraints are used to ensure that change sets do not logically depend on one another, and may be published or canceled independently. To keep things simple, it is easiest to use the same change set for related work even when multiple users are collaborating on the changes.

1. In the Space Manager window, click on a Fabric Authoring Space. ().
   
2. In the Getting Started window, click the Governance tab ()
   
3. In Governance window, click Actions and select Create New Change Set ()
   
4. In the Create New Change Set window, enter the following details and click OK ().
1. Name: Initial Modeling for Loans Origination 
2. Description: Vocabulary, business services, application, and policies for the new Loan origination application
   
5. A New change set is created ()
   

Note:

Publish change sets frequently to prevent timeout problems ()

Create a vocabulary

1. In the Getting Started window (), click Start working with vocabularies
2. In the Vocabulary Browser (), click Actions and select New Vocabulary.
3. In the Create New Vocabulary window (), enter the following details and click OK.
   
1. Name: Loans Origination Vocabulary
2. Description: Contains the vocabulary items for the Loans Origination application
3. Change set: Select the required change set
   
4. Click OK to create new vocabulary.
4. A new vocabulary is created ()
   Click the Loans Origination Vocabulary link to display the details page.
5. Business Space - Vocabulary Detail ()
   In the Vocabulary Detail page, you can add the following vocabularies:
1. channels
2. roles
3. business concepts.

Add Channels

A channel represents a way for users to interact with a solution.  Examples of channels are web portals and call centers.

Add two channels as follows ():

1. In the Vocabulary Details window (), click Add-Channels
2. In the Create New Channel window (), enter the following details:

Channel Name	Channel Description
Better Financials Online	Better Financials Online is a customer-accessible web portal that allows customers to apply for loans
Customer Care Call Center	Channel for customers to submit a loan application by calling the Better Financials Call Center

Add Roles

Add two roles using the same steps you did for adding Channels ()

Role Name	Role Description
CSR	Customer Care Representative, primarily responsible for collecting details of the customer and the loan.  Responsible for updating the customer of loan status.
Underwriter	Reviews loans, identifies associated risk, and the customer's assets to determine if a loan can be granted

Add Business Concepts

The table below describes the other kinds of concepts that can be added to a vocabulary. Note that it is typically necessary to edit a concept after creating it in order to specify fields such as min and max values, enumerated options, or a units label.

Concept Types	Concept Type Description
Boolean	Allows values of true or false
Date	Accept values that are dates
Decimal	Like integer, except that decimal values can specify an allowed number of digitss after the decimal point.
Enumeration	Represents text data where the values is one of the specified enumerated values.  When used in policies, the options are available for single or multi-select use.
Integer	Accepts numeric values between the specified min and max range.  Whenever possible, define a label for the units associated with this numeric value.
Object	Used to define concepts that are composed of other concepts.  The special "has" relationship implies composition to the system.  Object concepts are used to define the inputs and outputs of business services.
Text	Accepts any non-empty text when used in a policy.  Whenever possible, use the more constrained enumeration.

Add the following business concepts using the steps below: ().

Name	Description	Type	Constraints(Value\Display Label)
Amount of Loan	The amount of loan being requested.	Decimal	Units of measure: USD Minimum value: 500 Maximum Value: 20000000
Collateral	Description of the collateral used to secure the loan.	Text
Credit Check Type	Check if internal or third party	Set of Fixed Values (Enumeration)	INTERNAL(Internal) THIRDPARTY(Third party)
Credit Score	Score provided for the primary borrower by one of the credit agencies.	Integer	Minimum value: 300 Maximum value: 850
Customer Name	The first and last name of the borrower	Text
Line of Business	Loan Product Line offered by Better Financials	Set of Fixed Values (Enumeration)	RV(RV Loan) Auto(Auto Loan)
Loan Application Date	Date the loan application was filed.	Date
Loan Final Review Date	Date the loan application was reviewed.	Date
Loan Status	Determines whether an internal or third-party credit check service should be used. Internal credit checks are reserved for existing customers	Set of Fixed Values (Enumeration)	Options : OPEN (Open), INPROGRESS (In Progress), APPROVED (Approved), REJECTED (Rejected), MOREINFO (More info needed)
New Customer	Has value of true if the customer is creating a new relationship with the bank, false otherwise	Boolean
Premium Credit Check	Determines whether a premium credit check is required.	Boolean

How to Add/Edit Business Concepts

1. To add a business concept, click Add(Business Concepts) ()
   
2. Create New Business Concept with the following details ()
1. Name: Line of Business
2. Description: Loan Product Line offered by Better Financials
3. Type:  Set of Fixed Values (Enumeration)
4. Click OK.
3. Edit the Business Concept ()
   After creating a business concept (i.e Line of Business), you can add details.  Click the Edit button to begin making changes.
4. Fill in the Values for the business concept ()
   For an enumeration, you will need to fill in the “Values” section.
1. For the first row (Value\Display Label), enter RV\RV Loan.
2. For the second row (Value\Display Label), enter Auto\Auto Loan.
3. Click Save.
   
5. Completed business concept ()

Add/Edit object concept

Add the following complex objects using the following attributes:

Name	Description	Type
Customer Info	Information relating to the primary lender applying for the loan	Complex Object
Loan Application	Represents a loan application	Complex Object
Loan Info	Information related to the loan and its processing	Complex Object

Edit each complex object using the following settings:

Source Concept	RelationshipType (Click to set type)	Relationship Name (Click to set the name)	Cardinality (Click to set the cardinality)	Target Concept (None selected, click to select)
Customer Info	has	customerName	exactly one	Customer name
Customer Info	has	newCustomer	exactly one	New Customer
Customer Info	has	creditScore	at most one	Credit Score
Loan Application	has	loanInfo	exactly one	Loan Info
Loan Application	has	customerInfo	exactly one	Customer Info
Loan Info	has	loanStatus	exactly one	LoanStatus
Loan Info	has	loanApplicationDate	exactly one	Loan Application Date
Loan Info	has	collateral	exactly one	Collateral
Loan Info	has	amountOfLoan	exactly one	Amount of Loan
Loan Info	has	lineOfBusiness	exactly one	Line of Business
Loan Info	has	loanFinalReviewDate	exactly one	Loan Final Review Date

Guidelines for editing the object concept:

1. Edit the Business Concept ()
   Click the “Edit” button to fill in the details for a Business Concept. For a Complex Object, you need to fill in the “Relationships” by clicking the “add” button to the far right of the “Relationships” heading
   After creating a business concept (i.e Customer Info), you can add details.  Click the Edit button to begin making changes.
2. Fill in the Values for the business concept ()
1. Click and set the values as shown:
   
2. Click on “None selected, click to select”, select “Customer Name” in the “Select Concept” dialog box and then click “OK” ().
3. Click Save.

Completed Vocabulary Details

The vocabulary details page should now look like this ().

Related links

1. Previous: Create Fabric Spaces Next: Define Business Services
   
2. Modeling, developing, assembling, deploying and managing an application
3. Working with the Fabric templates in Business Space
4. Business Space Information Center