Using UX Components with ADEP Process Management

© 2011 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.

Using UX Components with ADEP Process Management


Using UX Components with ADEP Process Management

In this module, you will use UX Components and their supporting APIs to develop two applications. One of the applications works with Experience Server tasks and the other with Document Server process management.


Concepts

In this module, you will learn about the following topics

• Introducing ADEP UX Components• Introducing Standalone Task Management in ADEP Experience

Services• Configuring standalone task types• Creating and configuring standalone tasks• Using the LCTaskManager class


Exploring ADEP UX Components for Task Management

In this topic, you will learn the role of ADEP UX Components and use an application that implements several UX components.


Introducing ADEP UX Components

• ADEP UX Components are made available by the ADEP tooling for Flash Builder 4.5

• ADEP UX Components expose ADEP specific functionality through the Flex SDK express Experience Oriented Architecture (XOA) principles for Flex and ADEP provide a consistent way to extend ADEP functionality to Flex developers

• ADEP UX Components were previously referred to as "XOA" and/or "eRIA" components

3


Introducing XOA Architecture

• XOA describes a technology-agnostic approach to development• ADEP UX Components implement this XOA approach for ADEP

3


What is an ADEP UX Component?

• RIA component (Flex and/or PDF and/or HTML) to expose functionality specific to either ADEP Experience Services Core ADEP Customer Experience Solutions ADEP Document Services

• Implemented using a best practice, layered approach Presentation - view rendering Domain - client side computation, server API abstraction, etc. Infrastructure - server communication

• Specific implementation details will vary by component

3


How may ADEP UX Component architecture be generalized?

4


How may ADEP UX Component architecture be generalized?

• Evolving ADEP UX Component architectural discussions are available https://zerowing.corp.adobe.com/display/trident/eRIA+Application+Development+Guidelines https://zerowing.corp.adobe.com/display/lc/ES3+Systems+Architecture+and+Patterns

4


What ADEP UX Components are available?

• ADEP UX Components available in Flash Builder for ADEP M6 focus on task management

• ADEP tooling for Flash Builder 4.5 offers these UX componentsTable 1: UX Components overview

4

UX Component

Description Connects to

AttachmentList Allows a user to view and manage attachments associated with a task

Document Services Task Manager

AttachmentList- Component

Allows a user to view and manage attachments associated with a task; includes additional default variables and features


DocumentSubmit Allows a user to view a document associated with a task; submit the task or mark it complete using Task Manager methods


DocumentSubmit-Component

Allows a user to view a document associated with a task and submit it or mark it complete; includes additional default variables and features


TaskAction Allows users to apply an action to a task; for example, to approve a task



What ADEP UX Components are available?

Table 1: UX Components overview

4

UX Component

Description Connects to

TaskDetails Displays the details of a task and allows a user to manage the status of the task

Document Services Task Manager, stand-alone Task Manager

TaskDetailsComponent Displays the details of a task and allows a user to manage the status of the task; includes additional default variables and features


TaskList Allows a user to view and select items in a list of tasks


TaskListComponent Allows a user to view and select items in a list of tasks; includes additional default variables and features


WebDocumentViewer Displays the content at a specified URL in a web-based Flex application

Does not interact with a server-side service


What ADEP UX Components are on the roadmap?

• Over 50 ADEP UX Components are exposed throughout the ADEP Solutions examples: Document Browser, Gantt Chart, Live Chat, many more ...

• A list of ADEP UX Components in use across the ADEP Solutions is available https://zerowing.corp.adobe.com/display/lc/UX+Components

• The distribution method for ADEP UX Components may vary by solution Flash Builder tooling exists to expose relevant UX Components UX Components are also distributed in relevant solution SDKs

5


Task 1: Use a demo application that implements several UX components

In this task, you will perform the following

• Use the shape order Flex applications• Examine the shape order nodes in the content repository

6


Defining Custom Task Types for Adobe Experience Server Task Management

In this topic, you will be introduced to the standalone task management capability of ADEP Experience Services, and learn to configure a custom task type.

6


Introducing Standalone Task Management in ADEP Experience Services

• ADEP supports two task management approaches standalone task management in ADEP Experience Services process task management in ADEP Document Services

• ADEP task management can be integrated across the platform

8


Comparing and integrating ADEP task management solutions

• Experience Services and Data Services task management can be integrated

• This content is in development as of the ADEP M6 releaseNote: This topic focuses on task management in ADEP Experience Services.

8


Introducing task type properties

• Described by the com.adobe.ep.taskmanagement.domain.ITask interface

• Default properties - all standalone task types expose these properties Type - name of node defining the task structure Name - name for the task Status - created or completed Time Created / Updated / Deleted - date time information Instructions - arbitrary string value ID - task identifier Owner ID - task owner identifier Action Names - list of actions supported by the task Properties - list of custom properties

8


Introducing task type properties

• Custom properties - tasks types may be extended with any number of customer properties examples: contentType, url, poNumber

8


Configuring standalone task types

• standalone task types are defined as repository nodes• task instances are stored as repository nodes

9


Defining a standalone task type

1. Open the ADEP repository using CRXDE Lite or another tool

2. Browse to /content/aep/taskmanagement/tasktypes

9



3. Duplicate and rename the /default node for the desired task type name

4. Select the /properties node copied as part of the /default node

5. Select Create > Create Node

6. Set these values to define a custom property name Name: [name for the custom property] Type: nt:unstructured

9



7. With the new node selected, set a node attribute to define the property data type for AS3 Name: type Type: String Value: [AS3 data type (e.g., String, Number, Boolean)]

9

8. Select Save All


Examining standalone task instances

• Standalone task instances are stored in the repository by Task ID• Instances are created in the repository location specified by the

TaskManager endpoint

10


Task 2: Defining custom task types for Adobe Experience Server task management


• Copy default task type to define new task type• Declare custom task properties to hold String data

12


Implementing UX Components with Experience Services Task Management

In this topic, you will use UX components and associated API to create, retrieve and display tasks that are created and stored in the content repository.

12


Creating and configuring standalone tasks

• Standalone tasks are created and managed with com.adobe.ep.taskmanagement.services.TaskManager

• Methods invoked via TaskManager are asynchronous and so are managed using Events

• Creating a new task is a four step process1. Create the task manager

2. Use the task manager to initiate a new task instance

3. Configure the new task instance with the initial state of the task

4. Create the configured task

16


Creating the TaskManager

• A TaskManager may be created at application startupimport com.adobe.ep.taskmanagement.services.TaskManager;...protected var taskManager:TaskManager = new TaskManager();

16


Initiating a new task instance

• A new task is initiated as taskManager.newTaskInstance(["task type"])

• The method returns an IObjectToken through which event handlers are assignedvar token:IObjectToken = taskManager.newTaskInstance("ShapeOrder");token.addResultHandler(newTaskInstance_resultHandler);token.addFaultHandler(faultHandler);

Note: Result and Fault handlers may also be assigned via mx.rpc.Responder objects token.addResponder(new Responder(resultHandler,faultHandler))

16


Receiving the new task instance

• A Task object is returned through an ObjectResultEvent when the task instantiatesimport com.adobe.ep.taskmanagement.util.IObjectToken;import com.adobe.ep.taskmanagement.domain.Task;...protected function newTaskInstance_resultHandler(event:ObjectResultEvent):void {var taskDetails:ITask = event.result as Task;

16


Configuring the new task

• Default properties are configured directly on the Task objecttaskDetails.taskTypeName = "ShapeOrder";taskDetails.description = "New Shape Order";

• Custom properties are configured as a value through the custom property nametaskDetails.properties.shape.value = "Circle";taskDetails.properties.poNumber.value = "ABC123";

17


Creating the new task

• The task is created by taskManager.createTask([task object])• The method returns an IObjectToken through which event handlers are

assignedvar token:IObjectToken = taskManager.createTask(taskDetails);token.addResultHandler(createTask_resultHandler);token.addFaultHandler(faultHandler);

Note: Result and Fault handlers may also be assigned via mx.rpc.Responder objects token.addResponder(new Responder(resultHandler,faultHandler))

17


Task 3: Create and retrieve tasks stored in the content repository


• Create a TaskManager instance• Create a new ShapeOrder instance• Populate the task instance properties and create the task in the

repository• Create a TaskManager instance• Create a filter and retrieve tasks based on the filter• Display the tasks in a TaskList component

18


Implementing UX Components with Document Services Process Management

In this topic, you will use UX components and associated API to retrieve and display tasks that are created in Document Services process management.

18


Using the LCTaskManager class

• The LCTaskManager class provides the implementation for tasks that reside on the Document Server

• When creating an instance of the class, use a parameter to set the task manager endpoint

• Set of constants available for the endpoint

21


ILCTaskManager

• The LCTaskManager class implements the ILCTaskManager interface• Common methods are available via the interface

21


Task 4: Retrieve document services process management tasks


• Create a TaskManager instance• Create a filter and retrieve tasks based on the filter• Display the tasks in a TaskList component

23


Summary

• ADEP UX Components package RIA functionality specific to ADEP services

• ADEP UX Components express XOA architecture and best practices for ADEP RIAs

• 50+ ADEP UX Components are used across ADEP Core and Customer Experience Solutions

• ADEP supports task management in both Experiences Services and Document Services

• Task management can be integrated across the platform• Standalone task management supports custom task properties• Task properties and instances are defined in the repository• Standalone tasks are created and managed with

com.adobe.ep.taskmanagement.services.TaskManager

25


Summary

• Methods invoked via TaskManager are asynchronous and so are managed using Events

• Creating a new task is a four step process1. Create the task manager

2. Use the task manager to initiate a new task instance

3. Configure the new task instance with the initial state of the task

4. Create the configured task

• The LCTaskManager class provides the implementation for tasks that reside on the Document Server

25

© 2011 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2011 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.

Date post:	31-Dec-2015
Category:	Documents
Upload:	colette-rose
View:	37 times
Download:	2 times

Using UX Components with ADEP Process Management

Documents