Timeclock Clock In icon

Timeclock Clock In

Clock in a user in the timeclock system

Overview

This node, named "Timeclock Clock In," allows users to clock in a user into a timeclock system associated with a specific ticket. It is useful in scenarios where tracking the start time of work on a particular ticket or task is necessary, such as in managed service provider environments or helpdesk systems. By providing a ticket ID, the node records the clock-in event and returns details about the timeclock entry.

Practical examples include:

  • Automatically starting a timer when a technician begins working on a support ticket.
  • Logging time entries for billing or auditing purposes linked to specific tickets.
  • Integrating with other workflow steps that require knowledge of when work started on a ticket.

Properties

Name Meaning
Ticket ID The numeric ID of the ticket to clock into. This identifies which ticket the clock-in action applies to.
Data Selection A multiline string specifying which fields to return in the response. If left empty, default fields are returned. Example fields include: id, start, end, ticketId, message, etc.

Output

The node outputs an array with one element per input item. Each element contains a json object representing the clock-in record returned from the timeclock system. The structure of this JSON object includes the fields specified in the "Data Selection" property, or a default set if none is provided. Typical fields include:

  • id: Identifier of the clock-in record.
  • start: Timestamp when the clock-in started.
  • originalStart: Original start time before any adjustments.
  • end: Timestamp when the clock-out occurred (if applicable).
  • originalEnd: Original end time before any adjustments.
  • lastActive: Last active timestamp.
  • ticketId: The ticket ID associated with this clock-in.
  • todoId: Related todo item ID.
  • coreUserId: User ID in the core system.
  • autotaskUserId: User ID in the autotask system.
  • isDispatchedTicket: Boolean indicating if the ticket was dispatched.
  • message: Any message associated with the clock-in.
  • ticketCompleted: Boolean indicating if the ticket is completed.
  • ticketUpdateData: Additional update data related to the ticket.
  • fromRole: Role from which the clock-in was made.
  • mergeFromTicketId: ID of a ticket merged from.
  • isSynced: Boolean indicating synchronization status.

If the node encounters an error and "Continue On Fail" is enabled, it outputs an object with an error field containing the error message.

Dependencies

  • Requires an API key credential for authentication with the Enlightened MSP GraphQL endpoint.
  • The node uses a GraphQL mutation named timeclockClockin to perform the clock-in operation.
  • The environment must have access to the configured GraphQL endpoint.

Troubleshooting

  • Common issues:

    • Invalid or missing ticket ID: Ensure the ticket ID provided exists and is valid.
    • Authentication failures: Verify that the API key credential is correctly configured and has sufficient permissions.
    • Network or endpoint errors: Confirm that the GraphQL endpoint is reachable and operational.

  • Error messages:

    • Errors thrown by the GraphQL API will be surfaced as node errors unless "Continue On Fail" is enabled.
    • Typical error messages may relate to invalid input, permission denied, or server unavailability.

To resolve errors:

  • Double-check input parameters.
  • Validate credentials.
  • Review network connectivity.
  • Consult the API documentation or support for the timeclock system.

Links and References

  • No direct external links are provided in the source code.
  • For more information, consult the documentation of the Enlightened MSP GraphQL API or the timeclock system integrated with this node.

Discussion