Service Optimization
Related Assignments
Product ClickApp by ClickSoftware
For use with ClickMobile Touch
ClickSoftware Confidential
Legal Notice
The software with this guide is furnished under a license agreement and may be used only according to
the terms of that agreement.
Copyright
Copyright © ClickSoftware Technologies Ltd. All rights reserved.
No part of this publication may be copied without the express written permission of ClickSoftware
Technologies Ltd..
Patent and Trademark
US Patent Number 6,985,872 B2
ClickAnalyze, ClickFix, ClickForecast, ClickMobile, ClickPlan, ClickRoster, ClickSchedule, and
ClickSoftware are registered trademarks of ClickSoftware Technologies Ltd.
Contact Information
Contact information is available from the ClickSoftware web site: http://www.clicksoftware.com.
For general information, email to [email protected].
For ClickSoftware Worldwide Support, email to [email protected] or see the support page on
the ClickSoftware web site.
For Partner Enablement, email to [email protected].
Publication Notice
This guide has been carefully compiled. The information in this guide does not constitute a warranty of
performance. Furthermore, ClickSoftware reserves the right to revise this publication and make changes
from time to time in the content thereof, without obligation to notify any person of such revisions or
changes. ClickSoftware assumes no liability for losses incurred as a result of out-of-date or incorrect
information in this guide.
Version
Related Assignments
App number: 1040
App version: 1.2
Date: May 2015
Related Assignments
3
Contents
RELATED ASSIGNMENTS .............................. 4
Use ............................................................................................................. 5
Prerequisites .............................................................................................. 7
Installation .................................................................................................. 7
Configuration .............................................................................................. 8
Adding the Related Assignments Setting to the Administration Tool ... 8
Configuring the Related Assignments Setting .................................... 10
Configuring the SXPGetChainDetails Message ................................. 11
Configuring the Related Assignments Event and Custom Panel ....... 12
Comments ................................................................................................ 13
4
Related Assignments
Related Assignments
This app enables an engineer to view the stages of a multistage task. The stages are
related to the current assignment and to one another by time or resource
dependencies. The engineer can display the entire chain of related assignments and
communicate with the engineers who are assigned to the other stages.
Related Assignments
Use
The app displays related assignments that are associated with a multistage task. For
a discussion of multistage tasks, see the ClickSchedule Developer's Guide.
To view the chain of related assignments, open the current assignment, and display
the Related Assignments page.
The current assignment is highlighted in blue and its dependencies are displayed.
You can click other assignments in the multistage chain and view their
dependencies. When you expand the view of a related assignment, the other related
assignments are automatically collapsed.
5
6
Related Assignments
To call the engineer of a related assignment, click the phone number.
The Related Assignments page displays both completed and uncompleted stages of
the multistage chain. The page is refreshed automatically when the user logs in or
when the server sends schedule updates. To refresh the data manually, click the
button at the upper left corner of the page.
If an assignment is not part of a multistage chain, the Related Assignments page
displays a message.
Related Assignments
Prerequisites
This app requires ClickMobile Touch, configured with a Schedule view.
Installation
1.
On each ClickMobile middle tier, copy the following files to the
ClickMobileWEB\CustomScripts directory:

W6.ClickMobile.Web.RelatedAssignments.js

W6.ClickMobile.Web.RelatedAssignmentsEvent.js

W6.ClickMobile.Web.RelatedAssignments.Resources.js
7
8
Related Assignments
2.
On each Service Optimization server, copy the following files to the Service
Optimization\Bin directory:

3.
W6.ClickMobile.Web.RelatedAssignments.ServerAdmin.dll
W6CMGetChainDetailsSXP.dll
On the server, open a command prompt and run the following command (all on
one line, and substitute your installation paths):

C:\Windows\Microsoft.NET\Framework\v4.0.30319>RegAsm.exe
/codebase
"C:\Program Files (x86)\ClickSoftware\Service Optimization\Bin\
W6.ClickMobile.Web.RelatedAssignments.ServerAdmin.dll"
Configuration
To enable the app, perform the following main steps:
1.
2.
3.
4.
Add the Related Assignments setting to the Service Optimization
Administration tool.
Configure the setting.
Configure an SXP message.
In ClickMobile Touch, configure an event, and add a custom panel to the
assignment form.
Adding the Related Assignments Setting to the Administration Tool
You must add a Related Assignments settings node to the Service Optimization
Administration tool.
1.
2.
In the left pane of the Service Optimization Administration tool, right-click the
root node, Service Optimization Administration. On the pop-up menu, click
Settings.
In the XML editor, expand the code and find the Parameters group. It is
typically the fourth subgroup of the first top-level group.
Related Assignments
3.
9
Copy the following XML string to the clipboard:
<Group Property="Category"
Value="W6CMRelatedAssignments"
IconScheme="CentralSettingsView" Alias="Related
Assignments Settings">
<Object IconScheme="CentralSettingsItem"><Columns>
<Property Name="Name"/></Columns><Actions><Action
Type="Add"><Tools>
<Tool Alias="Settings..." Type="Specific" ProgID=
"W6.ClickMobile.Web.RelatedAssignments.ServerAdmin.W6
CMRelatedAssignmentsServerAdmin"/>
</Tools></Action><Action Type="Edit"><Tools>
<Tool Alias="Edit..." Type="Specific" ProgID=
"W6.ClickMobile.Web.RelatedAssignments.ServerAdmin.W6
CMRelatedAssignmentsServerAdmin"
Default="True"/></Tools></Action><Action
Type="Delete"><Tools>
<Tool Alias="Delete..."
Type="Generic"/></Tools><Properties/></Action>
<Action Type="Edit"><Tools><Tool Alias="Edit As
XML..." Type="Specific"
ProgID="W6AdminUIs.W6SettingUI" Default="True"/>
</Tools><Properties><Property
Name="Body"><Tools><Tool Type="Generic"/>
10
Related Assignments
4.
<Tool Type="XML" Alias="Edit Body..."
Default="True"/></Tools></Property>
</Properties></Action></Actions></Object></Group>
Right-click the Group element of the Parameters group, and click Paste. This
adds a new node to the Administration tool:
Central Settings/Parameters/Related Assignments
Configuring the Related Assignments Setting
You must configure the Related Assignments setting, specifying the statuses and
display properties of the related assignments.
1.
2.
3.
In the left pane of the Administration tool, select the setting node: Central
Settings/Parameters/Related Assignments
In the right pane, right-click and click New > Settings. The Related Assignment
Settings window displays
On the Status Selection tab, select the task statuses to display on the Related
Assignments page. For example, you might display related assignments whose
tasks have a status of Scheduled or Dispatched, but not assignments whose
tasks have a status of Tentative or Cancelled.
Related Assignments
4.
11
On the Property Selection tab, select the assignment, task, and engineer
properties to display for the related assignments. Typically, you should select
the following properties:

Task.Status

Engineer.Name

A property containing the engineer's telephone number

Assignment.Start

Assignment.Finish
It is permitted to substitute other properties that contain equivalent data. In
addition to the selected properties, the app displays the Number property of
each stage. Within a multistage chain, the Number property is the stage
identifier.
Configuring the SXPGetChainDetails Message
The app uses an SXP message to communicate with the server. You must configure
the message.
1.
In the Administration tool, edit the following setting:
12
Related Assignments
Central Settings/Integration & Services/Web Services & SXP
Messages/Message Settings
2.
3.
4.
Click the Add button. This opens a configuration wizard.
On the first wizard page, select the option to Add New SXP Message.
On the next page, set the following options:
Name
Enter the name SXPGetChainDetails
Type
Enter the following type name:
W6CMGetChainDetailsSXP.SXPGetChainDetails,
W6CMGetChainDetailsSXP
5.
6.
Optionally, you can click the Browse button and browse to the file and class.
On the next page, select the option to Enable Integration. On the subsequent
pages, accept the default options and finish the wizard.
Configuring the Related Assignments Event and Custom Panel
1.
2.
3.
4.
5.
6.
7.
8.
In the Service Optimization Administration tool, edit the ClickMobile Touch
(Professional) administrative setting. This opens the Mobility Studio.
From the toolbox, drag an Event component to the miscellaneous area below
the client template.
In the Properties pane, configure the following attribute of the Event:
Type
In the JS option, enter the name
W6.ClickMobile.Web.RelatedAssignmentsEvent.dll (even though the DLL
does not exist in the installation directory).
Enter the class name
W6.ClickMobile.Web.RelatedAssignmentsEvent.W6CMRelatedAssignmentsE
vent.
Select the Schedule View and edit its Object Form Definition attribute. This
opens the Assignment form in the ClickMobile Dialogs Editor.
Click the Add Page button, and add a page having a name such as Related
Assignments. Alternatively, you can insert the Related Assignments panel on
an existing page.
From the toolbox, drag a Custom Panel to the page.
In the Properties pane, configure the following attribute of the Custom Panel:
CustomPanelDef
Related Assignments
13
Enter the DLL name W6.ClickMobile.Web.RelatedAssignments.dll (even
though the DLL does not exist in the installation directory). Enter the class path
W6.ClickMobile.Web.RelatedAssignments.W6CMRelatedAssignments.
9. Click Apply and close the Dialogs Editor.
10. Click Apply and close the Mobility Studio.
Comments
The ClickMobile appearance is configurable. The layout might differ on your
device.
In Service Optimization 8.1.7 and earlier, ClickMobile Touch was known as
ClickMobile Professional.