Configuring General Help Topics
To customize the Help topics that appear in the General Help pane, you can configure the General Help Topics setting. You can select specific topics that are relevant to the currently selected tab or special mode per your organization's needs.
To configure General Help topics:
1. In Max Admin, on the User Management (
) launchpad menu, click Settings, and then in the list view, click General Help Topics.
) launchpad menu, click Settings, and then in the list view, click General Help Topics.2. On the record page, in the Default Value box, configure topic mappings in JSON as follows, and then in the top left corner, click Save and Close(
).
).|
Item
|
Parameters
|
|---|---|
|
Tab
|
tab
|
|
Scheduler Tab
|
scheduler
|
|
Map Tab
|
map
|
|
Crew Manager Tab
|
crewManager
|
|
Project Tab
|
project
|
|
Mode
|
mode
|
|
Resource Recommendation mode
|
recommendResources
|
|
Show on Calendar mode
|
showOnCalendar
|
|
Multiple-Resource mode
|
multipleResources
|
|
Nearby Jobs mode
|
nearbyJobs
|
|
Appointment Proposals and Schedule Proposals mode
|
proposeScheduleAndTimes
|
|
Resources and Assets mode
|
asset
|
|
Planning mode
|
planning
|
|
Help topic
|
title: The title of the Help topic, for example, Generating Resource Recommendations.
|
|
helpTopicId: The segment of the Help topic URL that follows the last forward slash (/), for example, generating-resource-recommendations.
|
JSON Code Example
{
"tab": {
"scheduler": [
{
"title": "Creating Custom Job Lists and Resource Lists",
"helpTopicId": "scheduler-tab"
},
...
],
"map": [
{
"title": "Slide Panels",
"helpTopicId": "slide-panels"
},
...
],
"crewManager": [
{
"title": "Configuring Crews",
"helpTopicId": "configuring-crews"
},
...
],
"project": [
{
"title": "Importing Project Data Files",
"helpTopicId": "importing-project-data-files"
},
...
]
},
{
"mode": {
"recommendResources": [
{
"title": "Generating Resource Recommendations",
"helpTopicId": "generating-resource-recommendations"
},
...
],
"showOnCalendar": [
{
"title": "Viewing Job-Related Appointments",
"helpTopicId": "viewing-job-related-appointments"
}
...
],
"multipleResources": [
{
"title": "Assigning Jobs to Multiple Resources",
"helpTopicId": "assigning-jobs-multiple-resources"
},
...
],
"nearbyJobs": [
{
"title": "Identifying Nearby Jobs",
"helpTopicId": "identifying-nearby-jobs"
}
...
],
"proposeScheduleAndTimes": [
{
"title": "Using Appointment Proposals",
"helpTopicId": "using-appointment-proposals"
},
...
],
"asset": [
{
"title": "Asset-Centric View",
"helpTopicId": "asset-centric-view"
}
...
],
"planning": [
{
"title": "Planning Mode",
"helpTopicId": "planning-mode"
}
...
]
}
}
For more information: