Your service knowledge base
33 reviewed bilingual tutorials, narrated videos, current navigation and v2 API guidance.
Video tutorials
Set up your company
- 1
Sign in at cloudattendence.com and select the correct company workspace. A company administrator or an approved invitation provides access.
- 2
Open Settings > General and review company details and timezone. Company time is used in attendance and reports.
- 3
Use Company Management for Employees, Departments, Branches, Devices, Device sharing and Operations.
- 4
Use Attendance for Punch log, shifts, schedules, calendar, rules, justifications, leave, confirmations and attendance reports, according to your permissions.
- 5
Use HR & Payroll for HR overview, personnel, payroll, Monthly Reports, employee services, approvals and policies.
- 6
Invite the people who need access through Team access. Give each role only its required permissions.
- 7
Test one employee, one schedule and a fresh punch before rolling the setup out to everyone. Open the bilingual KB whenever a task needs guidance.
The selected company, role permissions and enabled add-ons determine the screens you can use.
Find the right serviceEnable HR, Payroll and Assets
- 1
Review the effective company plan and Settings > General before enabling an add-on.
- 2
Review your effective plan with the company or platform administrator.
- 3
Confirm employee, device and branch limits before importing data.
- 4
The Global Admin enables the HR and Assets entitlements in the applicable plan.
- 5
In company settings, enable each entitled add-on and save the reason for the change.
- 6
Assign the relevant roles and permissions to the people who will use the modules.
- 7
Refresh the workspace and confirm the enabled sections appear in the menu.
An add-on needs both plan entitlement and company activation.
Find the right serviceConnect a ZKTeco device to the cloud
- 1
Open Company Management > Devices. Use only the exact connection instructions for that registered terminal.
- 2
Confirm your terminal and firmware support ADMS / PUSH attendance. Menu names differ by model; check its official manual.
- 3
Open Devices in your company. Register the exact serial number, name and branch; enable the device. Copy the assigned cloud host, port and communication key if the connection instructions require one.
- 4
On the device, configure Ethernet or Wi-Fi with a valid IP, gateway and DNS. Check it can reach the internet.
- 5
Open Menu > COMM / Communication > Cloud Server Settings / ADMS. Select ADMS as server type when that choice exists.
- 6
For the standard Doiteasy HTTPS deployment, use cloudattendence.com as Server Address, port 443, domain-name mode ON and HTTPS ON. Do not enter a dashboard URL or /iclock path in the host field. If your device uses a full URL field, follow its manual and the company connection instructions.
- 7
Leave Proxy OFF unless your network administrator provides proxy settings. Apply the assigned communication key only when supported and required. Save, then restart communication or reboot as the model requires.
- 8
Wait for the device to appear online. Perform a real test punch and verify employee code, device and Riyadh time in the punch log.
- 9
If the firmware cannot use the supplied HTTPS endpoint, ask support for an approved compatible gateway or device-specific endpoint. Do not switch to an arbitrary port or remove TLS protection.
Online status plus a matching test punch confirms the connection. A biometric face template alone is not an employee photo.
Review attendance before reportingTroubleshoot an offline device
- 1
Open Company Management > Devices and inspect the device connection state and latest contact time.
- 2
Check power, the network cable or Wi-Fi signal and the device network indicator.
- 3
Compare serial number and branch with the enabled cloud record.
- 4
Verify gateway, DNS, server host, port and HTTPS setting together; a valid IP alone does not prove internet access.
- 5
Ask IT to allow outbound traffic to the supplied cloud endpoint and check any router, proxy or TLS inspection restrictions.
- 6
Confirm device time and supported firmware. Restart communication, then watch the latest connection time in Devices.
- 7
Make a fresh punch. If it is still missing, send support the model, firmware, serial, connection settings without secrets, and test time.
Do not delete attendance history or factory-reset the device during a connection check.
Review attendance before reportingImport employees and profile photos
- 1
Open Company Management > Employees, then use the available device-sync or employee import action.
- 2
Open Employees and select Sync from devices, or use the import panel for a specific device.
- 3
Keep the device online while it returns supported employee names, card numbers, photos and templates.
- 4
Use the same employee code on the device and in the company profile. Codes are matched within the company.
- 5
Review unlinked profiles and plan capacity, then retry linking when the required limit is available.
- 6
Open the employee photo/name card to view department, branch, device details and weekly attendance.
- 7
A device photo appears when the firmware sends a supported image; otherwise notifications use an uploaded employee profile photo or the default avatar.
Importing a device profile does not create a cloud login; invite the employee separately.
Review attendance before reportingPrepare shifts and working calendars
- 1
Open Attendance > Shifts, Schedules and Calendar to prepare the working period.
- 2
Create the working shift and confirm start, end, break and applicable grace settings.
- 3
Define weekly working days, holidays and any company calendar exceptions.
- 4
Assign the appropriate shift and branch to each employee.
- 5
Check the company timezone before reviewing late arrivals or early departures.
- 6
Review overnight shifts and missing punch pairs with the attendance manager.
- 7
Open a sample timesheet to confirm the calendar and scheduled days match the intended period.
Attendance ratings need a schedule; approved leave and holidays are excluded from eligible days.
Review attendance before reportingMonitor attendance and notifications
- 1
Use Overview for activity; open Attendance > Punch log for the underlying device records.
- 2
Open the company overview to monitor activity and connected devices.
- 3
Check the arrival and departure popup for employee name, code, avatar and device.
- 4
Open the notification bell for recent punch events; use View punch log for the full record.
- 5
Use Employees to compare today’s recorded hours and attendance rating.
- 6
Select the information icon beside Employee directory to read the weekly rating explanation.
- 7
Click an employee card for the detailed weekly breakdown and device links.
Missing punch pairs require review; displayed hours are based on recorded sign-in and sign-out pairs.
Review attendance before reportingReview timesheets and export reports
- 1
Open Attendance > Attendance reports for date-range reports, or HR & Payroll > Monthly Reports for monthly employee packs.
- 2
Open an employee’s Timesheet or the Attendance reports section.
- 3
Select the employee, date range and company timezone.
- 4
Inspect daily punches, scheduled days, late minutes, missing pairs and leave exceptions.
- 5
Review disputed days through the available attendance review or complaint workflow.
- 6
Export the report as PDF or use Print after checking the selected language and filters.
- 7
Keep the report period and review evidence with the payroll preparation records.
Check totals against source punches before using attendance results for payroll.
Review attendance before reportingRequest and approve overtime
- 1
Open the employee request area, or Attendance > Requests & tasks, according to the account role.
- 2
The employee opens Services or My requests and chooses the overtime request.
- 3
Enter the date, requested hours, reason and any required attachment.
- 4
Submit and check the current reviewer in the request timeline.
- 5
The HR Agent reviews the request and forwards it to the HR Manager.
- 6
The HR Manager approves or rejects it with the decision recorded.
- 7
Payroll staff include approved overtime in the applicable pay period after checking the configured policy.
A submitted or reviewed request is not an approved payroll item.
Review attendance before reportingBack up device data safely
- 1
Open Company Management > Devices and choose the registered device and its backup/import tools.
- 2
Open the device import panel and receive the latest supported profiles and data.
- 3
Create a backup version from Device backups.
- 4
Review the recorded employee, template, photo and attendance counts.
- 5
For restore, select a version and confirm the destination device.
- 6
Confirm template and photo compatibility before including biometrics.
- 7
Monitor queued, acknowledged, pending and failed restore commands.
Restore merges supported profiles; it does not restore firmware, device passwords or replay archived attendance.
Review attendance before reportingPrepare personnel and salary profiles
- 1
Open HR & Payroll > Personnel. The HR overview highlights profile coverage and recorded expiry alerts.
- 2
Enable the HR add-on, then open Personnel and select an employee.
- 3
Record joining date, nationality group, identity documents, contract reference and cost center.
- 4
Enter the basic salary, housing, transport and applicable fixed allowances.
- 5
Record the bank IBAN and the insurance base, category and references verified by your payroll team.
- 6
Review identity and contract expiry dates and upload approved employee documents when needed.
- 7
Save the profile and check that the employee is ready for the intended payroll period.
Use verified policy values; sample data and configurable calculations are not an official government determination.
Keep HR reviews and payroll connectedRun the monthly payroll cycle
- 1
Open HR & Payroll > Payroll and select the intended company and payroll month.
- 2
Select the payroll month and eligible employees.
- 3
Confirm salary profiles, attendance review, paid days and approved leave before calculation.
- 4
Include approved overtime, variable allowances, loans, advances and authorized deductions.
- 5
Calculate the period and review each employee’s earnings, deductions, gross and net salary.
- 6
Resolve review warnings and obtain the required company approvals before publishing.
- 7
Publish the approved payroll and make payslips available in the employee portal.
Always review calculations and approval status before publishing or paying salaries.
Keep HR reviews and payroll connectedDownload payslips and official documents
- 1
Use the employee published-document area or HR & Payroll > Monthly Reports for the selected period.
- 2
Employees open Payroll to view published payslips for their own account.
- 3
Choose the month and review earnings, deductions, paid days and net salary.
- 4
Choose Arabic or English before downloading so the document uses one language and the correct direction.
- 5
Use Download PDF or Print to keep an official copy.
- 6
For approved service letters, open My requests or My documents and select the available document.
- 7
Contact HR if a payslip is unpublished, missing or under review; employees cannot publish payroll themselves.
Company branding and an uploaded transparent stamp can appear on supported official documents.
Monthly reports for one, selected or allPrepare WPS and government connections
- 1
Open HR & Payroll > Government connections and review actual provider readiness before planning an external export.
- 2
Open Policies & connections or the relevant API configuration page.
- 3
Record approved access details for each provider when your company obtains them.
- 4
Keep Qiwa, GOSI, Mudad/WPS, Muqeem and Absher connections disabled until credentials and the approved service contract are available.
- 5
For payroll files, obtain your bank’s current WPS/SIF specification and validate the account and pay data.
- 6
Review and export supported files only after your payroll team checks their required format.
- 7
Track provider responses and errors when a configured integration is enabled.
Configuration readiness does not mean a provider connection is live or certified.
Keep HR reviews and payroll connectedManage loans and final settlements
- 1
Open Company Management > Operations > Salary administration for loans and advances. Final settlements remain under HR & Payroll.
- 2
Record an authorized loan or advance with amount, repayment terms and employee reference.
- 3
Review approval and repayment schedules before including installments in payroll.
- 4
For an employee leaving the company, verify service dates, reason and approved salary components.
- 5
Review leave balances, unpaid amounts, outstanding loans and assets still in custody.
- 6
Use final settlement and end-of-service tools with the company’s current verified policy.
- 7
Approve the reviewed settlement and download its supporting documents.
Final entitlements require review against the applicable contract and current rules.
Keep HR reviews and payroll connectedCreate the company asset register
- 1
Open Assets. Asset inventory and employee custody are separate from attendance terminals in Company Management > Devices.
- 2
Confirm Assets is included in the company plan and enabled in company settings.
- 3
Assign an Assets Agent with the relevant inventory permissions.
- 4
Open Assets and create an asset with a clear name, type and model.
- 5
Record the serial number and barcode; keep identifiers unique and traceable.
- 6
Add the branch, condition and other available inventory details.
- 7
Save and check the asset is available before creating an employee assignment.
Serial numbers and barcodes identify inventory; they should not be shared between distinct assets.
Keep HR reviews and payroll connectedAssign an asset and obtain acceptance
- 1
Open Assets and select the item and the intended employee before starting a handover.
- 2
The Assets Agent selects an available asset and the employee who will receive it.
- 3
Create the assignment and record the handover information requested by the form.
- 4
The employee opens their asset section in the self-service portal.
- 5
They review the type, model, serial, barcode and condition before accepting.
- 6
After acceptance, the employee cannot revoke that acceptance.
- 7
The Assets Agent or company manager monitors custody and retains the assignment record.
Acceptance is an employee action; managers release custody through the authorized return flow.
Keep HR reviews and payroll connectedRelease, return and reassign assets
- 1
Open Assets and locate the current custody record and its authorized return or release action.
- 2
Open the current employee custody record and verify the asset identity.
- 3
Inspect the returned device and record its condition or any damage.
- 4
The Assets Agent or company manager releases the assignment using the authorized action.
- 5
Confirm custody is closed and the asset status matches the return result.
- 6
If available for reuse, create a new assignment to the next employee.
- 7
Review custody during offboarding and keep the history for inventory reconciliation.
Employees cannot release their own accepted custody.
Keep HR reviews and payroll connectedUse the employee portal
- 1
Sign in with the employee account. The employee portal shows only the employee’s permitted services and records.
- 2
Sign in through Employee login using the account invitation and assigned credentials.
- 3
Open Home to review your leave balance and available services.
- 4
Use My timesheet to inspect your own attendance.
- 5
Open Services to submit leave, attendance complaints, overtime or other enabled requests.
- 6
Track each request, its current reviewer and the recorded decisions.
- 7
Download published payslips and approved documents, and review any assigned assets.
Employees view their own records and the services their company has enabled.
Keep HR reviews and payroll connectedTrack HR review and manager approval
- 1
Open HR & Payroll > HR services & requests or Approvals. Inspect the current stage and named waiting person.
- 2
The employee submits a request with complete details and required attachments.
- 3
The request shows that it is waiting for the HR Agent and identifies the responsible reviewer when assigned.
- 4
The HR Agent checks the content and forwards it to the HR Manager.
- 5
The employee timeline updates to show the manager stage.
- 6
The HR Manager approves or rejects the request and records the outcome.
- 7
Approved downloadable documents become available from the employee’s request or document section.
Use the current reviewer and history to distinguish pending review from a final decision.
Keep HR reviews and payroll connectedMonitor identity and document expiry
- 1
Open HR & Payroll > Document expiry, or use the recorded expiry alerts in HR overview.
- 2
Enter verified expiry dates for national ID, Iqama, passport, driving license and relevant visas.
- 3
Review the employee’s documents and manually verified visa status.
- 4
Configure approved provider access before enabling automated external status checks.
- 5
Review the monitoring dashboard and HR alerts regularly.
- 6
Ensure HR Manager escalation is configured for one week before expiry.
- 7
Record renewal evidence and update the expiry date after verification.
Visa and traffic data need approved external services; an expiry date alone is not a live status check.
Keep HR reviews and payroll connectedApply company branding and stamp
- 1
Open Settings > Branding with an authorized company account.
- 2
Review the company identity, logo, primary and secondary colors, typography, button text, banner colors and report settings.
- 3
Choose a valid color in the picker or enter its hexadecimal value. Save the company changes and refresh a second screen to check the saved palette.
- 4
Review Company Management > Operations, HR & Payroll, Mobile App and Remote Work. Enabled company branding applies to their cards, actions, charts and neutral notices.
- 5
Upload only the company’s approved stamp and logo assets. Check their legibility on a light report page.
- 6
Open a report preview and its downloaded PDF. Check employee name and code, table headings, dividers and centered content.
- 7
Keep approval, rejection and warning states distinguishable. A visual stamp or generated PDF does not by itself execute a payment or create an external approval.
A saved company palette should be consistent across the screen and its exported document.
Branding, access and accountabilityConfigure PIN, 2FA and secure access
- 1
Open Settings > Security for your account and the applicable 2FA policies for the company.
- 2
Use your own account. Set or unlock the separate six-digit security PIN only in the site’s secure interface; never put it in a support ticket, video or chat.
- 3
Use Team access to grant the minimum required role permissions. Do not share administrator credentials with employees.
- 4
Use View as employee only when your role is authorized. Check which employee is being represented and leave impersonation when the task ends.
- 5
Open Settings > Audit log to review password changes, impersonation events, confirmations, approvals, additions, modifications and deletions captured by the system.
- 6
For newer events, inspect the recorded real actor, affected user or record and company. Older entries may use current names or incomplete historical identity; do not infer a missing actor.
- 7
Review the company timezone and sign out on shared devices. Password values, PINs and tokens are never appropriate audit or public tutorial content.
Audit events explain recorded actions; they are not a reconstruction of identities that were never captured.
Branding, access and accountabilityConfigure email, WhatsApp and API access
- 1
Open Settings > General for company communication settings and Settings > API integrations for machine access.
- 2
Check the actual email or WhatsApp readiness. A configured or preview provider is not a delivered message or a live government connection.
- 3
Create a named, time-limited integration key with only the required read, write or approval grants. Save the once-shown key in a server secret store.
- 4
Use https://cloudattendence.com/api/integration/v2 as the current machine API base. Send Authorization: Bearer YOUR_API_KEY in the header; never in a URL.
- 5
Begin with GET /api/integration/v2/capabilities using account:read. Check permissions and entitlements before calling a protected module.
- 6
Use the live API reference and version-specific OpenAPI schema for the exact method, fields, paging and error responses. v1 remains a supported contract; new integrations should select v2.
- 7
Rotate or revoke exposed keys. Interactive web sessions, mobile sessions and integration keys have different contracts and cannot be substituted for one another.
The published v2 schema is the authority for integration endpoints; a feature in the web UI is not automatically a public API.
Connect using the published v2 APIFind company operations by category
- 1
Open Company Management > Operations. Operations no longer sits under HR & Payroll.
- 2
Use the five category cards: Organization, Salary administration, Recruitment, Personnel and Performance.
- 3
Search with an English or Arabic module name, or select one category. Clear filters to restore all modules available to your account.
- 4
Choose a module card to open its existing register. Examples include allowances, loans, salary advances, deductions, contracts, training and performance reviews.
- 5
Use New record only if your account has write permission. Follow the original form, review and approval actions.
- 6
Use All operations to return to the dashboard. Browser Back and a direct register link retain the selected workflow.
- 7
Category and module counts reflect the authorized catalog, not employee counts or financial totals.
The dashboard organizes access; it does not approve records or change payroll automatically.
Find the right serviceMonthly reports for one, selected or all employees
- 1
Open HR & Payroll > Monthly Reports and choose the month.
- 2
Choose One employee, Selected employees or All employees. Scope is still limited by your authorized company and permissions.
- 3
For one or selected employees, search by employee name, code or ID. Choose the autocomplete result rather than leaving an unmatched search string.
- 4
Review the selected employees, then choose View report. Clear or change the selection before running another scope.
- 5
Read employee name and code, attendance, leave, justifications, reviewed deductions, published payslip figures and acknowledgment where present.
- 6
Check whether each report is published or a preview. Only approved and published payroll figures represent the published salary; viewing a report does not publish payroll.
- 7
Download the individual PDF. Where multiple PDFs are offered, use the provided bundle or ZIP. Check language, branding, table headings and the two-line Viewed on footer.
- 8
A report can include historical employees when the selected all-employees scope offers them. Confirm the period and recipients before sharing payroll documents.
Name, code or ID can locate a person; permissions still determine which report can be opened.
Monthly reports for one, selected or allUse the HR overview and payroll charts
- 1
Open HR & Payroll > HR overview to see the metrics available to your role.
- 2
Review active employees, personnel profile coverage, recorded document alerts and organization information where permitted.
- 3
Use profile coverage and document-expiry cards to open the relevant personnel workflow.
- 4
Read the six-month payroll chart as published batch totals. A draft batch or a zero month is not an employee salary calculation.
- 5
Open Payroll, Personnel, Approvals, Final settlements, Document expiry or Policies from the collapsible HR & Payroll menu.
- 6
HR modules require their effective plan entitlement and account permissions. Missing access must not be interpreted as zero business activity.
Dashboard figures summarize recorded, authorized data and do not replace payroll review.
Keep HR reviews and payroll connectedIdentify who changed, approved or impersonated
- 1
Open Settings > Audit log with an authorized company account. Global administrators use the corresponding global settings area.
- 2
Filter or search for password actions, impersonation, confirmations, approvals, additions, modifications and deletions.
- 3
Read the real actor separately from an effective employee identity during impersonation.
- 4
Open the affected user or record details and check the company and timestamp. Use the company timezone consistently.
- 5
Newer entries capture allowlisted actor and target identity at the time of the event. Legacy entries may show current identity or incomplete history.
- 6
Do not infer missing historical actors and do not copy secrets into an audit note or support request. Use the recorded evidence when investigating a change.
The audit log records accountability without storing password or PIN values.
Branding, access and accountabilityConfigure and use Mobile App attendance
- 1
Open Mobile App. Review company access, attendance locations, configured employees and recorded activity.
- 2
An authorized company administrator enables the company and employee settings and assigns active locations. The configured attendance radius is 100 metres.
- 3
Use the location wizard to select an accurate map pin, name the location and assign it to the intended company or the authorized global list.
- 4
Employees use the company-specific mobile sign-in flow and their existing employee account. Enabling attendance does not create a new password.
- 5
Grant location permission on the employee device when requested for a punch. Check the permitted site and the next sign-in or sign-out action.
- 6
Complete the enabled confirmation method. Location, session, MFA, PIN and policy requirements remain enforced by the server.
- 7
Review recorded check-in and check-out activity and correct setup problems through the administrator. A map pin or successful login alone is not a recorded punch.
Use the mobile API contract for mobile clients; an integration key cannot replace an employee mobile session.
Mobile attendance and optional remote workUnderstand the optional Remote Work Monitor
- 1
Open Remote Work to review the company’s actual add-on and readiness state.
- 2
If Monitoring is not active or the add-on is disabled, no enabled monitoring service should be assumed. Ask the authorized administrator about eligibility.
- 3
The operator verifies required storage, processing and backup locations before pairing or telemetry begins.
- 4
When enabled, HR approves the work arrangement and the employee pairs the supported desktop agent through the published setup flow.
- 5
Use work sessions, assigned tasks and transparent activity reports according to the enabled policy and role.
- 6
Review the current setup and privacy guide before installing an agent. An available download is not proof that a company or employee is authorized for monitoring.
Readiness, company activation, HR approval and employee pairing are separate checks.
Mobile attendance and optional remote workAsk the Smart Assistant for monthly reports
- 1
Open the floating Smart Assistant at the screen corner. It stays available while the page scrolls.
- 2
Choose Monthly employee reports or ask for a monthly report in Arabic or English.
- 3
Choose the month and One employee, Selected employees or All employees.
- 4
Search employee name, code or ID and select the intended autocomplete results where required.
- 5
Review the scope, then open the report and its available PDF or bundle. The same company and role restrictions apply.
- 6
Treat generated explanations and pay estimates as assistance. The assistant does not publish payroll or approve a record on your behalf.
- 7
Close the assistant with its close button or Escape. The launcher remains available as you continue working.
AI-generated explanations and voice can contain mistakes; verify the underlying recorded report.
Monthly reports for one, selected or allStart a scoped v2 API integration
- 1
Open Settings > API integrations and create the minimum required machine key with an expiry date.
- 2
Read the current schema at /api/integration/v2/openapi.json and the interactive /api-reference page. Keep v1 clients on their version until tested migration.
- 3
Send the key in the Authorization Bearer header over HTTPS. Start with /api/integration/v2/capabilities using account:read.
- 4
Review request-workflow routes for the current reviewer, stage, authorized actions and approved-document snapshots. A write grant is not an approval grant.
- 5
Use communications/status for sanitized readiness and hr/compliance routes for recorded expiry and provider-readiness data. They do not send messages or establish government connections.
- 6
Use the endpoint’s actual paging fields and response schema. Treat 401, 403, 409, 422 and 429 as errors, respect Retry-After when present, and check a create before retrying it.
- 7
Test against a company and key authorized for the intended module, then rotate or revoke temporary credentials. Use the API update guide for the verified v1/v2 differences.
The live schema is authoritative. Do not invent a public endpoint for a web-only feature.
Connect using the published v2 APICheck report views, tables and PDF downloads
- 1
Open the report or record view and confirm the employee name, code, selected period and language.
- 2
Review the on-screen content before downloading. Table headings use white text on the report’s branded header; thin dividers and centered content aid comparison.
- 3
Check the employee overview, reason and decision, reviewer history and reconciliation tables where provided.
- 4
The Viewed on label is bold. Its normal-weight date, time and timezone share the second line.
- 5
Choose Download PDF for the corresponding document design, or use Print preview for the print view.
- 6
For Arabic policy or report sections, review reading direction and spacing. Company branding and supported stamp or logo settings should carry through to the document.
- 7
If the downloaded report is unexpected, record the report type, language and period in Support without attaching unnecessary personal or salary information.
Compare the same report, language, employee scope and period before reporting a design discrepancy.
Monthly reports for one, selected or all