OD-17266 Add Kronos integration on client and server

client-html/src/js/containers/automation/containers/integrations/IntegrationTypes.tsx

@@ -21,6 +21,7 @@ import usi from "../../../../../images/usi.png";
 import tsci from "../../../../../images/vet_student_loans.png";
 import googleclassroom from "../../../../../images/google_classroom.png";
 import coassemble from "../../../../../images/coassemble.png";
+import kronos from "../../../../../images/kronos.png";
 import talentlms from "../../../../../images/talentlms.png";
 import learndash from "../../../../../images/learndash.png";
 import amazons3 from "../../../../../images/amazons3.png";
@@ -39,6 +40,7 @@ import { UsiForm } from "./components/forms/UsiForm";
 import { VetStudentLoansForm } from "./components/forms/VetStudentLoansForm";
 import { GoogleClassroomForm } from "./components/forms/GoogleClassroomForm";
 import { CoassembleForm } from "./components/forms/CoassembleForm";
+import { KronosForm } from "./components/forms/KronosForm";
 import { TalentLMSForm } from "./components/forms/TalentLMSForm";
 import { LearnDashForm } from "./components/forms/LearnDashForm";
 import { AmazonS3Form } from "./components/forms/AmazonS3Form";
@@ -195,7 +197,14 @@ const types: IntegrationTypesModel = {
         </a>
       </span>
     )
-  }
+  },
+  19: {
+    name: "Kronos",
+    form: KronosForm,
+    image: kronos,
+    description:
+      "Test discription KRONOS"
+  },
 };
 
 export default types;

client-html/src/js/containers/automation/containers/integrations/components/forms/KronosForm.tsx

@@ -0,0 +1,57 @@
+/*
+ * Copyright ish group pty ltd. All rights reserved. https://www.ish.com.au
+ * No copying or use of this code is allowed without permission in writing from ish.
+ */
+
+import * as React from "react";
+import { getFormValues, initialize, reduxForm } from "redux-form";
+import { connect } from "react-redux";
+import FormField from "../../../../../../common/components/form/formFields/FormField";
+import RouteChangeConfirm from "../../../../../../common/components/dialog/confirm/RouteChangeConfirm";
+import { onSubmitFail } from "../../../../../../common/utils/highlightFormClassErrors";
+import { State } from "../../../../../../reducers/state";
+
+class KronosBaseForm extends React.Component<any, any> {
+  constructor(props) {
+    super(props);
+
+    // Initializing form with values
+    props.dispatch(initialize("KronosForm", props.item));
+  }
+
+  componentDidUpdate(prevProps) {
+    if (prevProps.item.id !== this.props.item.id) {
+      // Reinitializing form with values
+      this.props.dispatch(initialize("KronosForm", this.props.item));
+    }
+  }
+
+  render() {
+    const {
+      handleSubmit, onSubmit, AppBarContent, dirty, form
+    } = this.props;
+
+    return (
+      <form onSubmit={handleSubmit(onSubmit)}>
+        {dirty && <RouteChangeConfirm form={form} when={dirty} />}
+        <AppBarContent>
+          <FormField name="fields.username" label="Username" type="text" className="mb-2" />
+          <FormField name="fields.password" label="Password" type="text" className="mb-2" />
+          <FormField name="fields.apiKey" label="API key" type="text" className="mb-2" />
+          <FormField name="fields.companyShortName" label="Company short name" type="text" className="mb-2" />
+          <FormField name="fields.CID" label="Company Id" type="text" className="mb-2" />
+        </AppBarContent>
+      </form>
+    );
+  }
+}
+
+const mapStateToProps = (state: State) => ({
+  values: getFormValues("KronosForm")(state)
+});
+
+export const KronosForm = reduxForm({
+  form: "KronosForm",
+  onSubmitFail
+})(connect<any, any, any>(mapStateToProps, null)(KronosBaseForm));
+

client-html/src/js/model/automation/integrations/IntegrationSchema.ts

@@ -11,7 +11,9 @@ import {
   SurveyMonkeyFields,
   XeroFields,
   AmazonS3Fields,
-  AzureFields, ServiceNSWFields
+  AzureFields,
+  ServiceNSWFields,
+  KronosFields
 } from "./IntegrationsFields";
 
 export interface IntegrationSchema {
@@ -36,6 +38,7 @@ export interface IntegrationSchema {
     | AmazonS3Fields
     | AzureFields
     | ServiceNSWFields
+    | KronosFields
 }
 
 export interface IntegrationTypeSchema {

client-html/src/js/model/automation/integrations/IntegrationsFields.ts

@@ -94,3 +94,11 @@ export interface ServiceNSWFields {
   programme: string;
   apiKey: string;
 }
+
+export interface KronosFields {
+  username: string;
+  password: string;
+  apiKey: string;
+  companyShortName: string;
+  CID: string;
+}

server-api/src/main/resources/def/enum/IntegrationType.yaml

@@ -16,3 +16,4 @@ enum:
   - coassemble
   - talentlms
   - learndash
+  - kronos

server/src/main/groovy/ish/oncourse/server/integration/kronos/KronosIntegration.groovy

@@ -0,0 +1,149 @@
+/*
+ * Copyright ish group pty ltd 2022.
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+ *
+ *  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+ */
+
+package ish.oncourse.server.integration.kronos
+
+import groovy.transform.CompileDynamic
+import groovyx.net.http.ContentType
+import groovyx.net.http.Method
+import groovyx.net.http.RESTClient
+import ish.oncourse.server.integration.Plugin
+import ish.oncourse.server.integration.PluginTrait
+
+@CompileDynamic
+@Plugin(type = 19)
+class KronosIntegration implements PluginTrait {
+    public static final String KRONOS_USERNAME_KEY = "username"
+    public static final String KRONOS_PASSWORD_KEY = "password"
+    public static final String KRONOS_API_KEY = "apiKey"
+    public static final String KRONOS_COMPANY_SHORT_NAME_KEY = "companyShortName"
+    public static final String KRONOS_CID_KEY = "CID"
+
+    public static final String KRONOS_REST_URL = "https://secure.workforceready.com.au"
+    public static final int HTTP_NOT_FOUND = 404
+    /**
+     * Error codes from https://secure.workforceready.com.au/ta/docs/rest/pages/errorCodes.html
+     */
+    public static final int ACCOUNT_NOT_FOUND_CODE = 10002
+
+    String username
+    String password
+    String apiKey
+    String companyShortName
+    String CID
+    String authToken
+
+    KronosIntegration(Map args) {
+        loadConfig(args)
+
+        this.username = configuration.getIntegrationProperty(KRONOS_USERNAME_KEY).value
+        this.password= configuration.getIntegrationProperty(KRONOS_PASSWORD_KEY).value
+        this.apiKey = configuration.getIntegrationProperty(KRONOS_API_KEY).value
+        this.companyShortName = configuration.getIntegrationProperty(KRONOS_COMPANY_SHORT_NAME_KEY).value
+        this.CID = configuration.getIntegrationProperty(KRONOS_CID_KEY).value
+    }
+
+    /**
+     * Auth header will need to be generated every hour or so. So only call this function if you have a very long running script
+     * using this KronosIntegration object
+     *
+     * @return the access token for used as Bearer authentication
+     */
+    def initAuthHeader() {
+        def client = new RESTClient(KRONOS_REST_URL)
+        client.headers["Api-Key"] = apiKey
+        def result = client.request(Method.POST, ContentType.JSON) {
+            uri.path = "/ta/rest/v1/login"
+            body = [
+                    credentials: [
+                        username: username,
+                        password: password,
+                        company: companyShortName,
+                    ]
+            ]
+            response.success = { resp, result ->
+                authToken = result["token"]
+            }
+            response.failure = { resp, result ->
+                throw new IllegalStateException("Failed to get access token  ${resp.getStatusLine()}")
+            }
+        }
+
+        return result
+    }
+
+    /**
+     * Return only those employees who the authenticated user can see.
+     * The list of returned fields depends on security and company settings.
+     * Employees from Kronos via API v1
+     *
+     * @return employees
+     */
+    protected getAllEmployeesV1() {
+        def client = new RESTClient(KRONOS_REST_URL)
+        client.headers["Authentication"] = "Bearer ${authToken}"
+        client.request(Method.GET) {
+            uri.path = "/ta/rest/v1/employees/"
+
+            response.success = { resp, result ->
+                return result
+            }
+            response.failure = { resp, result ->
+                throw new IllegalStateException("Failed  ${resp.getStatusLine()}")
+            }
+        }
+    }
+
+    /**
+     * Returns basic information about the employees a user has permissions to view,
+     * together with links to APIs that provide detailed information about each employee.
+     * Employees from Kronos via API v2
+     *
+     * @return employees
+     */
+    protected getAllEmployeesV2() {
+        def client = new RESTClient(KRONOS_REST_URL)
+        client.headers["Authentication"] = "Bearer ${authToken}"
+        client.request(Method.GET) {
+            uri.path = "/ta/rest/v2/companies/${CID}/employees"
+
+            response.success = { resp, result ->
+                return result
+            }
+            response.failure = { resp, result ->
+                throw new IllegalStateException("Failed  ${resp.getStatusLine()}")
+            }
+        }
+    }
+
+    /**
+     * Returns the core Employee record containing the bulk of the information about employee.
+     * Additionally the response contains links to additional APIs to return additional related data such as Pay Information or Demographics.
+     * Employee from Kronos via API v2
+     *
+     * @return employee
+     */
+    protected getEmployee(id) {
+        def client = new RESTClient(KRONOS_REST_URL)
+        client.headers["Authentication"] = "Bearer ${authToken}"
+        client.request(Method.GET) {
+            uri.path = "/ta/rest/v2/companies/${CID}/employees/${id}"
+
+            response.success = { resp, result ->
+                return result
+            }
+            response.failure = { resp, result ->
+                if (resp.getProperties()["status"] == HTTP_NOT_FOUND && result?.errors?.code?.get(0) == ACCOUNT_NOT_FOUND_CODE) {
+                    return null
+                } else {
+                    throw new IllegalStateException("Failed to get employee with id ${id} ${resp.getStatusLine()}")
+                }
+            }
+        }
+    }
+}

server/src/main/groovy/ish/oncourse/server/integration/kronos/KronosScriptClosure.groovy

@@ -0,0 +1,34 @@
+/*
+ * Copyright ish group pty ltd 2022.
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+ *
+ *  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+ */
+
+package ish.oncourse.server.integration.kronos
+
+import groovy.transform.CompileStatic
+import ish.oncourse.API
+import ish.oncourse.server.scripting.ScriptClosure
+import ish.oncourse.server.scripting.ScriptClosureTrait
+
+@API
+@CompileStatic
+@ScriptClosure(key = "kronos", integration = KronosIntegration)
+class KronosScriptClosure implements ScriptClosureTrait<KronosIntegration> {
+
+
+    @Override
+    Object execute(KronosIntegration integration) {
+        integration.initAuthHeader()
+
+        def employeesV1 = integration.getAllEmployeesV1()
+        def employeesV2 = integration.getAllEmployeesV2()
+
+        def employee = integration.getEmployee(29065659)
+        def employeeNotFound = integration.getEmployee(29065659111)
+
+        return null
+    }
+}