HaplooRegister()

Prev Next

Using Haploo Register ()

This function accepts a properly formed JSON Data Object. The syntax is very specific. How you deliver this registration payload to the

HaplooRegister() function is completely up to you. For example, in a multi-tenant environment, you may wish to dynamically fetch and resolve this JSON Object to be

specific to a customer or region. This registration definition creates the highest level sync domain for your clients or apps. 

Main JSON Payload Keys

Key NameKey DescriptionData TypeNotes
API_EndpointThe url subdomain for Haploo CloudStringLegacy Param: Moving towards multi-tenant. Use Tenant_EndPoint
API_TokenAssigned Token for your sync domainStringLegacy Key: Moving toward multi-tenant, use Tenant_ID
Client_SecretAssigned Password for authorizing syncsStringLegacy Key: Moving toward multi-tenant, use Tenant_Secret
Provider_IDthe associated billing account / account admin String
Tenant_EndPointThe url subdomain for Haploo CloudStringAssigned to you via your Haploo Cloud Login Portal
Tenant_IDAssigned Token for your sync domainStringSame as API Token, but generated for each tenant or sync domain
Tenant_LabelA friendly label to describe your tenantString
Tenant_SecretAssigned Password for authorizing syncsString
Solution_NameA friendly name for your deployed fm solutionStringExamples: Inventory System, Audit Tool, Purchasing Master. Simply, the name of your app
API_VersionDetermines if Schema needs to be fluid / dynamicStatic
Dynamic
Uses a keyword. If your solution does not need to resolve schema differences at runtime, use **Static**, otherwise use **Dynamic**. Please note dynamic is more compute intensive
PushOptionEnables push messaging for user / appEnabled
Disabled
We will register your iOS device's push token with Haploo Messaging Services. To trigger a push to actually send will be done within the SyncBy() Functions. 
PushUserTagsAn array of words describing the user / deviceArray / ListKeep these words simple and alpha numeric, no special chars or spaces. 
SyncTriggersToggles different sync modesJSON ObjectControl the behavior of specific sync related triggers.
ExcludePrefixPrevents certain fields from syncing based upon field name prefix pattern matchingStringFor example, using __ double underscore my indicate a private field and posting of such values should be ignored. 
ExcludeGlobalPrevents global fields from postingTrue
False
Global fields are typically reserved for user specific sessions and syncing them across multiple device may produce unwanted results. 
PullPolicyProvides a data pulling query to limit what records the device is allowed to access from the Haploo Cloud Servers. JSON ObjectThis pull will further break apart the sync domain into smaller sections. It will allow syncing to be more efficient for your users / apps. It can control what data is pulled for each table in your solution.

SyncTriggers JSON OBJECT Syntax

  



PullPolicy JSON Object Syntax




More on API_Version Designation