ClickHome 3 Consultants JobFile Setup Instructions (Public Test Environment)

JobFile set up instructions for ClickHome builders. This will configure the builders account so that all of their suppliers and contractors receive a JobFile url in their call up emails and can respond accordingly.

Step-by-step guide

ClickHome 3

1. Obtain an appropriate email address from the client which will be the main account/license holder as well as a first and last name for the account;

2. Create an account in JobFile;

3. Go to: http://jobfilepublictestap-env.elasticbeanstalk.com/JobFile/Registration

4. Click ‘Sign Up - Free’;

5. Enter the following fields as a minimum;

1. Company Name;

2. Email Address;

3. Password/Confirm Password (NOTE: the password cannot be ‘password’ and must be at least 6 characters);

4. Users Full Name;

6. Click next and accept the terms in the license agreement, then click confirm;

7. An email will be sent to the client, they need to verify their email addresses by clicking on the link in this email;

8. Once this has been done you can apply the correct settings in ClickHome;

9. You will need to login to ClickHome as an admin and go to: Administration > System Configuration > Configuration and System Settings.

10. Add all 4 of the following entries:

    1. ClickHome.JobFile.WebServiceURL:

       If using version 32 or below http://jobfilepublictstapi-env.elasticbeanstalk.com/V0

       If using version 33 or above http://jobfileapiv1publict-env.elasticbeanstalk.com/api/ 

       NOTE: ensure there are no spaces before or after these links once pasted into ClickHome

    2. ClickHome.JobFile.UserId: username/email address you created for the JobFile Account;

    3. ClickHome.JobFile.Password: password used for the JobFile Account;

    4. ClickHome.JobFile.JobFileQueueId: maxiumum value from idExportQueue in tblExportQueues (for now this will be manually obtained by JobFile Team - in future it will be generated in JobFile Admin module of the UI)

       1. ClickHome.JobFile.RegisterMode: Version 33 and above ONLY: 
          0 = nothing, 1 = external all, **2 = external but does not load any supplier with 'NOJobFIle' (see below), 3 = all
          NOTE: Ensure there is only 1 register mode entered and it is set to bStdActive = 1

          If this validation entry does not exist please add it.

          
          

11. Then click save and setup will be complete.

* ‘ClickHome.JobFile.UserId’ and ‘ClickHome.JobFile.Password’ are the credentials of the whole Builder Company, not a single user.

 ** To insert 'NOJobFIle'  against a resource go to: Administration > Resources > Select a Resource > Click on Detail. In the details page go to the field 'JobFile ID' and insert 'NOJobFile'

ClickHome 2

1. Apply same steps as as above (ClickHome 3) except the below information needs to be entered in the database instead of the user interface;
   Configure in tblValidationEntries:
   a. ClickHome.ClickHomeLive.ServerUrl
   b. ClickHome.ClickHomeLive.ServerUserName
   c. ClickHome.ClickHomeLive.ServerPassword
2. See below link in FogBugz or instructions beneath if link doesn't work.

http://apps.imagemation.com/FogBugz/default.asp?W512

OR;

Support for ClickHome2 JobFile Connector - Installing JobFile

*This document will work the user through how to install the JobFile system for the first time.

1. Find the export marker;

The Export marker is used by JobFile to determine which item in the Export Queue needs to be exported next. To find out where Jobfile needs to start this export you’ll need to run the SQL query found below. Begin scrolling through the table until you find the point in which the bProcessed is no longer 1 and becomes zero. This is the point in which the export queue has been processed.

select * from tblExportQueue order by idExportQueue

Grab the number in the idExportQueue of the first row to have a bProcessed value of 0.

Now we must enter the marker into the tblvalidationentries table. Run the script below inserting the desired Export Marker discovered previously.

insert into tblValidationEntries (cdValidCode,sgDisplay,sgvalue,inOrder,fkidOther,bStdActive,inStdCustomOrder)

values ('SETTINGS','JobFile.ExportQueue.Marker','AUTO',100,/*Insert Export Marker*/,1,100)

Search the database for the the following stored procedure, prcUpdValidationEntries.

The next on the SQL server is to check that the validation entry we added earlier is actually appearing in the required view.  (select * from ViewValidationEntries where sgDisplay like 'jobfile%')

Should find the record we entered, if this doesn’t then there’s an issue with the row we entered earlier.

2. Add the prcGetExportQueueByMarker procedure, use the following script to add this procedure;

CREATE PROCEDURE [dbo].[prcGetExportQueueByMarker] (@idExportQueueMarker INT)         

AS         

 /* SET NOCOUNT ON */         

 SELECT *         

 FROM   dbo.tblExportQueue         

 WHERE  idExportQueue > @idExportQueueMarker         

 --  WHERE idExportQueue=136973         

ORDER  BY idExportQueue ASC         

RETURN

GO

GRANT EXECUTE ON [dbo].[prcGetExportQueueByMarker] TO [SiteManager]

GO

3. Download and install the Jobfile Connector via the ftp site: 

ftp://mail.imagemation.com.au/ClickHomeReleases/JobFile 

Download both the exe and msi to a folder on the application server and run the setup.exe. This will install the Jobfile service on the Application server and from here we must configure JobfileCH2Connector.exe.config file to point to the Companies SQL Server.

There are two spots in this config file you need to change. The location of the server needs to be inserted after the first instance of the word (Data Source) and the database name needs to be inserted after the first instance of the word (Initial Catalog). You can use the ctrl + f function in notepad to find these locations

Once this has been completed you can start the service. Check the Event Viewer under application to see if there’s any error logs.

4. Finally, take the value and insert into the following statement;

insert into tblValidationEntries (cdValidCode,sgDisplay,sgvalue,inOrder,sgText1 ,bStdActive,inStdCustomOrder)

values ('SETTINGS','ClickHome.ClickHomeLive.Enabled','-',100,'TRUE',1,100)

insert into tblValidationEntries (cdValidCode,sgDisplay,sgvalue,inOrder,sgText1 ,bStdActive,inStdCustomOrder)

values ('SETTINGS','ClickHome.ClickHomeLive.ServerPassword','-',100,'password',1,100)

insert into tblValidationEntries (cdValidCode,sgDisplay,sgvalue,inOrder,sgText1 ,bStdActive,inStdCustomOrder)

values ('SETTINGS','ClickHome.ClickHomeLive.ServerUserName','-',100,'Client Name',1,100)

insert into tblValidationEntries (cdValidCode,sgDisplay,sgvalue,inOrder,sgText1 ,bStdActive,inStdCustomOrder)

values ('SETTINGS','ClickHome.ClickHomeLive.TimeOut','-',100,'60',1,100)

insert into tblValidationEntries (cdValidCode,sgDisplay,sgvalue,inOrder,bStdActive,inStdCustomOrder)

values ('SUPSETTING','Clickhome Live ID','CHLIVEID',100,1,100)

GO

Grabbing exportqueue for jobs started last month:

declare @idcontract nvarchar (100)

select top 1  @idcontract=idcontract from tblcontracts where dtdatestartschedule > '2013-01-24' order by idcontract

set @idcontract = '%<idcontract>'+@idcontract +'%'

print @idcontract

select top 1 *,idexportqueue from tblexportqueue where sgdata like @idcontract