springboard for k2 for k2 component and category structure is broken down into logical areas which...

32
BILL OF MATERIALS V3.0 Springboard for K2 SourceCode ANZ Bill of Materials – Springboard for K2 An outline of the components included with this version of Springboard for K2

Upload: nguyenquynh

Post on 22-Apr-2018

213 views

Category:

Documents


0 download

TRANSCRIPT

BILL OF MATERIALS V3.0

Springboard for K2

SourceCode ANZ

Bill of Materials – Springboard for K2

An outline of the components included with this version of Springboard for K2

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

1 | P a g e

CONTENTS

K2 blackpearl Version ..................................................................................................... 3

Introduction ................................................................................................................ 3

What has changed in this version? ...................................................................................... 3

Design Considerations .................................................................................................... 6

Design Goals ............................................................................................................. 6

Naming conventions .................................................................................................... 6

SmartObjects ......................................................................................................... 6

Views ................................................................................................................... 7

Forms .................................................................................................................. 7

Controls ................................................................................................................ 7

Parameters ............................................................................................................ 8

Identity Values .......................................................................................................... 9

Components ................................................................................................................ 9

Framework ............................................................................................................... 9

SmartObjects ......................................................................................................... 9

Views ................................................................................................................. 14

Forms ................................................................................................................ 16

K2 Object Explorer ................................................................................................... 17

SmartObjects ....................................................................................................... 17

Views ................................................................................................................. 17

Forms ................................................................................................................ 18

Management Worklist ................................................................................................ 19

SmartObjects ....................................................................................................... 19

Views ................................................................................................................. 19

Forms ................................................................................................................ 19

Templates .............................................................................................................. 20

Forms ................................................................................................................ 20

Views ................................................................................................................. 20

Show All Controls .................................................................................................. 20

Portal ................................................................................................................... 20

SmartObjects ....................................................................................................... 20

Views ................................................................................................................. 20

Forms ................................................................................................................ 21

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

2 | P a g e

Maintenance ........................................................................................................... 23

Views ................................................................................................................. 23

Forms ................................................................................................................ 25

Solution: Task Allocation ............................................................................................ 27

Process ............................................................................................................... 27

Views ................................................................................................................. 27

Forms ................................................................................................................ 27

Solution: Purchase Request ......................................................................................... 28

Process ............................................................................................................... 28

Roles ................................................................................................................. 28

SmartObjects ....................................................................................................... 29

Views ................................................................................................................. 29

Forms ................................................................................................................ 29

Sample Solution: Sample Customer (introduced in V1.1) ..................................................... 30

Views ................................................................................................................. 30

SmartObjects ....................................................................................................... 30

Process ............................................................................................................... 31

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

3 | P a g e

K2 BLACKPEARL VERSION

Springboard for K2 version 3.0 requires K2 blackpearl 4.6.11.

INTRODUCTION

Springboard for K2 provides a framework with building blocks to assist with the rapid creation of

applications using reusable components.

Springboard for K2 includes the following:

Dashboard and Process Tracking Interfaces

Workflow components and general reusable Views

Transactional and system SmartObjects

Task allocation and Purchase request processes

A Custom Management Worklist

K2 Object Explorer

The two working business processes offered with Springboard for K2 could be used “as-is”, or as a

base for more customized solutions.

Using the Task Allocation Process, you could validate the installation of a new K2 environment in a

matter of minutes. This process tests some of the key areas used within K2 – K2 SmartForms and

SmartObjects, workflow processes, email integration, the K2 worklist and K2 reporting capabilities.

Benefits of using Springboard for K2

• Immediate return on investment

• Instant capability to test a new K2 environment

• Provides customers with a unified and best practise approach for building K2 SmartForms and

workflow

• Rapid acceleration of K2 SmartForm development for all K2 projects

• Out of the box features, reporting and processes

WHAT HAS CHANGED IN THIS VERSION?

Version 3.0 of Springboard for K2 has some minor bug fixes. Included with this version:

Custom management worklist (includes a Custom SmartObject Broker);

The ability to grant access to specific actions

K2 Object Explorer

o This tool allows you to view details on Forms, Views, SmartObjects and Processes that

are deployed in the environment.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

4 | P a g e

o Forms Explorer allows you to see:

Display Name

System Name

Description

Category Path

Applied Theme

Version

Created by and Modified by Users and Dates

Checked out status

Application Type

Available Form States

Form Expressions

Form Parameter details

Details of Controls used on Form

Details of SmartObjects used on Form

Details of Views used on Form

Double clicking on any View will navigate to that object.

Sub Forms and Sub Views

Double clicking on any Sub Form or Sub View will navigate to that

object.

o Views Explorer allows you to see:

Display Name

System Name

Description

Category Path

View Type (Capture\Item View or List View)

Version

Created by and Modified by Users and Dates

Data Source

Checked out status

Application Type

View Expressions

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

5 | P a g e

View Parameter details

Details of Controls used on View

Details of SmartObjects used on View

o SmartObject Explorer allows you to see:

Display Name

System Name

Description

Category Path

View Type (Capture\Item View or List View)

Version

Created by User and Dates

Previous Versions

Includes the ability to compare different versions

SmartObject Method information

SmartObject Association Information

List all Dependencies (Views and Forms)

o K2 Process Explorer allows you to see:

Full Name

Name

Description

Environment Library used

Process ID and Process Set ID

Process Versions

Process Fields per Version

o Data Fields

o XML Data Fields

Process Activities Per Version

o Activity Details

o Data and XML Data Fields

o Events

Process Permissions

Process Instances

View Flow Report

View Type (Capture\Item View or List View)

o Process Permission Explorer

List permissions per user or per process.

o Checked Out Items Explorer

Details on all Forms and Views that are currently checked out

See below for the additional forms and views that are *NEW to this version.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

6 | P a g e

DESIGN CONSIDERATIONS

DESIGN GOALS

Springboard for K2 is designed to overcome the gap that exists between installing a new K2

environment and the “First Process Live”.

The developers of Springboard for K2 have been using the K2 product stack since the early days of

K2.net 2003 (and some even K2 2.4!). When deciding on naming conventions and components to use,

we relied on industry standards and also tried and proven K2 best practices.

Springboard for K2 component and category structure is broken down into logical areas which could

easily be differentiated and defined by simply relying on the name.

The reusable Views are designed in such a way that each acts as a “stand alone” entity with self-

contained rules which allows it to be used on its own, or with other Views on a K2 SmartForm.

We have opted to use a custom SQL database to serve as the data store for internal Springboard for K2

artefacts – this decision was made with future updates to Springboard for K2 in mind, and also to

isolate the data associated with Springboard for K2.

It is strongly recommended that users do not alter any of the components delivered with Springboard

for K2, as future updates will overwrite your changes, and it could also negatively affect other

components delivered with Springboard for K2.

NAMING CONVENTIONS

The naming convention guide made available by K2 (http://help.k2.com/k2ls-qrs023.aspx#) was used

as a starting point for the Springboard for K2 naming convention. We aimed to follow a naming

convention which makes it easy to understand what each component relates to and to align it with K2

and industry standards.

Each the Springboard for K2 artefacts is prefixed with K2ANZ to make it easy to identify items which

belong to the framework.

SMARTOBJECTS

Examples:

K2ANZ.Framework.Master.Application

Or

K2ANZ.Framework.Master.Application.Category

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

7 | P a g e

VIEWS

Examples:

K2ANZ.Framework.Workflow.Comments.List

Or

K2ANZ.Framework.Footer.Item

FORMS

Examples:

K2ANZ.Framework.Dashboard

Or

K2ANZ.Framework.Workflow.Status

CONTROLS

There are many schools of thought around the naming conventions of controls. Although you can

technically name a control nearly anything, at K2 we generally follow one of these three naming

conventions:

1) PascalCasing without a control identifier prefix

a. E.g. “FullName”, “UserGender”, “UserBirthday”

2) camelCasing with a control prefix

a. E.g. txtFullName, ddlUserGender, dteUserBirthday

3) Logical Name

a. E.g. “Name in full”, “Gender”, “Date of birth”

In Springboard for K2 we prescribe to number 3 as mentioned above. The reason for this is to allow

you to use the “pop-up” functionality when using the “when form passes validation” condition in the

rule.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

8 | P a g e

Here are two examples to what the validation message could look like using method 2 and 3

respectively:

PARAMETERS

Form and View Parameters can be any text sting that is allowed as part of a query string. For

Springboard for K2 we have opted for a natural parameter name that allows for spaces in the name.

E.g.:

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

9 | P a g e

IDENTITY VALUES

For Springboard for K2, we have opted to keep all Identity columns in the database as GUID. The

reason for this is to allow us to port data into the database, should this be required with future

upgrades of Springboard for K2.

COMPONENTS

FRAMEWORK

SMARTOBJECTS

K2ANZ.FRAMEWORK.MASTER.ADMINUSER

Determines if the provided user may act as an administrator

K2ANZ.FRAMEWORK.MASTER.APPLICATION

Applications are “systems” registered with Springboard for K2

K2ANZ.FRAMEWORK.MASTER.APPLICATION.ACTION

*NEW (V3.0)

Stores Actions which should match to Actions available in Workflow Processes. These actions will be

used by the Application Action Access section to grant access to actions to only specific users.

K2ANZ.FRAMEWORK.MASTER.APPLICATION.ACTION.USER

*NEW (V3.0)

Links Users to Actions which they can perform. If an action has no user associated with it, all users has

access to that action.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

10 | P a g e

K2ANZ.FRAMEWORK.MASTER.APPLICATION.ACTION.ACTIONGRANTED

*NEW (V3.0)

This is the SmartObject which links individual Actions to individual Users. It allows for a many-to-many

association between Actions and Users.

K2ANZ.FRAMEWORK.MASTER.APPLICATION.CATEGORY

Stores a category to categorize Applications in the K2ANZ.Framework.Master.Application.

K2ANZ.FRAMEWORK.MASTER.APPLICATIONACCESS

Determines if a user has access to the current application

K2ANZ.FRAMEWORK.MASTER.HELPTEXT

Stores Help Text Title and Value to be used as help text.

K2ANZ.FRAMEWORK.MASTER.HELPTEXT.REGISTER

It is possible to assign one or multiple register values (keys) to Help Text.

Use Case:

The same piece of help text is used on multiple forms – to automatically assign the help text to the

form, the form name is sent to system, and based on this value, the help text is loaded.

In this use case, you will add multiple register values (each being the form name that should load the

particular piece of help text) all referencing the same record in Help Text.

K2ANZ.FRAMEWORK.MASTER.KEYVALUESETTING

A generic key-value table to be used to store values based on a category.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

11 | P a g e

K2ANZ.FRAMEWORK.MASTER.KEYVALUESETTING.CATEGORY

Stores a category to categorize key-value pairs in the K2ANZ.Framework.Master.KeyValueSetting.

K2ANZ.FRAMEWORK.MASTER.PROFILE

SmartObject to store and manage Security Profiles

K2ANZ.FRAMEWORK.MASTER.PROFILE.APPLICATION

Links Applications to Profiles

K2ANZ.FRAMEWORK.MASTER.PROFILE.USER

Manages the links between users and profiles

K2ANZ.FRAMEWORK.MASTER.STATUS

Stores possible statuses that could be re-used. By default, Springboard for K2 is shipped with the

following:

Closed

Active

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

12 | P a g e

K2ANZ.FRAMEWORK.TRANSACTION.ACTIVITYLOG

This SmartObject allows you to log any activity that takes place on a form or in a workflow process.

K2ANZ.FRAMEWORK.TRANSACTION.APPLICATION.INSTANCE

This SmartObject is critical to architecture of interacting with K2 workflow processes. It stores a link to

the application registered with Springboard for K2 along with a reference to the custom user defined

business object and the K2 Process Instance ID.

K2ANZ.FRAMEWORK.TRANSACTION.BUSINESSAUDIT

Similar to the Activity Log, the Business Audit is designed to store specific business related auditing

information.

K2ANZ.FRAMEWORK.TRANSACTION.EXCEPTIONLOG

The exception log is designed to store any error that occurs on the form, and could also be used to

store system exceptions which aren’t necessarily an error, but rather unexpected behavior. E.g. logging

failed login attempts to a system.

K2ANZ.FRAMEWORK.USER

This SmartObject is built on the URM Service Broker and exposes all methods and properties of the User

Service Object based on the URM Service Instance.

K2ANZ.FRAMEWORK.WORKFLOW.ATTACHMENT

This SmartObject is built on the Workflow Service Broker.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

13 | P a g e

NOTE: In order to use this functionality, the user executing this SmartObject must have VIEW rights on

the K2 process.

K2ANZ.FRAMEWORK.WORKFLOW.COMMENT

This SmartObject is built on the Workflow Service Broker.

NOTE: In order to use this functionality, the user executing this SmartObject must have VIEW rights on

the K2 process.

K2ANZ.FRAMEWORK.WORKFLOW.ACTIVITYINSTANCEDESTINATION

This SmartObject is based on the out of the box K2 reporting SmartObject and is used to provide

Activity Destination Instance information to reporting.

K2ANZ.FRAMEWORK.EXCELFILE

*NEW (V3.0)

Springboard\Framework\Building Blocks\SmartObjects\ExcelSmartObjects

K2ANZ.FRAMEWORK.URM.LABEL

*NEW (V3.0)

Springboard\Framework\Building Blocks\SmartObjects\User Role ManagerViews

K2ANZ.FRAMEWORK.URM.LABEL

*NEW (V3.0)

Springboard\Framework\Building Blocks\SmartObjects\User Role Manager

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

14 | P a g e

VIEWS

K2ANZ.FRAMEWORK.ACTIVITYINSTANCE.ITEM

This view displays information based on the K2ANZ.Framework.Transaction.Application.Instance

SmartObject, and is placed on a form used for a K2 Workflow Process Client Event to display

information based on the Activity and Activity Instance.

K2ANZ.FRAMEWORK.APPLICATION.ACCESS

This view is responsible for checking the logged on user's access to the current application.

K2ANZ.FRAMEWORK.FOOTER.ITEM

A generic footer View that displays the version of Springboard for K2.

K2ANZ.FRAMEWORK.HEADER.ITEM

A generic header View that displays information pertaining to

a) The Application (based on the K2ANZ.Framework.Master.Application SmartObject) OR

b) Parameter values set on the View

K2ANZ.FRAMEWORK.HELPTEXT.ITEM

Displays HelpText information based on a parameter value. It will either display data based on

a) The HelpText item ID

b) The HelpText Register value

K2ANZ.FRAMEWORK.LOADBUTTONS.ITEM

A view with three unbound tool bar buttons:

Load Draft

Delete Draft

Cancel

The visibility of these buttons is driven by parameter values on the View. Setting the parameter values

during run-time will also influence the buttons’ visibility.

K2ANZ.FRAMEWORK.SUBMITBUTTONS.ITEM

A view with three unbound buttons:

Save as Draft

Submit

Cancel

The visibility of these buttons is driven by parameter values on the View. Setting the parameter values

during run-time will also influence the buttons’ visibility.

K2ANZ.FRAMEWORK.WORKFLOW.ACTIVITYINSTANCEDESTINATION.LIST

This view is used for Reporting Purposes to show Activity Destination Instance information.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

15 | P a g e

K2ANZ.FRAMEWORK.WORKFLOW.APPLICATIONINSTANCEREPORT.TYPESELECT.ITEM

This view is used on the K2ANZ.Framework.Workflow.Status form to determine if the user wants to see

all Application Processes they have started, or the ones to which they have access.

K2ANZ.FRAMEWORK.WORKFLOW.ATTACHMENT.ITEM

This view loads an attachment file into an Attachment control based on parameter value assigned to

the View.

K2ANZ.FRAMEWORK.WORKFLOW.ATTACHMENTS.LIST

Lists all attachments linked to a process ID.

NOTE: The user must have VIEW rights on the process, or must have participated in the process and

have VIEW PARTICIPATE rights on the process to use this View.

K2ANZ.FRAMEWORK.WORKFLOW.COMMENTS.LIST

Lists all comments linked to a process ID.

NOTE: The user must have VIEW rights on the process, or must have participated in the process and

have VIEW PARTICIPATE rights on the process to use this View.

K2ANZ.FRAMEWORK.WORKFLOW.REPORT.ACTIVITYGRAPH.ITEM

This is the main new reporting view which is included with version 1.2. This contains graphical reports

and allows the user to change settings.

Note that the User Performance section is disabled and hidden. In this version it appears that there is

an issue transferring the correct data from one report to the next. As such, we have opted to exclude

this from version 1.2.

K2ANZ.FRAMEWORK.WORKFLOW.REPORT.PROCESSGRAPH.ITEM

Displays the out of the box Process Graph Report SmartForm Control

K2ANZ.FRAMEWORK.WORKFLOW.REPORT.PROCESSINSTANCEDETAILS.ITEM

Displays the out of the box Process Activities Report SmartForm Control

K2ANZ.FRAMEWORK.WORKFLOW.REPORT.PROCESSINSTANCES.ITEM

Displays the out of the box Process Instance Report SmartForm Control

K2ANZ.FRAMEWORK.WORKFLOW.TASKACTION.ITEM

This View uses the K2 Workflow Process Instance’s Serial Number to load the Worklist Item, and has a

drop down list that will contain all possible Actions linked to the Worklist Item.

It will load the K2 Process ID (to be used with Comments and Attachments), Application Instance ID as

well as the Business Object ID.

It has functionality built in to action the worklist item based on the action selected from the drop down

list and the Serial Number provided in the View parameter.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

16 | P a g e

K2ANZ.FRAMEWORK.WORKFLOW.WORKLIST.ITEM

Displays the out of the box K2 Worklist SmartForm Control

FORMS

K2ANZ.FRAMEWORK.WORKFLOW.MYPROCESSINSTANCES

Displays a list of K2 Process Instances using the out of the box Process Instance Report.

K2ANZ.FRAMEWORK.WORKFLOW.PROCESSINSTANCE

Displays detail of a K2 Process Instance using the out of the box Process Activity Report.

K2ANZ.FRAMEWORK.WORKFLOW.STATUS

Displays detail of a K2 Process Activity Instance using the out of the box Process Activity Instance

Report.

K2ANZ.FRAMEWORK.WORKLIST

A form that simply displays the K2 Work List based on the out of the box K2 Work List

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

17 | P a g e

K2 OBJECT EXPLORER

*This is a new category for Version 3.0

SMARTOBJECTS

The SmartObjects are not described in detail, but simply listed. Each object’s name indicates its

purpose for the K2 Object Explorer.

VIEWS

The Views are not described in detail, but simply listed. Each view’s name indicates its purpose for the

K2 Object Explorer.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

18 | P a g e

FORMS

The Forms are not described in detail, but simply listed. Each form’s name indicates its purpose for the

K2 Object Explorer.

Note that the K2ObjectExplorer.Dashboard form is the parent form for the Object Explorer – this can

be run as a Stand Alone application without the need for the Springboard for K2 Portal.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

19 | P a g e

MANAGEMENT WORKLIST

All items in this section are NEW to version 3 of Springboard for K2.

SMARTOBJECTS

K2ANZ.FRAMEWORK.MANAGEMENT.WORKLIST

SmartObject that exposes all management worklist functionality based on the user which executes the

SmartObject

VIEWS

K2ANZ.FRAMEWORK.MANAGEMENT.WORKLIST.FILTER.ITEM

View used to apply a filter to the management worklist

K2ANZ.FRAMEWORK.MANAGEMENT.WORKLIST.LIST

The Management Worklist List. Users will see all worklist items to which they have management

permissions to in this list.

K2ANZ.FRAMEWORK.MANAGEMENT.WORKLIST.SELECTUSER.ITEM

This View is used to view details of a work list item, along with the ability to redirect or delegate the

work item.

FORMS

K2ANZ.FRAMEWORK.MANAGEMENTWORKLIST

The Management Worklist. Users will see work list items which they have management permissions to.

This form will also allow the user to perform management tasks on these items.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

20 | P a g e

TEMPLATES

FORMS

K2ANZ.FRAMEWORK.TEMPLATE

A Template to assist in the creation of a simple form where no workflow is required.

K2ANZ.FRAMEWORK.TEMPLATE.STARTPROCESSPAGE

A Template to assist in the creation of a form that starts a K2 workflow process. All rules to start the

process have been created and require minor configuration changes.

K2ANZ.FRAMEWORK.TEMPLATE.ACTIONWORKITEMPAGE

A Template to assist in the creation of a form that acts as a Client Event on a K2 workflow process. All

rules to open the Worklist Item and to Action the process have been created and requires minor

configuration changes.

VIEWS

K2ANZ.FRAMEWORK.PLACEHOLDER.ITEM AND K2ANZ.FRAMEWORK.PLACEHOLDER.LIST

These are empty views used on the Template forms as a place holder for custom Views.

SHOW ALL CONTROLS

This section introduced in version 1.1. The forms and views contained under this section can be used to

review any applied styles to the forms. The forms contain most controls, messages and subviews and

forms that could be affected by applying a different stylesheet.

PORTAL

SMARTOBJECTS

K2ANZ.FRAMEWORK.PORTAL.SETTINGS

The Settings SmartObject stores specific internal Springboard for K2 values, such as the version and

distribution date.

VIEWS

K2ANZ.FRAMEWORK.ACTIVITYINSTANCE.LIST

A view that lists all Application Instances based on the Application Instance data stored in the

Springboard for K2 database and the K2 workflow Process Instance.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

21 | P a g e

K2ANZ.FRAMEWORK.ACTIVITYLOG.LIST

A view to display the activity log linked to an Application Instance

K2ANZ.FRAMEWORK.BUSINESSAUDIT.ITEM

A view to display business audit detail

K2ANZ.FRAMEWORK.BUSINESSAUDIT.LIST

A view to display a list of business audit items linked to an Application Instance

K2ANZ.FRAMEWORK.EXCEPTIONLOG.ACKNOWLEDGED.LIST

Displays a list of all acknowledged exception log items

K2ANZ.FRAMEWORK.EXCEPTIONLOG.DETAILS.ITEM

Display Exception Log Details of a specified exception item

K2ANZ.FRAMEWORK.EXCEPTIONLOG.NEWITEMS.LIST

Displays a list of all new exception log items

K2ANZ.FRAMEWORK.EXCEPTIONLOG.SELECTLIST.ITEM

A simple View used for aesthetic purposes

K2ANZ.FRAMEWORK.PORTAL.APPLICATON.LIST

This list view displays the list of all Applications registered with Springboard for K2.

K2ANZ.FRAMEWORK.PORTAL.FORMLINKS.ITEM

A list of available actions (such as Administration, Reporting etc.) that’s displayed on the Portal Home

Page.

Currently there is no security model set up against these buttons, and all users are able to access the

administration or background selection screens.

FORMS

K2ANZ.FRAMEWORK.DASHBOARD

This is the main Springboard for K2 dashboard which allows you to:

a) Access your K2 Worklist

b) Open registered Applications

c) View Reporting

d) Perform Administration tasks

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

22 | P a g e

K2ANZ.FRAMEWORK.BUSINESSAUDIT

This is a reporting form that allows you to access business audit information

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

23 | P a g e

K2ANZ.FRAMEWORK.EXCEPTIONLOG

This form allows you to see new and existing exceptions logged with Springboard for K2.

K2ANZ.FRAMEWORK.PORTAL.PROCESS.INSTANCE.REPORTING

This new Reporting form is meant to be used as a modal dialog window. It contains multiple tabs and

displays a variety of information pertaining to an Application Instance. Detail includes:

Process Summary

Comments

Attachments

The current Application Process graphs

All Application Process graphs for this type of application.

MAINTENANCE

VIEWS

K2ANZ.FRAMEWORK.BACKGROUNDIMAGE.SET.ITEM

View to change the selected background image

K2ANZ.FRAMEWORK.MAINTENANCE.PROFILE.APPLICATION.ADD.ITEM

A view which lists all applications that’s not yet linked to the given profile

K2ANZ.FRAMEWORK.MAINTENANCE.PROFILE.USER.ADD.ITEM

A view to add users to a profile

K2ANZ.FRAMEWORK.MAINTENANCE.PROFILE.USERS.LIST

Lists all users already associated with the given profile

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

24 | P a g e

K2ANZ.FRAMEWORK.BACKGROUNDIMAGE.LOAD.ITEM

A view which is placed on all forms to load the correct background image

K2ANZ.FRAMEWORK.MAINTENANCE.APPLICATION.ACTION.LIST

*NEW (V3.0)

List of all available actions to which an administrator might set up permissions for.

K2ANZ.FRAMEWORK.MAINTENANCE.APPLICATION.ACTION.USER.LIST

*NEW (V3.0)

List of Users that could be linked to Application Actions.

K2ANZ.FRAMEWORK.MAINTENANCE.APPLICATION.CATEGORY.ITEM

Maintenance view for an Application Category Item

K2ANZ.FRAMEWORK.MAINTENANCE.APPLICATION.CATEGORY.LIST

Maintenance view to list all Application Category Items

K2ANZ.FRAMEWORK.MAINTENANCE.APPLICATON.ITEM

Maintenance view for an Application Item

K2ANZ.FRAMEWORK.MAINTENANCE.APPLICATON.LIST

Maintenance view to list all Application Items

K2ANZ.FRAMEWORK.MAINTENANCE.AREASELECT.ITEM

A simple View used for aesthetic purposes to allow the user to select which maintenance task to

perform.

K2ANZ.FRAMEWORK.MAINTENANCE.HELPTEXT.ITEM

Maintenance view for a Help Text Item

K2ANZ.FRAMEWORK.MAINTENANCE.HELPTEXT.LIST

Maintenance view to list all Help Text Items

K2ANZ.FRAMEWORK.MAINTENANCE.HELPTEXT.REGISTER.LIST

Maintenance view to list and maintain all Help Text Register Items

K2ANZ.FRAMEWORK.MAINTENANCE.KEYVALUESETTING.CATEGORY.ITEM

Maintenance view for a Key Value Category Item

K2ANZ.FRAMEWORK.MAINTENANCE.KEYVALUESETTING.CATEGORY.LIST

Maintenance view to list all Key Value Category Items

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

25 | P a g e

K2ANZ.FRAMEWORK.MAINTENANCE.KEYVALUESETTING.ITEM

Maintenance view for a Key Value Setting Item

K2ANZ.FRAMEWORK.MAINTENANCE.KEYVALUESETTING.LIST

Maintenance view to list all Key Value Setting Items

K2ANZ.FRAMEWORK.MAINTENANCE.PROFILE.APPLICATIONS.LIST

Lists all applications linked to a given profile

K2ANZ.FRAMEWORK.MAINTENANCE.PROFILES.LIST

Lists all available profiles

K2ANZ.FRAMEWORK.MAINTENANCE.STATUS.ITEM

Maintenance view for a Status Item

K2ANZ.FRAMEWORK.MAINTENANCE.STATUS.LIST

Maintenance view to list all Status Items

FORMS

K2ANZ.FRAMEWORK.MAINTENANCE.PROFILES

This form is used for Profile Administration. It allows the user to create and manage profiles, along

with assigning different users to the profiles.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

26 | P a g e

K2ANZ.FRAMEWORK.MAINTENANCE.APPLICATION

This form is used for all general maintenance functions. The user will pick the applicable maintenance

area, and as such the correct views will be displayed on screen.

K2ANZ.FRAMEWORK.MAINTENANCE.BACKGROUND

This form is used to preview and select the system background that will be seen by all users of

Springboard for K2 on this environment.

K2ANZ.FRAMEWORK.MAINTENANCE.LINKAPPLICATIONTOPROFILE

This Subform is used for linking applications to profiles.

K2ANZ.FRAMEWORK.MAINTENANCE.LINKUSERTOPROFILE

This Subform is used for linking users to a security profile.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

27 | P a g e

SOLUTION: TASK ALLOCATION

PROCESS

TASKALLOCATION

This process assigns work to a specified user (as specified by user starting the Task Allocation Process.

There is no custom business object associated with this workflow process, and all data is stored within

the process itself.

VIEWS

K2ANZ.SOLUTIONS.TASKITEM.ITEM

This is a custom view specifically for the task allocation process. It is used on both the form responsible

to start the process and the form used by the Process Client Events.

FORMS

K2ANZ.SOLUTIONS.TASKITEM.START

This form is used to start a new Task Allocation Process.

K2ANZ.SOLUTIONS.TASKITEM

This form is used as by all Client Events in the Task Allocation Process.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

28 | P a g e

SOLUTION: PURCHASE REQUEST

PROCESS

PURCHASEREQUEST

This Purchase Request Process demonstrates a two tier approval system. The destination rule of each

level of approval is set to use a Role as the destination user\group.

Placeholder Events have been added and should be replaced by relevant events that are applicable to

the end user’s environment.

Should the user require any changes made to the K2 Workflow Processes, these are to be downloaded

using the K2 Process Version section of the Management Console on the K2 Workspace.

ROLES

PURCHASE REQUEST APPROVERS

This is the first level of approval.

NOTE: When installing Springboard for K2, it is important that at least one user must be assigned to this

role.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

29 | P a g e

PURCHASE REQUEST ADDITIONAL APPROVER

This is the second level of approval.

NOTE: When installing Springboard for K2, it is important that at least one user must be assigned to this

role.

SMARTOBJECTS

K2ANZ.FRAMEWORK.PURCHASEREQUEST

This is the business object that acts as the main Purchase Request

K2ANZ.FRAMEWORK.PURCHASEREQUEST.LINEITEM

This is the business object that acts as the Line Item for each item associated with the Purchase

Request.

VIEWS

K2ANZ.SOLUTIONS.PURCHASEREQUEST.ITEM

This view is responsible for capturing and displaying the main Purchase Request information.

K2ANZ.SOLUTIONS.PURCHASEREQUEST.LINEITEM.LIST

This editable list view is responsible for capturing and displaying Line Items associated with the

Purchase Request.

FORMS

K2ANZ.SOLUTIONS.PURCHASEREQUEST.CAPTURE

This form is used to capture a new Purchase Request and submit this for Approval.

K2ANZ.SOLUTIONS.PURCHASEREQUEST.ACTION

This form is used as the K2 Process Client Event and displays information of the Purchase Request along

with the available actions that the user can perform. Based on the Process Activity, this information is

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

30 | P a g e

either read-only or can be changed by the end user (when the Purchase Request is declined and the

originator user has the option to make changes to the Purchase Request).

SAMPLE SOLUTION: SAMPLE CUSTOMER (INTRODUCED IN V1.1)

VIEWS

K2ANZ.SAMPLE.CUSTOMER.ITEM

A simple item view with load, create and save methods defined on the view. This view can be used to

quickly explain (in conjunction with the Template Views) on creating a new form.

K2ANZ.SAMPLE.CUSTOMER.LIST

A simple list view with load method defined on the view. This view can be used to quickly explain (in

conjunction with the Template Views) on creating a new form.

SMARTOBJECTS

K2ANZ.SAMPLE.CUSTOMER.ITEM

A SmartObject used to supply data to the Sample Solution Views.

BILL OF MATERIALS V3.0 – SPRINGBOARD FOR K2

31 | P a g e

PROCESS

K2ANZSAMPL\NEWCUSTOMER

This process is used to demonstrate the integration of a process using the Template Forms.