HR Leave — ONE DAY ALL-IN-ONE

Use HRLXProLeaveUtilsV2, HRLXProSecurityUtilsV2, and u_* columns only — not legacy LeaveRequestUtil or duration_days.

How development objects relate

Application (HR Leave)
  └── Tables: employee_v2 ←── bal_v2
                 ↑              ↑
                 └── req_v2 ────┴── audit_v2
                       │
        ┌──────────────┼──────────────┐
        ▼              ▼              ▼
  Script Includes   Business Rules   Client Scripts
  LeaveUtilsV2  ←── BR1 days/approver
                ←── BR2/BR4 events
                ←── BR3 audit/balance
  SecurityUtils ←── ACLs (ch.02)
  LeaveUtils    ←── CS2 GlideAjax
                       │
        ┌──────────────┼──────────────┐
        ▼              ▼              ▼
   UI Policy/Action   Menu/Modules   Flow Approval
   (sick / Submit)    (navigator)    (Ask For Approval)

Part 1: Application Setup

Purpose

Creates the scoped HR Leave application container. All other OBJ artifacts belong to scope x_786686_hr_leave and app sys_id e5f5bc9493a303507520703efaba104d on the lab instance.

Navigation path

Direct URL

Prerequisites

• PDI or dev instance with admin + app_creator roles.
• Rule 0 Update Set can be created immediately after app exists.

Form fields

Step-by-step create

1. Open Studio.
2. Click Create Application.
3. Enter every field from the table. Scope must be x_786686_hr_leave.
4. Click Create. Studio opens HR Leave workspace.
5. Classic verify: Application record → Scope = x_786686_hr_leave.
6. Proceed to Rule 0 Update Set → HR Leave – Build → Make Current.

Verify checklist

• Application picker lists HR Leave.
• Scope prefix on new tables is x_786686_hr_leave_.
• Application Menu stub exists (modules added in Modules).

Demo / test

Part 2: Table — HR Employee (employee_v2)

Purpose

Stores HR employee profiles linked to platform users. BR1 reads u_manager to populate leave request approver.

Navigation path

Direct URL

Prerequisites

• Part 1: Application Setup Application HR Leave.
• Rule 0 Update Set current.

Table form fields (create the table first)

Where: Studio → Create Application File → Table · Direct: {BASE}/sys_db_object.do

Column form fields (each column New)

On Columns related list → New: set Column label, Type, Max length, Reference. Element name = code below.

Form Layout — x_786686_hr_leave_employee_v2

1. All → System Definition → Tables → open x_786686_hr_leave_employee_v2 (or Studio → Tables).
2. Related link Form Layout → New or edit default.
3. Drag fields into sections: Profile (u_user, u_employee_id, u_department, u_grade, u_join_date), Management (u_manager).
4. Save.

List Layout — x_786686_hr_leave_employee_v2

1. Same table record → related link List Layout.
2. Add columns (left to right): User, Employee ID, Department, Manager, Join Date, Grade.
3. Save → open list URL and confirm columns appear.

Step-by-step create

1. Studio → Create Application File → Table.
2. Label: HR Employee · Name: employee_v2 → full name x_786686_hr_leave_employee_v2.
3. Extends table: leave blank (standalone).
4. Submit table record.
5. For each column in the table above: Table → Columns related list → New:
   • Element = column name · Column label = friendly name · Type = as listed · Max length · Reference · Application = HR Leave.
6. Complete Form Layout and List Layout steps above.

Verify checklist

• List opens: employee_v2 list
• Dictionary: {BASE}/sys_dictionary_list.do?sysparm_query=name=x_786686_hr_leave_employee_v2^elementSTARTSWITHu_
• Six u_* columns under HR Leave application.

Demo / test

Part 3: Table — Leave Request (req_v2)

Purpose

Core leave request table. Business rules, Flow, catalog, portal, and REST all target this table.

Navigation path

Direct URL

Prerequisites

• Part 1: Application Setup Application.
• Part 2: Table employee_v2 (for u_employee_ref reference).

Table form fields (create the table first)

Where: Studio → Create Application File → Table · New table

Column form fields (each column New)

On Columns related list → New: set Column label, Type, Max length, Reference. Element name = code below.

Choice values — u_leave_type

Choice values — u_state

Form Layout — x_786686_hr_leave_req_v2

1. All → System Definition → Tables → open x_786686_hr_leave_req_v2 (or Studio → Tables).
2. Related link Form Layout → New or edit default.
3. Drag fields into sections: Request (u_number, u_requested_for_user, u_employee_ref, u_leave_type), Dates (u_start_date, u_end_date, u_days_count), Approval (u_approver_user, u_reason), Status (u_state).
4. Save.

List Layout — x_786686_hr_leave_req_v2

1. Same table record → related link List Layout.
2. Add columns (left to right): Number, Requested For, Leave Type, Start Date, End Date, Days, State, Approver.
3. Save → open list URL and confirm columns appear.

Step-by-step create

1. Studio → Create Application File → Table.
2. Label: Leave Request · Name: req_v2 → x_786686_hr_leave_req_v2.
3. Create all columns per field table. For Choice columns add values in Choice List related list.
4. Table record → Display field = u_number.
5. Dictionary: mark u_days_count read-only on form (optional dictionary flag).
6. Complete Form Layout and List Layout above.

Verify checklist

• Ten u_* columns exist.
• Choice fields show five states and three leave types.
• Reference picker on u_employee_ref shows employee_v2 rows.

Demo / test

Part 4: Table — Leave Balance (bal_v2)

Purpose

Tracks per-employee leave entitlement and usage by year and leave type. BR3 recalculates on approval.

Navigation path

Direct URL

Prerequisites

• Part 2: Table employee_v2.
• Part 20: System Properties property for default entitled days (can seed manually first).

Table form fields (create the table first)

Column form fields (each column New)

On Columns related list → New: set Column label, Type, Max length, Reference. Element name = code below.

Form Layout — x_786686_hr_leave_bal_v2

1. All → System Definition → Tables → open x_786686_hr_leave_bal_v2 (or Studio → Tables).
2. Related link Form Layout → New or edit default.
3. Drag fields into sections: Employee (u_employee_ref, u_year, u_leave_type), Balance (u_entitled, u_used, u_remaining).
4. Save.

List Layout — x_786686_hr_leave_bal_v2

1. Same table record → related link List Layout.
2. Add columns (left to right): Employee, Year, Leave Type, Entitled, Used, Remaining.
3. Save → open list URL and confirm columns appear.

Step-by-step create

1. Studio → Table → Name bal_v2.
2. Add six columns per table.
3. Reuse u_leave_type choice values from req_v2.
4. Form/List layouts per steps above.

Verify checklist

• bal_v2 list opens.
• Reference to employee_v2 works.

Demo / test

Part 5: Table — Leave Audit (audit_v2)

Purpose

Append-only audit trail for leave state changes. BR3 writes rows automatically.

Navigation path

Direct URL

Prerequisites

• Part 3: Table req_v2.

Table form fields (create the table first)

Column form fields (each column New)

On Columns related list → New: set Column label, Type, Max length, Reference. Element name = code below.

Form Layout — x_786686_hr_leave_audit_v2

1. All → System Definition → Tables → open x_786686_hr_leave_audit_v2 (or Studio → Tables).
2. Related link Form Layout → New or edit default.
3. Drag fields into sections: Audit (u_leave_ref, u_event_type, u_old_state, u_new_state, u_actor).
4. Save.

List Layout — x_786686_hr_leave_audit_v2

1. Same table record → related link List Layout.
2. Add columns (left to right): Leave Request, Old State, New State, Event Type, Actor, Created.
3. Save → open list URL and confirm columns appear.

Step-by-step create

1. Studio → Table → audit_v2.
2. Add five columns.
3. Layouts as above.

Verify checklist

• audit_v2 list opens.
• Reference to req_v2 works.

Demo / test

Part 6: Script Include — HRLXProLeaveUtilsV2

Purpose

Server-side utility for business-day calculation, approver resolution, audit writes, balance recalc, and GlideAjax for CS2.

Navigation path

Direct URL

Prerequisites

• Part 1: Application Setup.
• Tables Table HR Employee..05 exist.

Form fields

Extends AbstractAjaxProcessor for ajaxGetBusinessDays.

Step-by-step create

1. Studio → Script Include → New.
2. Fill form fields table.
3. Paste full script below into Script field.
4. Save — fix any syntax errors.

Full script (paste-ready)

/**
 * Script Include: HRLXProLeaveUtilsV2
 * Scope: x_786686_hr_leave
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Client callable: true  (extends AbstractAjaxProcessor)
 * Purpose: Leave calculations + helpers (business days, approver, balance, audit).
 *
 * Create in ServiceNow:
 *   Studio > Create Application File > Script Include
 *   Name: HRLXProLeaveUtilsV2
 *   Client callable: checked
 */
var HRLXProLeaveUtilsV2 = Class.create();
HRLXProLeaveUtilsV2.prototype = Object.extendsObject(global.AbstractAjaxProcessor, {

    /**
     * Count business days (Mon-Fri) inclusive between two date strings.
     * @param {string} startDate - 'yyyy-MM-dd'
     * @param {string} endDate   - 'yyyy-MM-dd'
     * @return {number}
     */
    calculateBusinessDays: function (startDate, endDate) {
        if (!startDate || !endDate) return 0;
        var start = new GlideDateTime(startDate + ' 00:00:00');
        var end = new GlideDateTime(endDate + ' 00:00:00');
        if (end.before(start)) return 0;

        var days = 0;
        var cursor = new GlideDateTime(start);
        while (!cursor.after(end)) {
            var dow = cursor.getDayOfWeekLocalTime(); // 1=Mon ... 7=Sun
            if (dow >= 1 && dow <= 5) days++;
            cursor.addDaysLocalTime(1);
        }
        return days;
    },

    /**
     * Resolve the approver (employee's manager) and set it on the record.
     * @param {GlideRecord} currentRecord - leave request record
     */
    setApproverFromEmployee: function (currentRecord) {
        var empId = currentRecord.getValue('u_employee_ref');
        if (!empId) return;
        var emp = new GlideRecord('x_786686_hr_leave_employee_v2');
        if (emp.get(empId) && emp.u_manager) {
            currentRecord.u_approver_user = emp.getValue('u_manager');
        }
    },

    /**
     * Write an audit row when the state changes.
     */
    auditStateChange: function (leaveSysId, oldState, newState, eventType) {
        var a = new GlideRecord('x_786686_hr_leave_audit_v2');
        a.initialize();
        a.u_leave_ref = leaveSysId;
        a.u_old_state = oldState || '';
        a.u_new_state = newState || '';
        a.u_event_type = eventType || 'state_change';
        a.u_actor = gs.getUserID();
        a.insert();
    },

    /**
     * Recalculate remaining balance for an employee/year.
     */
    recalculateBalance: function (employeeSysId, year) {
        var used = this._sumApprovedDays(employeeSysId, year);
        var bal = new GlideRecord('x_786686_hr_leave_bal_v2');
        bal.addQuery('u_employee_ref', employeeSysId);
        bal.addQuery('u_year', year);
        bal.query();
        if (bal.next()) {
            bal.u_used = used;
            bal.u_remaining = parseInt(bal.getValue('u_entitled') || 0, 10) - used;
            bal.update();
        }
    },

    _sumApprovedDays: function (employeeSysId, year) {
        var total = 0;
        var gr = new GlideAggregate('x_786686_hr_leave_req_v2');
        gr.addQuery('u_employee_ref', employeeSysId);
        gr.addQuery('u_state', 'approved');
        gr.addQuery('u_start_date', '>=', year + '-01-01');
        gr.addQuery('u_start_date', '<=', year + '-12-31');
        gr.addAggregate('SUM', 'u_days_count');
        gr.query();
        if (gr.next()) total = parseInt(gr.getAggregate('SUM', 'u_days_count') || 0, 10);
        return total;
    },

    /**
     * GlideAjax entry point for client-side day calculation.
     */
    ajaxGetBusinessDays: function () {
        return this.calculateBusinessDays(
            this.getParameter('sysparm_start'),
            this.getParameter('sysparm_end')
        );
    },

    type: 'HRLXProLeaveUtilsV2'
});

Verify checklist

• Active record under HR Leave.
• No compile error banner.
• Background test returns 5 for Mon–Fri range.

Demo / test

var util = new x_786686_hr_leave.HRLXProLeaveUtilsV2();
gs.info('Days: ' + util.calculateBusinessDays('2026-09-01', '2026-09-05'));

Part 7: Script Include — HRLXProSecurityUtilsV2

Purpose

Centralized read/write authorization logic consumed by table ACLs on req_v2.

Navigation path

Direct URL

Prerequisites

• Part 6: Script Include (same app scope).

Form fields

Step-by-step create

1. Studio → Script Include → New.
2. Name = HRLXProSecurityUtilsV2, Client callable = false.
3. Paste script below. Save.

Full script (paste-ready)

/**
 * Script Include: HRLXProSecurityUtilsV2
 * Scope: x_786686_hr_leave
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Client callable: false
 * Purpose: Centralized security checks used by ACLs.
 *
 * Used by ACL scripts, e.g.:
 *   answer = new x_786686_hr_leave.HRLXProSecurityUtilsV2().canReadLeave(current);
 */
var HRLXProSecurityUtilsV2 = Class.create();
HRLXProSecurityUtilsV2.prototype = {

    initialize: function () {
        this.userId = gs.getUserID();
    },

    /** HR admin can do anything. */
    isHrAdmin: function () {
        return gs.hasRole('x_786686_hr_leave.hr_admin');
    },

    /** Can the current user READ this leave request? */
    canReadLeave: function (current) {
        if (this.isHrAdmin()) return true;
        // owner
        if (current.getValue('u_requested_for_user') === this.userId) return true;
        // approver / manager
        if (current.getValue('u_approver_user') === this.userId) return true;
        // manager of the employee
        return this._isManagerOfEmployee(current.getValue('u_employee_ref'));
    },

    /** Can the current user WRITE this leave request? */
    canWriteLeave: function (current) {
        if (this.isHrAdmin()) return true;
        var state = current.getValue('u_state');
        // owner can edit only while draft/submitted
        if (current.getValue('u_requested_for_user') === this.userId) {
            return (state === 'draft' || state === 'submitted');
        }
        // approver can act when submitted
        if (current.getValue('u_approver_user') === this.userId) {
            return (state === 'submitted');
        }
        return false;
    },

    _isManagerOfEmployee: function (employeeSysId) {
        if (!employeeSysId) return false;
        var emp = new GlideRecord('x_786686_hr_leave_employee_v2');
        if (emp.get(employeeSysId)) {
            return emp.getValue('u_manager') === this.userId;
        }
        return false;
    },

    type: 'HRLXProSecurityUtilsV2'
};

Verify checklist

• Record active under HR Leave.
• Used by ACLs ACL scripts.

Demo / test

Part 8: Business Rule BR1 — Calculate Days

Purpose

Calculates u_days_count and sets u_approver_user from employee manager before save.

Navigation path

Direct URL

Prerequisites

• Part 3: Table req_v2.
• Part 6: Script Include HRLXProLeaveUtilsV2.

Form fields

Step-by-step create

1. Studio → Business Rule → New.
2. Fill every field from table. Check Advanced.
3. Paste script below into Script field.
4. Save. Confirm Active = true.

Full script (paste-ready)

/**
 * Business Rule: BR1 - Calculate Days + Approver
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Table:  x_786686_hr_leave_req_v2
 * When:   before
 * Insert: true   Update: true
 * Order:  100
 *
 * Calculates u_days_count and resolves the approver before saving.
 */
(function executeRule(current, previous /*null when inserting*/) {

    var util = new x_786686_hr_leave.HRLXProLeaveUtilsV2();

    if (current.u_start_date.changes() || current.u_end_date.changes() || current.isNewRecord()) {
        current.u_days_count = util.calculateBusinessDays(
            current.getValue('u_start_date'),
            current.getValue('u_end_date')
        );
    }

    if (current.u_employee_ref.changes() || current.isNewRecord()) {
        util.setApproverFromEmployee(current);
    }

})(current, previous);

Verify checklist

• BR order: 100, 200, 250, 300.
• All Active on req_v2 under HR Leave.

Demo / test

Part 9: Business Rule BR2 — On Submit Event

Purpose

Queues submitted event when u_state becomes submitted (notifications + Flow trigger).

Navigation path

Direct URL

Prerequisites

• Part 3: Table req_v2.
• Part 6: Script Include HRLXProLeaveUtilsV2.

Form fields

Step-by-step create

1. Studio → Business Rule → New.
2. Fill every field from table. Check Advanced.
3. Paste script below into Script field.
4. Save. Confirm Active = true.

Full script (paste-ready)

/**
 * Business Rule: BR2 - On Submit Fire Event
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Table:  x_786686_hr_leave_req_v2
 * When:   after
 * Update: true   Insert: true
 * Order:  200
 *
 * Fires an event when state becomes 'submitted' (drives notification / flow).
 */
(function executeRule(current, previous) {

    if (current.u_state.changesTo('submitted')) {
        gs.eventQueue(
            'x_786686_hr_leave.leave_v2.submitted',
            current,
            current.getValue('u_approver_user'),
            current.getValue('u_number')
        );
    }

})(current, previous);

Verify checklist

• BR order: 100, 200, 250, 300.
• All Active on req_v2 under HR Leave.

Demo / test

Part 10: Business Rule BR3 — Audit State Change

Purpose

Writes audit_v2 row on state change; recalculates balance on approval.

Navigation path

Direct URL

Prerequisites

• Part 3: Table req_v2.
• Part 6: Script Include HRLXProLeaveUtilsV2.

Form fields

Step-by-step create

1. Studio → Business Rule → New.
2. Fill every field from table. Check Advanced.
3. Paste script below into Script field.
4. Save. Confirm Active = true.

Full script (paste-ready)

/**
 * Business Rule: BR3 - Audit State Change + Balance
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Table:  x_786686_hr_leave_req_v2
 * When:   after
 * Update: true
 * Order:  300
 *
 * Writes an audit row on any state change and recalculates balance on approval.
 */
(function executeRule(current, previous) {

    if (!current.u_state.changes()) return;

    var util = new x_786686_hr_leave.HRLXProLeaveUtilsV2();
    util.auditStateChange(
        current.getUniqueValue(),
        previous ? previous.getValue('u_state') : '',
        current.getValue('u_state'),
        'state_change'
    );

    if (current.u_state.changesTo('approved') && current.u_employee_ref) {
        var year = new GlideDateTime(current.getValue('u_start_date')).getYearLocalTime();
        util.recalculateBalance(current.getValue('u_employee_ref'), year);
    }

})(current, previous);

Verify checklist

• BR order: 100, 200, 250, 300.
• All Active on req_v2 under HR Leave.

Demo / test

Part 11: Business Rule BR4 — Approve / Reject Event

Purpose

Queues approved/rejected events for notifications.

Navigation path

Direct URL

Prerequisites

• Part 3: Table req_v2.
• Part 6: Script Include HRLXProLeaveUtilsV2.

Form fields

Step-by-step create

1. Studio → Business Rule → New.
2. Fill every field from table. Check Advanced.
3. Paste script below into Script field.
4. Save. Confirm Active = true.

Full script (paste-ready)

/**
 * Business Rule: BR4 - Fire Approved / Rejected Events
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Table:  x_786686_hr_leave_req_v2
 * When:   after
 * Update: true
 * Insert: false
 * Order:  250
 *
 * Drives notifications for approved and rejected leave requests.
 * Requires events registered in Event Registry (see events.md).
 */
(function executeRule(current, previous) {

    if (current.u_state.changesTo('approved')) {
        gs.eventQueue(
            'x_786686_hr_leave.leave_v2.approved',
            current,
            current.getValue('u_requested_for_user'),
            current.getValue('u_number')
        );
    }

    if (current.u_state.changesTo('rejected')) {
        gs.eventQueue(
            'x_786686_hr_leave.leave_v2.rejected',
            current,
            current.getValue('u_requested_for_user'),
            current.getValue('u_number')
        );
    }

})(current, previous);

Verify checklist

• BR order: 100, 200, 250, 300.
• All Active on req_v2 under HR Leave.

Demo / test

Part 12: Client Script CS1 — Validate Dates

Purpose

Client-side validation: end date cannot precede start date on req_v2 form.

Navigation path

Direct URL

Prerequisites

• Part 3: Table req_v2 table/form.

Form fields

Step-by-step create

1. Studio → Client Script → New.
2. Fill fields. Type = onChange, Field = u_end_date.
3. Paste script. Save.

Full script (paste-ready)

/**
 * Client Script: CS1 - Validate Dates
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Table:  x_786686_hr_leave_req_v2
 * Type:   onChange
 * Field:  u_end_date
 *
 * Shows an error if end date is before start date.
 */
function onChange(control, oldValue, newValue, isLoading, isTemplate) {
    if (isLoading || newValue === '') return;

    var start = g_form.getValue('u_start_date');
    var end = g_form.getValue('u_end_date');
    if (!start || !end) return;

    if (end < start) {
        g_form.showFieldMsg('u_end_date', getMessage('End date cannot be before start date'), 'error');
        g_form.clearValue('u_end_date');
    } else {
        g_form.hideFieldMsg('u_end_date', true);
    }
}

Verify checklist

• Client script list shows Active on req_v2.

Demo / test

Part 13: Client Script CS2 — Calc Days (GlideAjax)

Purpose

Calls HRLXProLeaveUtilsV2.ajaxGetBusinessDays to preview u_days_count before save.

Navigation path

Direct URL

Prerequisites

• Part 6: Script Include client-callable Script Include.
• Part 12: Client Script CS1 can share u_end_date onChange.

Form fields

Step-by-step create

1. Create Client Script after Script Include HRLXProLeaveUtilsV2.
2. onChange on u_end_date — same field as CS1 (both execute).
3. Paste script. Save.

Full script (paste-ready)

/**
 * Client Script: CS2 - Calculate Days (GlideAjax)
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Table:  x_786686_hr_leave_req_v2
 * Type:   onChange
 * Field:  u_end_date
 *
 * Calls HRLXProLeaveUtilsV2.ajaxGetBusinessDays asynchronously to fill u_days_count.
 */
function onChange(control, oldValue, newValue, isLoading, isTemplate) {
    if (isLoading || newValue === '') return;

    var start = g_form.getValue('u_start_date');
    var end = g_form.getValue('u_end_date');
    if (!start || !end || end < start) return;

    var ga = new GlideAjax('x_786686_hr_leave.HRLXProLeaveUtilsV2');
    ga.addParam('sysparm_name', 'ajaxGetBusinessDays');
    ga.addParam('sysparm_start', start);
    ga.addParam('sysparm_end', end);
    ga.getXMLAnswer(function (answer) {
        if (answer !== null && answer !== '') {
            g_form.setValue('u_days_count', answer);
        }
    });
}

Verify checklist

• Browser dev tools → Network → GlideAjax to HRLXProLeaveUtilsV2.

Demo / test

Part 14: UI Policy — Sick Requires Reason

Purpose

When leave type is sick, makes u_reason mandatory on the req_v2 form.

Navigation path

Direct URL

Prerequisites

• Part 3: Table req_v2 with u_leave_type and u_reason.

Form fields

UI Policy Action (related list New)

Step-by-step create

1. Application = HR Leave.
2. All → System UI → UI Policies → New.
3. Fill policy fields. Condition builder: Leave Type is sick.
4. Submit policy.
5. Related list UI Policy Actions → New → u_reason mandatory true.
6. Save action. Verify policy Active.

Verify checklist

• Leave type Sick → red asterisk on Reason.
• Annual → Reason not mandatory.

Demo / test

Part 15: UI Action — Submit

Purpose

Form button that moves draft leave requests to submitted state (triggers BR2 and Flow).

Navigation path

Direct URL

Prerequisites

• Part 3: Table req_v2.
• Part 9: Business Rule BR2 BR2 for event.

Form fields

Step-by-step create

1. Studio → UI Action → New on req_v2.
2. Fill fields. Uncheck Client checkbox.
3. Paste server script below in Script field.
4. Save. Open draft req_v2 → Submit button visible.

Full script (paste-ready)

current.u_state = 'submitted';
current.update();
action.setRedirectURL(current);

Verify checklist

• Button only on draft records.
• After click state = submitted.

Demo / test

Part 24: Application Menu

Purpose

Top-level Application Navigator entry for HR Leave modules.

Navigation path

Direct URL

Prerequisites

• Part 1: Application Setup with Create application menu checked.

Form fields

Step-by-step create

1. If missing: Studio → Application Menu → New → fill fields.
2. Save. Confirm appears in Application Navigator.

Verify checklist

• Navigator shows HR Leave heading.

Demo / test

Part 25: Modules

Purpose

Four list modules linking to req_v2, employee_v2, bal_v2, audit_v2 tables.

Navigation path

Direct URL

Prerequisites

• Part 24: Application Menu menu. Tables Table HR Employee..05.

Form fields

Step-by-step create

1. Module → New for each row. Application Menu = HR Leave.
2. Type = List → Table = as listed. Order as table.
3. Roles: restrict Employees/Balances/Audit to hr_admin; Requests to all three roles.

Verify checklist

• Four modules under HR Leave menu.
• URLs x_786686_hr_leave_*_list.do open.

Demo / test

Part 27: Flow Designer — Leave Approval

Purpose

When leave state becomes submitted, sends approval to u_approver_user; on approve/reject updates u_state.

Navigation path

Direct URL

Prerequisites

• Part 3: Table req_v2 with u_state, u_approver_user.
• Part 8: Business Rule BR1 BR1 fills approver.
• manager1 user for approval tests.

Form fields — Create Flow wizard

Trigger — Record Updated

Action 1 — Ask For Approval

If Approved → Update Record

Else → Update Record

Step-by-step create

1. Flow Designer → Create Flow → Name HRLX Leave Approval, Application HR Leave.
2. Add trigger → Record Updated → table req_v2 → condition u_state is submitted + changes.
3. + → Ask for Approval → fill Action 1 table → Rules: Anyone approves → Done.
4. + → Flow Logic → If → condition "approval was Approved".
5. Yes branch → Update Record → u_state = approved.
6. Else branch → Update Record → u_state = rejected.
7. Save → fix any red errors (missing approval rule is common).
8. Test → pick sample submitted req_v2 → Run test.
9. Publish → Publish new version → wait for Published status.

Verify checklist

• Submitted req creates sysapproval_approver for manager.
• Approve → u_state approved → BR3 audit + BR4 event.
• Reject → u_state rejected.

Demo / test

Optional — CS1 on u_start_date

Duplicate CS1 logic on u_start_date onChange (same script body) so validation runs when the user changes start date after end date is set.

Development verify / demo checklist

1. Update Set — HR Leave – Build is current; Customer Updates shows new artifacts.
2. Tables — Four _v2 lists open; dictionary shows u_* columns only (Schema).
3. Script Includes — HRLXProLeaveUtilsV2 client-callable; Background script: new x_786686_hr_leave.HRLXProLeaveUtilsV2().calculateBusinessDays('2026-06-01','2026-06-05') → 5.
4. Business Rules — New req_v2 sets u_days_count and u_approver_user (BR1); submit fires event (BR2); approve writes audit + balance (BR3/BR4).
5. Client Scripts — End date before start shows error (CS1); valid range fills u_days_count via GlideAjax (CS2). Optional: duplicate CS2 on u_start_date onChange.
6. UI Policy — Sick → u_reason mandatory.
7. UI Action Submit — Draft → submitted visible only on draft.
8. Menu + Modules — HR Leave navigator shows four modules.
9. Flow — Submit → manager approval → approved/rejected.

Extended properties catalog: PROFESSIONAL_HR_CREATE_PROPERTIES_AND_LINKS.html · Master OBJ index: STUDIO_CREATE_ALL_OBJECTS_01_16.html

How administration objects relate

01 Development (tables, Script Includes, BR)
        │
        ▼
  Part 1 Roles (4 scoped roles)
        │
        ▼
  Part 2 Groups (grant roles to lab users)
        │
        ▼
  Part 3 Users (employee1, manager1, hradmin, integration)
        │
        ├──────────────────┐
        ▼                  ▼
  Part 4 ACLs          Part 5 System Properties (9 config keys)
  (read/write/create   (annual_days, notify, ERP endpoint…)
   on req_v2 via SI)
        │
        ▼
  Part 6 Update Set promotion (export to target)

Part 1: Roles

Purpose

Defines four scoped roles for employee self-service, manager approval, HR admin, and integration REST access.

Navigation path

Direct URL

Prerequisites

• Part 1: Application Setup (01 Development).
• Rule 0 Update Set current.

Form fields

Repeat for three more roles:

Step-by-step create

1. For each row: Studio → Role → New.
2. Name = scoped role name. Description as table. Application = HR Leave.
3. Submit. Repeat four times.

Verify checklist

• Four roles filtered by x_786686_hr_leave.

Demo / test

Part 2: Groups

Purpose

Assignment groups that grant scoped roles to lab users.

Navigation path

Direct URL

Prerequisites

• Part 1: Roles exist.

Form fields

Step-by-step create

1. Groups → New → Name from table.
2. Related list Group Roles → Edit → add scoped roles.
3. Related list Users → add members.
4. Repeat for all four groups.

Verify checklist

• User record → Roles related list shows inherited group roles.

Demo / test

Part 3: Users (lab matrix)

Purpose

Four lab users for E2E testing.

Navigation path

Direct URL

Prerequisites

• Part 2: Groups ready.

Form fields

Step-by-step create

1. Users → New for each row. Set password per instance policy.
2. Active = true. Email required for notifications (chapter 06).
3. Add to group via Groups related list.
4. Seed employee_v2: employee1 user, manager = manager1, Employee ID E-1001.

Verify checklist

• Impersonate each user successfully.
• employee_v2 links employee1 → manager1.

Demo / test

Part 4: ACLs

Purpose

Record and field ACLs enforce who can read, write, and create leave requests using HRLXProSecurityUtilsV2.

Navigation path

Direct URL

Prerequisites

• Part 7: HRLXProSecurityUtilsV2 (01).
• Part 1: Roles.
• Elevate security_admin.

Form fields

ACL 1 — read

ACL 2 — write

ACL 3 — create

ACL 4 — field write u_approver_user

Step-by-step create

1. Elevate security_admin. Application = HR Leave.
2. ACL → New for each table above. Active = true.
3. Paste scripts. Save all four.

Verify checklist

• employee1 sees own requests only.
• manager1 sees direct reports.
• hradmin sees all.
• employee1 direct URL to another user's record → denied.

Demo / test

Part 5: System Properties

Purpose

Scoped configuration — create all 9 properties from the professional catalog.

Navigation path

Direct URL

Prerequisites

• Part 1: Application Setup.

Form fields — create each row

On every property form: Application = HR Leave · Ignore cache = false · Private = false.

Step-by-step create

1. Application picker = HR Leave.
2. Open New property.
3. Fill Label, Name, Type, Value, Description from one row → Submit.
4. Repeat for all 9 rows.

Verify checklist

• Background: gs.info(gs.getProperty('x_786686_hr_leave.config.annual_days')); → 20.
• Nine properties visible in scoped list.

Demo / test

Part 6: Update Set Promotion

Purpose

Complete and export HR Leave – Build for target instance promotion.

Navigation path

Direct URL

Prerequisites

• All Parts 1–5 captured in HR Leave – Build.
• Rule 0 Update Set was current during creates.

Form fields

Step-by-step create

1. Complete local set — HR Leave – Build → State = Complete.
2. Export — Retrieved Update Sets → Import from source OR XML export.
3. Target instance — Import → Preview conflicts → Commit.
4. Post-import — Recreate users/groups if not in set; verify 9 properties; run accrual job once.
5. Smoke test — employee1 submit → manager1 approve → balance updated.

Verify checklist

• Customer Updates lists roles, ACLs, properties.
• No Global-scope rows in set.

Demo / test

Administration verify checklist

1. Four scoped roles exist under HR Leave.
2. Four groups with correct role assignments and lab users.
3. Four lab users impersonate successfully; employee_v2 seeded.
4. Four ACLs active; employee isolation verified.
5. Nine system properties readable via gs.getProperty.
6. Update Set Complete and ready for export.

How catalog objects relate

Part 1 Category (HR Leave)
        │
        ▼
Part 2 Record Producer → Part 3 Variables
        │
        ▼
Part 4 Producer script (maps variables → req_v2)
        │
        ▼
Part 5 Publish → Employee Center / Portal catalog
        │
        ▼
BR1 days + approver → BR2 event → Flow approval

Part 1: Catalog Category — HR Leave

Purpose

Groups the Submit Leave Request record producer under a dedicated HR Leave catalog category.

Navigation path

Direct URL

Prerequisites

• Part 1: Application Setup (01 Development).
• Rule 0 Update Set current.

Form fields

Step-by-step create

1. Service Catalog → Categories → New.
2. Fill Title, Description, Order from table. Active = true.
3. Submit. Note category sys_id for record producer.

Verify checklist

• Category HR Leave appears in category list.

Demo / test

Part 2: Record Producer — Submit Leave Request

Purpose

Service Catalog item that inserts submitted req_v2 from catalog variables.

Navigation path

Direct URL

Prerequisites

• Part 3: Table — Leave Request (01).
• Part 1: Roles employee role (02).
• Part 1: Catalog Category.

Form fields

Step-by-step create

1. Record Producers → New. Fill header fields from table.
2. Category = HR Leave. Table = req_v2. Roles = employee.
3. Save. Continue to Part 3 for variables and Part 4 for script.

Verify checklist

• Producer record saved under HR Leave application.

Demo / test

Part 3: Catalog Variables

Purpose

Four question variables mapped by the producer script to req_v2 u_* fields.

Navigation path

Direct URL

Prerequisites

• Part 2: Record Producer created.

Form fields — each variable New

Choice values for leave_type: annual, sick, personal (match req_v2 u_leave_type choices).

Step-by-step create

1. Open Submit Leave Request producer → Variables related list → New.
2. For each row: Name must match producer.* references in script. Set Label, Type, Mandatory.
3. Order: leave_type, start_date, end_date, reason.

Verify checklist

• Four variables on producer; names exactly leave_type, start_date, end_date, reason.

Demo / test

Part 4: Producer Script

Purpose

Server-side script maps catalog variables to req_v2 fields and sets state submitted. Source: src/catalog/RP_submit_leave.js.

Navigation path

Direct URL

Prerequisites

• Part 3: Catalog Variables.
• Part 8: BR1 calculates days on insert.

Step-by-step create

1. Open producer → Script tab.
2. Paste full script below.
3. Save.

Full script (paste-ready)

/**
 * Record Producer Script: Submit Leave Request
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Target table: x_786686_hr_leave_req_v2
 *
 * Maps producer variables to record fields. Runs server-side when submitted.
 * Variables expected: leave_type, start_date, end_date, reason
 */
(function () {

    current.u_requested_for_user = gs.getUserID();
    current.u_leave_type = producer.leave_type;
    current.u_start_date = producer.start_date;
    current.u_end_date = producer.end_date;
    current.u_reason = producer.reason;
    current.u_state = 'submitted';

    // Link to employee profile of the current user (if exists)
    var emp = new GlideRecord('x_786686_hr_leave_employee_v2');
    emp.addQuery('u_user', gs.getUserID());
    emp.query();
    if (emp.next()) {
        current.u_employee_ref = emp.getUniqueValue();
    }

    // BR1 will calculate days and set the approver on insert.

})();

Verify checklist

• Script saves without syntax errors.

Demo / test

Part 5: Publish and Test

Purpose

Publish catalog item and verify end-to-end submit from Employee Center.

Navigation path

Direct URL

Prerequisites

• Parts 1–4 complete.
• employee1 user with employee role and employee_v2 seeded.

Step-by-step create

1. Record Producer → Related Lists → Catalogs → add to HR Leave category.
2. Service Catalog → open producer → Publish.
3. Login as employee1 → Employee Center → HR Leave → Submit Leave Request.
4. Fill variables → Submit.
5. Verify req_v2 created in submitted state; u_days_count and u_approver_user set by BR1.
6. Verify Flow starts for manager1 approval.

Verify checklist

• Catalog item visible to employee role.
• Submit creates req_v2 in submitted state.
• sysapproval_approver row for manager1.

Demo / test

Service Catalog verify checklist

1. HR Leave category active.
2. Record Producer scoped to HR Leave with four variables.
3. Producer script from src/catalog/RP_submit_leave.js pasted.
4. Published and visible in Employee Center.
5. E2E submit creates submitted req_v2.

How portal objects relate

Portal (url_suffix hrlx)
  └── Page hrlx_home
        ├── Part 1 Widget hrlx_my_leaves (req_v2 list + cancel)
        └── Part 2 Widget hrlx_balance (bal_v2 cards)
Property x_786686_hr_leave.config.portal_page_id = hrlx_home

Part 1: Widget — hrlx_my_leaves

Purpose

Lists current user's leave requests with cancel action for draft/submitted rows.

Navigation path

Direct URL

Prerequisites

• Part 3: Table — Leave Request (01).
• Part 1: Roles employee (02).

Form fields

Step-by-step create

1. SP → Widgets → New → ID hrlx_my_leaves.
2. Paste HTML template, CSS, Client script, Server script from sections below.
3. Save.

Full script — hrlx_my_leaves HTML template

<div class="hrlx-my-leaves">
  <h3>My Leave Requests</h3>

  <table class="table table-striped" ng-if="data.leaves.length">
    <thead>
      <tr>
        <th>Number</th>
        <th>Type</th>
        <th>Start</th>
        <th>End</th>
        <th>Days</th>
        <th>State</th>
        <th></th>
      </tr>
    </thead>
    <tbody>
      <tr ng-repeat="item in data.leaves">
        <td>{{item.number}}</td>
        <td>{{item.type}}</td>
        <td>{{item.start}}</td>
        <td>{{item.end}}</td>
        <td>{{item.days}}</td>
        <td><span class="label label-default">{{item.state}}</span></td>
        <td>
          <button class="btn btn-xs btn-danger"
                  ng-if="item.state === 'submitted' || item.state === 'draft'"
                  ng-click="c.cancelLeave(item)">Cancel</button>
        </td>
      </tr>
    </tbody>
  </table>

  <p ng-if="!data.leaves.length" class="text-muted">No leave requests yet.</p>
</div>

Full script — hrlx_my_leaves CSS

.hrlx-my-leaves {
  padding: 16px;

  h3 {
    margin-top: 0;
    margin-bottom: 16px;
    font-weight: 600;
  }

  .label {
    text-transform: capitalize;
  }
}

Full script — hrlx_my_leaves Client script

/**
 * Widget: hrlx_my_leaves — Client Controller
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 */
function HrlxMyLeavesCtrl() {
    var c = this;

    c.cancelLeave = function (item) {
        if (!confirm('Cancel leave ' + item.number + '?')) return;
        c.data.action = 'cancel';
        c.data.sys_id = item.sys_id;
        c.server.update().then(function () {
            c.data.action = '';
            c.data.sys_id = '';
        });
    };
}

Full script — hrlx_my_leaves Server script

/**
 * Widget: hrlx_my_leaves — Server Script
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Shows the current user's leave requests (secure).
 */
(function () {
    data.leaves = [];

    var gr = new GlideRecordSecure('x_786686_hr_leave_req_v2');
    gr.addQuery('u_requested_for_user', gs.getUserID());
    gr.orderByDesc('sys_created_on');
    gr.setLimit(50);
    gr.query();

    while (gr.next()) {
        data.leaves.push({
            sys_id: gr.getUniqueValue(),
            number: gr.getValue('u_number'),
            type: gr.getDisplayValue('u_leave_type'),
            start: gr.getValue('u_start_date'),
            end: gr.getValue('u_end_date'),
            days: gr.getValue('u_days_count'),
            state: gr.getValue('u_state')
        });
    }

    // Cancel action from client
    if (input && input.action === 'cancel' && input.sys_id) {
        var c = new GlideRecord('x_786686_hr_leave_req_v2');
        if (c.get(input.sys_id) && c.getValue('u_requested_for_user') === gs.getUserID()) {
            c.u_state = 'cancelled';
            c.update();
        }
    }
})();

Verify checklist

• Widget saves. Preview shows table structure.

Demo / test

Part 2: Widget — hrlx_balance

Purpose

Read-only balance cards for current year from bal_v2.

Navigation path

Direct URL

Prerequisites

• Part 4: Table — Leave Balance (01).
• Part 1: Widget hrlx_my_leaves (same portal context).

Form fields

Step-by-step create

1. SP → Widgets → New → ID hrlx_balance.
2. Paste HTML, CSS, Client, Server from below.
3. Save.

Full script — hrlx_balance HTML template

<div class="hrlx-balance">
  <h3>Leave Balance {{data.year}}</h3>

  <div class="hrlx-cards" ng-if="data.balances.length">
    <div class="hrlx-card" ng-repeat="b in data.balances">
      <div class="hrlx-card-type">{{b.type}}</div>
      <div class="hrlx-card-remaining">{{b.remaining}}</div>
      <div class="hrlx-card-meta">used {{b.used}} / {{b.entitled}}</div>
    </div>
  </div>

  <p ng-if="!data.balances.length" class="text-muted">No balance records found.</p>
</div>

Full script — hrlx_balance CSS

.hrlx-balance {
  padding: 16px;

  h3 { margin-top: 0; font-weight: 600; }

  .hrlx-cards {
    display: flex;
    flex-wrap: wrap;
    gap: 12px;
  }

  .hrlx-card {
    flex: 1 1 120px;
    border: 1px solid #e0e0e0;
    border-radius: 8px;
    padding: 12px;
    text-align: center;
  }

  .hrlx-card-type { text-transform: capitalize; color: #707070; }
  .hrlx-card-remaining { font-size: 28px; font-weight: 700; }
  .hrlx-card-meta { font-size: 12px; color: #909090; }
}

Full script — hrlx_balance Client script

/**
 * Widget: hrlx_balance — Client Controller
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 */
function HrlxBalanceCtrl() {
    var c = this;
    // No client actions needed; data is read-only.
}

Full script — hrlx_balance Server script

/**
 * Widget: hrlx_balance — Server Script
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Shows the current user's remaining leave balance for the current year.
 */
(function () {
    data.balances = [];
    data.year = new GlideDateTime().getYearLocalTime();

    // find employee record of current user
    var emp = new GlideRecord('x_786686_hr_leave_employee_v2');
    emp.addQuery('u_user', gs.getUserID());
    emp.query();
    if (!emp.next()) return;

    var bal = new GlideRecordSecure('x_786686_hr_leave_bal_v2');
    bal.addQuery('u_employee_ref', emp.getUniqueValue());
    bal.addQuery('u_year', data.year);
    bal.query();
    while (bal.next()) {
        data.balances.push({
            type: bal.getDisplayValue('u_leave_type'),
            entitled: parseInt(bal.getValue('u_entitled') || 0, 10),
            used: parseInt(bal.getValue('u_used') || 0, 10),
            remaining: parseInt(bal.getValue('u_remaining') || 0, 10)
        });
    }
})();

Verify checklist

• Cards show entitled/used/remaining when bal_v2 seeded.

Demo / test

Part 3: Portal Page — hrlx_home

Purpose

HR Leave home page with balance widget on top and my leaves below.

Navigation path

Direct URL

Prerequisites

• Part 1 and Part 2 widgets exist.

Form fields — Portal (sp_portal)

Page (sp_page)

Step-by-step create

1. Portals → New OR configure dedicated portal url_suffix hrlx.
2. Pages → New → ID hrlx_home → drag hrlx_balance (top), hrlx_my_leaves (below) on 12-column layout.
3. Page security → role employee.
4. Set property x_786686_hr_leave.config.portal_page_id = hrlx_home (02 Administration Part 5).
5. Save. Open {BASE}/hrlx?id=hrlx_home as employee1.

Verify checklist

• employee1 sees own requests and balance.
• Cancel button works on draft/submitted.

Demo / test

Service Portal verify checklist

1. Two widgets scoped to HR Leave.
2. Page hrlx_home published with role restriction.
3. Portal URL opens for employee1.

How workspace objects relate

Part 1 Experience (HR Leave Workspace)
  ├── Part 2 Pages (My Requests, Team Approvals, Admin)
  ├── Part 3 Data resource → req_v2 table broker
  └── Part 4 List component + role bindings

Part 1: Create Experience — HR Leave Workspace

Purpose

Now Experience workspace container scoped to HR Leave application.

Navigation path

Direct URL

Prerequisites

• Part 3: Table — Leave Request (01).
• Roles from 02 Administration.

Form fields

Step-by-step create

1. UI Builder → Create experience → fill fields → Create.
2. Confirm Application = HR Leave in header.

Verify checklist

• Experience opens in UI Builder.

Demo / test

Part 2: Pages — My Requests, Team Approvals, Admin

Purpose

Three routed pages for employee, manager, and HR admin personas.

Navigation path

Prerequisites

• Part 1: Create Experience.

Form fields

Step-by-step create

1. Add page → Name My Requests → Route my-requests.
2. Repeat for Team Approvals and Admin pages.
3. Add navigation menu items linking each page (Part 4).

Verify checklist

• Three pages listed in experience.

Demo / test

Part 3: Data Resource — req_v2

Purpose

Table data broker feeding list components with req_v2 records.

Navigation path

Prerequisites

• Part 2: Pages.

Form fields — My Requests broker

Team Approvals broker

Step-by-step create

1. Data Resources → Create → Table → req_v2.
2. Set conditions per page persona.
3. Columns: Number, Leave Type, Start, End, Days, State.

Verify checklist

• Data resource preview returns rows for test user.

Demo / test

Part 4: Bind List + Role Restrictions

Purpose

Attach list components to data resources and publish workspace with role access.

Navigation path

Prerequisites

• Part 3: Data Resource.

Step-by-step create

1. My Requests page → drag List → bind My Leave Requests data resource.
2. Team Approvals page → List → team broker filter.
3. Admin page → Lists for employee_v2 and bal_v2 — hr_admin only.
4. Navigation: menu items with role restrictions per page.
5. Publish workspace → assign roles employee, manager, hr_admin.
6. Impersonate each test user → open workspace URL.

Verify checklist

• employee sees only own requests on My Requests.
• manager sees submitted items awaiting approval.
• hr_admin sees admin lists.

Demo / test

Workspace verify checklist

1. Experience published under HR Leave.
2. Three pages with correct role gates.
3. req_v2 list filtered per persona.

How events, notifications, and jobs relate

BR2 submit → Part 1 Event leave_v2.submitted → Part 2 Notification to approver
BR4 approve/reject → events approved/rejected → Part 2 Notifications to requester
Part 3 Scheduled Job → creates bal_v2 rows from property annual_days

Part 1: Event Registry

Purpose

Registers three scoped events queued by BR2/BR4 for notifications and monitoring.

Navigation path

Direct URL

Prerequisites

• Part 3: Table req_v2 table.

Form fields

Step-by-step create

1. Registry → New (three times).
2. Event name exactly as table. Table = Leave Request. Application = HR Leave. Active.

Verify checklist

• Submit req → System Logs → Events shows leave_v2.submitted.

Demo / test

Part 2: Notifications

Purpose

Three email notifications: submitted (to approver), approved/rejected (to requester).

Navigation path

Direct URL

Prerequisites

• Part 1: Events events.
• Part 9: Business Rule BR2 BR2, Part 11: Business Rule BR4 BR4.
• Users have email addresses.

Form fields

Notification 1 — Submitted

Notification 2 — Approved

Notification 3 — Rejected

Step-by-step create

1. Application = HR Leave. Notifications → New for each.
2. Tab When to send: Event is fired + event name.
3. Tab Who will receive: Users/Groups in fields → pick u_approver_user or u_requested_for_user.
4. Tab What it will contain: Subject + Message HTML with ${u_number}, ${u_start_date}, ${URI_REF}.
5. Submit each notification. Active = true.

Verify checklist

• Three active notifications on Leave Request table.
• Email log entry after submit/approve.

Demo / test

Part 3: Scheduled Job — Annual Accrual

Purpose

Creates missing bal_v2 rows for current year for every employee using property annual_days.

Navigation path

Direct URL

Prerequisites

• Part 2: Table employee_v2, Part 4: Table bal_v2, Part 5: System Properties property.

Form fields

Step-by-step create

1. Scheduled Script Execution → New.
2. Fill fields. Paste script below.
3. Save. Click Execute Now to test.

Full script (paste-ready)

/**
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Scheduled Job: Annual Leave Accrual
 * Run: yearly (e.g. Jan 1)
 *
 * Creates a fresh balance row per employee for the new year if missing.
 * Default entitlement is read from a property (fallback 21 annual days).
 */
(function annualAccrual() {

    var year = new GlideDateTime().getYearLocalTime();
    var annualEntitlement = parseInt(gs.getProperty('x_786686_hr_leave.config.annual_days', '21'), 10);

    var emp = new GlideRecord('x_786686_hr_leave_employee_v2');
    emp.query();

    var created = 0;
    while (emp.next()) {
        // skip if a balance for this year/type already exists
        var existing = new GlideRecord('x_786686_hr_leave_bal_v2');
        existing.addQuery('u_employee_ref', emp.getUniqueValue());
        existing.addQuery('u_year', year);
        existing.addQuery('u_leave_type', 'annual');
        existing.query();
        if (existing.hasNext()) continue;

        var bal = new GlideRecord('x_786686_hr_leave_bal_v2');
        bal.initialize();
        bal.u_employee_ref = emp.getUniqueValue();
        bal.u_year = year;
        bal.u_leave_type = 'annual';
        bal.u_entitled = annualEntitlement;
        bal.u_used = 0;
        bal.u_remaining = annualEntitlement;
        bal.insert();
        created++;
    }

    gs.info('[HRLX] Annual accrual ' + year + ' created ' + created + ' balance rows.');
})();

Verify checklist

• Execute Now creates bal_v2 per employee without duplicate year row.
• System log: [HRLX] Annual accrual message.

Demo / test

Notifications & Jobs verify checklist

1. Three events registered on req_v2.
2. Three email notifications active.
3. Accrual job creates balance rows without duplicates.

How reports and dashboards relate

Part 1: Report Wizard — Leave Requests by State

Purpose

Visual report grouping leave requests by state.

Navigation path

Direct URL

Prerequisites

• Part 3: Table — Leave Request with seeded mixed states.

Form fields — Report wizard

Step-by-step create

1. Reports → Create New → Table → req_v2.
2. Choose Bar or Pie → Group by u_state → Count.
3. Title: Leave Requests by State. Application HR Leave.
4. Run report → verify segments for draft/submitted/approved.

Verify checklist

• Report renders with correct counts.

Demo / test

Part 2: Dashboard + Widget

Purpose

HR Leave dashboard with embedded report widget.

Navigation path

Direct URL

Prerequisites

• Part 1: Report Wizard.

Form fields

Step-by-step create

1. Dashboards → New → Name HR Leave Dashboard.
2. Add widget → Report → select report from Part 1.
3. Share with roles hr_admin, manager. Save dashboard.

Verify checklist

• Dashboard widget displays report.

Demo / test

Reports verify checklist

1. Report scoped to HR Leave.
2. Dashboard shared with manager/hr_admin.

How ATF objects relate

Part 1: Test Suite — HRLX Leave Core

Purpose

Container suite for all HR Leave automated tests.

Navigation path

Direct URL

Prerequisites

• Part 1: Application Setup. ATF plugin active.

Form fields

Step-by-step create

1. Test Suite → New → fill fields.
2. After Parts 2–4: Related list Tests → Add all three tests.
3. Run Suite → all green.

Verify checklist

• Suite lists three tests.

Demo / test

Part 2: Test — BR1 Business Days (Server)

Purpose

Validates BR1 sets u_days_count = 5 for Mon–Fri range.

Navigation path

Prerequisites

• Part 8: BR1 active.

Form fields

Step-by-step create

1. ATF → Tests → New → Name: HRLX BR1 Days Calculation.
2. Step 1: Create a Record → Table req_v2 → u_start_date=2026-06-01, u_end_date=2026-06-05, u_state=draft.
3. Step 2: Run Server Side Script → assertion below.

Full script (assertion step)

(function(outputs, steps, stepResult, assertEqual) {
  var gr = new GlideRecord('x_786686_hr_leave_req_v2');
  gr.get(steps('Create a Record').record_id);
  assertEqual({ name: 'days', expected: '5', actual: gr.getValue('u_days_count') });
})(outputs, steps, stepResult, assertEqual);

Verify checklist

• Test passes on clean instance.

Demo / test

Part 3: Test — CS2 Form Days (Client)

Purpose

Client test: changing dates on form fills u_days_count via GlideAjax.

Navigation path

Prerequisites

• Part 13: CS2 active.

Form fields

Step-by-step create

1. New client test: HRLX CS2 Form Days.
2. Step: Open/New req_v2 form.
3. Step: Set Field Values u_start_date, u_end_date.
4. Step: Assert Field Value u_days_count equals 5.

Verify checklist

• Client test passes.

Demo / test

Part 4: Test — ACL Employee Isolation (Server)

Purpose

Impersonate employee1 → query returns only own req_v2 records.

Navigation path

Prerequisites

• Part 4: ACLs (02).

Form fields

Step-by-step create

1. Test: HRLX ACL Employee Isolation.
2. Step: Impersonate user employee1.
3. Step: Record Query req_v2 → assert count matches only own records.

Verify checklist

• Isolation test passes.

Demo / test

ATF verify checklist

1. Three tests in HRLX Leave Core suite.
2. Suite runs without failure.

How menu, modules, and flow relate

Part 1 Application Menu → Part 2 Modules (4 list links)
Submit (UI Action / Catalog) → Part 3 Flow → Approval → BR3/BR4

Part 1: Application Menu

Purpose

Top-level Application Navigator entry for HR Leave modules.

Navigation path

Direct URL

Prerequisites

• Part 1: Application Setup with Create application menu checked.

Form fields

Step-by-step create

1. If missing: Studio → Application Menu → New → fill fields.
2. Save. Confirm appears in Application Navigator.

Verify checklist

• Navigator shows HR Leave heading.

Demo / test

Part 2: Modules

Purpose

Four list modules linking to req_v2, employee_v2, bal_v2, audit_v2 tables.

Navigation path

Direct URL

Prerequisites

• Part 1: Application Menu menu. Tables Table HR Employee..05.

Form fields

Step-by-step create

1. Module → New for each row. Application Menu = HR Leave.
2. Type = List → Table = as listed. Order as table.
3. Roles: restrict Employees/Balances/Audit to hr_admin; Requests to all three roles.

Verify checklist

• Four modules under HR Leave menu.
• URLs x_786686_hr_leave_*_list.do open.

Demo / test

Part 3: Flow Designer — Leave Approval

Purpose

When leave state becomes submitted, sends approval to u_approver_user; on approve/reject updates u_state.

Navigation path

Direct URL

Prerequisites

• Part 3: Table req_v2 with u_state, u_approver_user.
• Part 8: Business Rule BR1 BR1 fills approver.
• manager1 user for approval tests.

Form fields — Create Flow wizard

Trigger — Record Updated

Action 1 — Ask For Approval

If Approved → Update Record

Else → Update Record

Step-by-step create

1. Flow Designer → Create Flow → Name HRLX Leave Approval, Application HR Leave.
2. Add trigger → Record Updated → table req_v2 → condition u_state is submitted + changes.
3. + → Ask for Approval → fill Action 1 table → Rules: Anyone approves → Done.
4. + → Flow Logic → If → condition "approval was Approved".
5. Yes branch → Update Record → u_state = approved.
6. Else branch → Update Record → u_state = rejected.
7. Save → fix any red errors (missing approval rule is common).
8. Test → pick sample submitted req_v2 → Run test.
9. Publish → Publish new version → wait for Published status.

Verify checklist

• Submitted req creates sysapproval_approver for manager.
• Approve → u_state approved → BR3 audit + BR4 event.
• Reject → u_state rejected.

Demo / test

Part 4: Professional Module Encyclopedias

Purpose

After HR Leave menu/flow works, use the professional implementer guides (same Part structure as 01 Development) for ITSM, CMDB, ITOM, ITAM, HRSD, CSM, FSM, SPM, GRC, SecOps, DevOps, App Engine — with direct URLs, properties, and navigator module publish steps.

Navigation path

Direct URL

Prerequisites

• Parts 1–3 complete for core HR Leave.

Related guides

• 00 Modules Index — hub + study order for all 12 modules
• ITSM · CMDB · ITOM · ITAM
• HRSD · CSM · FSM · SPM
• GRC · SecOps · DevOps · App Engine
• 12 Integration — Scripted REST after menu/flow works

Verify checklist

• Core app E2E works without optional modules.
• Modules Index opens and links resolve.

Demo / test

Modules verify checklist

1. HR Leave menu visible.
2. Four modules with correct roles.
3. Flow published and approving.

How implementation artifacts relate

Part 1: Seed Data

Purpose

Lab employee, manager link, and opening balance for E2E demos.

Navigation path

Prerequisites

• Chapters 01–02 complete (tables, users, properties).

Step-by-step create

1. Lookup sys_ids for employee1 and manager1 users.
2. Run background script below as admin, Application = HR Leave.
3. Verify employee_v2 and bal_v2 rows.

Full script (paste-ready)

(function () {
  var empUser = 'PASTE_EMPLOYEE1_SYS_ID';
  var mgrUser = 'PASTE_MANAGER1_SYS_ID';
  var emp = new GlideRecord('x_786686_hr_leave_employee_v2');
  emp.initialize();
  emp.u_user = empUser;
  emp.u_employee_id = 'E-1001';
  emp.u_department = 'People Ops';
  emp.u_manager = mgrUser;
  emp.u_join_date = '2024-01-15';
  emp.u_grade = 'G5';
  var empId = emp.insert();
  var bal = new GlideRecord('x_786686_hr_leave_bal_v2');
  bal.initialize();
  bal.u_employee_ref = empId;
  bal.u_year = 2026;
  bal.u_leave_type = 'annual';
  bal.u_entitled = parseInt(gs.getProperty('x_786686_hr_leave.config.annual_days', 20), 10);
  bal.u_used = 0;
  bal.u_remaining = bal.u_entitled;
  bal.insert();
  gs.info('Seeded employee=' + empId);
})();

Verify checklist

• employee_v2 links employee1 → manager1.
• bal_v2 year 2026 with entitled from property.

Demo / test

Part 2: E2E Demo Checklist

Purpose

Prove full leave lifecycle from draft/submit through approval, audit, balance, notifications, portal, REST.

Prerequisites

• Part 1: Seed Data.

Verify checklist

1. Update Set current — HR Leave – Build (Rule 0).
2. Seed employee — Part 2: employee_v2, Part 3: Users.
3. Seed balance — Part 4: bal_v2.
4. Create request — Part 3: req_v2 OR Part 2: Record Producer.
5. Submit — Part 15: UI Action, Part 9: BR2.
6. Flow approval — Part 3: Flow.
7. Audit — Part 10: BR3.
8. Balance — BR3 updates bal_v2.
9. Notification — Part 2: Notifications.
10. Security — Part 4: ACLs.
11. Portal — Part 3: hrlx_home.
12. REST — Part 4: REST Explorer.

Demo / test

Part 3: Update Set Export

Purpose

Complete and export HR Leave – Build for target instance promotion.

Navigation path

Direct URL

Form fields

Step-by-step create

1. HR Leave – Build → State = Complete.
2. Export via Retrieved Update Sets or XML per process.
3. Target: Import → Preview → Commit.
4. Post-import: users/groups if missing; verify 9 properties; run accrual job once.
5. Smoke test: employee1 submit → manager1 approve → balance updated.

Verify checklist

• Customer Updates lists all scoped artifacts.

Demo / test

Part 4: UAT Matrix

Purpose

Sign-off matrix for lab personas and expected outcomes.

Form fields — test matrix

Seed values: SCHEMA_AND_DATA.html

Verify checklist

• All four UAT rows pass.

Demo / test

Implementation verify checklist

1. Seed data present.
2. E2E checklist green.
3. Update Set exported.
4. UAT matrix signed.

How chapters map to Studio work

Part 1: Daily Workflow in Studio

Purpose

Repeatable steps every time you create or edit HR Leave artifacts.

Navigation path

Step-by-step create

1. Set Application picker to HR Leave (x_786686_hr_leave).
2. Set Local Update Set current (HR Leave – Build).
3. Open Studio → select HR Leave.
4. Create Application File → choose type (Table, Business Rule, Client Script, Script Include, …).
5. Fill every form field from the matching chapter Part section.
6. Paste script from embedded <pre> blocks or Scripts portal.
7. Save → open list/form URL → run Verify + Demo for that Part.

Verify checklist

• Customer Updates shows new artifact in HR Leave – Build.

Demo / test

Part 2: Object Type → Chapter Map (01–12)

Purpose

Quick lookup: which chapter documents each ServiceNow object type.

Verify checklist

• Every row links to a chapter with Part anchors (not OBJ).

Part 3: Scripts Portal

Purpose

Browse paste-ready scripts mirrored from HR_Leave_App/src/ on disk.

Navigation path

Direct URL

Step-by-step create

1. Open Scripts portal → find script by name (e.g. RP_submit_leave.js, annual_accrual.js).
2. Copy from HTML pre block OR open chapter Part Full script section.
3. Paste into Studio form Script field while Application = HR Leave.

Verify checklist

• Script saves without syntax errors in Studio.

Demo / test

Practice companion verify checklist

1. Workflow habit: picker + Update Set before every create.
2. Object table bookmarked.
3. Scripts portal used for paste source.

How integration objects relate

Part 1 HRLXProIntegrationUtilsV2 (SI)
  └── Part 2 REST API definition (hrlx_api_v2)
        └── Part 3 POST /leave resource script
              └── Part 4 REST Explorer test (201 + sys_id)

Part 1: Script Include — HRLXProIntegrationUtilsV2

Purpose

Inbound create + outbound ERP push helpers for REST integration.

Navigation path

Direct URL

Prerequisites

• Part 1: Roles integration role.
• Part 3: req_v2.

Form fields

Step-by-step create

1. Studio → Script Include → New → fill fields → paste script → Save.

Full script — HRLXProIntegrationUtilsV2

/**
 * Script Include: HRLXProIntegrationUtilsV2
 * Scope: x_786686_hr_leave
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Client callable: false
 * Purpose: Inbound create + Outbound push for leave integration.
 */
var HRLXProIntegrationUtilsV2 = Class.create();
HRLXProIntegrationUtilsV2.prototype = {

    initialize: function () {},

    /**
     * Inbound: create a leave request from a JSON payload (string).
     * @return {string} sys_id of created record
     */
    inboundCreateLeave: function (jsonString) {
        var data = {};
        try { data = JSON.parse(jsonString); } catch (e) { return ''; }

        var gr = new GlideRecord('x_786686_hr_leave_req_v2');
        gr.initialize();
        gr.u_employee_ref = this._findEmployeeByExternalId(data.employee_id);
        gr.u_requested_for_user = this._findUserByEmployee(data.employee_id);
        gr.u_leave_type = data.leave_type || 'annual';
        gr.u_start_date = data.start_date || '';
        gr.u_end_date = data.end_date || '';
        gr.u_reason = data.reason || '';
        gr.u_state = 'submitted';
        return gr.insert();
    },

    /**
     * Outbound: push an approved leave decision to ERP/Payroll.
     * Endpoint + auth come from system properties (no secrets in code).
     */
    outboundPushDecision: function (leaveSysId) {
        var gr = new GlideRecord('x_786686_hr_leave_req_v2');
        if (!gr.get(leaveSysId)) return false;

        var endpoint = gs.getProperty('x_786686_hr_leave.config.erp_endpoint');
        if (!endpoint) {
            gs.error('[HRLX] Missing property x_786686_hr_leave.config.erp_endpoint');
            return false;
        }

        try {
            var r = new sn_ws.RESTMessageV2();
            r.setEndpoint(endpoint);
            r.setHttpMethod('POST');
            r.setRequestHeader('Content-Type', 'application/json');
            r.setRequestBody(JSON.stringify({
                number: gr.getValue('u_number'),
                employee: gr.getDisplayValue('u_employee_ref'),
                type: gr.getValue('u_leave_type'),
                days: gr.getValue('u_days_count'),
                state: gr.getValue('u_state')
            }));
            var resp = r.execute();
            var code = resp.getStatusCode();
            gs.info('[HRLX] Outbound status ' + code);
            return (code >= 200 && code < 300);
        } catch (ex) {
            gs.error('[HRLX] Outbound error: ' + ex.message);
            return false;
        }
    },

    _findEmployeeByExternalId: function (employeeId) {
        var e = new GlideRecord('x_786686_hr_leave_employee_v2');
        e.addQuery('u_employee_id', employeeId);
        e.query();
        return e.next() ? e.getUniqueValue() : '';
    },

    _findUserByEmployee: function (employeeId) {
        var e = new GlideRecord('x_786686_hr_leave_employee_v2');
        e.addQuery('u_employee_id', employeeId);
        e.query();
        return e.next() ? e.getValue('u_user') : '';
    },

    type: 'HRLXProIntegrationUtilsV2'
};

Verify checklist

• Script Include active under HR Leave.

Demo / test

Part 2: Scripted REST API Definition

Purpose

Defines scoped API hrlx_api_v2 with authentication and default ACLs.

Navigation path

Direct URL

Prerequisites

• Part 1: Integration SI.

Form fields — Scripted REST API (sys_ws_definition)

Step-by-step create

1. Scripted REST APIs → New → fill API fields.
2. Security → Default ACLs → execute requires integration role.
3. Submit API record before adding resource in Part 3.

Verify checklist

• API ID hrlx_api_v2 under HR Leave (not Global).

Demo / test

Part 3: Resource Script — POST /leave

Purpose

POST /api/x_786686_hr_leave/hrlx_api_v2/leave creates submitted req_v2 from JSON.

Navigation path

Prerequisites

• Part 2: REST API Definition.
• employee_v2 with u_employee_id = EMP001.

Form fields — Resource POST /leave

Step-by-step create

1. Related Resources → New → POST /leave → paste resource script → Submit.

Full script — Resource (POST /leave)

/**
 * Application: Custom · Scope: x_786686_hr_leave · sys_id: 83d5298c932b8f107520703efaba1072
 * Scripted REST API Resource: Create Leave (Inbound)
 * API ID:        hrlx_api_v2
 * Resource:      POST /leave
 * Full path:     /api/x_786686_hr_leave/hrlx_api_v2/leave
 *
 * TEST FIRST (no Postman until this works):
 *   All > System Web Services > REST API Explorer  ($restapi.do)
 *   Namespace: x_786686_hr_leave | API: hrlx_api_v2 | Resource: leave | POST
 *   Request body: { "employee_id":"EMP001", "leave_type":"annual", ... }
 *   Click Send → expect 201 → Copy as cURL
 *
 * Simpler alternative (Table API, no script):
 *   Explorer → namespace now → Table API → x_786686_hr_leave_req_v2 → POST
 *   See: src/server/rest/rest_api_explorer.md
 *
 * Create API record:
 *   All > System Web Services > Scripted REST APIs > New + Resource POST /leave
 */
(function process(request, response) {

    var data = request.body && request.body.data ? request.body.data : {};

    // Validate
    if (!data.employee_id) {
        response.setStatus(400);
        return response.setBody({ error: 'employee_id is required' });
    }
    if (!data.start_date || !data.end_date) {
        response.setStatus(400);
        return response.setBody({ error: 'start_date and end_date are required' });
    }

    // Create via integration utility
    var sysId = new x_786686_hr_leave.HRLXProIntegrationUtilsV2().inboundCreateLeave(JSON.stringify(data));

    if (!sysId) {
        response.setStatus(422);
        return response.setBody({ error: 'Could not create leave request (employee not found?)' });
    }

    response.setStatus(201);
    response.setBody({ sys_id: sysId, message: 'Leave request created' });

})(request, response);

Verify checklist

• Resource active; path /leave relative to API.

Demo / test

Part 4: REST Explorer Test

Purpose

Validate inbound POST returns 201 and creates req_v2 as integration user.

Navigation path

Direct URL

Prerequisites

• Parts 1–3 complete.
• User hrlx.integration with integration + rest_service roles.

Step-by-step create

1. Application = HR Leave.
2. Studio → Script Include → HRLXProIntegrationUtilsV2 → paste script → Save.
3. System Security → ACL → New: Type scripted_rest_api, Operation execute, Requires role integration → Save.
4. Scripted REST APIs → New → fill API fields → Security tab → Default ACLs → add ACL → Submit.
5. Related Resources → New → POST /leave → paste resource script → Submit.
6. REST API Explorer → Namespace x_786686_hr_leave → API hrlx_api_v2 → Resource leave → POST.
7. Body: {"employee_id":"EMP001","leave_type":"annual","start_date":"2026-06-01","end_date":"2026-06-05","reason":"Vacation"}
8. Run as hrlx.integration (Impersonate) → Send → expect 201 + sys_id.

Verify checklist

• 201 response with sys_id.
• req_v2 row exists in submitted state.
• 403 without integration role; 422 if EMP001 missing.

Demo / test

Demo / test

Integration verify checklist

1. SI + API + resource scoped to HR Leave.
2. POST returns 201.
3. req_v2 row in submitted state.
4. 403 without integration role.

Revision map

Part 1: Quick Checklist (Chapter Parts)

Purpose

Fast pass/fail review of all create objects linked by chapter Part anchors.

Verify checklist

Part 2: E2E Demo

Purpose

Single scripted walkthrough proving leave lifecycle.

1. Update Set current — HR Leave – Build (Rule 0).
2. Seed employee — Part 2: employee_v2, Part 3: Users.
3. Seed balance — Part 4: bal_v2.
4. Create request — Part 3: req_v2 OR Part 2: Record Producer.
5. Submit — Part 15: UI Action, Part 9: BR2.
6. Flow approval — Part 3: Flow.
7. Audit — Part 10: BR3.
8. Balance — BR3 updates bal_v2.
9. Notification — Part 2: Notifications.
10. Security — Part 4: ACLs.
11. Portal — Part 3: hrlx_home.
12. REST — Part 4: REST Explorer.

Demo / test

Part 3: Gaps (Optional)

Purpose

Items often skipped in a 2-hour sprint — schedule if time allows.

• 05 Workspace — Now Experience lists
• 07 Reports — dashboard for managers
• 08 ATF — regression suite
• 12 REST — inbound POST /leave
• 14 AI Agents — platform AI (post core app)

Verify checklist

• Core path (01, 02, 03, 06, 09, 10) complete before optional gaps.

Demo / test

Summary verify checklist

1. All Part links resolve.
2. E2E demo passes.
3. Gaps documented if deferred.

How AI features relate to HR Leave

Core app (ch.01–12) — tables, BR, Flow, ACLs
        │
        ▼
Platform AI (this chapter) — Now Assist, Agents, VA, Search
        │
        ▼
Optional: HR Leave skills/topics referencing req_v2 / bal_v2 data

Table of Contents

1. What You Will Build
2. Direct Navigation URLs
3. Part 0 — Quick Map & Prerequisites
4. Part 1 — Plugin Activation & Roles
5. Part 2 — Now Assist Studio (Skills)
6. Part 3 — AI Agent Studio
7. Part 4 — BYO LLM (Claude / GPT)
8. Part 5 — AI Search + GenAI Search
9. Part 6 — Predictive Intelligence
10. Part 7 — Virtual Agent + NLU (Full Topics & Flows)
11. Part 8 — Document Intelligence (IDP)
12. Part 9 — Workflow Studio AI Actions
13. Part 10 — Now Assist for Developers
14. Part 11 — End-to-End HR Leave AI Example
15. Part 12 — AI Governance & Safety
16. Part 13 — Performance & Cost Optimization
17. Part 14 — Hands-On Labs (5 Sessions)
18. Part 15 — Best Practices
19. Part 16 — Production Deployment Checklist
20. Appendices

🎯 What You Will Build — ماذا ستبني

By the end of this guide you will have deployed a complete AI layer on the HR Leave scoped app:

• ✅ 6 Now Assist Skills (summarize, classify, suggest dates, history summary, sentiment, email draft)
• ✅ 1 AI Agent — HR Leave Assistant with 6 tools wired to HRLXAIAgentTools
• ✅ 1 AI Search profile — hrlx_kb_profile with GenAI answers + masked sensitive fields
• ✅ 2 Predictive Intelligence solutions — approval prediction + duration regression
• ✅ 1 NLU model — hrlx_leave_nlu with 8 intents and 200+ utterances
• ✅ 8 Virtual Agent topics — balance, request, cancel, policy, status, handoff, greeting, fallback
• ✅ 1 IDP template — medical certificate extraction wired to sick-leave flow
• ✅ 3 Flow Designer AI Actions — summarize history, classify type, draft manager email
• ✅ Governance — AI policies, PII redaction, audit to x_786686_hr_leave_audit_v2
• ✅ Monitoring dashboard — skill latency, agent containment, PI drift, search zero-results

Style in this doc: English instruction line → Arabic explanation on its own line where helpful. All code in fenced blocks.

📍 Direct Navigation URLs — روابط التنقل المباشرة

Replace {BASE} with your instance URL (e.g. https://dev12345.service-now.com).

Now Assist & AI Agents

AI Search

Predictive Intelligence

Virtual Agent & NLU

Document Intelligence

HR Leave App Tables (Grounding & Tools)

Development & Deployment

Part 0 — Quick Map & Prerequisites

0.1 Decision matrix — which AI tool when?

ابدأ بـ Skill للمهام أحادية الخطوة. انتقل إلى Agent عندما يحتاج المستخدم محادثة متعددة الخطوات مع أدوات.

0.2 Prerequisites checklist

Before starting any AI work:

[ ] HR Leave v2 tables exist and have ≥ 50 test leave requests
[ ] Roles assigned: x_786686_hr_leave.employee, .manager, .hr_admin
[ ] Update Set created: "HR Leave AI v1.0"
[ ] Application picker set to HR Leave (x_786686_hr_leave) in Studio
[ ] At least 5 KB articles tagged topic=HR Leave (for AI Search)
[ ] Integration user NOT used for AI testing — use real employee personas
[ ] Instance has outbound HTTPS to LLM APIs (if BYO) — check ACL network rules
[ ] Admin access to activate plugins (requires admin role)

0.3 Verify app scope (Background Script)

URL: {BASE}/sys.scripts.do

var app = new GlideRecord('sys_app');
app.addQuery('scope', 'x_786686_hr_leave');
app.query();
if (app.next()) {
    gs.info('App: ' + app.name + ' | sys_id: ' + app.sys_id);
} else {
    gs.error('HR Leave app not found — create via 01_DEVELOPMENT.md first');
}

var tables = ['x_786686_hr_leave_req_v2', 'x_786686_hr_leave_bal_v2',
              'x_786686_hr_leave_employee_v2', 'x_786686_hr_leave_audit_v2'];
tables.forEach(function (t) {
    var gr = new GlideRecord(t);
    gs.info(t + ' exists: ' + gr.isValid());
});

Part 1 — Plugin Activation & Roles

Step 1.1: Activate required plugins

Navigation: All > System Definition > Plugins — Open direct
Direct URL: {BASE}/v_plugin_list.do

Detailed activation steps:

1. Open {BASE}/v_plugin_list.do
2. Filter: Name contains "Now Assist" OR "AI Search" OR "Virtual Agent"
3. For each plugin in the table above:
   a. Click the plugin name
   b. Click "Activate" (or "Install" on some instances)
   c. UNCHECK "Load demo data" in production-like sub-prod
   d. Wait for activation (may take 2–10 minutes)
   e. Note any dependent plugins auto-activated
4. After all activations: logout and login (refresh session roles)
5. Open Now Assist Setup wizard: {BASE}/now/assist/admin
6. Accept terms → select data region → Enable HRSD skill pack
7. Verify: All > Now Assist > Now Assist Admin shows "Configured"

Step 1.2: Assign AI admin roles

Navigation: All > User Administration > Users — Open direct
Direct URL: {BASE}/sys_user_list.do

Step 1.3: Create system properties (AI config)

Navigation: All > System Properties — Open direct
Direct URL: {BASE}/sys_properties_list.do

Create these properties in scope x_786686_hr_leave:

Verification script:

var props = ['ai.enabled', 'llm.daily_budget_usd', 'ai_search.profile'];
props.forEach(function (p) {
    var v = gs.getProperty('x_786686_hr_leave.' + p, 'NOT SET');
    gs.info('x_786686_hr_leave.' + p + ' = ' + v);
});

Part 2 — Now Assist Studio (Skills)

2.1 Architecture overview

Step 2.1: Open Now Assist Studio

URL: {BASE}/now/assist/studio

1. App picker (top-left) → select "HR Leave" scope
2. Click "Skills" in left nav
3. Click "New" → "Create Skill"
4. Confirm Application = x_786686_hr_leave on every record

Step 2.2: Skill 1 — hrlx_summarize_reason

Prompt template (SYSTEM + USER):

SYSTEM:
You are an HR assistant for a multinational company. Summarize the employee's
leave reason in ONE sentence, maximum 25 words, neutral professional tone.
Do NOT include medical diagnoses, medication names, or sensitive health details.
If reason is empty, return exactly: "No reason provided."
Respond in the same language as the reason text (English or Arabic).

USER:
Employee: {{employee_name}}
Leave type: {{u_leave_type}}
Start: {{u_start_date}} | End: {{u_end_date}} | Days: {{u_days_count}}
Reason:
"""
{{u_reason}}
"""

Variable mapping:

Grounding config:

1. Skill > Grounding tab > Enable
2. Table: x_786686_hr_leave_req_v2
3. Key: sys_id
4. Map each {{variable}} to column above
5. Save

Test in Playground (5 samples):

Playground steps:
1. Skills > hrlx_summarize_reason > Test
2. Paste sys_id of test request OR fill variables manually
3. Run → check latency (target ≤ 2s)
4. If bad output → edit prompt → Save as version 1.1
5. Repeat until 90%+ acceptable on 20 samples
6. Status → Active

Step 2.3: Skill 2 — hrlx_classify_leave_type

SYSTEM:
Classify the leave request text into EXACTLY ONE label:
annual, sick, parental, unpaid
Return ONLY the label, lowercase, no punctuation or explanation.

USER:
Leave type already selected (may be wrong): {{u_leave_type}}
Employee reason: {{u_reason}}
Additional notes: {{u_notes}}

Wire to Business Rule (before insert/update when u_leave_type empty):

(function executeRule(current, previous) {
    if (!gs.getProperty('x_786686_hr_leave.ai.enabled', 'true') === 'true') return;
    if (current.u_leave_type) return;
    if (!current.u_reason) return;

    try {
        var ext = new sn_one_extend.OneExtendUtil();
        var res = ext.execute({
            executionRequests: [{
                capabilityId: 'hrlx_classify_leave_type',
                payload: {
                    u_leave_type: String(current.u_leave_type),
                    u_reason: String(current.u_reason),
                    u_notes: String(current.u_notes || '')
                }
            }]
        });
        var label = (res.capabilities[0] || {}).response;
        if (/^(annual|sick|parental|unpaid)$/.test(label))
            current.u_leave_type = label;
    } catch (e) {
        gs.warn('hrlx_classify_leave_type failed: ' + e);
    }
})(current, previous);

Step 2.4: Skill 3 — hrlx_suggest_dates

SYSTEM:
Suggest adjusted leave dates avoiding public holidays.
Return ONLY valid JSON:
{"start":"YYYY-MM-DD","end":"YYYY-MM-DD","notes":"..."}
No markdown fences.

USER:
Country: {{u_country}}
Requested start: {{u_start_date}}
Requested end: {{u_end_date}}
Leave type: {{u_leave_type}}
Public holidays next 90 days:
{{holidays_json}}

Pre-step Script Include to build holidays_json:

var HRLXHolidayUtil = Class.create();
HRLXHolidayUtil.prototype = {
    initialize: function() {},
    getHolidaysJson: function(country, days) {
        // Replace with your holiday table or IntegrationHub spoke
        var out = [];
        var gr = new GlideRecord('sn_hr_core_federal_holiday'); // if HRSD installed
        if (gr.isValid()) {
            gr.addQuery('country', country);
            gr.addQuery('date', '>=', new GlideDate());
            gr.setLimit(days || 90);
            gr.query();
            while (gr.next()) {
                out.push({ date: String(gr.date), name: String(gr.name) });
            }
        }
        return JSON.stringify(out);
    },
    type: 'HRLXHolidayUtil'
};

Step 2.5: Skill 4 — hrlx_summarize_history

Summarizes last N leave requests for a manager email.

SYSTEM:
Summarize this employee's leave history for a manager briefing.
Max 150 words. Bullet format. Include totals by type. Neutral tone.

USER:
Employee: {{employee_name}}
Lookback days: {{lookback_days}}
History records:
{{history_text}}

Step 2.6: Skill 5 — hrlx_detect_sentiment

SYSTEM:
Classify employee leave reason sentiment: positive, neutral, frustrated, urgent.
Return ONLY the label.

USER:
Reason: {{u_reason}}

Use output to route frustrated → human HR in Flow Designer.

Step 2.7: Skill 6 — hrlx_draft_manager_email

SYSTEM:
Draft a short email from HR system to employee about their leave request.
Professional, empathetic. Max 120 words. Include request number and dates.
Do not invent approval status — use {{u_state}} exactly.

USER:
Employee name: {{employee_name}}
Request: {{u_number}}
Type: {{u_leave_type}}
Dates: {{u_start_date}} to {{u_end_date}}
State: {{u_state}}
Manager note: {{manager_comment}}

Step 2.8: Activate skills per channel

URL: {BASE}/sys_one_extend_activation_list.do

For each skill create activation:

Step 2.9: UI Action — Summarize on form

URL: {BASE}/sys_ui_action_list.do

(function executeAction(current) {
    var ext = new sn_one_extend.OneExtendUtil();
    var res = ext.execute({
        executionRequests: [{
            capabilityId: 'hrlx_summarize_reason',
            payload: { record: current.getUniqueValue() }
        }]
    });
    var summary = (res.capabilities[0] || {}).response || 'No summary';
    gs.addInfoMessage('AI Summary: ' + summary);
})(current);

Part 3 — AI Agent Studio

3.1 What AI Agent Studio provides

AI Agent Studio builds agentic assistants: an LLM that plans steps, selects tools, executes them, observes results, and responds — across multiple conversation turns.

Direct URL: {BASE}/now/aia/studio

Step 3.1: Create Script Include HRLXAIAgentTools

URL: {BASE}/sys_script_include_list.do
Application: HR Leave

var HRLXAIAgentTools = Class.create();
HRLXAIAgentTools.prototype = {
    initialize: function() {
        this.SCOPE = 'x_786686_hr_leave';
        this.T_EMP = 'x_786686_hr_leave_employee_v2';
        this.T_REQ = 'x_786686_hr_leave_req_v2';
        this.T_BAL = 'x_786686_hr_leave_bal_v2';
        this.T_AUD = 'x_786686_hr_leave_audit_v2';
    },

    _getEmployeeByUser: function(userId) {
        var gr = new GlideRecord(this.T_EMP);
        gr.addQuery('user', userId);
        gr.setLimit(1);
        gr.query();
        return gr.next() ? gr : null;
    },

    getBalance: function(userId) {
        var emp = this._getEmployeeByUser(userId);
        if (!emp) return { error: 'employee_not_found' };
        var out = { annual: 0, sick: 0, parental: 0, unpaid: 0 };
        var bal = new GlideRecord(this.T_BAL);
        bal.addQuery('u_employee_ref', emp.getUniqueValue());
        bal.query();
        while (bal.next()) {
            var t = String(bal.u_leave_type);
            if (out.hasOwnProperty(t)) out[t] = Number(bal.u_remaining_days) || 0;
        }
        return out;
    },

    requestLeave: function(payload) {
        try {
            if (gs.getProperty(this.SCOPE + '.ai.enabled', 'true') !== 'true')
                return { ok: false, error: 'ai_disabled' };

            var emp = this._getEmployeeByUser(payload.user_id);
            if (!emp) return { ok: false, error: 'employee_not_found' };

            var start = new GlideDateTime(payload.start_date);
            var end = new GlideDateTime(payload.end_date);
            if (start.compareTo(end) > 0)
                return { ok: false, error: 'start_after_end' };

            var bal = this.getBalance(payload.user_id);
            var days = Math.ceil((end.getNumericValue() - start.getNumericValue()) / 86400000) + 1;
            if ((bal[payload.type] || 0) < days)
                return { ok: false, error: 'insufficient_balance', needed: days, available: bal[payload.type] || 0 };

            var req = new GlideRecord(this.T_REQ);
            req.initialize();
            req.u_requested_for_user = payload.user_id;
            req.u_employee_ref = emp.getUniqueValue();
            req.u_leave_type = payload.type;
            req.u_start_date = payload.start_date;
            req.u_end_date = payload.end_date;
            req.u_reason = payload.reason || '';
            req.u_state = 'submitted';
            req.u_source = 'ai_agent';
            var sysId = req.insert();
            this._audit('ai_request_leave', sysId, payload);
            return { ok: true, request_id: sysId, number: req.getValue('u_number') };
        } catch (e) {
            gs.error('HRLXAIAgentTools.requestLeave: ' + e);
            return { ok: false, error: 'exception' };
        }
    },

    checkPolicy: function(question) {
        var profile = gs.getProperty(this.SCOPE + '.ai_search.profile', 'hrlx_kb_profile');
        try {
            var sn = new sn_ais.AISearch();
            var results = sn.search(profile, question, { limit: 5, genai: true });
            return {
                answer: results.genai_answer || '',
                citations: results.citations || []
            };
        } catch (e) {
            return { answer: '', citations: [], error: String(e) };
        }
    },

    escalate: function(userId, summary) {
        var emp = this._getEmployeeByUser(userId);
        if (!emp) return { ok: false, error: 'employee_not_found' };
        var hr = new GlideRecord('sn_hr_core_case');
        if (!hr.isValid()) {
            // Fallback: create audit + notify
            this._audit('ai_escalate_no_hrsd', userId, { summary: summary });
            return { ok: true, case_id: null, note: 'HRSD not installed — audit only' };
        }
        hr.initialize();
        hr.opened_for = userId;
        hr.short_description = 'AI escalation: ' + (summary || '').substring(0, 80);
        hr.description = summary;
        hr.subject_person = userId;
        var sysId = hr.insert();
        this._audit('ai_escalate', sysId, { summary: summary });
        return { ok: true, case_id: sysId };
    },

    getMyRequests: function(userId, days) {
        var emp = this._getEmployeeByUser(userId);
        if (!emp) return [];
        var since = new GlideDateTime();
        since.addDaysLocalTime(-1 * (days || 90));
        var gr = new GlideRecord(this.T_REQ);
        gr.addQuery('u_employee_ref', emp.getUniqueValue());
        gr.addQuery('sys_created_on', '>=', since);
        gr.orderByDesc('sys_created_on');
        gr.query();
        var out = [];
        while (gr.next()) {
            out.push({
                id: gr.getUniqueValue(),
                number: String(gr.u_number),
                type: String(gr.u_leave_type),
                start: String(gr.u_start_date),
                end: String(gr.u_end_date),
                state: String(gr.u_state)
            });
        }
        return out;
    },

    cancelRequest: function(userId, requestId) {
        var gr = new GlideRecord(this.T_REQ);
        if (!gr.get(requestId)) return { ok: false, error: 'not_found' };
        if (gr.u_requested_for_user != userId) return { ok: false, error: 'not_owner' };
        if (gr.u_state != 'submitted') return { ok: false, error: 'not_cancellable' };
        gr.u_state = 'cancelled';
        gr.update();
        this._audit('ai_cancel_request', requestId, { user: userId });
        return { ok: true };
    },

    _audit: function(action, recordId, payload) {
        var a = new GlideRecord(this.T_AUD);
        a.initialize();
        a.u_action = action;
        a.u_record = recordId;
        a.u_payload = JSON.stringify(payload || {});
        a.u_actor = gs.getUserID();
        a.u_source = 'ai_agent';
        a.insert();
    },

    type: 'HRLXAIAgentTools'
};

Step 3.2: Define tools in AI Agent Studio

URL: {BASE}/sn_aia_tool_list.do

Tool 1 — GetMyBalance

Tool 2 — RequestLeave

Confirmation gate: Enable “Require user confirmation” for this tool in Agent Studio.

Tool 3 — CheckPolicy

Tool 4 — GetMyRequests

| Method | getMyRequests |
| Input | user_id, days (default 90) |

Tool 5 — CancelRequest

| Method | cancelRequest |
| Input | user_id, request_id |

Tool 6 — EscalateToHR

| Method | escalate |
| Input | user_id, summary |

Step 3.3: Create agent “HR Leave Assistant”

URL: {BASE}/sn_aia_agent_list.do

System prompt:

You are "HR Leave Assistant" for employees of this company.

CAPABILITIES (use tools):
- GetMyBalance: show remaining leave days
- RequestLeave: submit a new request (ALWAYS confirm dates/type first)
- CheckPolicy: answer policy questions from official KB (cite sources)
- GetMyRequests: list recent requests
- CancelRequest: cancel a submitted request owned by the user
- EscalateToHR: create HR case when user is frustrated or issue is complex

RULES:
1. Identity comes from session — never ask for employee ID number.
2. NEVER reveal another employee's data.
3. Out of scope → "I can only help with leave. Contact HR at hr@company.com."
4. Match user language (English or Arabic).
5. Before RequestLeave: summarize dates, type, days count, ask "Shall I submit?"
6. If tool returns error insufficient_balance, explain clearly with numbers.
7. For medical/sick policy, remind user a certificate may be required.

STYLE: concise, friendly, professional. Use bullet lists for balances.

Agent JSON export reference:

{
  "name": "HR Leave Assistant",
  "scope": "x_786686_hr_leave",
  "model": "now-llm-pro-v1",
  "tools": ["GetMyBalance", "RequestLeave", "CheckPolicy", "GetMyRequests", "CancelRequest", "EscalateToHR"],
  "knowledge_sources": [{ "type": "ai_search_profile", "name": "hrlx_kb_profile" }],
  "triggers": [
    { "type": "chat", "channel": "employee_center" },
    { "type": "chat", "channel": "service_portal" }
  ],
  "memory": { "session": true, "persistent": { "enabled": true, "max_turns": 8 } },
  "guardrails": {
    "pii_redaction": true,
    "escalation_keywords": ["urgent", "complaint", "discrimination", "harassment", "lawyer"]
  },
  "audit": { "store_inputs": true, "store_outputs": true, "retention_days": 365 }
}

Step 3.4: Enable agent on Employee Center

1. Open {BASE}/now/assist/admin
2. Channels > Employee Center
3. Enable "AI Agents"
4. Add agent: HR Leave Assistant
5. Position: HR Leave category in chat launcher
6. Save
7. Test: {BASE}/esc → open chat → "How many annual days do I have?"

Step 3.5: Test agent (10 test utterances)

Part 4 — BYO LLM (Claude / GPT)

Step 4.1: When to use BYO LLM

Step 4.2: Configure Anthropic provider

URL: {BASE}/sys_one_extend_provider_config_list.do

1. New > Provider type: Anthropic (or Generic REST)
2. Name: hrlx_anthropic
3. API endpoint: https://api.anthropic.com/v1/messages
4. Credential: link to Generic API Key credential (x-api-key)
5. Default model: claude-sonnet-4-5
6. Test connection
7. Per skill: LLM Provider = hrlx_anthropic

Step 4.3: REST Message — Claude_API

URL: {BASE}/sys_rest_message_list.do

Body template:

{
  "model": "${model}",
  "max_tokens": ${max_tokens},
  "system": "${system}",
  "messages": [{ "role": "user", "content": "${user_message}" }]
}

Step 4.4: Script Include — HRLXAIProvider (fallback chain)

var HRLXAIProvider = Class.create();
HRLXAIProvider.prototype = {
    initialize: function() {
        this.SCOPE = 'x_786686_hr_leave';
        this.TIMEOUT_MS = parseInt(gs.getProperty(this.SCOPE + '.llm.timeout_ms', '15000'), 10);
    },

    _prop: function(name, def) { return gs.getProperty(this.SCOPE + '.' + name, def); },

    _budgetCheck: function(provider) {
        var budget = parseFloat(this._prop('llm.daily_budget_usd', '10'));
        var key = 'llm.spent.' + provider + '.' + new GlideDateTime().getDate().getDisplayValue();
        return parseFloat(gs.getProperty(this.SCOPE + '.' + key, '0')) < budget;
    },

    askClaude: function(prompt, model, maxTokens, system) {
        if (!this._budgetCheck('anthropic')) return { error: 'budget_exceeded' };
        try {
            var rm = new sn_ws.RESTMessageV2('Claude_API', 'post');
            rm.setHttpTimeout(this.TIMEOUT_MS);
            rm.setStringParameterNoEscape('model', model || this._prop('llm.anthropic.model', 'claude-sonnet-4-5'));
            rm.setStringParameterNoEscape('max_tokens', String(maxTokens || 400));
            rm.setStringParameterNoEscape('system', system || 'You are a helpful HR assistant.');
            rm.setStringParameterNoEscape('user_message', prompt);
            var resp = rm.execute();
            if (resp.getStatusCode() >= 400) return { error: 'http_' + resp.getStatusCode() };
            var json = JSON.parse(resp.getBody());
            var text = '';
            (json.content || []).forEach(function(c) { if (c.type === 'text') text += c.text; });
            return { text: text, usage: json.usage || {} };
        } catch (e) { return { error: 'exception', message: String(e) }; }
    },

    askWithFallback: function(prompt, options) {
        options = options || {};
        var chain = options.chain || ['anthropic', 'openai', 'now_llm'];
        for (var i = 0; i < chain.length; i++) {
            var res = (chain[i] === 'anthropic') ? this.askClaude(prompt, options.model, options.max_tokens, options.system) : null;
            if (res && !res.error && res.text) return res;
        }
        return { error: 'all_providers_failed' };
    },

    type: 'HRLXAIProvider'
};

Step 4.5: HRLXRagService (custom RAG)

var HRLXRagService = Class.create();
HRLXRagService.prototype = {
    initialize: function() {
        this.PROVIDER = new HRLXAIProvider();
        this.PROFILE = gs.getProperty('x_786686_hr_leave.ai_search.profile', 'hrlx_kb_profile');
    },

    answer: function(question) {
        var sn = new sn_ais.AISearch();
        var res = sn.search(this.PROFILE, question, { limit: 5, genai: true, min_similarity: 0.65 });
        if (res.genai_answer) return { text: res.genai_answer, citations: res.citations || [] };
        return { text: 'I could not find an answer in HR Leave policies.', citations: [] };
    },

    type: 'HRLXRagService'
};

Part 5 — AI Search + GenAI Search

5.1 AI Search vs Zing

Step 5.1: Create search source — hrlx_kb

URL: {BASE}/ais_search_source_list.do

1. New Search Source
2. Name: hrlx_kb
3. Table: kb_knowledge
4. Condition: topic=HR Leave^workflow_state=published^active=true
5. Indexed fields:
   - title (boost 2.0)
   - short_description (boost 1.5)
   - text (boost 1.0)
   - meta (boost 0.5)
6. Index transform script (PII mask):

(function transform(record, indexed) {
    indexed.title = record.short_description + '';
    var body = (record.text || '') + '';
    indexed.body = body.replace(/\b(SSN|PASSPORT|MRN|diagnosis)\b[: ]?\S+/gi, '[REDACTED]');
    indexed.u_kb_number = record.number + '';
    return indexed;
})(record, indexed);

7. Save → Full Index (wait for completion)
8. Verify: AI Search Admin > Index Status = Green

Step 5.2: Create source — hrlx_policy_attachments

Step 5.3: Create profile — hrlx_kb_profile

URL: {BASE}/ais_search_profile_list.do

Step 5.4: Create search application (Portal)

URL: {BASE}/ais_search_application_list.do

1. New Application: hrlx_portal_search
2. Profile: hrlx_kb_profile
3. UI: Service Portal
4. Placeholder: "Ask about leave policy, sick days, carry-over..."
5. Enable GenAI answer panel + citations
6. Link to page: {BASE}/sp?id=hrlx_policy_search

Widget HTML (Service Portal):

<div class="hrlx-aisearch">
  <sp-search
    profile="hrlx_kb_profile"
    placeholder="Ask about leave policy"
    show-genai-answer="true"
    show-citations="true">
  </sp-search>
</div>

Step 5.5: Boost rules & synonyms

URL for synonyms: {BASE}/ais_dictionary_term_list.do

Step 5.6: Search analytics dashboard

Build PA indicators from:

Target: zero-result rate < 5% after 30 days.

Part 6 — Predictive Intelligence

6.1 Solution types for HR Leave

Step 6.1: Add ML output fields to req_v2

URL: {BASE}/sys_dictionary_list.do?sysparm_query=name=x_786686_hr_leave_req_v2

Step 6.2: Backfill training label (one-time script)

Run after you have historical approvals:

var gr = new GlideRecord('x_786686_hr_leave_req_v2');
gr.addQuery('u_state', 'IN', 'approved,rejected');
gr.query();
while (gr.next()) {
    var created = new GlideDateTime(gr.sys_created_on);
    var updated = new GlideDateTime(gr.sys_updated_on);
    var hours = (updated.getNumericValue() - created.getNumericValue()) / 3600000;
    var approved = gr.u_state == 'approved' && hours <= 24;
    gr.u_approved_within_24h = approved ? 'yes' : 'no';
    gr.setWorkflow(false);
    gr.update();
}
gs.info('Backfill complete');

Minimum training rows: ≥ 1,000 historical requests (≥ 100 per class for classification).

Step 6.3: Create classification solution — hrlx_predict_approval_24h

URL: {BASE}/ml_solution_definition_list.do

1. New Solution Definition
2. Name: hrlx_predict_approval_24h
3. Table: x_786686_hr_leave_req_v2
4. Solution type: Classification
5. Input fields:
   - u_leave_type
   - u_days_count
   - u_department (from employee)
   - u_employee_tenure_days (calculated field or BR)
   - day_of_week (derived from u_start_date)
   - u_has_reason (boolean: u_reason length > 5)
6. Output field: u_approved_within_24h
7. Prediction fields: u_predicted_approval_24h, u_predicted_confidence_24h
8. Training window: last 18 months
9. Exclusion: u_state=draft
10. Click Train → wait (15–60 min)
11. Review accuracy report: target ≥ 0.80 accuracy, F1 ≥ 0.65 minority class
12. Activate solution

Step 6.4: Business Rule — predict on insert

(function executeRule(current, previous) {
    if (current.u_predicted_approval_24h) return;
    try {
        var ml = new sn_ml.SolutionStore().get('hrlx_predict_approval_24h');
        if (!ml || !ml.isActive()) return;

        var startDt = new GlideDateTime(current.u_start_date);
        var input = {
            u_leave_type: String(current.u_leave_type),
            u_days_count: parseInt(current.u_days_count || '0', 10),
            u_department: String(current.u_department || ''),
            u_employee_tenure_days: parseInt(current.u_employee_tenure_days || '0', 10),
            day_of_week: startDt.getDayOfWeekUTC(),
            u_has_reason: (current.u_reason && current.u_reason.length > 5) ? 1 : 0
        };
        var pred = ml.predict([input]);
        if (pred && pred[0]) {
            current.u_predicted_approval_24h = pred[0].predicted_value;
            current.u_predicted_confidence_24h = pred[0].confidence;
        }
    } catch (e) {
        gs.warn('PI predict failed: ' + e);
    }
})(current, previous);

Step 6.5: Regression solution — hrlx_predict_duration

Same wizard, type = Regression, output = u_days_count (actual), prediction = u_predicted_duration.

Step 6.6: Solution Monitor

URL: {BASE}/ml_solution_monitor_list.do

Schedule monthly re-train via Scheduled Script Execution.

Part 7 — Virtual Agent + NLU (Full Topics & Flows)

7.1 Virtual Agent vs AI Agent — coexistence

Recommended pattern: VA handles structured flows; fallback / policy Q&A routes to AI Agent.

Step 7.1: Create NLU model — hrlx_leave_nlu

URL: {BASE}/now/nlu/workbench

Step 7.2: Intents (8 total)

Step 7.3: Entities

Step 7.4: Utterances — check_balance (30 examples)

how many leave days do I have
what is my annual leave balance
show my remaining vacation days
how much PTO do I have left
check my sick leave balance
remaining parental leave
how many days off can I take
what's my leave balance
do I have any unpaid leave left
show balance for annual leave
how many annual days remaining
tell me my vacation balance
what leave do I have available
check my time off balance
how much annual leave is left
show me sick days remaining
balance inquiry for leave
how many days of leave remain
what is my current leave entitlement
remaining days for sick leave
how much leave have I got left
annual balance please
sick leave days left
parental leave balance check
unpaid leave remaining
how many holidays can I still take
leave days available
my remaining leave
check PTO balance
how many days can I still book off

Step 7.5: Utterances — request_leave (35 examples)

I want to take leave next Monday
request 3 days annual leave
book sick leave for tomorrow
I need time off from June 5 to June 10
apply for parental leave starting next month
request vacation days
take 2 days off next week
I want to book annual leave
schedule sick leave for Friday
need unpaid leave for 5 days
book me 3 days annual starting Monday
I would like to request leave
can I take leave next Tuesday and Wednesday
request time off for a wedding
apply for 10 days annual leave in July
I need sick leave for 2 days
book parental leave from September 1
request leave for family emergency
take annual leave Dec 20 to Dec 31
I want 1 week off
schedule 4 days sick leave
request unpaid leave next month
book leave type annual for 3 days
I need to take Friday off
request half day sick leave
apply for leave starting {date_range}
book {days_count} days of {leave_type} leave
I want {leave_type} leave from {date_range}
need {days_count} days off
request leave please
take time off
book my vacation
I want to go on leave
schedule my days off
can I have next week off

Step 7.6: Utterances — check_policy (25 examples)

what is the maternity leave policy
can I carry over unused annual leave
how many sick days am I allowed per year
what is the parental leave entitlement
do I need a medical certificate for sick leave
what is the notice period for annual leave
can managers reject my leave request
what happens to unused leave at year end
is unpaid leave available
what is the maximum consecutive leave days
how does sick leave accrue
what is the leave policy for new joiners
can I take leave during probation
what documents are required for sick leave
explain the annual leave policy
how far in advance must I request leave
what is the carry forward limit
are public holidays deducted from leave
what is bereavement leave policy
can I split parental leave
what is the leave approval process
how is leave calculated for part time staff
what is the sick leave waiting period
tell me about leave encashment
what are the rules for emergency leave

Step 7.7: Utterances — cancel_leave (20 examples)

cancel my leave request
withdraw my leave application
I want to cancel HRLX0001234
cancel my upcoming vacation
withdraw the leave I submitted
delete my leave request
cancel submitted leave
I no longer need those days off
please cancel my time off request
revoke my leave request
cancel annual leave for next week
withdraw sick leave request
cancel request number {request_number}
I want to undo my leave request
cancel my pending leave
stop my leave application
cancel the leave I booked
withdraw my days off
cancel leave starting Monday
I need to cancel my vacation request

Step 7.8: Utterances — check_status (20 examples)

what is the status of my leave request
has my leave been approved
track my leave application
where is my request HRLX0001234
is my leave approved yet
check approval status
status of my vacation request
has manager approved my leave
what happened to my leave request
show status of pending leave
is my sick leave approved
check my submitted leave
approval status please
where is my annual leave request
has HR approved my leave
track request {request_number}
what state is my leave in
is my leave still pending
did my leave get rejected
update on my leave request

Step 7.9: Train and publish NLU

1. NLU Workbench > hrlx_leave_nlu
2. Add all utterances above (minimum 15 per intent; we have 20–35)
3. Annotate entities in utterances (highlight dates, types)
4. Click Train → wait for model metrics
5. Target: Intent accuracy ≥ 0.92 on test set
6. Publish model version 1.0
7. Set property x_786686_hr_leave.nlu.model = hrlx_leave_nlu

Step 7.10: Topic catalog (8 topics)

URL: {BASE}/now/virtual-agent/designer

TOPIC FLOW 1 — HRLX Check Balance (block-by-block)

Topic: HRLX Check Balance
Channel: Employee Center, Service Portal
NLU: check_balance (confidence ≥ 0.7)

BLOCK 1 — Script Action "Fetch Balance"
  Script:

(function execute() {
    var userId = vaSystem.getUserId();
    var tools = new x_786686_hr_leave.HRLXAIAgentTools();
    var bal = tools.getBalance(userId);
    if (bal.error) {
        vaInputs.has_error = true;
        vaInputs.error_msg = 'Employee profile not found. Contact HR.';
        return;
    }
    vaInputs.has_error = false;
    vaInputs.balance_text =
        'Annual: ' + bal.annual + ' days\n' +
        'Sick: ' + bal.sick + ' days\n' +
        'Parental: ' + bal.parental + ' days\n' +
        'Unpaid: ' + bal.unpaid + ' days';
})();

BLOCK 2 — Decision
  Condition: has_error == true
  True → Bot Message: "${error_msg}" → End
  False → continue

BLOCK 3 — Bot Message
  Text: "Here is your current leave balance:\n${balance_text}"

BLOCK 4 — Quick Reply
  Question: "Would you like to request leave?"
  Options: Yes | No

BLOCK 5 — Branch
  Yes → Link to Topic "HRLX Request Leave"
  No → Bot Message "Have a great day!" → End

TOPIC FLOW 2 — HRLX Request Leave (slot filling)

Topic: HRLX Request Leave
NLU: request_leave

BLOCK 1 — Collect leave_type (if not in NLU entities)
  Prompt: "Which type of leave? (annual / sick / parental / unpaid)"
  Slot: leave_type
  Validation: must be in [annual, sick, parental, unpaid]
  Max retries: 2 → on fail go to Fallback

BLOCK 2 — Collect start_date
  Prompt: "What is the start date? (YYYY-MM-DD or 'next Monday')"
  Slot: start_date
  Validation: date >= today

BLOCK 3 — Collect end_date
  Prompt: "What is the end date?"
  Slot: end_date
  Validation: end_date >= start_date

BLOCK 4 — Collect reason (optional)
  Prompt: "Reason for leave? (optional — press Skip)"
  Slot: reason
  Required: false

BLOCK 5 — Script Action "Calculate Days Preview"

(function execute() {
    var start = new GlideDateTime(vaVars.start_date);
    var end = new GlideDateTime(vaVars.end_date);
    var days = Math.ceil((end.getNumericValue() - start.getNumericValue()) / 86400000) + 1;
    vaInputs.preview_days = days;
    var tools = new x_786686_hr_leave.HRLXAIAgentTools();
    var bal = tools.getBalance(vaSystem.getUserId());
    vaInputs.enough = (bal[vaVars.leave_type] || 0) >= days;
    vaInputs.available = bal[vaVars.leave_type] || 0;
})();

BLOCK 6 — Decision insufficient balance
  Condition: enough == false
  True → Message: "You need ${preview_days} days but only have ${available}. Choose shorter dates."
         → Go to BLOCK 2 (re-collect dates)
  False → continue

BLOCK 7 — Confirmation
  Message: "Please confirm:\nType: ${leave_type}\nFrom: ${start_date} To: ${end_date}\nDays: ${preview_days}\nReason: ${reason}"
  Quick Reply: Confirm | Cancel

BLOCK 8 — Branch Cancel → End polite

BLOCK 9 — Script Action "Submit Request"

(function execute() {
    var tools = new x_786686_hr_leave.HRLXAIAgentTools();
    var res = tools.requestLeave({
        user_id: vaSystem.getUserId(),
        type: vaVars.leave_type,
        start_date: vaVars.start_date,
        end_date: vaVars.end_date,
        reason: vaVars.reason || ''
    });
    vaInputs.ok = !!res.ok;
    vaInputs.req_number = res.number || '';
    vaInputs.err = res.error || '';
})();

BLOCK 10 — Decision ok
  True → "Your leave request ${req_number} has been submitted for approval."
  False → "Sorry, submission failed: ${err}. Try again or contact HR."
  → End

TOPIC FLOW 3 — HRLX Check Policy

BLOCK 1 — Decision: use AI Agent for open questions
  If utterance length > 50 chars OR contains "?"
    → Transfer to AI Agent "HR Leave Assistant" with context
  Else
    → Script Action CheckPolicy with vaInputs.last_utterance

BLOCK 2 — Display answer + citations
BLOCK 3 — "Was this helpful?" Yes/No → log to analytics

TOPIC FLOW 4 — HRLX Cancel Leave

BLOCK 1 — Collect request_number (or pick from list)
  Script Action: getMyRequests → build choice list

BLOCK 2 — Confirm cancellation

BLOCK 3 — Script Action cancelRequest

BLOCK 4 — Success/fail message

TOPIC FLOW 5 — HRLX Live Agent Handoff

BLOCK 1 — Collect issue summary (optional)

BLOCK 2 — Live Agent Queue
  Queue: HR Leave Support
  Pre-chat fields: user_id, last_intent, last_5_messages

BLOCK 3 — Fallback if no agent available
  Script Action escalate()
  Message: "An HR partner will contact you. Case reference logged."

Step 7.11: Enable VA on channels

1. Virtual Agent > Administration > Channels
2. Employee Center: ON, Bot name from x_786686_hr_leave.va.bot_name
3. Service Portal: add Virtual Agent widget to sp_page
4. Topic recommendations: enable HR Leave topics
5. Test: {BASE}/esc

Step 7.12: VA analytics KPIs

Part 8 — Document Intelligence (IDP)

8.1 Use case — medical certificate for sick leave

When u_leave_type = sick and u_days_count > 2, require medical certificate attachment. IDP extracts fields automatically.

Step 8.1: Create IDP template — hrlx_medical_cert

URL: {BASE}/sn_idp_template_list.do

1. New Template
2. Name: hrlx_medical_cert
3. Document type: Medical Certificate
4. Upload 8–12 sample PDFs (anonymized):
   - 3 hospital letterheads
   - 3 clinic formats
   - 2 Arabic certificates
   - 2 poor-scan quality (for robustness)
5. For each sample, annotate bounding boxes:
   - patient_name
   - certificate_date
   - doctor_name
   - days_recommended
   - clinic_name
   - condition_summary
6. Save annotations

Step 8.2: Train extraction model

URL: {BASE}/sn_idp_model_list.do

1. New Model → Template: hrlx_medical_cert
2. Train/Test split: 80/20
3. Click Train (30–90 minutes)
4. Review per-field F1 scores (target ≥ 0.90 each)
5. If condition_summary F1 low: add more samples or mark optional
6. Activate model v1.0
7. Set property x_786686_hr_leave.idp.template = hrlx_medical_cert

Step 8.3: Flow — run IDP on attachment

URL: {BASE}/now/flow-designer

Flow: HRLX IDP Medical Certificate
Trigger: Attachment added to x_786686_hr_leave_req_v2
Condition: u_leave_type=sick^u_days_count>2

Step 1 — Get attachment sys_id
Step 2 — Action: Document Intelligence Extract
  Template: hrlx_medical_cert
  Input: attachment_sys_id
Step 3 — Script (update request):

(function(inputs, outputs) {
    var fields = inputs.extraction_result.fields || {};
    var req = new GlideRecord('x_786686_hr_leave_req_v2');
    if (!req.get(inputs.request_sys_id)) return;

    req.u_cert_date = fields.certificate_date || '';
    req.u_cert_days = fields.days_recommended || '';
    req.u_cert_doctor = fields.doctor_name || '';
    req.u_cert_clinic = fields.clinic_name || '';
    // Mask sensitive summary for display
    req.u_cert_summary = (fields.condition_summary || '').substring(0, 200);
    req.update();

    var aud = new GlideRecord('x_786686_hr_leave_audit_v2');
    aud.initialize();
    aud.u_action = 'idp_extract_cert';
    aud.u_record = req.getUniqueValue();
    aud.u_payload = JSON.stringify(fields);
    aud.u_actor = gs.getUserID();
    aud.u_source = 'idp';
    aud.insert();
})(inputs, outputs);

Step 4 — Decision: days_recommended < u_days_count → notify HR for review
Step 5 — Email employee if extraction failed (manual upload retry)

Step 8.4: Standalone IDP test

1. IDP Admin > Test Extraction
2. Upload new PDF not in training set
3. Verify all fields extracted
4. Latency target: ≤ 8 seconds per document

Step 8.5: IDP metrics dashboard

Part 9 — Workflow Studio AI Actions

Step 9.1: Built-in actions to reuse

Step 9.2: Custom action — HRLX Summarize Leave History

URL: {BASE}/now/flow-designer → Custom Actions

1. New Custom Action: HRLX Summarize Leave History
2. Application: HR Leave
3. Inputs:
   - employee_ref (Reference: x_786686_hr_leave_employee_v2)
   - lookback_days (Integer, default 365)
4. Outputs:
   - summary_text (String)
5. Steps:
   a. Look Up Records: x_786686_hr_leave_req_v2
      Query: u_employee_ref = employee_ref AND sys_created_on >= lookback
   b. Transform Data: build history_text lines
   c. Now Assist Skill: hrlx_summarize_history
   d. Return summary_text
6. Guardrails: PII redaction ON, max_tokens 250

Step 9.3: Flow — weekly manager digest

Trigger: Scheduled weekly Monday 08:00
For Each: managers with pending approvals
  Action: HRLX Summarize Leave History (direct reports, 90 days)
  Action: Send Email with summary + link to workspace

Step 9.4: Flow — auto-classify on submit