Start

OpenSpan Core Training

Introduction
version 7.0
01 March 2015
This book serves as in introduction to the OpenSpan Core Training class. It provides information on what is
required to take the class, conventions used in the training manuals, and an overview of the class and
OpenSpan Automation software.
This OpenSpan Core Training class includes these modules:
Windows Integration
Interaction Framework
Web Integration
Project Deployment
Diagnostics and Debugging
Notice

Copyright 2012 - 2015 OpenSpan, Inc. All Rights Reserved.

No part of this publication may be reproduced or distributed in any form or by

any means, electronic or otherwise, now known or hereafter developed,
including, but not limited to, the Internet, without explicit prior written consent
from OpenSpan, Inc. Requests for permission to reproduce or distribute to
individuals not employed by OpenSpan any part of, or all of, this publication
should be mailed to:

OpenSpan, Inc.
Suite 200
11175 Cicero Drive
Alpharetta, Georgia 30022

Phone (International) +1 (678) 527-5400

Phone (US and Canada) (877) 733-1136
Email: sales@openspan.com

OpenSpan and Surface Integration are registered trademarks of OpenSpan

Inc., a Delaware Corporation.

Microsoft, Visual Studio, MSDN, and Windows are either registered

trademarks or trademarks of Microsoft Corporation in the United States and/or
other countries.

TIBCO Spotfire is a registered trademark of TIBCO Software Inc. in the United

States and/or other countries.
Contents

v Conventions
vi Feedback

1 Introduction
2 OpenSpan Project Certification Outline
2 OpenSpan Developer Certification Exams
2 OpenSpan Training Survey

3 Overview

5 OpenSpan Studio

7 OpenSpan Interaction Framework

7 Terminology

9 OpenSpan Agile Desktop Framework

11 OpenSpan Management Console

iii
iv
Preface
This training module provides a foundation in how to build solutions using OpenSpan Studio. Additional
Core training modules explore more advanced concepts and features.
The modules in the Core training series require the following:
OpenSpan Studio version 7.0
OpenSpan Runtime version 7.0, installed as part of OpenSpan Studio

For Studio OpenSpan.Runtime.exe is in this folder by default:

Standalone C:\Program Files\OpenSpan\OpenSpan Studio for Visual Studio 2010\Application
Plug-in C:\Program Files\OpenSpan\OpenSpan Plug-in for Microsoft Visual Studio 2010

Note If you are using the OpenSpan Studio plug-in, change the extensions of the sample solution files from .ossln
to .sln.

Sample CRM application. You can find the installation file in the OpenSpan Studio installation Extras
folder.
Microsoft Internet Explorer. For more information on OpenSpan Studio system requirements,
download this manual:
Downloading and Installing OpenSpan Studio
Access to the OpenSpan training web site:
http://training.openspan.com

Conventions
This document uses these typographical conventions:

Convention Description
Bold Font Names of program elements that require emphasis appear in bold, such as command
buttons, menus, and dialogs.
Blue, Bold Font Text that you are supposed to type is in a bold blue font, such as text in a text box or field.
Next to this icon, you can find best practices and shortcuts to use OpenSpan Studio more
effectively.

The Group Discussion icon highlights information you will discuss in class with your
instructor.

The Group Activity icon introduces exercises you will perform with the instructor and the rest
of the class.

The Self-Paced Exercise icon introduces steps you will perform on your own, leveraging what
you have learned in class.

Next to the Building Blocks icon, you will find information about what you will learn as you
build on the previous exercises.

OpenSpan Core Training Revised: 31 March 2015

Basics version 7.0 v
 |

Convention Description
At the end of each chapter, next to the Knowledge Check icon, you will find questions that
test your knowledge of what you learned in the chapter.

Next to the Test icon, you will find steps that let you test the solutions you have built.

Feedback
Our goal is to provide you with the documentation you need to get the most out of your OpenSpan
software. We encourage you to provide feedback on your experience with the various manuals, Help
systems, and training guides. Send your comments to this email address:
training@openspan.com

Revised: 31 March 2015 OpenSpan Core Training

vi Basics version 7.0
INTRODUCTION
OpenSpan training is designed for new OpenSpan users as an instructor led training to introduce the basic
functionality, terminology, recommended practices and core building blocks of OpenSpan Studio. Through
a series of instructor-led, group, and self-paced exercises, you will learn how to use the OpenSpan Studio
software and features.

During this course, you will learn how to:

Navigate the OpenSpan Studio Integrated Development Environment (IDE)
Interrogate Windows and web applications
Build and develop OpenSpan solutions and projects from design and data flow to setup and day-to-
day operations
Work with OpenSpan adapters and automations tools to improve manual processes
Simplify development, improve reusability and take full advantage of new features without re-coding
Easily create, manage and deploy OpenSpan packages to runtime users without on premise
infrastructure
Deliver a modern, out of the box brandable interface using HTML plug-ins providing a customer 360
view and functionality
Diagnose and Debug solutions and projects
OpenSpan Training consists of the following projects during your training week.

OpenSpan Core Training Revised: 31 March 2015

Basics version 7.0 1-1
: Introduction | OpenSpan Project Certification Outline

OpenSpan Project Certification Outline

OpenSpan training is designed for new OpenSpan users as an instructor led training to introduce the basic
functionality, process flow, terminology, and core building blocks of OpenSpan Studio. Through a series of
instructor-led, group, and self-paced activities, you will learn how to use the OpenSpan Studio software.
OpenSpan Training is divided into six Project Certification exercises:
Project Certification 1: OpenSpan Windows Interrogation
Project Certification 2: OpenSpan Interaction Manager
Project Certification 3: OpenSpan Web Interrogation
Project Certification 4: OpenSpan Agile Desktop and OpenSpan Management Console
Project Certification 5: OpenSpan Diagnostics and Debugging

OpenSpan Developer Certification Exams

After each module you will take an on-line developer certification exam to test your knowledge of your
training experience.

Once you have passed each of the six exams you will receive your OpenSpan Certificate of Excellent. This
certificate distinguishes you as an OpenSpan Certified Developer.

OpenSpan Training Survey

On the final day of training, wed like to hear your impression on the various aspects of the training, so
that we can continually improve the experience for all attendees.
A short 5-minute survey will be available on the last day of training to share your training experience and
opinions.

Revised: 31 March 2015 OpenSpan Core Training

1-2 Basics version 7.0
 : Introduction | Overview

Overview
This course is intended for new OpenSpan Studio users. It provides instruction on using OpenSpan
Automations, Interaction Framework, OpenSpan Management Console and Agile Desktop Framework to
create application integration and automation projects. With OpenSpan Studio users will:

OpenSpan Studio Build with OpenSpan Studio to automate manual processes, modify
user interfaces and add procedural | process guidance to workflows.

Interaction Framework Build with Interaction Framework to simply development, improve

reusability and take advantage of new features without re-coding

Agile Desktop Framework Engage with Agile Desktop Framework deliver a modern, out of
the box, brandable, intuitive HTML user experience. Configurable customer 360 view with
shortcuts for quick access to functionality.
OpenSpan Management Console Manage with Management Console to easily deploy
packages, configure settings and update runtimes without on premise.

OpenSpan Core Training Revised: 31 March 2015

Basics version 7.0 1-3
: Introduction | Overview

OpenSpan Studio runs within the Microsoft Visual Studio Isolated Shell design environment or as a plug-in
to the Visual Studio application. For information on the Visual Studio framework, see the Microsoft MSDN
web site.
This chapter contains these building block topics.

Revised: 31 March 2015 OpenSpan Core Training

1-4 Basics version 7.0
 : Introduction | OpenSpan Studio

OpenSpan Studio

OpenSpan Studio provides a unique, intuitive, rapid visual development environment that lets you create
runtime solutions which enable end users to complete tasks more efficiently. For example, using
OpenSpan Studio you can create solutions which:
Automate manual processes such as copying and pasting between applications
Provide a single user interface for interaction with multiple applications
Display process guidance tips to assist users in completion of workflow tasks
Invoke a web service
The OpenSpan Studio application provides base adapters for integrating desktop applications without
modifying the underlying software. Using the OpenSpan application adapters, you can select specific
application targets (such as text-entry controls and web links) and then use the properties, methods, and
events of the controls to design application automation and event monitoring solutions.

OpenSpan Core Training Revised: 31 March 2015

Basics version 7.0 1-5
: Introduction | OpenSpan Studio

When you finish OpenSpan Studio training, you will be able to:
Describe the main terminology of OpenSpan Studio
Arrange tool windows in OpenSpan Studio
Locate the main functional areas of OpenSpan Studio
Work with OpenSpan Studio Recommended Practices
Develop OpenSpan solutions and projects
Define Window and web adapters

Revised: 31 March 2015 OpenSpan Core Training

1-6 Basics version 7.0
 : Introduction | OpenSpan Interaction Framework

OpenSpan Interaction Framework

Interaction Framework is a systematic approach providing OpenSpan developers with a collection of tools
that can be incorporated into the development of projects and solutions. Organizations will have the
ability to launch concurrent customer interactions (or sessions) when implementing the framework to
simplify development, improve reusability and streamline solutions for implementing new developer
features.
The framework further provides developers with increased visibility to reference a broad spectrum of
customer information across multiple applications while performing unique activities and tasks across
deployed OpenSpan packages. When a user loads one or more deployed packages, the framework allows
for communicating information and events across the Runtime environment.

Terminology
Often with a new approach, the first thing to understand is its purpose and use. To start, lets define the
key building blocks used within the Interaction Framework. These include:

Term Definition
Interaction This file defines the contexts, activities, and plug-ins that comprise the Agile Desktop
Configuration implementation you are designing. This file serves as a binding contract that allows for
File communicating information and events across independently running deployed packages.
Typically, there will only be one, but you can define multiple interaction XML definition files.
Interaction This component connects all customer interactions through the configuration of its
Manager properties, events and methods. The Interaction Manager maintains a direct link to the
Component contents of the Interaction.xml configuration file and stores the context values defined for
each interaction.
These context values appear as component properties. Only one Interaction Manager
component can be referenced per project in a deployment package, and it enables the
connectivity of the frameworks activities and tasks.
Interaction Host The Interaction Host is the software component/service that handles the interaction between
Agile Desktop, Interaction Manager, and other OpenSpan components.
The interaction host also queues activities for you to simplify threading and state
management during automations. These tasks are performed automatically and require no
end user or solution developer interaction.

OpenSpan Core Training Revised: 31 March 2015

Basics version 7.0 1-7
: Introduction | OpenSpan Interaction Framework

Term Definition
Activity The various work items that constitute the interaction are called activities. Changing an
Component address is an example of an activity. Activities are queued and only one activity can run at a
time. Because only one activity happens at a time, you do not have to worry about the
processing of one activity affecting another activity by changing the state of an application.
Activities are defined in the Activities section of the Interaction.xml configuration file. You can
define as many activities as you need in this section and every defined activity is represented
by its own Activity component.
When a method starts an activity in one deployed package, it can fire an event within the
same deployed package or in a different deployed package. Activities are queued and run in
sequence within the Interaction Framework.

When you finish Interaction Framework training, you will be able to:
Locate the Interaction-Call.xml File
Review the InteractionManager component
Review Activities
Add the InteractionManager component to a project
Review event links and properties
Create a new automation: CRM_E_CRMChild_Created.os automation
Create a new folder and set the StartActivityForKey property

Revised: 31 March 2015 OpenSpan Core Training

1-8 Basics version 7.0
 : Introduction | OpenSpan Agile Desktop Framework

OpenSpan Agile Desktop Framework

Agile Desktop provides a framework for integrating, managing, and presenting the OpenSpan solutions
you create. Agile Desktop includes several predefined solutions that let you track notes, present
shortcuts, and provide a panoramic view of the current customer. Agile Desktop provides a set of user
interface elements so you can design an easy-to-use, standardized, and configurable end user experience
for those using OpenSpan projects.
Agile Desktop hosts and runs OpenSpan projects retrieved from the configuration service. It can host and
run multiple projects simultaneously. Agile Desktop shares data and orchestrates actions across projects
without introducing direct project dependencies.
In addition to simplifying the development of new features by building configuration, analytics, and other
capabilities into a standard framework, Agile Desktop provides a...
Modern, easy-to-use look and feel.
Recognizable, standardized OpenSpan identity on the desktop.
Set of re-parenting components to host applications and organize the agent desktop.
Way to coordinate projects without creating direct dependencies.
Framework that encourages project standardization in Services.
Way to componentize product features so individual features can be licensed and delivered
independently.

OpenSpan Core Training Revised: 31 March 2015

Basics version 7.0 1-9
: Introduction | OpenSpan Agile Desktop Framework

When you finish Agile Desktop Framework training, you will be able to:
Identify the context values of the Interaction.xml file
Set StartUp Application
Set the Interaction-Call.xml file path
Modify Agile Desktop display:
Branding URL Logo
Branding Accent color
360 App Bar Primary View
360 App Bar Extended View
Shortcuts

Revised: 31 March 2015 OpenSpan Core Training

1-10 Basics version 7.0
 : Introduction | OpenSpan Management Console

OpenSpan Management Console

OpenSpan Management Console enables administrators to configure, manage, and deploy OpenSpan
projects from a centralized portal. Used with OpenSpan Updater, the OpenSpan Management Console lets
you manage and test the implementation of the solutions you create with OpenSpan Studio and updates
OpenSpan periodically distributes.
Organizations using OpenSpan large and small, across every industry, rely on OpenSpan Desktop
Automation to transform and accelerate critical operational processes to achieve significant efficiency
gains. OpenSpan Management Console extends these efficiencies by enabling administrators to
configure, manage and deploy OpenSpan projects from a centralized portal. With OpenSpan
Management Console, deploying projects is fast, flexible and secure and without costly infrastructure.
Designed for IT administrators who need to reduce complexity and increase productivity, OpenSpan
Management Consoles web-based portal gives administrators a new level of functionality to distribute,
manage and deploy projects across all business units within a few clicks. Using OpenSpan Management
Console, users have instant access to all Runtimes including the ability to push updates to OpenSpan
Runtime users. Combined with collection of Runtime management reports, administrators now have the
comprehensive operational insight to make updates more quickly and in a manner that is less disruptive
to end users.

Using OpenSpan Management Console, you will have:

Deep manageability and governance
Easy package management

OpenSpan Core Training Revised: 31 March 2015

Basics version 7.0 1-11
: Introduction | OpenSpan Management Console

Restore and recover

Navigator
When you finish OpenSpan Management Console training, you will be able to:
Manage tenants and departments
Import and manage users
Manage packages
Customize the RuntimeConfig.xml file

Revised: 31 March 2015 OpenSpan Core Training

1-12 Basics version 7.0