_inclusionsLibrary
The children of this page contain information which is included in other pages. This is a library of reusable information chunks.
If you want to change any of these pages, be aware that:
- Changing page names is problematic – you will need to change all the {include} and {excerpt-include} macros manually.
- The content is used in many places – make sure your change is generic enough to fit the contexts in which the pages are used.
To include an excerpt from a page:
{excerpt-include:_page name|nopanel=true}
Note that the page titled '_page name' must contain the {excerpt} macro
, otherwise the {excerpt-include}
will not work.
{excerpt}Blah, blah, blah.{excerpt}
To include the entire contents of a page:
{include:page name}
Children of this page:
- _inclusionsLibrary_RegEx — Note that Datameer tries to match entire record without automatically adding ^ or $ to the regular expression. But if the record has multiple lines, then this must be accounted for with (?s) or line terminators.
- _inclusionsLibrary_videos_generalComment — To run the videos, click the the center of the screen.
- _inclusionsLibrary-AvailableAsOf
- _noteTOJSON — As of version 2.1, this function returns a list. If you require a JSON represented as a string please wrap this function in TOJSON, e.g. TOJSON(FUNCTION(...)).
- _inclusionsLibrary-Commands
- _restartingDatameer — <Datameer Application Folder>/bin/conductor.sh restart
- _startingDatameer — <Datameer Application Folder>/bin/conductor.sh start
- _startingDatameer-JMX — <Datameer Application Folder>/bin/conductor.sh start --jmx
- _startingJConsole — # jconsole localhost:6789
- _stoppingDatameer — <Datameer Application Folder>/bin/conductor.sh stop
- _inclusionsLibrary-Icons
- _database-OrdinalStatus — Status
- _icons-DataFieldTypes — Icon
- _icons-JobStatus — Job status
- _icons-JobTypes — Job type
- _InclusionsLibrary-REST
- _AllUserManagmentREST — {
- _connectionsCreate — {
- _connectionsDelete — Connection has successfully been deleted.
- _connectionsListAll — [
- _connectionsRead — {
- _connectionsUpdate — {"status": "success"}
- _CreateAUser — {
- _dashboardsListAll — [
- _dashboardsRead — {
- _dataVolumeLimitRead — [
- _DeleteAUser — No confirmation / Response
- _exportCancel — This command does not return a response.
- _exportCreate — {
- _exportDelete — {"status": "success"}
- _exportListAll — [
- _exportRead — {
- _exportStart — {
- _exportUpdate — {"status": "success"}
- _ExResponse-ReadDashboard — {
- _ExResponse-ReadImportJob — {
- _ExResponse-ReadWorkbook — {
- _global_volume_&_license_info — {
- _importCancel — This command does not return a response.
- _importCreate — {
- _importDelete — {"status": "success"}
- _importDownloadData — "ID","NAME","Email","Status","Check"
- _ImportJob_FileExtensions — We have three import job extensions:
- _importListAll — [
- _importMetadata — {
- _importRead — {
- _importSheetDetails — {
- _importStart — {
- _importUpdate — {"status": "success"}
- _ImportUsersExternalAuth — {
- _infographicsCreate — {
- _infographicsDelete — No Response for a successful action{
- _infographicsListAll — [{
- _infographicsRead — {
- _infographicsUpdate — {
- _jobDataDelete — No job or data available:{
- _jobDetailsRead — {
- _jobHistoryRead — [
- _jobPayload — <job-payload>.json
- _jobStatusRead — For a running job:{
- _LicenseFileUpload — If the license is accepted.VALID
- _listActiveJobs — [
- _ListAllGroups — {
- _ListAllRoles — {
- _ListAllUsers — {
- _ListAUser — {
- _ProductID — Returns the product ID and version.4b4038ba-3550-4844-b432-4c6f64d80807das-test:Datameer-2.1.3-1.0.3
- _SendNotificationWhenCreatingAUser — {
- _SendNotificationWhenUpdatingAPassword — No confirmation / Response
- _SetOrUpdatePasswordForExistingUser — No confirmation / Response
- _UpdateAUser — {
- _UpdateUsersImportedExternalAuth — {
- _workbookCancel — This command does not return a response.
- _workbookCreate — {
- _workbookDelete — {"status": "success"}
- _workbookDownloadData — "ID","NAME","Email","Status","Check"
- _workbookListAll — [
- _workbookMetadata — {
- _workbookRead — {
- _workbookSheetDetails — {
- _workbookStart — {
- _workbookUpdate — {"status": "success"}
- _infoDateTimeRepresentation — Note that Datameer always uses the following format (e.g. 12.01.2012 gets transferred to January 12, 2012 12:00:00 AM)
- _noteTOJSON — As of version 2.1, this function returns a list. If you require a JSON represented as a string please wrap this function in TOJSON, e.g. TOJSON(FUNCTION(...)).
- _restartingDatameer — <Datameer Application Folder>/bin/conductor.sh restart
- _startingDatameer — <Datameer Application Folder>/bin/conductor.sh start
- _startingDatameer-JMX — <Datameer Application Folder>/bin/conductor.sh start --jmx
- _startingJConsole — # jconsole localhost:6789
- _stoppingDatameer — <Datameer Application Folder>/bin/conductor.sh stop
- _database-OrdinalStatus — Status
- _icons-DataFieldTypes — Icon
- _icons-JobStatus — Job status
- _icons-JobTypes — Job type
- _AllUserManagmentREST — {
- _connectionsCreate — {
- _connectionsDelete — Connection has successfully been deleted.
- _connectionsListAll — [
- _connectionsRead — {
- _connectionsUpdate — {"status": "success"}
- _CreateAUser — {
- _dashboardsListAll — [
- _dashboardsRead — {
- _dataVolumeLimitRead — [
- _DeleteAUser — No confirmation / Response
- _exportCancel — This command does not return a response.
- _exportCreate — {
- _exportDelete — {"status": "success"}
- _exportListAll — [
- _exportRead — {
- _exportStart — {
- _exportUpdate — {"status": "success"}
- _ExResponse-ReadDashboard — {
- _ExResponse-ReadImportJob — {
- _ExResponse-ReadWorkbook — {
- _global_volume_&_license_info — {
- _importCancel — This command does not return a response.
- _importCreate — {
- _importDelete — {"status": "success"}
- _importDownloadData — "ID","NAME","Email","Status","Check"
- _ImportJob_FileExtensions — We have three import job extensions:
- _importListAll — [
- _importMetadata — {
- _importRead — {
- _importSheetDetails — {
- _importStart — {
- _importUpdate — {"status": "success"}
- _ImportUsersExternalAuth — {
- _infographicsCreate — {
- _infographicsDelete — No Response for a successful action{
- _infographicsListAll — [{
- _infographicsRead — {
- _infographicsUpdate — {
- _jobDataDelete — No job or data available:{
- _jobDetailsRead — {
- _jobHistoryRead — [
- _jobPayload — <job-payload>.json
- _jobStatusRead — For a running job:{
- _LicenseFileUpload — If the license is accepted.VALID
- _listActiveJobs — [
- _ListAllGroups — {
- _ListAllRoles — {
- _ListAllUsers — {
- _ListAUser — {
- _ProductID — Returns the product ID and version.4b4038ba-3550-4844-b432-4c6f64d80807das-test:Datameer-2.1.3-1.0.3
- _SendNotificationWhenCreatingAUser — {
- _SendNotificationWhenUpdatingAPassword — No confirmation / Response
- _SetOrUpdatePasswordForExistingUser — No confirmation / Response
- _UpdateAUser — {
- _UpdateUsersImportedExternalAuth — {
- _workbookCancel — This command does not return a response.
- _workbookCreate — {
- _workbookDelete — {"status": "success"}
- _workbookDownloadData — "ID","NAME","Email","Status","Check"
- _workbookListAll — [
- _workbookMetadata — {
- _workbookRead — {
- _workbookSheetDetails — {
- _workbookStart — {
- _workbookUpdate — {"status": "success"}