| Property | Type | Description |
|---|
| AllowMobileCreateOrder | boolean | Identifies if the mobile worker can create a work order. Valid values are: true - The mobile worker can create a work orderfalse - The mobile worker can not create a work order
Default value is false |
| CloudElements | object | Contains Cloud Elements integration settings for the entity | Property | Type | Description |
|---|
| CustomerID | string | Identifies an unique identifier for an entity in Cloud Elements | | Email | string | The email address of the user. This email receives all the password reset emails | | Enabled | boolean | Enable use of Cloud Elements integration for mobile workers. Valid values are: true - Mobile workers can use Cloud Elements integration featuresfalse - Mobile workers cannot use Cloud Elements integration features
Default value is false | | Modules | object | This object contains a list of authenticated modules (elements) in Cloud Elements | Property | Type | Description |
|---|
| ${ModuleID} | object | Indicates identifier for the module. Valid values are: - 1001 - Quick Books Online
| Property | Type | Description |
|---|
| Enabled | boolean | Enable use of authenticated Cloud Elements module Valid values are: - true - System can use authenticated Cloud Elements module.
- false - System cannot use authenticated Cloud Elements module
Default value is true | | ID | integer | Identifies unique numeric identifier for authenticated module | | Key | string | Identifies alpha numeric | | Name | string | Identifies name of the authenticated module | | Token | string | The security token returned upon authenticating a module. You must include token in Authorization header in API calls to Cloud Elements |
|
| | Name | string | Identifies name of an entity | | UserSecret | string | Identifies User Secret required for API calls to Cloud Element APIs | | UserID | string | Identifies user's unique ID for an entity registered in Cloud Elements |
|
| DefaultCulturalIdentifer | string | The default language code identifier associated with entity. Default value is en |
| EnableMobileApplication | boolean | Enable use of mobile application for mobile workers. Valid values are: true - Mobile workers can use mobile application.false - Mobile workers cannot use mobile application
Default value is true |
| ExportNotifications | object | This object manages subscriptions for Export Notifications. | Property | Type | Description |
|---|
| Authentication | object | This object contains settings for identity verification. ServiceMobility supports Client Credential Flow defined in OAuth 2.0 |
|
| JMSExpirationInDays | integer | Identifies ActiveMQ message's expiration value. Default value is 30 |
| PasswordResetLength | integer | Identifies the length of reset password Default value is 10 |
| SupportEmailAddress | string | Identifies ServiceMobility/Nexus customer care email address Default value is support@servicemobility.com |
| SupportedCountries | string | Identifies comma separated list of entity supported countries.
Default value is USA standard. Export Notification will pass Client ID and Client Secret to authenticate service and get a token. | Property | Type | Description |
|---|
| Headers | collection | Identifies a collection of one or more HTTP header name and value for authentication Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name. The maximum length for the field is 40 | | Value | string | Identifies HTTP header value. |
| | Request | object | Identifies the payload to be sent to Authorization server for authentication. | Property | Type | Description |
|---|
| audience | string | Identifies the audience for Access Token | | client_id | string | Identifies a public identifier for the Export Notification service. Client ID must be unique across all the applications and services managed by the Authorization server | | client_secret | string | Identifies a secret known only to Export Notification service and the Authorization server | | grant_type | string | OAuth 2.0 standard supports various Grant Types for several use cases. Valid values are: Default value is client_credentials |
| | Type | string | Identifies the Authentication Type for the Export Notification service. Valid values are: Default value is OAuth2 | | URL | string | Identifies Access Token REST API endpoint Default value is http://localhost:3000/mock/access_token |
| | Notifications | object | This object stores subscriptions for Export Notifications | Property | Type | Description |
|---|
| Activity | object | This object contains subscription settings for Activity Export Notification. | Property | Type | Description |
|---|
| Enabled | boolean | Identifies if the Activity Export Notification subscription is active. If true, then ServiceMobility will send Activity Export Notification to the target URL. Valid values are: false = Subscription to Activity Export Notification is inactive. This is the default value if this property is not specified.true = Subscription to Activity Export Notification is active.
| | Headers | collection | Identifies a collection of one or more HTTP header name and value for Activity Export Notification REST API Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name. The maximum length for the field is 40 | | Value | string | Identifies HTTP header value. |
| | URL | string | Identifies a target URL to send Activity Export Notification. This is a required field in case Activity Export Notification subscription is active Default value is null |
| | Audit | object | This object contains subscription settings for Audit Export Notification. | Property | Type | Description |
|---|
| Enabled | boolean | Identifies if the Audit Export Notification subscription is active. If true, then ServiceMobility will send Audit Export Notification to the target URL. Valid values are: false = Subscription to Audit Export Notification is inactive. This is the default value if this property is not specified.true = Subscription to Audit Export Notification is active.
| | Headers | collection | Identifies a collection of one or more HTTP header name and value for Audit Export Notification REST API Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name. The maximum length for the field is 40 | | Value | string | Identifies HTTP header value. |
| | URL | string | Identifies a target URL to send Audit Export Notification. This is a required field in case Audit Export Notification subscription is active Default value is null |
| | InventoryTransfer | object | This object contains subscription settings for Inventory Transfer Export Notification. | Property | Type | Description |
|---|
| Enabled | boolean | Identifies if the Inventory Transfer Export Notification subscription is active. If true, then ServiceMobility will send Inventory Transfer Export Notification to the target URL. Valid values are: false = Subscription to Inventory Transfer Export Notification is inactive. This is the default value if this property is not specified.true = Subscription to Inventory Transfer Export Notification is active.
| | Headers | collection | Identifies a collection of one or more HTTP header name and value for Inventory Transfer Export Notification REST API Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name. The maximum length for the field is 40 | | Value | string | Identifies HTTP header value. |
| | URL | string | Identifies a target URL to send Inventory Transfer Export Notification. This is a required field in case Inventory Transfer Export Notification subscription is active Default value is null |
| | InventoryUsage | object | This object contains subscription settings for Inventory Usage Export Notification. | Property | Type | Description |
|---|
| Enabled | boolean | Identifies if the Inventory Usage Export Notification subscription is active. If true, then ServiceMobility will send Inventory Usage Export Notification to the target URL. Valid values are: false = Subscription to Inventory Usage Export Notification is inactive. This is the default value if this property is not specified.true = Subscription to Inventory Usage Export Notification is active.
| | Headers | collection | Identifies a collection of one or more HTTP header name and value for Inventory Usage Export Notification REST API Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name. The maximum length for the field is 40 | | Value | string | Identifies HTTP header value. |
| | URL | string | Identifies a target URL to send Inventory Usage Export Notification. This is a required field in case Inventory Usage Export Notification subscription is active Default value is null |
| | LoadInventory | object | This object contains subscription settings for Inventory Load Export Notification. | Property | Type | Description |
|---|
| Enabled | boolean | Identifies if the Inventory Load Export Notification subscription is active. If true, then ServiceMobility will send Inventory Load Export Notification to the target URL. Valid values are: false = Subscription to Inventory Load Export Notification is inactive. This is the default value if this property is not specified.true = Subscription to Inventory Load Export Notification is active.
| | Headers | collection | Identifies a collection of one or more HTTP header name and value for Inventory Load Export Notification REST API Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name. The maximum length for the field is 40 | | Value | string | Identifies HTTP header value. |
| | URL | string | Identifies a target URL to send Inventory Load Export Notification. This is a required field in case Inventory Load Export Notification subscription is active Default value is null |
| | StockLevelRecommendation | object | This object contains subscription settings for Stock Level Recommendation Export Notification. | Property | Type | Description |
|---|
| Enabled | boolean | Identifies if the Stock Level Recommendation Export Notification subscription is active. If true, then ServiceMobility will send Stock Level Recommendation Export Notification to the target URL. Valid values are: false = Subscription to Stock Level Recommendation Export Notification is inactive. This is the default value if this property is not specified.true = Subscription to Stock Level Recommendation Export Notification is active.
| | Headers | collection | Identifies a collection of one or more HTTP header name and value for Stock Level Recommendation Export Notification REST API Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name. The maximum length for the field is 40 | | Value | string | Identifies HTTP header value. |
| | URL | string | Identifies a target URL to send Stock Level Recommendation Export Notification. This is a required field in case Stock Level Recommendation Export Notification subscription is active Default value is null |
| | TimeEntry | object | This object contains subscription settings for Time Entry Export Notification. | Property | Type | Description |
|---|
| Enabled | boolean | Identifies if the Time Entry Export Notification subscription is active. If true, then ServiceMobility will send Time Entry Export Notification to the target URL. Valid values are: false = Subscription to Time Entry Export Notification is inactive. This is the default value if this property is not specified.true = Subscription to Time Entry Export Notification is active.
| | Headers | collection | Identifies a collection of one or more HTTP header name and value for Time Entry Export Notification REST API Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name. The maximum length for the field is 40 | | Value | string | Identifies HTTP header value. |
| | URL | string | Identifies a target URL to send Time Entry Export Notification. This is a required field in case Time Entry Export Notification subscription is active Default value is null |
| | WorkOrder | object | This object contains subscription settings for WorkOrder Export Notification. | Property | Type | Description |
|---|
| Enabled | boolean | Identifies if the WorkOrder Export Notification subscription is active. If true, then ServiceMobility will send WorkOrder Export Notification to the target URL. Valid values are: false = Subscription to WorkOrder Export Notification is inactive. This is the default value if this property is not specified.true = Subscription to WorkOrder Export Notification is active.
| | Headers | collection | Identifies a collection of one or more HTTP header name and value for WorkOrder Export Notification REST API Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name. The maximum length for the field is 40 | | Value | string | Identifies HTTP header value. |
| | URL | string | Identifies a target URL to send WorkOrder Export Notification. This is a required field in case WorkOrder Export Notification subscription is active Default value is null |
|
|
|
| ExtUserAuth | object | This object contains settings for allowing third-party authentication for mobile workers | Property | Type | Description |
|---|
| AuthEndpoint | string | Third-party Authentication service REST API endpoint Default value is "" | | Enabled | boolean | Flag to enable third-party authentication for all mobile workers within an entity Default value is false |
|
| Invoice | object | This object contains settings which support emailing invoice to the customer | Property | Type | Description |
|---|
| EmailFrom | string | The FROM email address Default value |
| is donotreply@servicemobility.com is "" | | EmailSender | object | Identifies configuration settings for cross-account/delegate sender's identity information | Property | Type | Description |
|---|
| SourceArn | string | Cross-account/delegate sender's Amazon Resource Name (ARN) for email's Source | | FromArn | string | Cross-account/delegate sender's Amazon Resource Name (ARN) for email's From address | | ReturnPathArn | string | Cross-account/delegate sender's Amazon Resource Name (ARN) for email's ReturnPath parameter |
|
|
| Invoicing | boolean | Identifies setting for Invoicing feature. The flag value determines support for invoice generation. Default value is true |
| JMSExpirationInDays | integer | Identifies ActiveMQ message's expiration value. Default value is 30 |
| MaxLoginAttempts | integer | Identifies the maximum number of failed login attempts allowed in the system. This setting will trigger user account lockout after several failed attempts. Default value is 3
|
| PasswordResetLength | integer | Identifies the length of reset password Default value is 12 |
| PayByLink | object | This object contains configuration for sending a payment link. | Info |
|---|
The PayByLink property is relevant when payment for work items will be collected via integration with a 3rd party payment processing facility which is not ServicePowerHub. See also the Payment Processor Webhook REST API. |
| Property | Type | Description |
|---|
| ID | string | Identifies Pay by Link system ID for an entity Default value is 1002 | | MerchantID | string | Identifies Pay by Link system Merchant ID for an entity | | UserID | string | Identifies Pay by Link system User ID for an entity | | Passcode | string | Identifies password for Pay by Link system User ID |
|
| Payment | object | This object contains payment gateway information for processing payments. | Info |
|---|
The Payment property is relevant when payment for work items will be collected via the ServicePowerHub payment processing facility. See also the Payment Transaction Token REST API. |
| Property | Type | Description |
|---|
| GatewayID | string | Identifies payment gateway ID for an entity Default value is 1001 | | MerchantID | string | Identifies payment gateway Merchant ID for an entity Default value is CAAF8BFE-65AD-466C-A513-CC7854D4E90D | | UserID | string | Identifies payment gateway User ID for an entity Default value is apiUser | | Passcode | string | Identifies password for payment gateway User ID |
| ExtUserAuth |
| RestApi | object | This object contains settings for allowing third-party authentication for mobile workersIdentifies settings for entity hosted REST API | Property | Type | Description |
|---|
| AuthorizationHeaders | collection | Identifies a collection of one or more HTTP header name and value for REST API authentication |
| AuthEndpoint | Third-party Authentication service REST API endpointIdentifies HTTP header name for authentication. Default value is |
|
| "" | Enabled | boolean | Flag to enable third-party authentication for all mobile workers within an entityobject| string | Identifies HTTP header value for authentication. Default value is |
|
| false RestApi | | entity hosted AssetModelsAsset Model Number Verification REST API | Property | Type | Description |
|---|
| AuthorizationHeaders | collection | Identifies a collection of one or more HTTP header name and value for REST API authentication | Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name for authentication. Default value is null | | Value | string | Identifies HTTP header value for authentication. Default value is null |
|
|
| | | URL | string | Identifies Asset Model Number Verification REST API endpoint Default value is http://localhost:3000/mock/Assets/{0}/Models |
| | AssetHistory | string | Identifies settings for Asset History REST API | Property | Type | Description |
|---|
| AuthorizationHeaders | collection | Identifies a collection of one or more HTTP header name and value for REST API authentication | Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name for authentication. Default value is null | | Value | string | Identifies HTTP header value for authentication. Default value is null |
| | Criteria | string | Identifies criteria for matching history for an asset | | URL | string | Identifies Asset History REST API endpoint Default value is null |
| | BookJob | string | Identifies settings for BookJob REST API | Property | Type | Description |
|---|
| AuthorizationHeaders | collection | Identifies a collection of one or more HTTP header name and value for REST API authentication | Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name for authentication. Default value is null | | Value | string | Identifies HTTP header value for authentication. Default value is null |
| | URL | string | Identifies book job REST API endpoint Default value is http://localhost:3000 /mock/BookJobMock/{0} |
| | EstimateHistory | string | Identifies settings for Account Location Work Order Estimate History REST API | Property | Type | Description |
|---|
| AuthorizationHeaders | collection | Identifies a collection of one or more HTTP header name and value for REST API authentication | Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name for authentication. Default value is null | | Value | string | Identifies HTTP header value for authentication. Default value is null |
| | Criteria | string | Identifies criteria for matching history for a work order | | URL | string | Identifies Account Location Work Order Estimate History REST API endpoint Default value is http://localhost:3000 /mock/Account/{0}/Location/{1}/EstimateHistory |
| | IVR | string | Identifies settings for VR REST API | Property | Type | Description |
|---|
| AuthorizationHeaders | collection | Identifies a collection of one or more HTTP header name and value for REST API authentication | Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name for authentication. Default value is null | | Value | string | Identifies HTTP header value for authentication. Default value is null |
| | URL | string | Identifies IVR REST API endpoint Default value is http://localhost:3000/IVRMock/{0} |
| | PartsOrdering | string | Identifies settings for Parts Ordering REST API | Property | Type | Description |
|---|
| AuthorizationHeaders | collection | Identifies a collection of one or more HTTP header name and value for REST API authentication | Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name for authentication. Default value is null | | Value | string | Identifies HTTP header value for authentication. Default value is null |
| | URL | string | Identifies parts ordering REST API endpoint Default value is http://localhost:3000/mock/partsOrderingMock |
| | SearchAppts | string | Identifies settings for search appointment REST API | Property | Type | Description |
|---|
| AuthorizationHeaders | collection | Identifies a collection of one or more HTTP header name and value for REST API authentication | Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name for authentication. Default value is null | | Value | string | Identifies HTTP header value for authentication. Default value is null |
| | URL | string | Identifies search appointment REST API endpoint Default value is http://localhost:3000/mock/SearchApptsMock |
| | SiteHistory | string | Identifies settings for Site History REST API | Property | Type | Description |
|---|
| AuthorizationHeaders | collection | Identifies a collection of one or more HTTP header name and value for REST API authentication | Property | Type | Description |
|---|
| Name | string | Identifies HTTP header name for authentication. Default value is null | | Value | string | Identifies HTTP header value for authentication. Default value is null |
| | Criteria | string | Identifies criteria for matching history for a site/location | | URL | string | Identifies Site History REST API endpoint Default value is null |
|
|
| Scheduler | object | Contains ServiceScheduling integration settings for the entity | Property | Type | Description |
|---|
| Host | string | Scheduler instance host Default value is null | | DBUser | string | Scheduler instance DB User (Catalog) Default value is null | | UserName | string | Identifies user name for scheduler Default value is null | | Password | string | Identifies password for scheduler Default value is null | | DispatchExportTran | boolean | Flag to enable auto creation of new Export Transaction upon dispatching a new job Default value is false | | IntegrationEnabled | boolean | Flag to enable integration with ServiceScheduling for an entity Default value is false | | ExternalObjectName | string | External object name for scheduler technician Default value is null |
|
| StockLevelRecommendation | object | Identifies settings for Stock Level Recommendation module for the entity. This setting will purge expired/overdue open Stock Level Recommendations. See also the Stock Level Recommendation REST API. | Property | Type | Description |
|---|
| ExpiryCheckEnabled | boolean | Indicates the ability to expire/purge overdue open Stock Level Recommendations Default value is false. This is the default value if this property is not specified. | | ExpirationTime | integer | Indicates the number of minutes which will be added to Stock Level Recommendation's DueDate property. The calculated value will be compared against current date time for expiry check. Default value is 540 |
|
| SupportEmailAddress | string | Identifies ServiceMobility/Nexus customer care email address Default value is support@servicemobility.com |
| SupportedCountries | string | Identifies comma separated list of entity supported countries. Default value is USA |
| SSO | object | ServiceMobility supports /wiki/spaces/MOB3/pages/2510243. The design of single sign-on implements OAuth 2.0 Authorization Flow with Proof Key for Code Exchange (PKCE) extension. This property identifies settings to setup SSO for the entity. | Property | Type | Description |
|---|
| Enabled | boolean | Indicates the ability to use single sign-on for ServiceMobility users Default value is false. This is the default value if this property is not specified. | | UsePKCEFlow | boolean | Indicates the ability to use Authorization Flow with Proof Key for Code Exchange (PKCE) Default value is false. This is the default value if this property is not specified. |
|
| TemplatePrefix | string | Identifies the prefix for Templates. Default value is "". |
| TokenClaims | object | ServiceMobility implements token based authentication. ServiceMobility issues JSON Web Token (JWT) in response to user credentials verification. Mobile application uses JWT to exchange data with the server. JWT contains registered, public and private claims in JSON format in the payload. JWT claims are a collection of key-value pairs. This property identifies JWT claim values for the entity. | Property | Type | Description |
|---|
| ExpirationTime | integer | Indicates the expiration time in minutes for JWT token. Default value is 5400 | | ExpiryDeadband | integer | Indicates Expiry Dead Band in minutes for JWT. This private claim will allow a mobile worker to remain logged into the mobile application through the auto-login process even after the expiration of JWT token. The mobile application will not have ability to communicate with the back office when a mobile worker is logged with expired JWT. Default value is 0 |
|
| WorkOrder | object | Identifies settings for Work Order module for the entity | Property | Type | Description |
|---|
| ClosedOverride | boolean | Indicates the ability to accept mobile application transactions after work order has been closed from back office Default value is false | | GenerateHashKey | object | Mobile workers can review the historical data for a given work order. ServiceMobility groups this historical work order data using the AccountNum and LocationNum properties. In order for grouping to work, unique account and location values need to be present in the ServiceMobility data. In the event that ServiceMobility customers cannot generate their own unique values, the optional GenerateHashKey property allows a ServiceMobility Entity to be configured define a key structure which will be used to generate hash keys for the data. These keys will reduce query result sets by grouping data.
| Note |
|---|
When enabled, the GenerateHashKey option will only create unique account and location values for grouping for new data that is added to ServiceMobility. Any existing historical work order data for the entity will not have unique account and location values generated. |
| Property | Type | Description |
|---|
| Enabled | boolean | Ability to auto-generate identifier (for e.g. AccountNum, LocationNum) values for work orders. Default value is false. This is the default value if this property is not specified. | | KeyFunctions | object | When the GenerateHashKey option is Enabled for a given Entity, each entry in the object defines the expression for the hash key structure. Expressions are defined in JSONata function format. | Property | Type | Description |
|---|
| AccountNum | string | Identifies JSONata function to construct a string based on a series of field values. This string will be used to calculate the AccountNum hash code. ServiceMobility will store hash code value in Account.AccountNum field of Work Order object. | | LocationNum | string | Identifies JSONata function to construct a string based on a series of field values. This string will be used to calculate the LocationNum hash code. ServiceMobility will store hash code value in Location.LocationNum field of Work Order object. |
|
| GenerateIncompleteOrderInvoice | boolean | Indicates the ability to generate invoice for a incomplete work order. The OrderStatus field of Work Order object will contain value Closed Incomplete (4097) Default value is true | | OnlyAllowProductCatalogParts | boolean | Ability to only allow product catalog parts for in a work order. The valid values are "true" or "false" Default value is true | SendScheduleChangeNotification | boolean | Indicates the ability to send work order dispatch and schedule change notification SMS Default value is false
| | SkipDeletedWOExport | boolean | Identifies a flag to exclude deleted work order transactions from Work Order Export REST API Default value is false | | UseSystemTaxRates | boolean | Indicates the ability to use system specified tax rates for totals calculation Default value is false |
|
Required properties are in bold.