Stakeholder: QualiWare Superusers

The GovernanceGetMethod is used for getting information about the objects, such as an attribute value or a person’s name and email, e.g. use in a NotificationTemplate to send current data from the object in a notification.

Short description: Here you give a short description of the GovernanceGetMethod. This should be able to give the user an overview of the feature.

Method used for: This is to tell when the GetMethod should be available to choose from a list.

• Analytics Measurement makes the bool method available in the analytics.
• JSON

Examine: Verifies the Method. If the action is verified, today’s date, OK checkmark, and a “Method OK” will be filled out.

GovernanceGetMethod – Advanced

Method actual name: The C# method name – custom or predefined.

• There is a set of predefined methods:

• Each of the predefined methods is detailed in the table below.

Parameter: Depending on the method as set of parameter(s) can be set.

• The different parameters are shortly explained in the table below in relation to the different Methods

Verify: Verifies the Method. If the action is verified, today’s date, OK checkmark, and a “Method OK” will be filled out.

Predefined Get Methods

Method	Description
GetAttribute	Returns the Objects attribute in specified format.
Object	Select the object where you want to get information. Clicking F2 gives predefined values (see below). If generic attribute is needed just use Object as value.
Attribute	The attribute data that you want to information from
Format	Format of the returned attribute
Separator	HTMLUrl/Email/Name/Attribute on linked object Separator = ‘;’ or ‘ ’ or ‘-‘ or ‘,’
GetInformation	Returns the attribute Select the attribute where you want to get information. Clicking F2 gives predefined governance attributes to select between (see below).
GetPlayersByRole	Returns the players of a Governance role
GetParticipantListStringText	Returns string with new and removed players
GetInfoFromAddedParticipantList	Returns information about added participant(s)
GetInfoFromRemovedParticipantList	Returns information about removed participant(s)

 

The GovernanceEventMessage is used in a GovernanceWorkflow when you want to do some action based on a GovernanceEvent.

Short description: Here you give a short description of the GovernanceEventMessage. This should be able to give the user an overview.

Condition: Should some condition (GovernanceBoolMethod/List) be true before the feature can be used/is visible.

Event types: Choose from a list of ‘events’ that decide when to run the action.

Rule to define Duration: An object is moved from GovernanceState to GovernanceState using different kinds of transitions, e.g. a GovernanceConditionalMessage. When a transition moves an object in to a GovernanceState the object will get a date set that is the limit for how long the object is allowed to be in the GovernanceState. The limit is calculated based on what the duration is set to in the transition leading in to the GovernanceState.

The date limit can be used to handle SLAs on objects. E.g. an email can be send out to the responsible of the object when the SLA is approaching or is already passed.

• Number of days:
  • Set a specific number of days for the duration. This will be used for all objects handled by this transition.
• Use the following Attribute
  • Use an attribute on the object to set a specific number of days for the duration. Use this to have different durations for different objects.
  • The attribute on the object will have to contain a number that can be translated into an integer.
• Use a date attribute
  • Use a date attribute on the object to set a specific date for when the object should no longer be in the next GovernanceState. Use this to have different dates defined for different objects.
  • The date attribute will have to be in a date format.

The number of days defined in this field decides the number of days you have to finish the next state. If you have an SLA it will influence the days to finish like this:

1. If your days from “Beginning In State” is 5 (this is set on the GovernanceWorkFlow’s attribute “Initial State Duration”), and if your SLA is a positive number 2. Then you will have 7 (5+2) days to finish the transition to next state, and the governance task will be green the first 5 days, then yellow for the next 2 days and then red until handled.
2. If your days from “Beginning In State” is 5 and if your SLA is a negative number -2. Then you will have 5 days to finish the transition to next state, and the governance task will be green for 3 days, yellow for 2 days and then red until handled.

Actions: What should the event do; here you insert a NotificationTemplate, GovernanceActionList or GovernanceActionMethod.

Asynchronously: If checked, the action(s) will run asynchronously.

The GovernanceBoolList is used in relation to a GovernanceWorkflow e.g. to specify a condition for a GovernanceTransition to take place.

The GovernanceBoolMethod returns either true or false and can be used to tell:

1. if an action should run
2. if the transition should be visible

A GovernanceBoolList can contain several GovernanceBoolMethods, and if just one returns false the Condition will return false.

Short description: Here you give a short description of the GovernanceBoolMethod. This should be able to give the user an overview of the feature.

Method used for: This is to tell when the GovernanceBoolMethod should be available to choose from a list.

• Workflow Apply condition Makes the GovernanceBoolMethod available under “Additional conditions” in the GovernanceWorkflow.
• When Condition Makes the GovernanceBoolMethod available under “Condition” in the GovernanceActionMethod
• Analytics Measurement Makes the GovernanceBoolMethod available in the analytics setup.

Verify: Verifies the Method. If the action is verified, today’s date, OK checkmark, and a “Method OK” will be filled out.

Governace Bool Method – Advanced

Condition: This is used for flexibility of methods in the code (C#).

Method actual Name: Name of the C# method used. A set of predefined methods are available in the drop down:

Parameter: Depending on the method used parameters will either be predefined or just generic. (right click in window to add parameter(s))

 

The GovernanceBoolList is used in relation to a GovernanceWorkflow e.g. to specify a set of conditions for a GovernanceTransition to take place.

The GovernanceBoolList returns either true or false and can be used to tell:

1. if an action should run
2. if the transition should be visible

A GovernanceBoolList can contain several GovernanceBoolMethods, and if just one returns false the Condition will return false.

The GovernanceActionList or a single GovernanceActionMethod is used in relation to a GovernanceWorkflow and can be activated when doing a transition (GovernanceTransition/GovernanceConditionalMessage) either before (pre) or after (post).

It can also be activated when an event happens (GovernanceEventMessage).

Short description: Here you give a short description of the GovernanceActionMethod. This should be able to give the user an overview of the feature.

Condition: Contains a GovernanceBoolList or GovernanceBoolMethod (the action will not run if it does not evaluate to true).

Verify: Verifies the Method. If the action is verified, today’s date, OK checkmark, and a “Method OK” will be filled out.

GovernanceActionMethod – Advanced

Is check method: Indicates if the action should check specified conditions on the object or if the action should be run on the object.

Method actual name: The name of the C# function to run. There is a set of predefined methods available.

• A list of check methods is available, see section 10.2.2
• A list of methods that are not check methods is available, see section 0

It is also possible to define a custom function.

You can click the icon to get some help to the selected Method.

 

Level: In case an error occurs during action execution, this is the error level to be used to inform the user.

• If level is set to Error, the action will stop executing and all following actions (see GovernanceActionList) will not run. An error message is displayed to the user.
  • Example: If the action is set to run as pre-action on a transition and the action fails, it will result in the transition not happening. The object will remain in the state it is already in.
• If level is set to Warning, the action will stop executing. Any following actions will still run. A warning message is displayed to the user.
  • Example: If the action is set to run as pre-action on a transition and the action fails, it will result in the following actions to be run. If these actions do not fail, the transition will be successful.

Parameter: Corresponding parameters – predefined for the current possible methods.

For most of the methods there are some parameters that can be set. Right click in the window and select: “Add Parameters…” to get the list of parameters.

The parameters are predefined for the GovernanceActionMethods in the standard GovernanceWorkFlow, but can be configured/customized.

For some methods Relations and Template filter and/or Attributes to be checked can be added as Parameters.

Predefined methods for when the action is not a check method

Each of the Predefined GovernanceCheckMethods – when the action is not a check method is explained in the following table. Where available the standard parameters are shown for each of the methods. Note that each of the Values needs to be specified, see below.

Method	Description
SetObjectAttributeList	Set one or more attributes on the object.
SetAttributeListByRelation	Set one or more attributes on objects related to the current object. E.g. content of a diagram.
Approve	This will approve the object. Parameters control if content of models should be approved along with the parent model. If content will be approved along with the parent, it is also possible to define if content controlled by GWE will follow the parent or follow its own GovernanceWorkFlow.
Promote	This will promote the object. Parameters control if content of models should be promoted along with the parent model. If content will be promoted along with the parent, it is also possible to define if content controlled by GWE will follow the parent or follow its own GovernanceWorkFlow.
CreateNewRevision	This will create a new revision of the object. Parameters control if object should be published.
FreezeObject	Freezes the object (it will be readonly). (No parameters to be set)
CreateAcknowledgeList	Creates an AcknowledgeList for the object. (No parameters to be set)
CreateLanguageVariants	Creates a LanguageVariant for the object. (No parameters to be set)
ApproveByRelation	Performs approve routine according to the relations
PromoteByRelation	Performs promote routine according to the relations
NewRevisionByRelation	Creates a new revision for all objects according to the relations
FreezeByRelation	Freeze all objects in accordance to the relations
AcknowledgeListByRelation	Create acknowledge list or all objects according to the relations
PublishContent	Publish current content.
PostByRelation	Post for all objects according to the relations.
EventActionByRelation	Send an Event Action for all objects following relation.
ResetCanApprove	Reset CanApprove for the current object. (No parameters to be set)
ResetCanApproveByRelation	Reset CanApprove for all objects following relation.
EmailAllParticipants	Send an email to all participants.
GlobalUpdateParticipantList	Update the participants list
GlobalAcknowledgeListChange	Execute a global acknowledge list change
GlobalCheckAcknowledgementSLA	Perform a SLA check on acknowledgement

Predefined methods for when the action is a check method

When the check box ‘Is check method’ is enabled the predefined methods for a check are shown. See in the image below.

Method	Description
CheckAttributeList	Performs a list of check in some attributes for the object.
CheckAttributeListByRelation	Performs a list of check in some attributes for all object following a relation for a specific template
CheckUnableToUpdateObject	Will give a message to the user, when the object cannot be updated (No parameters to be set)
CheckChangesOnAttrList	Returns error message if attribute is not changed with a change event.
CheckUnableToUpdateContent	Will give a message to the user, when some of the content on a diagram cannot be updated (No parameters to be set)
IsStateByRelation	Checks if object is in a target state and returns error if not. (TemplateFilter can be removed if not required.)
DoCompareDate	Returns an error message if the dates do not respect the condition.

Add attributes to be checked

Some of the Method have parameters that can be specified.

Right click in the window to “Add Parameters…”

Once a parameter is added, you can click on the three dots in the Value column to choose from the menu.

The value can be a custom input or one of the predefined. Generic Content gives the choice of checking if the attribute is empty or not empty. Object Attribute gives you a list of attributes on the chosen object. Governance Attributes are governance specific values. explained in the table below.

Note the list of available Governance Attributes depends on the method.

GovernanceAttribute	Description
GovernanceCurrentState	Check the current State-object that the object is in (returns the State object)
GovernanceStatus	Check the current status of the object (returns a string with the status)
GovernanceMessageComment	The message written when a user does the transition is returned
GovernanceNextApprover	Check the approver of the next governance state
GovernanceOnStatusSince	The date for when the object got into its current state (used for calculating how long it takes to changes states for analytics and governance history)
GovernanceDateLimitOnState	The limit on state is calculated from the set SLA and time limit set for each state
GovernanceCycleOwner	Checks the cycle owner of the object
GovernanceCycleCount	The cycle count of the governance flow
GovernanceRecyclingCount	The workflow can be setup to count the number of rewinds is being done (requires a configuration of the standard workflows)
GovernanceWarningDate	Checks the warning date
GovernanceLimitDate	Checks the limit date
GovernanceSLA	Checks the SLA value
GovernanceSignatureDone	Checks the number of signatures
GovernanceSignatureMissing	Checks the missing signatures
GovernanceSignal	Check the governance signal

The GovernanceActionList or a single GovernanceActionMethod is used in relation to a GovernanceWorkflow and can be activated when doing a transition (GovernanceTransition/GovernanceConditionalMessage) either before (pre) or after (post).

It can also be activated when an event happens (GovernanceEventMessage).

A GovernanceActionList can be composed of one or more GovernanceActionMethod(s) and NoticationTemplate(s).