Scheduler Definition

Revision as of 00:01, 5 December 2024 by Admin (talk | contribs) (Created page with "The scheduler's definition JSON has the following footprint. == Schedulables == The schedulable defines the object to be scheduled<syntaxhighlight lang="json"> { "schedulables":{ "shift":{ ... } "request": { ... } } } </syntaxhighlight><syntaxhighlight lang="json"> { "schedulables":{ "request":{ "objectType":"b3s__Employee_Request__c", "startFieldPath":"b3s__Start__c",...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The scheduler's definition JSON has the following footprint.

Schedulables

The schedulable defines the object to be scheduled

{
   "schedulables":{
          "shift":{
            ...
          }
          "request": {
            ...
          }
    }
}
{
   "schedulables":{
      "request":{
         "objectType":"b3s__Employee_Request__c",
         "startFieldPath":"b3s__Start__c",
         "endFieldPath":"b3s__End__c",
         "selectionClause":[
            //SOQL selector
         ],
         "contactFieldPath":"b3s__Contact__c",
         "contactRecordPath":"b3s__Contact__r",
         "contactFirstNameFieldPath":"b3s__Contact__r.FirstName",
         "contactLastNameFieldPath":"b3s__Contact__r.LastName",
         "contactsLoader":"contacts",
         "recordStatusFieldPath":"b3s__Type__c",
         "additionalFields":[
         	//Array of field paths to be loaded
         ],
         "contextMenu":{
            //Context menu definition
         },
         "eventTooltipFields":[
            //Fields to display in the event tooltip
         ],
         "recordFormFields":[
            //Fields to be displayed when creating/editing records
         ],
         "recordHistoryData":[
            //Path component definition
         ],
         "background":null,
         "topBorder":null
      },
      "shift":{
         "objectType":"b3s__Shift__c",
         "startFieldPath":"b3s__Scheduled_Start_Time__c",
         "endFieldPath":"b3s__Scheduled_End_Time__c",
         "selectionClause":[
            //SOQL selector
         ],
         "additionalFields":[
            //Array of field paths to be loaded
         ],
         "contactFieldPath":"b3s__Contact__c",
         "contactRecordPath":"b3s__Contact__r",
         "contactFirstNameFieldPath":"b3s__Contact__r.FirstName",
         "contactLastNameFieldPath":"b3s__Contact__r.LastName",
         "contactsLoader":"contacts",
         "matchingLoaders":[
            //Names of loaders to be passed on to the matching engine
         ],
         "placementFieldPath":"b3s__Placement__c",
         "recordStatusFieldPath":"b3s__Status__c",
         "cancelledFieldPath":"b3s__Cancelled_Timestamp__c",
         "contextMenu":{
            "recordNavigate":[
              //Context menu definition
            ],
            "canCut":{
           		//Selector
            },
            "canCopy":{
              	//Selector 
            },
            "canCancel":{
               //Selector
            },
            "canEdit":{
               //Selector
            },
            "canClone":{
               //Selector
            },
            "canDelete":{
               //Selector
            }
         },
         "eventTooltipFields":[
            
         ],
         "eventAlerts":{
            "objectName":"b3s__Event_Alert__c",
            "shiftReferenceField":"b3s__Shift__c",
            "categoryField":"b3s__Category__c",
            "detailsField":"b3s__Details__c",
            "severityField":"b3s__Severity__c",
            "pointsField": "b3s__Points__c"
         },
         "isCancelled":null,
         "isReadOnly":null,
         "recordFormFields":[
            
         ],
         "cancelFormFields":[
            
         ],
         "reassignEventFieldsFlush":[
            
         ],
         "cloneEventFieldsFlush":[
            
         ],
         "recordHistoryData":[
            
         ],
         "moveRestrictions":[
            
         ],
         "cancelRestrictions":[
            
         ],
         "editRestrictions":[
            
         ],
         "cloneRestrictions":[
            
         ],
         "deleteRestrictions":[
            
         ],
         "decorations":[
            
         ],
         "background":null,
         "topBorder":null
      }
   }
}