| Include Page |
|---|
| _Mobile Entity System Configuration Object Format |
|---|
| _Mobile Entity System Configuration Object Format |
|---|
|
Required properties are in bold.
| Property | Type | Description |
|---|
| _t | string | Identifies the document type and will always be set to entitySysConfig |
| _v | string | Identifies the version of the document structure |
| AllowMobileCreateOrder | boolean | Identifies if the mobile worker can create a work order. Valid values are: - true - The mobile worker can create a work order
- false - The mobile worker can not create a work order
Default value is false |
| DefaultCulturalIdentifer | string | The default language code identifier associated with entity. Default value is en |
| 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 |
| 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 | | 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 |
| PartsOrdering | object | Identifies settings for Parts Ordering feature. | Property | Type | Description |
|---|
| EntityServiceURI | string | PartsOrdering REST API endpoint Default value is https://sm-qa.hostedservicepower.com/partsOrderingMock | | EntityServiceAccessKey | string | PartsOrdering REST API access code Default value is rbGlqax1#b |
|
| Payment | object | This object contains payment gateway information for processing payments | 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 10012 | | MerchantKey | string | Identifies payment gateway merchant key for an entity Default value is C22A63EE-2E7A-4ACE-96AC-0958DC8D953F |
|
| 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 |
|
| RestApi | object | Identifies settings for entity hosted REST API | Property | Type | Description |
|---|
| Host | string | Identifies host and port address for REST API Default value is localhost:3000 | | Protocol | string | Identifies protocol for REST API. The valid values are http or https. Default value is https | | 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 |
| | AssetModels | string | Identifies Asset Model Number Verification REST API endpoint Default value is /mock/Assets/{0}/Models
| | AssetHistory | string | Identifies Asset History REST API endpoint Default value is null | | BookJob | string | Identifies book job REST API endpoint Default value is /crmmock/api/BookJobMock/{0} | | EstimateHistory | string | Identifies Account Location Work Order Estimate History REST API endpoint Default value is /mock/Account/{0}/Location/{1}/EstimateHistory
| | IVR | string | Identifies IVR REST API endpoint Default value is /IVRMock/{0} | | PartsOrdering | string | Identifies parts ordering REST API endpoint Default value is /mock/partsOrderingMock
| | SearchAppts | string | Identifies search appointment REST API endpoint Default value is /crm/apimock/SearchApptsMock | | SiteHistory | 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 |
|
| 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 | | 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 |
|
