Difference between revisions of "Starfish Scheduler"

From Starfish ETL
Jump to navigation Jump to search
(Created page with "The Scheduler is a run as Windows Service. It may installed on any server which has access to the web service, but for the sake of simplicity it is recommended to be installed...")
 
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
=Installation=
 
The Scheduler is a run as Windows Service. It may installed on any server which has access to the web service, but for the sake of simplicity it is recommended to be installed the same server as the Starfish Engine. The Scheduler reads in the jobs’ configured schedules and launches them at the appropriate times.
 
The Scheduler is a run as Windows Service. It may installed on any server which has access to the web service, but for the sake of simplicity it is recommended to be installed the same server as the Starfish Engine. The Scheduler reads in the jobs’ configured schedules and launches them at the appropriate times.
  
Line 14: Line 15:
 
3. Click next and complete installation.
 
3. Click next and complete installation.
  
4. It is recommended to update the default web service location. To do this, open the .config file in the install path (“C:\Program Files\Technology Advisors\Starfish Scheduler\StarfishScheduler.exe.config”) with a text editor.
+
=Configure The Starfish Scheduler=
 +
==Setting The Scheduler's Engine Web Service URL==
 +
If you changed the default Engine's web service URL, you must update the default web service location. To do this, open the .config file in the install path (“C:\Program Files\Starfish\Starfish Scheduler\StarfishScheduler.exe.config”) with a text editor.
  
5.
+
Near the end of the file, change http://localhost/StarfishEngine/StarfishEngine.asmx to the location of your custom web service URL.  Ex: http://localhost:8080/StarfishService.asmx.<br>
 +
'''Please pay special attention to if you are editing the HTTP or HTTPS section of the config file, or edit both sections.'''
  
 
[[file:Schedulerurl.png]]
 
[[file:Schedulerurl.png]]
  
Near the end of the file, change http://servername/StarfishEngine.asmx to the location of your new web service (http://server_name/StarfishEngine/StarfishService.asmx).
 
  
6. A number of other options may be changed through this config file.
+
==Scheduler Config Settings==
 +
A number of other options may be changed through the C:\Program Files\Starfish\Starfish Scheduler\StarfishScheduler.exe.config config file.
  
 
[[file: StarfishSchedulerConfigFile.png]]
 
[[file: StarfishSchedulerConfigFile.png]]
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 52: Line 55:
 
| Port of your SMTP server. Default is port 25.
 
| Port of your SMTP server. Default is port 25.
 
|}
 
|}
 +
 +
=Configuring for use with several IIS Applications=
 +
==Why?==
 +
So you can run multiple integrations on a single server.
 +
==How?==
 +
Note that these instructions are a preliminary outline.  If you need help, please contact support@starfishetl.com.
 +
#Make a copy of the default installed StarfishEngine folder found in C:\inetpub\wwwroot\
 +
#Rename the folder.  Something like "StarfishERPIntegration" or "StarfishTEST".
 +
#Ensure your new folder has the proper Security settings.
 +
##Right click on the Folder -> Properties -> Security Tab.
 +
##Confirm that System, Administrators and IIS_IUSRS have "Full control" of the folder.
 +
#Open Internet Information Services (IIS) Manager.
 +
##Open Application Pools and "Add Application Pool".  Give it the same name as the folder you copied.  Set the .NET version and Pipeline Mode to the same as the default StarfishETL Application Pool.
 +
##Find the folder you copied in the Sites -> Default Web Site tree.  It will likely look like a folder.  If it does, right click and select "Convert To Application".  Make sure to select your new Application Pool.
 +
##Surf to your new Application to test.  The URL will be something like: http://localhost/StarfishTEST/StarfishService.asmx.
 +
#Open your map in the Starfish Admin and point Starfish Admin to this new Web Service URL.
 +
#Deploy your map.
 +
#Edit the StarfishScheduler.exe.config file found in C:\Program Files\Starfish ETL\Starfish Scheduler\.  Change the applicationSetting section for <setting name="AdditionalServices" serializeAs="Xml">.  This tells the Starfish Scheduler to look at multiple Web Service URLs.
 +
#:<source lang="xml">
 +
            <setting name="AdditionalServices" serializeAs="Xml">
 +
                <value>
 +
                    <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
 +
                </value>
 +
            </setting>
 +
</source>
 +
#:to:
 +
#:<source lang="xml">
 +
            <setting name="AdditionalServices" serializeAs="Xml">
 +
                <value>
 +
                    <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 +
<string>http://localhost/StarfishERPIntegration/StarfishService.asmx</string>
 +
</ArrayOfString>
 +
                </value>
 +
            </setting>
 +
</source>
 +
#Restart the Starfish Scheduler service.

Latest revision as of 11:38, 6 September 2018

Installation

The Scheduler is a run as Windows Service. It may installed on any server which has access to the web service, but for the sake of simplicity it is recommended to be installed the same server as the Starfish Engine. The Scheduler reads in the jobs’ configured schedules and launches them at the appropriate times.

Installation Steps

1. Run StarfishSchedulerSetup.msi on the desired server.

StarfishSchedulerSetupWizard.png


2. Select the installation folder, and the default access.

StarfishWizardInstallationFolder.png

3. Click next and complete installation.

Configure The Starfish Scheduler

Setting The Scheduler's Engine Web Service URL

If you changed the default Engine's web service URL, you must update the default web service location. To do this, open the .config file in the install path (“C:\Program Files\Starfish\Starfish Scheduler\StarfishScheduler.exe.config”) with a text editor.

Near the end of the file, change http://localhost/StarfishEngine/StarfishEngine.asmx to the location of your custom web service URL. Ex: http://localhost:8080/StarfishService.asmx.
Please pay special attention to if you are editing the HTTP or HTTPS section of the config file, or edit both sections.

Schedulerurl.png


Scheduler Config Settings

A number of other options may be changed through the C:\Program Files\Starfish\Starfish Scheduler\StarfishScheduler.exe.config config file.

StarfishSchedulerConfigFile.png

Setting Description
SchedulePollMS Interval in milliseconds on how often the Service should cycle to check if it needs to execute any Jobs based on the schedules. Default is 5 seconds.
Commit True/False, whether Jobs executed through the Scheduler should be committed to the destination database. Default is True.
ChainJobs True/False, whether Jobs executed through the Scheduler should automatically call the next Job configured in Job Changing. Default is True.
LoggingLevel Level of logging to return through notification.0=None, 1=Low, 2=Medium, 3=High
FromAddress The email address notifications should come from.
FromDisplay The display name of the notification email address.
SMTPPort Port of your SMTP server. Default is port 25.

Configuring for use with several IIS Applications

Why?

So you can run multiple integrations on a single server.

How?

Note that these instructions are a preliminary outline. If you need help, please contact support@starfishetl.com.

  1. Make a copy of the default installed StarfishEngine folder found in C:\inetpub\wwwroot\
  2. Rename the folder. Something like "StarfishERPIntegration" or "StarfishTEST".
  3. Ensure your new folder has the proper Security settings.
    1. Right click on the Folder -> Properties -> Security Tab.
    2. Confirm that System, Administrators and IIS_IUSRS have "Full control" of the folder.
  4. Open Internet Information Services (IIS) Manager.
    1. Open Application Pools and "Add Application Pool". Give it the same name as the folder you copied. Set the .NET version and Pipeline Mode to the same as the default StarfishETL Application Pool.
    2. Find the folder you copied in the Sites -> Default Web Site tree. It will likely look like a folder. If it does, right click and select "Convert To Application". Make sure to select your new Application Pool.
    3. Surf to your new Application to test. The URL will be something like: http://localhost/StarfishTEST/StarfishService.asmx.
  5. Open your map in the Starfish Admin and point Starfish Admin to this new Web Service URL.
  6. Deploy your map.
  7. Edit the StarfishScheduler.exe.config file found in C:\Program Files\Starfish ETL\Starfish Scheduler\. Change the applicationSetting section for <setting name="AdditionalServices" serializeAs="Xml">. This tells the Starfish Scheduler to look at multiple Web Service URLs.
                <setting name="AdditionalServices" serializeAs="Xml">
                    <value>
                        <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
                    </value>
                </setting>
    
    to:
                <setting name="AdditionalServices" serializeAs="Xml">
                    <value>
                        <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    						<string>http://localhost/StarfishERPIntegration/StarfishService.asmx</string>
    					</ArrayOfString>
                    </value>
                </setting>
    
  8. Restart the Starfish Scheduler service.