...
...
...
Overview:
JobFile provides a way for suppliers & contractors to update their status of a task (accept, reject, started, completed etc.).
It is the suppliers system which ClickHome merely links to JobFile in order to push the information through and receive it back.
For the purpose of this document a supplier/contractor will be referred to as a ‘resource’.
Workflow:
On scheduling a task from ClickHome (if JobFile is chosen as a way for the assigned resource to confirm the task) an email is created which includes a URL link to JobFile, the . The resource can click on this link and accept, reject or propose an alternate date for the task.
Replies from the resources are then automatically downloaded from JobFile (standard is every 30 minutes) when it runs and sent back to ClickHome.
Settings:
1. Create a JobFile account
(theseThese account details will be used to setup the link between ClickHome and JobFile, JobFile is not the system for builders to use, ClickHome is).
Go to: http://jobfilepublictestap-env.elasticbeanstalk.com/Registration;
Enter the following;
Company Name;
- Company Type "(Builder");
Contact Name;
Email Address;
Password
Confirm Password NOTE: Password (the password cannot be ‘password’ and must be at least 6 characters);
Click next
Accept the terms in the license agreement, then click confirm;
An email will be sent to that the registered email address, you will need to verify the email address using the link in the email;
NOTE: No email will be sent to you in the test environment as emails are setup to go to JobFile Support. Please wait for a JobFile Team member to forward you the email.Once this has been done you can apply you have verified the email address contact JobFile support and request them to manually upgrade your builders account to a paid account. Then you can apply the correct settings in ClickHome as per the next step.
2. Configure Settings in ClickHome
- JobFile for all resources;In the navigation panel on the left hand side go to;
Administration > System Configuration > Configuration and System Settings;
In the configuration and system settings page go to the column ‘Display’;
Apply a filter to this column on: 'Show rows with value that ‘Contains’' and enter; 'JobFile' in the text field below;
Click ‘Filter’.
f. When the filtered results appear there will be 5 rows to edit;
g. Edit the information in the column ‘Text 1’ of each row as per the following:
ClickHome.JobFile.WebServiceURL: http://api.jobfile.com.au/jobfileapi/v0 NOTE: ensure there are no spaces before or after these links once pasted into ClickHome
ClickHome.JobFile.UserId: email address you created for the JobFile Account;
ClickHome.JobFile.Password: password used for the JobFile Account;
NOTE: ‘ClickHome.JobFile.UserId’ and ‘ClickHome.JobFile.Password’ are the credentials of the whole Building Company, not just a single user.ClickHome.JobFile.JobFileQueueId: enter '0'. As long as this is done BEFORE turning on JobFile then this value will update with maximum value from idExportQueue in tblExportQueues in JobFile.
ClickHome.JobFile.RegisterMode: 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.
cdValidCode
sgDisplay
sgText1
SETTINGS
ClickHome.JobFile.WebServiceURL
If using version 32 or below http://api.jobfile.com.au/jobfileapi/v0
If using version 33 or above http://api1.jobfile.com.au/api
NOTE: ensure there are no spaces before or after these links once pasted into ClickHome
SETTINGS
ClickHome.JobFile.UserId
*[email address used to set up JobFile account]
SETTINGS
ClickHome.JobFile.Password
*[password used to set up JobFile account]
ClickHome.JobFile.JobFileQueueId
Version 33 and above ONLY
0 = nothing
* ‘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'
h. Save and setup will be complete
3. Test call up email - JobFile URL link for a resource:
Log into ClickHome as a Supervisor
Open a contract and then a construction task
In the Call Sheet, assign a task to a Resource (preferably one that you can contact to confirm the link is working)
Click ‘Save’
On receiving the email, the resource will click on the link and then be redirected to the below page where they can accept, reject or propose an alternate date for the task depending on the settings applied by the builder. Then the resource will be able to register for free which will allow them to log in to JobFile, manage their tasks and access a variety of features or they can simply continue to receive the call up emails one at a time without registering. (For more information about resource access to JobFile please see the JobFile Registered Supplier Guide)
4. Setup JobFile options for resources:
JobFile allows the 'Job Owners' (builders) to predetermine some of the options that their resources have when accepting tasks.
a. Acceptance Permissions
Log into JobFile and go to:
Admin > Options > Relationships
This page is separated into 3 types of user accounts;
- Anonymous = resources with no registered account in JobFile
- Login = resources registered in JobFile
- Own = Job Owners that are assigning themselves work (non ClickHome Users)
Under the first 2 user types (anonymous and login) check the settings on the right hand side (Yes/No) for each of the following (these settings will be applied to all tasks that are scheduled to a resource from ClickHome. This means, in JobFile the resource will or will not be able to do the following depending on the settings applied):
- The Resource can reject a task
- The Resource can propose an alternate date for a task
- The Resource can select a booked in date
When you are finished click 'Save'.
b. Reasons
Recording a Job Not Ready, Proposing an Alternate Date & Rejecting a task are all actions that the resource will take when working on a task.
As the Job Owner you can determine the reasons for the resource to choose from.
To do this;
1. Log into JobFile and go to; Admin > Options > Lists
There are 3 lists:
1. Job Not Ready Reasons
2. Propose Alternate Date Reasons
3. Reject Reasons
There may be default reasons inserted however you can edit or remove these and add your own or you can leave them as they are.
Click on 'Edit' then enter a new entry and click 'Save.
You must create at least one (1) entry for each list otherwise that function will not work for the resource.
5. Upload Logo for JobFile call ups:
In the JobFile account details page you can upload your company logo to your account to ensure that it appears on the resources tasks (in top left hand corner as per above example).
1. Go to; Admin > Account > Details
2. Click on the attach button (paperclip icon)
3. In the popup window click Attach
4. Using the windows browser navigate to your logo and then click Open.
5. Your logo will be added as per below
;
Enter the below information via the backend in tblValidationEntries > sgText1:
ClickHome.ClickHomeLive.ServerUserName: email address used to set up JobFile account
ClickHome.ClickHomeLive.ServerPassword: password used to set up JobFile account
JobFile.ExportQueue.Marker see below for how to obtain these
Query: select * from tblExportQueue order by idExportQueue desc
Grab the number in the idExportQueue of the first row. Now enter this number as the marker into tblValidationEntries by running the script below inserting the number in *Insert Export Marker*.
Script:
insert into tblValidationEntries (cdValidCode,sgDisplay,sgvalue,inOrder,fkidOther,bStdActive,inStdCustomOrder)
values ('SETTINGS','JobFile.ExportQueue.Marker','AUTO',100,/*Insert Export Marker*/,1,100)If prcGetExportQueueByMarker procedure does not exist use the following script to add this to your database.
Script:
CREATE PROCEDURE [dbo].[prcGetExportQueueByMarker] (@idExportQueueMarker INT)
AS
/* SET NOCOUNT ON */
SELECT *
FROM dbo.tblExportQueue
WHERE idExportQueue > @idExportQueueMarker
ORDER BY idExportQueue ASC
RETURN
GO
GRANT EXECUTE ON [dbo].[prcGetExportQueueByMarker] TO [SiteManager]
GO
The next step is to download and install the JobFile Connector via: https://drive.google.com/file/d/0BzFoAfjAJGPObHNsZ2E3TkJIWUU/view?usp=sharing
Using the windows service create command (SCCreate) create the JobFile Connector Service.
Copy your ClickHome.lic file from your ClickHome win service into the JobFile connector Service.
Modify the connection strings config file and ensure it points to your ClickHome SQL Server Instance.
Modify the JobfileCH2Connector.exe.config file to ensure all settings point to your ClickHome SQL Server Instance where required. If you're not sure then look at your ClickHome win service config file for these settings.
Modify the app settings keys in the file to suit your requirements but you must change the <add key="url" value to: http://jobfilepublictstapi-env.elasticbeanstalk.com/V0.
Depending upon your site consider any proxy or firewall settings that need to be altered to allow the url to be accessed.
Once this has been completed you can start the service. Then check the Event Viewer under application to see if there are any error logs.
- Configure Suppliers
- Login to your instance of ClickHome
- Go to Admin > Setup > JobFile Admin
- Click the 'Add' button in the far right hand column for each supplier that you would like to add to JobFile.
- Once a supplier is added to JobFile a JobFile id will be returned and from that point forward all tasks that are assigned to them and not completed will be sent to JobFile.
Note: if you would like to add all suppliers write a script to update the JobFile id field with 'JobFile'. (This is the same as clicking the add button for each individual supplier.)