Error codes
A list of error codes you might encounter when creating or customizing pages.
This article contains the error codes you can encounter in the Skedulo Pulse Platform and their meanings.
Generic
| Code | Meaning |
|---|---|
unknown |
An unknown error has occurred. Usually, these codes are used when we haven’t yet implemented error codes in the given area. If found, please make a point of setting a specific error code if possible. |
UI Crud
| Code | Variances | Meaning |
|---|---|---|
XNotFound |
DataSchemaNotFoundDataSchemaFieldOverlayNotFoundDataSchemaRelationshipOverlayNotFoundFilterNotFoundListNotFoundNavNotFoundResourceNotFoundTemplateNotFoundValidationNotFoundViewOverrideNotFound |
The given configuration/document does not exist. |
XKeyAlreadyExists |
DataSchemaKeyAlreadyExistsDataSchemaFieldOverlayKeyAlreadyExists DataSchemaRelationshipOverlayKeyAlreadyExistsFilterKeyAlreadyExistsListKeyAlreadyExistsNavKeyAlreadyExistsResourceKeyAlreadyExistsTemplateKeyAlreadyExistsValidationKeyAlreadyExistsViewOverrideKeyAlreadyExists |
The unique key/constraint for the given configuration/document already exists within the given namespace. |
XForeignKeyViolation |
TemplateForeignKeyViolation |
Configuration cannot be deleted or updated due to an existing or missing reference from another table. |
UI API
| Code | Meaning |
|---|---|
UnknownBulkAction |
The bulk action specified doesn’t exist. |
AccessDenied |
You do not have permission to perform the given action. More information can be found in the error message. |
InvalidReferenceId |
Returned during data validation when validating a reference field but the given record ID is missing/blank. |
FieldNotUnique |
Returned during data validation when checking if a field is unique but a duplicate is found. |
MissingIdentifier |
Returned from GET endpoints when you haven’t provided enough information. |
OwnershipMismatch |
Returns from PageTemplate endpoints when you try to relate a page and template that do not have the same ownership information. |
KafkaConsumptionFailed |
Something went wrong during the consumption of a Kafka message. |
Query API
| Code | Meaning |
|---|---|
CustomRequestFailed |
Something went wrong when sending the custom datasource request. This could mean a part of your resource configuration is wrong. |
CustomRequestTimeout |
The custom datasource request did not return a result within the allocated time. |
CustomResponseMappingFailed |
Something went wrong when mapping the response from the custom datasource. This usually means a part of your resource configuration is wrong. |
ElasticSearchRequestFailed |
Something went wrong when sending the elasticsearch datasource request. This could mean a part of your resource configuration is wrong. |
GetAllTenantMetadataFailed |
Returned from the MetadataClient when we are unable to get a list of all objects/metadata from the custom/metadata Skedulo API. |
GetCustomDataSchemaFailed |
Something went wrong when getting the data-schema for a custom resource. This suggests something is wrong with the resource configuration. |
GetGraphQLDataSchemaFailed |
Something went wrong when getting the data-schema for a graphql resource. This suggests either: 1. Something is wrong with the resource configuration. 2. The environment is out of sync with the core Skedulo data model. 3. The request was made using a token that belongs to an incorrect tenant. |
GetObjectMetadataFailed |
Returned from the MetadataClient when we are unable to get a list of object fields/metadata from the custom/metadata/{mapping} Skedulo API. |
GraphQLRequestFailed |
Something went wrong when sending the graphql datasource request. This could mean a part of your resource configuration is wrong. |
GraphQLRequestTimeout |
The graphql datasource request did not return a result within the allocated time. |
InvalidFilter |
The lucene parser was able to parse the given query, but one of the filters given within it is invalid in some way. |
LuceneParsingFailed |
Returned from the Lucene parser when something goes wrong. This could mean that: 1. You have given an invalid query string. 2. Something went wrong internally. |
LuceneResolutionFailed |
Returned from the Lucene resolver when something goes wrong. This typically means either: 1. There is an invalid relationship configuration. 2. The lucene filter is invalid. 3. Something went wrong resolving the nested relationships. |
RecordNotFound |
Returned from the getObject endpoint when the given record ID is not found. |
QueryMultipleExecutionFailed |
Something went wrong while querying a list of records. The error could not be any more specific. |
QuerySingleExecutionFailed |
Something went wrong while querying a single record. The error could not be any more specific. |
ValidationFailed |
Returned from the createObject and updateObject endpoints when the given record data fails validation. |
KafkaConsumptionFailed |
Something went wrong during the consumption of a Kafka message. |
UI Framework
| Code | Meaning |
|---|---|
TemplateRenderFailed |
Something went wrong in the Nunjucks environment when parsing a template. This could be a template syntax error, or another issue caused template parsing to fail. |
DataTableInvalidList |
Something went wrong trying to get the list of cells for a column in the data table. |
DataTableMissingSchema |
The Data Table in a List View could not be rendered because the columns Data Schema is missing. |
ReflectiveTabsInvalidTabsList |
A malformed tab list was supplied to the reflective tabs component. |
Get started with Skedulo Plus extensions
Download the Skedulo Plus examples repository to get started with Skedulo Plus extensions.
Skedulo concepts
This chapter provides an overview of core Skedulo concepts and our data model.
API Overview
This section will help you get started with using the Skedulo API.
Authentication requirements and API tokens
Authentication requirements for Skedulo API users
Build and deploy a standalone web page (formerly known as Connected Pages)
Developing web extensions (connected pages) for your organization.
Create a webhook
Establishing and using webhooks.
Create and configure work
Creating and configuring jobs in Skedulo
Create and customize objects, and fields
How to add custom data objects and fields in Skedulo.
Create and deploy packages with the SDK
Create and deploy a suite of custom content to your Skedulo organization using packages.
Create custom objects and fields with the Skedulo API
Using the Skedulo API to create custom objects and unique fields.
Create custom objects in Salesforce
How to add data objects in Skedulo for Salesforce.
Flat page components
Configure components for flat pages in Skedulo Plus extensions.
Get started with GraphQL
Use the Skedulo GraphQL schema to interact with objects and fields.
Get started with libraries
The generated library using Skedulo SDK
Get started with Skedulo packages
Create a Skedulo package using the SDK.
Getting started with Skedulo
This section will walk you through basic setup and authentication requirements for using Skedulo and its APIs.
Install and set up Skedulo Packages SDK
Install and set up the Skedulo SDK.
Install the GraphiQL web extension
Add the GraphiQL web extension in the Skedulo web application.
Install the Skedulo CLI for mobile extensions
Install dependencies and tools for creating Skedulo Plus extensions.
Introduction to custom functions
How to use the Skedulo CLI to develop custom functions for web and mobile extensions.
Introduction to custom objects and fields in Skedulo
Overview of custom object and field documentation and requirements.
Introduction to pages
Understanding pages on the Skedulo Pulse Platform.
Introduction to the Skedulo CLI
What the Skedulo CLI is and what it does.
Introduction to triggered actions
Perform actions in response to Skedulo events.
Mobile extensions page type definition
Introduction to the page types in the UI definition file.
Object and field permissions (deprecated)
Permission restrictions for schedulers and resources.
Overview of package components
Get to know the types of components that can be used in the Skedulo packages.
Overview of Skedulo picklists
Get to know object picklists in the Skedulo web application.
Overview of triggered actions and webhooks
Introduction to triggered actions and webhooks, and what can be achieved with each.
Provision user accounts via the API
How to create a user record via REST API on the Skedulo Pulse Platform.
Skedulo Plus extension components overview
Understand the pages and components that are used to build Skedulo Plus extensions.
Skedulo Plus extensions
Create custom mobile page views for the Skedulo Plus mobile application.
Skedulo v2 mobile app extensions for custom forms
Use the SDK to developer mobile extensions for the Skedulo v2 mobile app.
Skedulo v2 mobile extension
Custom mobile page views for the Skedulo v2 mobile application using the SDK.
Suggest: Resources and times for a job
Optimize resources, schedule, and dispatch a job using the optimize/resource_suggestions endpoint and GraphQL
Use list views
Access list view functionality and manage permissions.
Use tags for resources and jobs
Using resource skill tags and assigning tags to jobs.
Using the Geoservices API
Overview of the Geoservices API and location management in Skedulo.
Create an object and add custom fields
This article covers how to create the Arcade Games custom object and set up some custom fields.
Manage pages
View and modify the pages available on your tenant.
Manually run a job to evaluate pre-existing schedules
Using a service that can evaluate records against the Rule service’s core rules.
Configure the navigation menu
This article covers how to configure the navigation menu.
Add Contact tags to Accounts using GraphQL
Using GraphQL to add contacts to accounts.
Add custom fields to your custom object in Salesforce
How to create custom fields in Skedulo for Salesforce.
Authentication for Skedulo for Salesforce
Authentication requirements for Skedulo for Salesforce managed package users.
Build and deploy embedded web extensions
Creating web extensions as embedded custom tabs on jobs and resources pages.
Build and deploy multiple pages as a package
Creating web extensions for the Skedulo web application using the Skedulo Packages SDK.
Build and deploy Skedulo v2 mobile app extensions
Build mobile extensions using Skedulo SDK.
Create a triggered action for modified objects
Setting up a new triggered action that triggers when a Skedulo object is modified.
Create and customize pages
Create pages on the Skedulo Pulse Platform using Horizon and Breeze components.
Create custom objects and fields in the Skedulo Pulse Platform
How to create custom objects and fields in the Skedulo Pulse Platform.
Create custom objects and fields in the Skedulo Pulse Platform
How to add custom objects to meet your use case requirements.
Create libraries with the SDK
A package component for writing re-usable code that is shared amongst multiple package components.
Create pages
Create and preview pages on the Skedulo Pulse Platform.
Deprecated: Use provisioning to create multiple user accounts
IMPORTANT!! Provisioning user records in bulk via REST API is deprecated. Users should use the Skedulo web app Data loader for user record management.
Develop a function
How to use the Skedulo CLI to develop custom functions for extensions, automations, and integrations.
Error handling and debugging triggered actions and webhooks
How retries work and how to view webhook and triggered action logs.
sked artifacts function
Manage the retrieval and deployment of functions
Get started with Skedulo Plus extensions
Learn how to get started with Skedulo Plus extensions.
Install the Skedulo CLI
How to download and install the Skedulo CLI.
Introduction to Skedulo libraries
Get to know how dependency works with Skedulo libraries.
Job lifecycle
Skedulo job and allocation lifecycle.
List pages
Configure list pages for mobile extensions.
Make API calls from Salesforce
Making calls to the Skedulo API from Salesforce using Apex
Manage resource availability
Resource availability and scheduled activities.
sked artifacts mobile-extension
Manage the retrieval and deployment of mobile extensions.
Modify picklist items and field dependencies
Use the Skedulo API to modify picklist values and field dependencies.
Override the default Create record page
This article covers how to override the default settings of the arcade-games-create page.
Page types
Get to know the different page types.
Query the GraphQL schema
Querying the Skedulo GraphQL schema.
Quickstart
An introduction to using the Skedulo API
Role-based permissions (deprecated)
Setting permissions for users and objects based on their role.
Schedule or defer a webhook
Defer a webhook or schedule a webhook to trigger at a specified time.
Section
A container of components that is used to group data into regions on a flat page.
Set Skedulo Plus extension context and metadata
Configure the context and metadata for a Skedulo Plus extension to display the extension on the job details screen or as a global form for all resource users in your team.
Skedulo for Salesforce permission sets
Assigning the correct permission sets for Skedulo for Salesforce users.
Sort list views
Use the Sort option to sort your list view data.
Suggest: Times to schedule a job
Optimize resources, schedule, and dispatch a job using the optimize/suggest endpoint and GraphQL
sked artifacts triggered-action
Manage the retrieval and deployment of triggered actions.
Use shared components library
A package library that share react components for both web extension and mobile extension.
Use the Skedulo REST API
Using the Skedulo REST API endpoints to send and retrieve data remotely.
sked artifacts user-role
Manage the retrieval and deployment of user roles.
sked artifacts web-extension
Manage the retrieval and deployment of web extensions.
sked artifacts webhook
Manage the retrieval and deployment of webhooks.
Override the default View record page
This article covers how to override the default settings of the arcade-games-view page.
Override the default Edit record page
This article covers how to override the default settings of the arcade-games-edit page.
Skedulo Plus extension files and data
Understand the file structure and data definitions for Skedulo Plus extensions.
Add Resource tags to Jobs using GraphQL
Using GraphQL to create a job with tags for resource skill requirements.
Authenticate with the Skedulo CLI
How to authenticate to Skedulo tenants using the Skedulo CLI.
Automate responses to changes using webhooks and triggered actions
Integrating Skedulo with third party applications using webhooks and triggered actions.
Change the extension title and summary
Modify the UI definition to change the title and description fields of your Skedulo Plus extension.
Create a scheduled optimization
Create large scheduling queries to be run at a specified time daily, weekly, or monthly.
Create and customize list views
Creating and customizing list views in the Skedulo web app.
Customize pages
Edit pages and customize your experience on the Skedulo Pulse Platform.
Deskless Productivity Cloud fundamentals
Understanding the fundamentals of interacting with the Skedulo APIs and the Deskless Productivity Cloud.
Edit the default columns
Configure which fields you want available to be displayed on your list view.
Error codes
A list of error codes you might encounter when creating or customizing pages.
Estimate travel times between work items (deprecated)
Using the Planr Geoservices endpoint to approximate resource travel time.
Extend Skedulo functionality with custom functions
How to use the Skedulo CLI to develop custom functions for web and mobile extensions.
Extend Skedulo functionality with functions
How to use Skedulo functions to develop custom functions for web and mobile extensions.
Filter list views
Use the Filter options to restrict which data is displayed.
Insufficient access (deprecated)
Insufficient access errors and overriding default permissions.
Job start and end times
Setting job start and end time fields.
Make generic Skedulo API requests using Salesforce
Making generic requests to the Skedulo API using Salesforce.
Manage incoming SMS with webhooks
Using webhooks to manage incoming SMS related to jobs
Optimized scheduling using the Skedulo API
Find a valid scheduling solution for multiple jobs and resources.
Page components
Get to know the flat page and list page components.
Perform multiple actions using GraphQL aliases
Use aliases to perform multiple actions in a single GraphQL mutation
sked tenant
Overview of sked tenant format reference.
Skedulo permissions and access control (deprecated)
Permission restrictions for schedulers and resources.
Skedulo Plus extensions component library
Technical specifications for the UI components of Skedulo Plus extensions.
Text editor
Configure text editor page components for flat page components.
Update a triggered action
Modify an existing triggered action.
Use GraphQL
Using the Skedulo GraphQL schema to interact with objects and fields.
Use GraphQL to fetch instance data
Use the instanceFetch file to fetch input data for the form, depending on the form type.
Use GraphQL to query custom objects and fields
How to use GraphQL to interact with custom object data.
Use the Skedulo Software Development Kit (SDK)
How to use the Skedulo Packages SDK to develop custom pages and server extensions for the web application and mobile.
Use webhooks
Using webhooks for Skedulo events.
Web extensions API services
Using injected API services for developing web extensions.
Edit the column templates
Configure how your data is displayed on a List view page.
List view columns
Use the Columns option to choose which columns are visible.
Text view
A simple text field to show basic context in a flat page.
Best practices: Create record access policies and rules
Best practices for creating rules and policies that control user access to data.
Configure default columns for list views
Define which columns are visible for your object on the default list view.
Customize and modify Skedulo picklist values
Managing object picklists in the Skedulo web application.
Delete a triggered action
Delete an existing triggered action.
Develop and deploy custom code using connected functions and the SDK
Using back end API functionality to automate specific behavior in response to certain triggers.
Fetch static data
Understand how static data is fetched in mobile extensions.
Geolocation field type and distance comparison
GraphQL queries for filtering by geolocation and distance from a fixed point
Job time constraints
Adding time constraints to jobs
Make changes to the schema using GraphQL mutations
Use GraphQL mutations to make changes to the schema.
Make Skedulo API Notification requests using Salesforce
Dispatch jobs and notify resources from Salesforce using the Skedulo API.
Manage and schedule work
Manage accounts, resource availability, and optimize schedules.
Optimize vs Suggest
What is the difference between using optimize and suggest for allocating jobs?
Override system-generated pages
A tutorial taking you through the process of overriding the default system-generated pages and configuring your data.
Override the default List view page
This article covers how to override the default settings of the arcade-games-list page.
Select editor
Configure the select editor component for Skedulo Plus flat page mobile extensions.
Understand the Lookup and Has many custom field types
Information about the reference custom fields that create links between objects in the data schema.
Use triggered actions
Perform actions in response to Skedulo event triggers.
Use triggered actions
Perform actions in response to Skedulo event triggers.
Valid Date and DateTime formats
Specify the right format for dateTime and date fields.
Work with artifacts
How to use the Skedulo CLI to create, retrieve and delete artifacts.
Work with objects and fields
Best practices and considerations when working with objects and fields using the Skedulo CLI.
Create a new job or activity with pre-filled data
Automatically create a new job or activity with data from a URL
Create and map custom objects in Salesforce
Instructions for creating custom objects in the Salesforce Skedulo managed package.
Create forms that only work when users are online
How to create online-mode extensions for Skedulo Plus.
Developing web extensions with the CLI
Develop, deploy and manage web extensions with the Skedulo CLI.
Multi-selector
Multi-select picklist component.
Save and share list views
Save and share your list views with your organization.
Use and manage location information
Use geoservices to calculate distances between locations and estimate travel time.
Use pagination to access all GraphQL query results
Paging the results of GraphQL queries.
Use the Skedulo CLI to upload and manage your Skedulo Plus extension
Use the Skedulo CLI to deploy, modify, or delete your Skedulo Plus extension.
Work with packages
How to use the Skedulo CLI to build, register, list, and deploy packages.
Skedulo CLI
How to use the Skedulo CLI to extend and customize your Skedulo team.
Advanced column configuration for list views
Enhance the data presented within a list view.
Artifact availability
Which artifacts are available in the Skedulo CLI
Customize and extend Skedulo web app
Create custom objects, fields, and extensions for the Skedulo web app and use Horizon components to develop unique list views and pages.
Date and time picker
A date and time picker component.
Resource localization
Understand the localization resource files and how they work in mobile extensions.
Skedulo Plus extensions validation rules
How to add validation to your mobile extensions.
Skedulo web extensions
Custom web page views for the Skedulo web application.
Subscribe to Skedulo objects
GraphQL schema subscriptions.
Customize and extend Skedulo mobile apps
Create custom objects and fields, extensions for the Skedulo v2 mobile app and Skedulo Plus.
Customize list views
Customize the layout of your list views.
Help and troubleshooting
How to get help and answers to common issues with the Skedulo CLI.
Integration and automation
Integrate with Skedulo via REST API and GraphQL, and create webhooks and triggered actions to automatically respond to Skedulo events.
Optimize schedules
Using optimization to automatically schedule multiple jobs
Toggle
The toggle component is used to render a toggle switch, checkbox, or radio button on a flat page.
Upsert records with GraphQL
Using upsert to perform GraphQL insert or update operations.
Attachments
Configure the Attachments component for Skedulo Plus flat page mobile extensions.
Skedulo CLI command reference
How to use the Skedulo CLI to easily build, test, and deploy custom solutions on the Skedulo Pulse Platform.
Render content dynamically in mobile extensions
How to use dynamic content for pages or components.
Create and manage deployments
Create and deploy customizations using the Skedulo SDK.
Signature
Configure the Signature component for Skedulo Plus flat page mobile extensions.
Menu list
Configure the Menu list component for Skedulo Plus flat page mobile extensions.
ReadOnly text
Configure the Read-only text component for Skedulo Plus flat page mobile extensions.
ButtonGroup
Configure a button or group of buttons in your mobile extension.
Address editor
Configure an address editor in your mobile extension.
Feedback
Was this page helpful?