Misc commands
GetMobileAppSettings
A collection of functions and settings used by the mobile apps to configure itself.
Keyword | Function |
|---|---|
AllowReposition | When checking in far from an objects location, the user should be allowed to move the position of the object to their current position. |
AutoCheckOut | Allows Automatically checkout if users have been checked in for longer than their normal workday plus a little extra. |
CalendarCreate | Create calendar appointments |
CalendarView | Access to the calendar module |
CalendarHideOtherUsers | Same as ProdplanHideOtherUsers |
CallLogging | Deprecated |
Calls | Access to the sales module |
CheckIn | Allow checkin via app (always set) |
CheckInOnEvents | Allow to check in on events (which will check in on the customer assigned to the event) |
CheckInOnProduction | Allow to check in on planning (which will check in on the planned task) |
Checkout_FormRequired | When checking out, any checkout form is mandatory to fill in. |
Checkout_Registration_None | When checking out, a time registration should never be posted. |
Checkout_Registration_Optional_Off | When checking out, the user should be able to select if a time registration should be made. This should default to off. |
Checkout_Registration_Optional_On | When checking out, the user should be able to select if a time registration should be made. This should default to on. |
Checkout_Registration_Required | When checking out, a time registration is mandatory. |
CustomersCreate | The user may create new CRM objects from the app. |
CustomersDraw | The user is allowed to draw map objects on customers. |
CustomersEdit | The user may edit CRM objects from the app. |
CustomersFiles | Files are accessible on CRM objects. |
CustomersFloorplan | Deprecated |
CustomersForms | Allow filling forms on customers. |
CustomersNotes | Access to customer notes. |
CustomersPhoto | User may take photos on CRM objects. |
CustomersProcedures | Procedures are visible on CRM objects. |
CustomersView | Access to the CRM module |
CustomRegistrations | If Custom registrations are allowed |
DayCheckin | Allow the user to check in on the day (deprecated?) |
Drive | Deprecated |
EnableNFC | Enable NFC functionality |
LimitNumObjects | The app should use the special strategy for reduced object count |
LocationLogging | The app should passively track the user location. |
ManyProducts100K | This is set if there are more than 100000 products in the DB, the app may use this to adjust how it synchronizes products |
ManyProducts10K | This is set if there are more than 10000 products in the DB (but less than 100000) |
NewMessages | Enable the new message system |
NewNotes | Enable the new note system |
NoCustomerCheckin | Checkin isn't allowed on CRM objects |
NoCustomerRegistration | It isn't allowed to register time on CRM objects |
NoEditTimeAtCheckout | Time is not allowed to be edited when checking out |
NoEditTime | It is not allowed to edit/delete own registrations - but it is still allowed to create registrations |
CustomersHideProspects | It isn't allowed to show customer prospects in App |
NoProximityAlert | If the option named “Alert when close to a task or company?” isn't set, then this keyword is present |
NoTimeOverlap | Do not allow hour registrations to overlap. |
NotePost | Allow to post notes (always present) |
PersonEdit | Allow to edit person |
PersonView | Access to the person module |
PersonalDocuments | Allows to see personal documents (which are files under the current user) |
Project2Enabled | Access to the process module (unused?) |
PlaceOrder | Access to the sales module |
PricePortal | If a price portal is available and the API call ExecutePricePortal can be used |
ProdplanHideOtherUsers | If the production plan/calendar should show other users |
ProdplanAhead<n> | Limits the number of days one should be able to look forward in the production plan where <n> is the number of days; if the value is 0 or not specified then it should be considered to mean "forever" |
ProdplanReveal<clock> | When is the next day revealed in the production plan, where <clock> is the timestamp. |
ProdplanView | Access to the planning module |
ProdplanEdit | Allow editing a plannings |
ProductEdit | Allow product edit |
ProductView | Deprecated |
QRLogging | Enables the QR scanner |
Registration_Clock | Registration is with time stamps instead of minutes, so 12:00-14:00 instead of 120 minutes. |
Registration_Star1 | The blue star should be present |
Registration_Star2 | The yellow star should be present |
Registration_Star3 | The green star should be present |
Registration_Star4 | The red star should be present |
Registration | The user should be able to register time |
RegistrationMidnightToFirstDate | When registering time over midnight, the selected date should be the first day ie. 01-01-2000 23:00:00 - 01:00:00 |
RegistrationMidnightToSecondDate | When registering time over midnight, the selected date should be the second day ie. 02-01-2000 23:00:00 - 01:00:00 |
RegistrationOnClosedOff | Do not allow registrering time on a closed task |
RegistrationOnClosedAlways | Allow registrering time on a closed task |
RegistrationOnClosedUntilMidnight | Allow registrering time on a closed task, but only on the date when the task was closed |
Stock | Use stock functions |
StockRequired | Stock is required to be selected when adding a product use. |
TodoChangeState | Allow changing status on task |
TodoCloseDays<N> | How long after task closure will MB keep sending info about the closed tasks, f.ex. "TodoCloseDays90" for 90 days; if N=10000 then MB will not send closed task. Notice that the setting only applies if the app sends "ignoreclosed" in the GetTodosByLastChange API call. |
TodoCreate | Allow creation of new tasks |
TodoDraw | The user is allowed to draw map objects on tasks. |
TodoEdit | The user may edit todo objects from the app. |
TodoFiles | Files are accessible on task objects. |
TodoForms | Allow filling out forms. |
TodoHideAll | Don't show the “all tasks” tab in app v2 |
TodoHideProjects | Don't show projects |
TodoNotes | Allow notes on tasks. |
TodoPhoto | User may take photos on task objects. |
TodoPlan | Allow planning the task. |
TodoPlannedTabs | Show planned tab in app v2 |
TodoProducts | Allows product use on tasks. |
TodoRegistrationView | Allow accees to registrations in the Task module |
TodoShowProjectFiles | Show project files amongst the other files for a task |
TodoTeamTabs | Show tabs for each team (in app v2?) |
TodoView | Access to the task module |
ToolCreateTask | Allow creating tasks on tool |
ToolDetach | Allow to detach tool. |
ToolDraw | The user is allowed to draw map objects on tool. |
ToolEdit | The user may edit tools. |
ToolFiles | Files are accessible on tool objects. |
ToolForms | Fill forms on tools |
ToolInstall | Allow installing tool |
ToolNotes | Allows notes on tools. |
ToolPhoto | User may take photos on tool objects. |
ToolPlaceOfHome | Allow to change the tool place of home. |
TodoProductUseSearch | If you can search for productuse |
TodoProductUseCreate | If you can create new productuse |
TodoProductUseCreate | If you can create edit existing productuse |
TodoProductUseDelete | If DeleteProductUseByID will delete the product use |
TodoProductUseOffset | If DeleteProductUseByID will offset the product use |
ToolChangeState | Change state of tools |
ToolRegistrations | Allow registration of time on tools |
ToolTakeOthers | Allows to take tools carried by others |
ToolTake | Allows to book tool. |
ToolWriteNFC | Allow writing of tool NFC tags. |
ToolsManualPickup | Can pick up tools (always on if tool module available) |
ToolsSetDownOnCheckout | All carried tools should be set down when checkin out |
Tools | Access to tool module |
UserEdit | If the user is allowed to edit details about himself/herself |
VirtualFoldersREADONLY | If virtual folders should be readonly; virtual folders are f.ex. task folders that are shown for the customer, or subtasks folders that are shown on a project |
Input
permissions | number | Set to 1 to also read the permissions |
will_resync | number | Set to 1 if the app intends to resync because of the resync instructions it received in the previous GetMobileAppSettings |
Output
functions | collection[string] | A collection of functions to enable - see the list above |
permissions | set | A set of module names and the list of enabled permissions for each module |
settings | set | Various settings |
defaultstock | number | MB ID of the default stock |
minutesteps | number | Granularity when selecting a duration in minutes; default 5 |
resync | number | Set to 1 if MB wants the app to resync |
The following settings may be provided in the settings field:
imagenodateandlocation | boolean | If 1 then don't insert time+date+location in the photos |
GetAccessToken
Get an access token that can be used with endpoint_token.php instead of using endpoint.php.
Input
None | - | - |
Output
accesstoken | string | An access token that should be passed to endpoint_token.php |
expiredate | date | When then token expires |
expiretime | time | When the token expires |
ValidateSessionToken
Validate that a session token belongs to an active Microbizz user (or person). Used when developing plugins.
Input
sessiontoken | string | The token you would like to validate |
is_xnet | bool | Set to true if the token is passed in the extranet context. |
Output
result | bool |