Job notifications
- Applies to:
- MindTouch (current)
- Role required:
- Admin
Completed, failed, or canceled jobs can optionally trigger a notification to be sent to either an email address or a webhook.
The email notification will contain the following information in the received message:
- A URL to download any generated error or warning logs
- If successful, the Expert site that completed a content import or export
- If a successful content export job, a URL to the exported archive to download
Webhook
A public webhook (without any authorization requirements) can be configured to receive an HTTP POST message from Expert with the following JSON-formatted payload:
{
"@id": "{id}",
"@type": "{type}",
"@status": "{status}",
"site": "{hostname}",
"log": {
"csv": "{log}"
},
"uri": "{archive}"
}
| Name | Type | Description |
|---|---|---|
| {id} | string | The unique id for this job in UUID v4 format |
| {type} | {export, import} | The type of job |
| {status} | {completed, failed, cancelled} | The status of the job |
| {hostname} | string | The Expert site hostname where the job was queued |
| {log} (optional) | string | A URL to download any generated error or warning logs |
| {archive} (optional) | string | If a successful content export job, a URL to the exported content archive to download |
Error and Warning Logs
Error logs are available if a content import or export job fails or is canceled. Warning logs may be available if the job is successful but non-critical issues were detected during processing. The log format is CSV with the following columns in the header row:
| Header | Description |
|---|---|
| DataId | A unique, deterministic id for the piece of data, referenced in the package.xml file, that triggered the warning or error (pages, attachments, page permissions, etc) |
| PagePath | The relative page URL that the data is associated with |
| WarningType | The type of error or warning message |
| Message | An explanation of the error or warning |
Message Types
The message type value is available in the WarningType header row column.
| Message Type (WarningType) | Job Type | Description |
|---|---|---|
| UserGrantsPresent | export | Page permissions granted to users will not be exported or imported |
| DekiScriptErrorDetected | export | Page content contains invalid DekiScript source |
| NonPortableLinkDetected | export | Page content contains link to local file id (without filename) |
| AnalyzerFailedToRun | export | Page content could not be analyzed in order to prepare content for export |
| ContentParsingErrorDetected | export | Page content resulted in a parsing error that is described further in log message |
| PageOverviewWithScriptedContentDetected | export | Page summary can only be plain text and cannot contain DekiScript source |
| IgnoredSearchRecommendation | export | Page that is associated with an exported search recommendation was not part of the content export manifest |
| IgnoredContextMapping | export | Page that is mapped to an exported content id was not part of the content export manifest |
| FailedToImportItem | import | See message for import exception details |
| PageDraftDetected | export | The draft for this page will not be exported |
| IgnoredInvalidLearningPathName | export | Invalid guided path name (path names can only contain letters, dashes, and hyphens) |
| IgnoredLearningPathPage | export | Page that is associated with a guided path was not part of the content export manifest |
| IgnoredLearningPathPages | export | Pages that are associated with a guided path were not part of the content export manifest |
| PageCreationConflictsWithExistingPage | import | The page guid between a page location in the export manifest and the same location in the destination Expert site do not match |
| PageMoveConflictsWithExistingPage | import | Could not move page because a page with the same title already exists |
| PageMoveConflictsWithExistingPageOutsideSubHierarchy | import | In order to sync page hierarchies, a page from outside the destination Expert site page hierarchy needs to be moved to a location inside the destination Expert site page hierarchy and the page location already exists |
| PageMoveTargetParentFailedToImport | import | Parent page of move destination failed so move cannot proceed |
| SkippingPageCreationBecauseParentPagePreviouslySkipped | import | Page cannot be imported because the parent page was not imported |
| SkippingPageCreationBecauseItWasPreviouslyDeleted | import | Page to be created upon import was previously deleted in the destination Expert site |
| SkippingPageTagsBecausePagePreviouslySkipped | import | Page was skipped so any associated resources were also skipped |
| SkippingPageFileBecausePagePreviouslySkipped | import | Page was skipped so any associated resources were also skipped |
| SkippingPagePropertyBecausePagePreviouslySkipped | import | Page was skipped so any associated resources were also skipped |
| SkippingFilePropertyBecausePagePreviouslySkipped | import | Page was skipped so any associated resources were also skipped |
| SkippingPagePermissionsBecausePagePreviouslySkipped | import | Page was skipped so any associated resources were also skipped |
| MissingPageInImport | import | Page is defined in export manifest but is missing from the archive |