Portal 2011.1 Ad-Hoc and Scheduled Tasks - Installation ... - Casewise

casewise.com

Portal 2011.1 Ad-Hoc and Scheduled Tasks - Installation ... - Casewise

Portal 2011.1 Ad-Hoc andScheduled TasksInstallation Guide


Portal 2011.1 Ad-Hoc and Scheduled Tasks


ContentsContentsAbout this Guide ............................................................................ 3Document audience .......................................................................................... 3Document conventions ..................................................................................... 3Chapter 1 .............................................................................................. 5Installation overview ...................................................................... 5System requirements and pre-requisites .......................................................... 6Chapter 2 .............................................................................................. 7Creating and configuring the Tasks databases .......................... 7Enable Microsoft Distributed Transaction Coordinator (MSDTC) .................... 7Creating the Tasks databases .......................................................................... 8Initializing the Tasks databases ........................................................................ 9Assign the SQL Logins to the Tasks databases ............................................. 10Chapter 3 ............................................................................................ 13Installing and configuring the Portal Tasks service ................. 13Before you begin............................................................................................. 13Step 1 - Register the Tasks service................................................................ 13Step 2 - Configure the Tasks service ............................................................. 14Step 3 - Start the Tasks service ..................................................................... 17Step 4 - Test the installation ........................................................................... 17Step 5 – Specify Task Administration users ................................................... 17Troubleshooting .............................................................................................. 18Chapter 4 ............................................................................................ 19Configure your models ................................................................ 19Chapter 5 ............................................................................................ 21Logging ......................................................................................... 21Options and settings ....................................................................................... 21Chapter 6 ............................................................................................ 23Help and Support ......................................................................... 23Web Desk ....................................................................................................... 23Telephone and Email support ......................................................................... 23i


Portal 2011.1 Ad-Hoc and Scheduled TasksAppendix A ........................................................................................ 25Ad-Hoc Tasks Customization and Administration .................... 25Rename the Tasks section heading ............................................................... 25Email layout and content ................................................................................ 26ii


About this GuideAbout this GuideThis guide explains how to install the required components for Ad-Hoc Tasks andScheduled Tasks for Portal 2011.1. The components detailed in this guide arerequired for both Portal Ad-Hoc Tasks and Portal Scheduled Tasks. You should onlyattempt to install these components if you have already installed and tested the basicCasewise Portal in accordance with the Base Portal Installation Guide.If you are reading this guide to set up and configure Portal Ad-Hoc Tasks, then thisguide contains all the information you need. If you are setting up and configuringPortal Scheduled Tasks, then once you have completed the steps in this guide youshould read the Portal Scheduled Tasks Customization and Administration Guide tocomplete your configuration.The guide is part of a set of documents related to the Casewise Portal. The full set,including this document (highlighted) is:1. Portal System Requirements and Installation Overview2. Base Portal Installation Guide3. Base Portal Customization and Administration Guide4. Portal Ad-Hoc and Scheduled Tasks Installation Guide5. Portal Scheduled Tasks Customization and Administration Guide6. Portal Web Services GuideIt is essential that you read and follow these guides in order to fully understand thedetails in any one of them.It is recommended that you print this guide so that you can follow the instructionsmore easily. The guide is designed to be printed double-sided in booklet form.Document audienceThis guide is intended to be read by a system administrator who is tasked withinstalling the necessary components for Portal Ad-Hoc Tasks or Portal; ScheduledTasks, preferably a user with SQL Server Database Administrator (DBA) experience.Document conventionsThroughout this guide you are asked to make notes of certain variables or nameswhich are referenced or used elsewhere. These are referenced using the followingformatting: [Variable], and are highlighted in the following way:3


Portal 2011.1 Ad-Hoc and Scheduled TasksNote the name of this variable [MyVariable] as it is used later in this guidefor configuring the Portal.It is recommended that you write these settings down in the Notes section of theguide so that you can easily refer to them where required.4


Installation overviewChapter 1Installation overviewThis Installation Guide contains instructions on installing the components required forrunning both Portal Ad-Hoc Tasks and Portal Scheduled Tasks. You should onlyattempt to install these components if you have already installed and tested the basicCasewise Portal in accordance with the Base Portal Installation Guide.If you read this guide and follow the instructions, by the end of it you will have atested and fully-working Portal with Ad-Hoc Tasks. If you are enabling PortalScheduled Tasks, after completing this guide you must go on to the Portal ScheduledTasks Customization and Administration Guide for further instructions on setting upyour system.The following diagram shows how the Portal’s architecture fits together:Figure 1.The architecture is extended from that of the basic Portal installation which consistsof an ASP.NET-enabled web server machine with the Portal application, theCorporate Modeler client software, and the Portal Search Engine. The Portalapplication has a connection to the Corporate Modeler repository, and also aconnection to the optional Access Rights database.In addition to the basic Portal architecture, both the Portal Ad-Hic Tasks and PortalScheduled Tasks functionality requires two dedicated databases and the Portal TasksService.5


Portal 2011.1 Ad-Hoc and Scheduled TasksPortal Tasks functionality uses the Windows Workflow Foundation (WWF) toorchestrate the tasks. As tasks may need to run over a length of time, their state ispreserved in a WWF database while they are in progress.System requirements and pre-requisitesAs Ad-Hoc Tasks and Scheduled Tasks are optional add-ons for the Casewise Portal,the system requirements are the same as those defined in the Base Portal InstallationGuide.Microsoft SQL Server 2005/2008The databases required to enable Ad-Hoc and Scheduled Tasks functionality withinthe Portal can only run on Microsoft SQL Server.The Portal only supports Microsoft SQL Server 2005 and 2008 for running thesedatabases.For further details on database system requirements, please refer to the CorporateExchange system requirements documentation.6


Creating and configuring the Tasks databasesChapter 2Creating and configuring the TasksdatabasesThis chapter details how to create and configure the two Windows WorkflowFoundation (WWF) databases required for use with both the Ad-Hoc and ScheduledTasks functionality.All activities detailed in this chapter should be actioned on the database server itself.The instructions in this section are based on the assumption that yourTasks databases are on a different machine to the Portal web serverapplication. It is possible to run the Portal web server on the same machineas the databases, however the specific instructions for granting accessmay be different. Please consult Casewise for help in this matter.Enable Microsoft Distributed TransactionCoordinator (MSDTC)Before you create the databases, you must configure the database server so thattransactions can be executed between them both. To do this, you must enableMSDTC.To enable MSDTC (Windows Server 2003):1. Open the Component Services dialog:Go to Start > Control Panel > Administrative Tools > ComponentServices2. In the left-hand pane, expand the Component Services node3. In the left-hand pane, expand the Computers node4. In the left-hand pane, right-click My Computer and select PropertiesThe My Computer Properties dialog opensNote: If you are doing this remotely, choose the database computer5. In the My Computer Properties dialog, select the MSDTC tab6. Click Security ConfigurationThe Security Configuration dialog opens7


Portal 2011.1 Ad-Hoc and Scheduled Tasks7. Select the Network DTC Access checkbox8. Click OKIf prompted to restart the service, choose Yes.To enable MSDTC (Windows Server 2008):1. Open the Component Services dialog:Go to Start > Control Panel > Administrative Tools > ComponentServices2. In the left-hand pane, expand the Component Services node3. In the left-hand pane, expand the Computers node4. In the left-hand pane, expand My Computer5. In the left hand-pane, expand Distributed Transaction Coordinator6. In the left-hand-pane, right-click Local DTC and select PropertiesThe Local DTC Properties dialog opensNote: If you are doing this remotely, choose the database computer7. In the Local DTC Properties dialog, select the Security tab8. In Security Settings, select the Network DTC Access checkbox9. Click OKIf prompted to restart the service, choose Yes.We recommend that you restart your server at this point.Experience has demonstrated that while restarting the service should itselfenable distributed transactions, often it does not. Restarting the server willensure that distributed transactions are enabled.Creating the Tasks databasesThis section details the creation, initialization, and configuration of the two WWFdatabases.Note: If you already use WWF for some other application you may already havethese databases and therefore do not need to create them again. You will have toconfigure the correct login details however.To create the databases:1. Run SQL Server Management Studio2. Connect to the SQL Server instance where the databases are to be located8


Creating and configuring the Tasks databases3. In the left-hand-pane, right-click Databases and select New DatabaseThe New Database dialog opens4. In the Database name field, enter the following name:wwfTracking5. Click OKThe New Database dialog closes6. Repeat steps 3 to 5 for the second database, but use the following name:wwfPersistenceInitializing the Tasks databasesOnce the databases have been created, they must be initialized. This involvesopening, editing and executing four different SQL script files.The table below shows the name of each file to be edited and the command you mustenter in the script file.The accompanying instructions for initializing the databases refer to this table todetermine what command to enter in which file.FileTracking_Schema.sqlTracking_Logic.sqlSqlPersistenceService_Schema.sqlSqlPersistenceService_Logic.sqlCommanduse wwfTrackinguse wwfTrackinguse wwfPersistenceuse wwfPersistenceThe files can be found in the following location:C:\WINDOWS\Microsoft.NET\Framework\v3.0\Windows WorkflowFoundation\SQL\EN\To initialize the databases:1. In SQL Server Management Studio, go to File > Open > FileThe Open File dialog opens2. Locate and open the file to be edited:When prompted, connect to the SQL Server instance where the databasesareThe file is opened in the right-hand pane3. Edit the file to include the specified commandSee the table aboveFor example, the code should now begin as shown below:9


Portal 2011.1 Ad-Hoc and Scheduled Tasks-- Copyright (c) Microsoft Corporation. All rightsreserved.COMMAND GOES HERE (Example: use wwfTracking)SET NOCOUNT ON4. Click ExecuteThe script file is executed5. Go to File > CloseThe script is closed6. Repeat steps 2 to 5 for each of the four files that require editing andexecuting.Assign the SQL Logins to the Tasks databasesWhen the Base Portal was installed and configured, a SQL Login was created toprovide access to the database.You should use this same Login to provide access to the Portal Tasks databases,which you should note as [SQL_Login_Name].To do this:1. Run SQL Server Management Studio2. In the left-hand pane of SQL Server Management Studio, expand the nodefor the Corporate Modeler database server3. In the left-hand pane, expand Security4. In the left-hand pane, expand Logins5. Double-click the Login used for Portal access – noted earlier as[SQL_Login_Name]6. The Login Properties dialog opens7. In the Select a page section in the left-hand pane of the dialog, click UserMapping8. In the Users mapped to this login section, select wwfPersistence andensure the Map checkbox is ticked9. In the Database role membership for: wwfPersistence section, select thestate_persistence_users role10. Click OK11. Repeat the instructions above, but this time with the following differences:At step 8, choose the wwfTracking database instead ofwwfPersistence10


Creating and configuring the Tasks databasesAt step 9, select the following Role Members:oootracking_profilereaderwritertracking_readertracking_writerThe login is mapped to the Portal Tasks database.11


Portal 2011.1 Ad-Hoc and Scheduled Tasks12


Installing and configuring the Portal Tasks serviceChapter 3Installing and configuring the PortalTasks serviceThe Portal Tasks service is a Windows service that must be registered on the Portalweb server machine. Once it is registered, the settings of the service must beconfigured, before the service can be started.The actual name of the Tasks service is “PortalScheduleService”. However,despite its name it is required for both Ad-Hoc and Scheduled Tasks.Before you beginBefore you can register the service, note the location of the Services directory whichwas among the [Portal_Files] that were copied to the web server machine at thestart of the Portal installation process.Note the location of the Services directory as: [Services_Files]Step 1 - Register the Tasks serviceTo register the Portal Tasks service:1. On the Portal web server machine, open a command promptGo to Start > Run and enter cmd2. CD to the [Services_Files] directoryFor exampleC:\Portal\Services3. Enter the following command to invoke the Installation Utility to install thesearch engine service:InstallUtil.exe PortalScheduleService.exeThe following message is displayed when the service has been installed:the transacted install completed successfully13


Portal 2011.1 Ad-Hoc and Scheduled TasksStep 2 - Configure the Tasks serviceNow the Tasks service is registered, you must configure it to connect to yourCorporate Modeler repository.To do this you must edit the shared services’ configuration file, Shared.config.To find and edit the file:1. Locate the file Shared.configThis can be found in the [Services_Files] directory2. Open the file with a text editor, such as Notepad.3. Edit the settings as requiredEach setting is represented by a key/value pair in the section of the file, such as:The table below details all the settings you must configure. If any key/valuepairs are missing from your file, you can add them.Note: Options marked as “Scheduled Tasks Only” need only be configured ifyou are to use Portal Scheduled Tasks. All other options must be configuredfor both Ad-Hoc and Scheduled Tasks.Keydefaults.WorkflowPersistenceServerdefaults.WorkflowPersistenceDatabasedefaults.WorkflowTrackingServerdefaults.WorkflowTrackingDatabaseDescription of valueThis is the name of the machine wherethe Tasks workflow persistence databasecan be found.For installations where the workflowdatabases are on the same machine asthe Portal use: localhostThis is the name of the SQL databaseused for workflow persistence.If you are following the namingconventions used in this guide, the nameis: wwfPersistenceThis is the name of the machine wherethe Tasks workflow tracking database canbe found.For installations where the workflowdatabases are on the same machine asthe Portal, use: localhostThis is the name of the SQL databaseused for workflow tracking.If you are following the namingconventions used in this guide, the nameis: wwfTracking14


Installing and configuring the Portal Tasks servicescheduler.refreshIntervaldefaults.AutoScheduleItemsscheduler.email.serverscheduler.email.sendNote: Scheduled Tasks OnlyAt fixed intervals the service refreshesitself against the matrices that define theschedules. The value of this property isthe number of minutes between refreshes.The default is 60, or once every hour.If you have few scheduled items with ahigh degree of change then set this valuelower. If you have a large number ofscheduled items an the server loadgenerated by the scheduler is large, thenset this value higher.Note: Scheduled Tasks OnlyThis property allows you to enable ordisable scheduling. If set to 1 thescheduler creates workflows and sendsportal messages to users when they aredue.If this property is set to 0 no tasks will becreated from the schedule definition.The server can be configured to sendstatus emails every day to registeredusers who have tasks assigned to them.This property contains the IP address ofthe SMTP mail server to be used forsending mails.Use this property to enable or disable thesending of emails.If set to 1 emails will be sent, if set to 0emails will not be sent.scheduler.email.fromscheduler.email.sendAllPlease note this option is different to theproperty AutoScheduleItems shownabove for Scheduled Tasks. You can stillhave AutoScheduleItems set to 1 to sendmessages within the portal but the valueof AutoEmailSchedules set to 0 to stopemails being dispatched.This is the email address that appears inthe From field of any emails sent.It is sensible to create a specific no-replyemail address in your email system foruse by these emails and to specify it here.Note: For Ad-Hoc Tasks, the valueshould always be set to 1 if you wantto receive emails.0 = Users who are involved in any Tasksare sent an email each day informingthem of the status of any Tasks relevantto them.15


Portal 2011.1 Ad-Hoc and Scheduled TasksServicePortServiceMachineNamedefaults.ScheduleModels1 = In addition to the daily emailmentioned above, when a Task iscreated, submitted, rejected or accepted,each user involved in that Task (with theexception of the Escalate To user) is sentan email notifying them of the action andstatus.The service communicates with the portalapplication via TCP/IP. This propertyspecifies the TCP port that the servicelistens on. The default is 8080.Note: if you change this value, you mustchange the corresponding value in thePortal’s web.config file to match.This is the IP address, or machine name,of the SNMTP server used to send emailfrom the PortalNote: Scheduled Tasks OnlySince schedules can be defined inmultiple models, the format for defining aschedule is as follows:The string contains one configuration permodel in square brackets: [ ]Inside the each set of brackets, enter theScriptname of the model, a colon, andthen a list of Matrix diagrams separatedby commas.For example, the following two models:Model 1: Scriptname CWFREX09Matrix IDs 1876, 77Model 2: Scriptname BPCA304Matrix ID 100Are configured in the value property as:redirectUrlscheduler.startAdhocScheduledItemPowerLevelscheduler.ignoreDoNotScheduleAfterscheduler.email.sendScheduleTaskInviteMessagescheduler.email.[CWFREX09: 1876, 77][BPCA: 100]This is the URL of your Portal homepage.Specify the minimum CM user PowerLever a user needs in order to use the“Schedule Now” function. For example“System Manager”Set to 1 to ignore the “Do Not ScheduleAfter” date set for a scheduled task andcontinue creating tasks according to theschedule.Set to 1 to send an email to a TaskFollower when a scheduled task iscreated.Set to 1 to send a daily task summary16


Installing and configuring the Portal Tasks servicesendDailyRoundupscheduler.email.DailyEmailSubjectscheduler.email.StageEmailSubjectemail to all users involved in any tasks.The subject of the daily task summaryemail (detailed above)The subject of the emails that are sentwhen tasks have been updated.Step 3 - Start the Tasks serviceThe final step in the Tasks service installation and configuration is to ensure that theservice is enabled.To do this:1. Open the Component Services dialog:Go to Start > Control Panel > Administrative Tools > ComponentServices2. In the left-hand pane, select Services (local)3. In the right-hand pane, right-click PortalScheduleService and selectPropertiesThe PortalScheduleService Properties dialog opens4. Ensure that the Startup type drop-down is set to Automatic5. If the Start button is enabled, click Start to begin the service.If Start is disabled, the service is already running.6. Close any open dialogs.Step 4 - Test the installationTo test that the installation has been successful, log on to the Portal, select an object,assign it as a task to yourself and see that a message is delivered to your inbox.You can also check the Portal’s log file to ensure the application is started. For moreon logging, see Chapter 5 - Logging.Step 5 – Specify Task Administration usersThe Portal enables certain users to administer Tasks through a dedicated UI. Usingthe UI, these users can Reassign Tasks, Stop, or Cancel Tasks, and Delete Tasks.The Portal does this by including a configuration option where you name theCorporate Modeler User Group which contains the users you want to be able toadminister Tasks.If no valid User Group is specified, then no users will be able to administer Tasks inthe Portal.17


Configure your modelsChapter 4Configure your modelsAny models that you want to use with Ad-Hoc or Scheduled Tasks must beconfigured to include some new design data.This design data includes:1. Two new Object Types named Portal Tasks and Portal Messages2. Two new Association Types - Portal Tasks to Portal Messages andObjects for Task (Portal Tasks to All Objects).The simplest way to get this information into your model is to import an XML file wehave created just for this purpose.The Portal_Tasks.xml file can be found in the [Portal_Files]\Supporting_Filesdirectory.To import the file into you model you can use Model Explorer or Object Explorer –please refer to the Corporate Modeler Suite help for further information on importingdata into models.After importing, please check your model or models to ensure that the correct datahas been imported.Once the new design data is imported into your model, you must ensure that the newObject Types and Association Types are not edited or changed in any way.19


Portal 2011.1 Ad-Hoc and Scheduled Tasks20


LoggingChapter 5LoggingLogging is enabled by default in the Tasks service, however, there are optionsavailable which you should consider before deciding whether to leave the defaultsettings in place or configure them to suit your needs.Logging is controlled via settings in the service’s configuration file,PortalScheduleService.exe.config, which can be found in the application’s servicesdirectory.Options and settingsThe logging details are contained in a section of the configuration file which is markedby the following tags:...The following parameters can be set:ParameterfilemaximumFileSizemaxSizeRollBackupslevelDescription of valueThe name of the log file.The log file is created in the application services directory.The maximum size the log file is allowed to grow to.The number of log files to store.When the maximum size is met for the first log file, it isrenamed to filename.log1 and a new log file (filename.log)is created for the current log.Each time a new log file is created all other log files arerenamed so they can be viewed in order – sofilename.log1 would become filename.log2 and so on.When the maximum number of log files to store has beenreached, the oldest log file is deleted.The following values are available, each recording differentamounts of information and/or types of event, ranging fromall events for ALL, to no events for OFF: ALL INFO DEBUG ERROR WARNING OFFIf you are experiencing specific problems, set the level to21


Portal 2011.1 Ad-Hoc and Scheduled TasksDEBUG and then reproduce the problem. You can thensend a copy of the resulting log file to Casewise forassistance in resolving the issue.22


Help and SupportChapter 6Help and SupportWeb DeskYou can submit a request for assistance and search our knowledge base on our webdesk support system:http://www.casewise.com/support/Telephone and Email supportCasewise provides telephone and Email support services to registered users whohave paid their annual maintenance charge. The service is available during normaloffice hours.When you contact Service Desk for help, please ensure that you include the followinginformation in your email, or have it at hand if you are telephoning:Your name and organization nameYour license numberThe version number of the Casewise product you are usingAny error messages you have encountered, or the precise steps that causedthe problemFor Europe, Asia and AustralasiaFor technical queries, contact the Casewise Service Desk on: +44 (0)1923 830 333For general and business queries, contact your Casewise account manager on: +44(0)1923 830 300Email: servicedesk@casewise.comFor USA, North and South AmericaFor technical queries, contact the Casewise Service Desk on: +1 856-380-1400For general and business queries, contact your Casewise account manager on: +1856-380-1400Email: servicedesk@casewise.com23


Portal 2011.1 Ad-Hoc and Scheduled Tasks24


Appendix A - Ad-Hoc Tasks Customization and AdministrationAppendix AAd-Hoc Tasks Customization andAdministrationThere two areas where you can customize the Portal in relation to Ad-Hoc Tasks.1. Rename the Tasks section heading in the Portal’s left-hand navigation2. Email layout and content.Rename the Tasks section headingYou can change the default title for the Taskssections by manually-editing one of the Portal’sconfiguration files.Note: You cannot change the associated icon.If you change this heading it will change it for all language versions of thePortal – so if you have some users who use the Portal in French and othersusing it in EnglishTo change the Tasks section heading:1. Locate and open presentationText.xmlThis can be found at [Portal_Files]\Portal_Application\xmlOpen the file with a text editor such as Notepad2. Locate the section within the file where the details are listed, asshown below:3. Edit the title=”” value and enter the name you want to display:4. Save and Close the file.Whenever you edit one of the Portal’s configuration files you must restartInternet Information Services (IIS) for the changes to take effect.25


Portal 2011.1 Ad-Hoc and Scheduled TasksEmail layout and contentThe structure, layout and content of Ad-Hoc Task Emails are configured usingmessage templates.There are two sets of templates used – one for the daily Emails and another set forthe Emails that relate to a specific Task.This guide does not provide specific documentation on editing these template files,however, you may experiment with them if you wish. Anyone with programmingexperience, particularly with mark-up-type languages, should be able to understandhow the template files work. However, the following notes should be observed:Please make backup copies of the Email templates before you startexperimenting with them so that you can revert to the default set if youencounter problems.You may notice what appears to be non-standard formatting in relation toCSS styles. Please keep all CSS formatting in this style as the template willnot work.The templates for the daily Email messages can be found in the following location:Services\Scheduler\MailMessageThe templates for the Task-specific Email messages can be found at the followinglocation:Services\Scheduler\InternalMessage26


NotesNotes:27


Portal 2011.1 Ad-Hoc and Scheduled Tasks28


Notes29


v1.0 Portal 2011.1

More magazines by this user
Similar magazines