Jobs

_Jobs_AdvancedImportFiles, _Jobs_AlignSlide, _Jobs_AlignWellplate, _Jobs_BackgroundDetection_Setup, _Jobs_BackupDb, _Jobs_ContinueJobOrWizard, _Jobs_CopyJobToProject, _Jobs_CopyRunsIntoJob, _Jobs_CreateDb, _Jobs_CreateDbFromCurrent, _Jobs_CreateJob, _Jobs_CreateJobFromTemplate, _Jobs_CreateProject, _Jobs_DefinitionWizard, _Jobs_DefinitionWizardLastState, _Jobs_DeleteAllGA3Runs, _Jobs_DeleteAllJobTestRuns, _Jobs_DeleteAllLargeImageRuns, _Jobs_DeleteAllMaxIPRuns, _Jobs_DeleteAllReconstructedRuns, _Jobs_DeleteJob, _Jobs_DeleteProject, _Jobs_EditJavaScript, _Jobs_ErrorNotification, _Jobs_ExportJobDef, _Jobs_ImportBioCtFiles, _Jobs_ImportFiles, _Jobs_ImportJobDef, _Jobs_InsertCustomPlate, _Jobs_JobDefinitionOptions, _Jobs_MakeMaxIP, _Jobs_ManageCategories, _Jobs_ManageCustomSlides, _Jobs_ManageCustomWellplates, _Jobs_ManageDbs, _Jobs_ManageJavaScriptFiles, _Jobs_ManageLabels, _Jobs_ManageQuantities, _Jobs_ManageRecipes, _Jobs_OpenAndEditJavaScript, _Jobs_OpenAndRunJavaScript, _Jobs_OpenDb, _Jobs_PropertiesDialog, _Jobs_RenameDb, _Jobs_RestoreDb, _Jobs_RunAnalysis, _Jobs_RunBatchAnalysis, _Jobs_RunGeneralAnalysis3OnJobdef, _Jobs_RunGeneralAnalysis3OnJobrun, _Jobs_RunJobOrWizard, _Jobs_RunJobOrWizardByName, _Jobs_ShowDownloadDialog, _Jobs_ShowInitErrorDlg, _Jobs_ShowMostRecent, _Jobs_ShowUploadDialog, _Jobs_StitchLargeImage, _Jobs_StitchLargeImageOnWholeJob, _Jobs_UpdateProject, _Jobs_ViewGA3Results, _Jobs_ViewJobDefinition, _Jobs_ViewJobResults, _Jobs_ViewJobrunImage, _Jobs_ViewJobrunResults, _Jobs_ViewJobrunResultsEx, _Jobs_ViewLargeImageResults, _Jobs_ViewMaxIPResults, _Jobs_ViewProjectResults, _Jobs_ViewReconstructedResults, DocMoveToNext, DocMoveToPrev, Jobs_BackgroundDetection_IsReady, Jobs_BackupDb, Jobs_BackupDbEx, Jobs_CleanupDb, Jobs_ContinueJob, Jobs_ContinueJobOrWizard, Jobs_CopyJobToProject, Jobs_CopyRunsIntoJob, Jobs_CreateNewDb, Jobs_CreateProject, Jobs_CreateProjectEx, Jobs_DecryptDb, Jobs_DeleteAnalysis, Jobs_DeleteAnalysisFromProject, Jobs_DeleteJob, Jobs_DeleteJobrunFiles, Jobs_DeleteJobrunFolder, Jobs_DeleteJobruns, Jobs_DeleteProject, Jobs_DownloadDb, Jobs_DownloadJobrun, Jobs_DownloadJobrunEx, Jobs_ExecSqlCommand, Jobs_ExecuteJavaScript, Jobs_FindJobrunWithState, Jobs_FinishJob, Jobs_GetDbFilenameParts, Jobs_GetJobExecResult, Jobs_GetJobKey, Jobs_GetJobrunFile, Jobs_GetJobrunFileCount, Jobs_GetJobrunFolder, Jobs_GetJobrunKeyByIndex, Jobs_GetJobrunKeyByIndexEx, Jobs_GetJobrunLatest, Jobs_GetJobrunUuid, Jobs_GetProjectKey, Jobs_GetProjectUuid, Jobs_ImageReuseJobDefinition, Jobs_ImportCustomSlides, Jobs_ImportCustomWellplates, Jobs_ImportFiles, Jobs_ImportMetadata, Jobs_InsertCustomPlate, Jobs_MakeMaxIP, Jobs_MakeMaxIPOnWholeJob, Jobs_MoveRunsIntoJob, Jobs_OpenExistingDb, Jobs_OpenFrameFromJobrun, Jobs_ProjectSetTags, Jobs_RefreshDb, Jobs_RestoreDb, Jobs_RunAnalysis, Jobs_RunJob, Jobs_RunJobByName, Jobs_RunJobInitParam, Jobs_RunJobPhase, Jobs_RunJobPhaseContinue, Jobs_SelectBinaryObjectsFromJobrun, Jobs_SetCloseJobViews, Jobs_SetFilenamePart, Jobs_SetHcaFixedRestriction, Jobs_SetHcaLiveRestriction, Jobs_SetJobrunState, Jobs_SetParallelDeviceMovement, Jobs_ShowGeneralAnalysis3Results, Jobs_StitchLargeImage, Jobs_StitchLargeImageOnWholeJob, Jobs_TestRunJob, Jobs_ToggleCloseJobViews, Jobs_UpdateNd2Files, Jobs_UpdateProject, Jobs_UploadDb, Jobs_UploadJobrun, Jobs_ViewJobrunImage

DocMoveToNext

Description

 DocMoveToNext();

Moves to the next image loaded from the jobs results view.

DocMoveToPrev

Description

 DocMoveToPrev();

Moves to the previous image loaded from the jobs results view.

Jobs_BackgroundDetection_IsReady

Description

 Jobs_BackgroundDetection_IsReady();

Returns whether the background detection was performed.

Jobs_BackupDb

Interactive command to this function: HCA/JOBS > Database > Backup

Description

 Jobs_BackupDb(
   char *DbFolder,
   int  ImageFileOp
);

This function enables saving all files you have created using Jobs into a desired folder.

Parameters

char *DbFolder

Name of the database folder.

int ImageFileOp

Includes image files in the backup.

0	Image files are not included in the backup.
1	Image files are included in the backup.

See Also
_Jobs_BackupDb

Jobs_BackupDbEx

Description

 Jobs_BackupDbEx(
   char *DbFile,
   int  ImageFileOp
);

Backs up the Jobs database.

Parameters

char *DbFile

Name of the database file (including the full path).

int ImageFileOp

Includes image files in the backup.

0	Image files are not included in the backup.
1	Image files are included in the backup.

Jobs_CleanupDb

This function runs the HCA/JOBS > Database > Cleanup command.

Description

 Jobs_CleanupDb();

Cleans up the Jobs database.

Jobs_ContinueJob

Description

 Jobs_ContinueJob(
   char *JobrunDbUuid
);

Runs the specified JOB and appends the results to the latest job-run as a new time loop. Make sure the job structure (number of frames, positions, etc) is always the same. Use the Jobs_GetJobrunLatest and Jobs_GetJobrunUuid functions to lookup the ID.

Parameters

char *JobrunDbUuid

Unique database ID of a job run.

Jobs_ContinueJobOrWizard

Description

 Jobs_ContinueJobOrWizard(
   int64  JobdefDbKey
);

Starts the specified job directly (without wizard).

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

Jobs_CopyJobToProject

Description

 Jobs_CopyJobToProject(
   int64  JobdefDbKey,
   int64 *ProjDbKey
);

Copies the selected job into a selected project.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

int64 *ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

Jobs_CopyRunsIntoJob

Description

 Jobs_CopyRunsIntoJob(
   int64 *LpJobrunDbKeys,
   int  Count,
   int64  JobdefDbKey
);

Copies job runs into the selected job.

Parameters

int64 *LpJobrunDbKeys

Database value of the specified jobrun (output value).

int Count

Number of iterations.

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

Jobs_CreateNewDb

Description

 Jobs_CreateNewDb(
   char *DbFolder,
   int  DbMode,
   int  DbFolderOption
);

Creates a new database for storing jobs.

Parameters

char *DbFolder

Name of the database folder.

int DbMode

Database mode.

int DbFolderOption

Database folder options.

Jobs_CreateProject

Description

 Jobs_CreateProject(
   char *ProjDbName,
   char *ProjDbDesc,
   char *ProjDbPath,
   int64 *LpProjDbKey
);

Creates a new project.

Parameters

char *ProjDbName

Name of the Project containing the job. E.g.: “Project 1” (input value).

char *ProjDbDesc

Text description of the project.

char *ProjDbPath

Name of the new folder which will be created where the database is stored.

int64 *LpProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

Jobs_CreateProjectEx

Description

 Jobs_CreateProjectEx(
   char *ProjDbUuid,
   char *ProjDbName,
   char *ProjDbDesc,
   char *ProjDbPath,
   int64 *LpProjDbKey
);

This macro function creates project with specified parameters in the current NIS database and returns the pointer to its project key.

Parameters

char *ProjDbUuid

Database value of the project uuid.

char *ProjDbName

Name of the Project containing the job. E.g.: “Project 1” (input value).

char *ProjDbDesc

Text description of the project.

char *ProjDbPath

Name of the new folder which will be created where the database is stored.

int64 *LpProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

Jobs_DecryptDb

Description

 Jobs_DecryptDb();

Database is encrypted using SQLite3. This function decrypts the database files into a .db file.

Jobs_DeleteAnalysis

Description

 Jobs_DeleteAnalysis(
   int64 *LpAssaydefDbKeys,
   int  Count
);

Deletes the specified analysis. Count parameter is the number of job runs.

Parameters

int64 *LpAssaydefDbKeys

Table of keys.

int Count

Number of iterations.

Jobs_DeleteAnalysisFromProject

Description

 Jobs_DeleteAnalysisFromProject(
   int64 *ProjDbKey,
   char *Name
);

Deletes the specified analysis from a project. Name parameter is the name of the analysis defined by the user.

Parameters

int64 *ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

char *Name

Name.

Jobs_DeleteJob

Description

 Jobs_DeleteJob(
   int64  JobdefDbKey
);

Deletes the specified job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

Jobs_DeleteJobrunFiles

Description

 Jobs_DeleteJobrunFiles(
   int64  JobrunDbKey
);

Deletes all ND2 files of the specified job run. Files not created in NIS-ElementsNIS-Elements are kept intact.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

Jobs_DeleteJobrunFolder

Description

 Jobs_DeleteJobrunFolder(
   int64  JobrunDbKey
);

Deletes the folder where ND2 files are saved for the specified job run. All files present in the folder are deleted as well.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

Jobs_DeleteJobruns

Description

 Jobs_DeleteJobruns(
   int64 *LpJobrunDbKeys,
   int  Count
);

Deletes the specified job run.

Parameters

int64 *LpJobrunDbKeys

Database value of the specified jobrun (output value).

int Count

Number of iterations.

Jobs_DeleteProject

Description

 Jobs_DeleteProject(
   int64  ProjDbKey
);

Deletes the specified project.

Parameters

int64 ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

Jobs_DownloadDb

Description

 Jobs_DownloadDb(
   char *DbFilename,
   char *SelectedJobsPattern,
   int  DeleteJobMergeOption,
   int  OverwriteJobMergeOption
);

This macro function downloads selected jobs specified by the SelectedJobsPattern parameter from the target database to the currently opened JOB database.

Parameters

char *DbFilename

Name of the database (including the full path).

char *SelectedJobsPattern

Regular expression (Wildcard syntax) specifying job names to be downloaded, job name is considered in the “projectName/jobdefName” format. If null or empty, all jobs are selected.

int DeleteJobMergeOption

Equals the drop-down menu options in the JOBs DOWNLOAD dialog (see _Jobs_ShowDownloadDialog).

0	Keep Local
1	Delete from Local

int OverwriteJobMergeOption

Equals the drop-down menu options in the JOBs DOWNLOAD dialog (see _Jobs_ShowDownloadDialog).

0	Keep Local
1	Overwrite Using Remote

See Also

Jobs_DownloadJobrun

Description

 Jobs_DownloadJobrun(
   char *DbFilename,
   int  ImageFilesToo,
   int64  JobrunDbKey,
   int64 *LpJobrunLocalDbKey
);

This macro function downloads the jobrun specified by its jobrunkey from the database specified by its filename (including full path) to the current NIS database and returns the pointer to the jobrun's jobrunkey in the current database. It is optional to download captured images by setting the ImageFilesToo parameter (download image files together with the jobrun).

Parameters

char *DbFilename

Name of the database (including the full path).

int ImageFilesToo

Include / exclude image files in the process.

0	Do not include images.
1	Include images.

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

int64 *LpJobrunLocalDbKey

Database value of the jobrun key in the local database (after download).

Jobs_DownloadJobrunEx

Description

 Jobs_DownloadJobrunEx(
   char *DbFilename,
   int  ImageFilesToo,
   char *ProjDbName,
   char *ProjDbJobName,
   int  JobrunIndex,
   int64 *LpJobrunLocalDbKey
);

Macro function which downloads the particular jobrun specified by the project name, job name and jobrun index from other database specified by the first argument. It is optional to download image files of the jobrun. If the LpJobrunLocalDbKey parameter is not NULL, the macro function returns jobrunKey of the downloaded jobrun in the current NIS database. ImageFilesToo parameter is used to download image files together with the jobrun.

Parameters

char *DbFilename

Name of the database (including the full path).

int ImageFilesToo

Include / exclude image files in the process.

0	Do not include images.
1	Include images.

char *ProjDbName

Name of the Project containing the job. E.g.: “Project 1” (input value).

char *ProjDbJobName

Name of the Job. E.g.: “HCA Live Job” (input value).

int JobrunIndex

Indexing the jobruns within a job can be done using either:

positive indexes from 0 to N-1 in order as they were captured (oldest first), or
negative indexes from -1 to -N in the reversed order (newest first)

Table 18. Example index values

Job - Jobruns	Positive Index	Negative Index
3/1/2015 “third” (newest)	2	-1
2/1/2015 “second”	1	-2
1/1/2015 “first” (oldest)	0	-3

int64 *LpJobrunLocalDbKey

Database value of the jobrun key in the local database (after download).

Jobs_ExecSqlCommand

Description

 Jobs_ExecSqlCommand(
   char  Text
);

Executes an SQL command.

Parameters

char Text

SQL text command.

Jobs_ExecuteJavaScript

Description

int Jobs_ExecuteJavaScript(
   char *JavaFilename
);

Runs JavaScript on the jobrun table. Message boxes informs the user about the script progress.

Parameters

char *JavaFilename

Specifies path to the file containing the JavaScript code.

Return Values

int

Returns 0 if the JavaScript file was found and run, otherwise returns a negative value.

Jobs_FindJobrunWithState

Description

 Jobs_FindJobrunWithState(
   char *DbFilename,
   char *JobrunDbState,
   char *JobrunDbNewState,
   double  TimeoutSec,
   int64 *LpJobrunDbKey
);

This macro function finds the first jobrun “marked” by the JobrunState in the database specified by its filename (including full path). If succesfull, jobrun's jobrunState is set to the JobrunNewState value and the pointer to its jobrunKey is returned. If not successful, the searching procedure is repeated as long as the TimeOut expires.

Parameters

char *DbFilename

Name of the database (including the full path).

char *JobrunDbState

Database value of the jobrun state. Use in case of upload/download to “server DB” context otherwise fill with NULL.

char *JobrunDbNewState

New value of the jobrun state. NULL is an invalid value of the parameter.

double TimeoutSec

Time in seconds (to try searching a specified jobrun)

int64 *LpJobrunDbKey

Database value of the specified jobrun (output value).

Jobs_FinishJob

Description

 Jobs_FinishJob();

This function finishes the current job. It behaves in the same way as if the user clicked Finish in the Job Execution Progress window.

Jobs_GetDbFilenameParts

Description

 Jobs_GetDbFilenameParts(
   char *Directory,
   char *Name,
   char *Ext
);

Returns the directory, name and extension of a job database.

Parameters

char *Directory

Directory path.

char *Name

Name.

char *Ext

File extension.

Jobs_GetJobExecResult

Description

 Jobs_GetJobExecResult(
   int64  JobdefDbKey,
   int64 *LpJobResultFlags,
   char *LpJobResultText,
   int  Length
);

Returns result of a job run.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

int64 *LpJobResultFlags

A bit mask of result messages:

0x00 // normal finish (no other flag is set)
0x01 // set after start
0x02 // user clicked finish
0x04 // finished was forced by some error
0x100 // run as test
0x200 // large image run
0x400 // maxIP run
0x800 // Reconstruct run

char *LpJobResultText

Job result text.

int Length

Buffer length.

Jobs_GetJobKey

Description

 Jobs_GetJobKey(
   char *ProjDbName,
   char *ProjDbJobName,
   int64 *LpJobdefDbKey,
   int64 *LpJobrunDbKeys,
   int  Count
);

The whole function returns the number of job runs (number of items of the LpJobrunDbKeys parameter). Count represents the field size of LpJobrunDbKeys.

Parameters

char *ProjDbName

Name of the Project containing the job. E.g.: “Project 1” (input value).

char *ProjDbJobName

Name of the Job. E.g.: “HCA Live Job” (input value).

int64 *LpJobdefDbKey

Database value of the Job specified by the ProjDbName and ProjDbJobName (output value).

int64 *LpJobrunDbKeys

Database value of the specified jobrun (output value).

int Count

Number of iterations.

Jobs_GetJobrunFile

Description

 Jobs_GetJobrunFile(
   int64  JobrunDbKey,
   int  Index,
   char *Filename
);

Returns the name of the file of the specified job run.

Index parameter is the index to the array of all object features.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

int Index

Index number (zero-based).

char *Filename

Path to the file.

Jobs_GetJobrunFileCount

Description

 Jobs_GetJobrunFileCount(
   int64  JobrunDbKey
);

Returns the count of job runs.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

Jobs_GetJobrunFolder

Description

 Jobs_GetJobrunFolder(
   int64  JobrunDbKey,
   char *Foldername
);

Returns folder name of the specified job run.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

char *Foldername

Folder name return value.

Jobs_GetJobrunKeyByIndex

Description

 Jobs_GetJobrunKeyByIndex(
   char *ProjDbName,
   char *ProjDbJobName,
   int  JobrunIndex,
   int64 *LpJobdefDbKey,
   int64 *LpJobrunDbKey
);

Finds the pointers to jobrunkey and jobdefkey of the selected jobrun, which is specified by ProjDbName, ProjDbJobName and JobrunIndex.

Parameters

char *ProjDbName

Name of the Project containing the job. E.g.: “Project 1” (input value).

char *ProjDbJobName

Name of the Job. E.g.: “HCA Live Job” (input value).

int JobrunIndex

Indexing the jobruns within a job can be done using either:

positive indexes from 0 to N-1 in order as they were captured (oldest first), or
negative indexes from -1 to -N in the reversed order (newest first)

Table 19. Example index values

Job - Jobruns	Positive Index	Negative Index
3/1/2015 “third” (newest)	2	-1
2/1/2015 “second”	1	-2
1/1/2015 “first” (oldest)	0	-3

int64 *LpJobdefDbKey

Database value of the Job specified by the ProjDbName and ProjDbJobName (output value).

int64 *LpJobrunDbKey

Database value of the specified jobrun (output value).

See Also
Jobs_GetJobKey

Jobs_GetJobrunKeyByIndexEx

Description

 Jobs_GetJobrunKeyByIndexEx(
   char *DbFilename,
   char *ProjDbName,
   char *ProjDbJobName,
   int  JobrunIndex,
   int64 *LpJobdefDbKey,
   int64 *LpJobrunDbKey
);

Finds the pointers to jobrunkey and jobdefkey of the selected jobrun, which is specified by ProjDbName, ProjDbJobName and JobrunIndex from the database specified by filename.

Parameters

char *DbFilename

Name of the database (including the full path).

char *ProjDbName

Name of the Project containing the job. E.g.: “Project 1” (input value).

char *ProjDbJobName

Name of the Job. E.g.: “HCA Live Job” (input value).

int JobrunIndex

Indexing the jobruns within a job can be done using either:

positive indexes from 0 to N-1 in order as they were captured (oldest first), or
negative indexes from -1 to -N in the reversed order (newest first)

Table 20. Example index values

Job - Jobruns	Positive Index	Negative Index
3/1/2015 “third” (newest)	2	-1
2/1/2015 “second”	1	-2
1/1/2015 “first” (oldest)	0	-3

int64 *LpJobdefDbKey

Database value of the Job specified by the ProjDbName and ProjDbJobName (output value).

int64 *LpJobrunDbKey

Database value of the specified jobrun (output value).

See Also
Jobs_GetJobKey

Jobs_GetJobrunLatest

Description

 Jobs_GetJobrunLatest(
   int64  JobrunDbKey,
   int64 *LpJobrunDbKey
);

Retrieves ID of the latest job run of the specified job definition.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

int64 *LpJobrunDbKey

Database value of the specified jobrun (output value).

Jobs_GetJobrunUuid

Description

 Jobs_GetJobrunUuid(
   int64  JobrunDbKey,
   char *JobrunDbUuid
);

Retrieves unique ID of a job run needed for the Jobs_ContinueJob function.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

char *JobrunDbUuid

Unique database ID of a job run.

Jobs_GetProjectKey

Description

 Jobs_GetProjectKey(
   char *ProjDbName,
   int64 *LpProjDbKey
);

Database key of a project is returned based on the name of the job and the project it is placed in.

Parameters

char *ProjDbName

Name of the Project containing the job. E.g.: “Project 1” (input value).

int64 *LpProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

Jobs_GetProjectUuid

Description

 Jobs_GetProjectUuid(
   char *ProjDbName,
   int64  ProjDbKey,
   char *ProjDbUuid
);

This macro function gets ProjectUuid of the project specified by its name or project key. To prefer specification by name set ProjectKey to 0.

Parameters

char *ProjDbName

Name of the Project containing the job. E.g.: “Project 1” (input value).

int64 ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

char *ProjDbUuid

Database value of the project uuid.

Jobs_ImageReuseJobDefinition

Description

 Jobs_ImageReuseJobDefinition(
   char *Filepath
);

Opens the Job Definition window containing the job which created the image. This image file can be located using the Filepath parameter.

Parameters

char *Filepath

Defines the complete path to the folder of interest.

Note

If the parameter is used to load images, use e.g.: C:\Images\*.tif

Jobs_ImportCustomSlides

Description

 Jobs_ImportCustomSlides();

Imports all custom slide definitions present in the currently running JOBs database into the HCA/JOBS > Slide Holder > Manage Custom Slides list.

Note

Since NIS-Elements version 6.01, slide definitions are not saved into the database. Built-in slides are embedded in the system. Custom slides are stored in the file system per user in C:\ProgramData\Laboratory Imaging\Platform\<user>\CustomSlides.json. Only the definitions of used slides are stored in the database.

Jobs_ImportCustomWellplates

Description

 Jobs_ImportCustomWellplates();

Imports all custom wellplate definitions present in the currently running JOBs database into the HCA/JOBS > Well Plate > Manage Custom Well Plates list.

Note

Since NIS-Elements version 6.01, well plate definitions are not saved into the database. Built-in well plates are embedded in the system. Custom well plates are stored in the file system per user in C:\ProgramData\Laboratory Imaging\Platform\<user>\CustomWellplates.json. Only the definitions of used well plates are stored in the database.

Jobs_ImportFiles

Description

 Jobs_ImportFiles(
   int64 *ProjDbKey,
   char *ProjDbJobName,
   char  Directory,
   char *Prefix,
   char *FileFilter,
   int  IncludeSubfolders
);

Imports .nd2, .tif and .tiff files into jobs.

Parameters

int64 *ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

char *ProjDbJobName

Name of the Job. E.g.: “HCA Live Job” (input value).

char Directory

Directory name with the path.

char *Prefix

Text to be used as prefix.

char *FileFilter

Type first filename characters to filter the sequence images.

int IncludeSubfolders

Specifies whether the macro is executed even on images in all subfolders existing in the selected directory.

0	Do not include subfolders
1	Include subfolders

Jobs_ImportMetadata

Description

 Jobs_ImportMetadata(
   int64  JobrunDbKey,
   char *Filename
);

Imports custom metadata or labels stored in a .csv file to the jobrun specified by the JobrunDbKey parameter. Single column records are considered to be separated by a tab whereas row records should be separated by the end of a line.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

char *Filename

Full path to the CSV file. E.g. “C:\backup\backup1.csv”

Jobs_InsertCustomPlate

Description

 Jobs_InsertCustomPlate(
   char *Filename
);

Inserts a custom well plate from a specified .xml file.

Parameters

char *Filename

Full path to the XML file. E.g. “C:\backup\backup1.xml”

Jobs_MakeMaxIP

Description

 Jobs_MakeMaxIP(
   int64  JobrunDbKey,
   int  LoopType
);

Applies Maximum Intensity Projection to the specified job run.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

int LoopType

The type of ND document to be created.

3	XY multipoint
4	Time-lapse
5	Z-Series
6	Count

Jobs_MakeMaxIPOnWholeJob

Description

 Jobs_MakeMaxIPOnWholeJob(
   int64  JobdefDbKey,
   int  LoopType
);

Performs Maximal Intensity Projection on a timelapse/Z-Stack of the selected job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

int LoopType

The type of ND document to be created.

3	XY multipoint
4	Time-lapse
5	Z-Series
6	Count

Jobs_MoveRunsIntoJob

Description

 Jobs_MoveRunsIntoJob(
   int64 *LpJobrunDbKeys,
   int  Count,
   int64  JobdefDbKey
);

Moves the selected jobrun into the defined job.

Parameters

int64 *LpJobrunDbKeys

Database value of the specified jobrun (output value).

int Count

Number of iterations.

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

Jobs_OpenExistingDb

This function runs the HCA/JOBS > Database > Quick Open command.

Description

 Jobs_OpenExistingDb(
   char *DbFolder,
   int  DbMode,
   int  DbFolderOption
);

Opens the existing specified job database.

Parameters

char *DbFolder

Name of the database folder.

int DbMode

Database mode.

int DbFolderOption

Database folder options.

Jobs_OpenFrameFromJobrun

Description

 Jobs_OpenFrameFromJobrun(
   int64  JobrunDbKey,
   int  FrameIndex,
   int  Reuse
);

Opens the particular job frame specified by the JobrunDbKey and FrameIndex. It is optional to reuse the currently opened jobrun window.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

int FrameIndex

Database value of the frame.

int Reuse

Uses the result window which is already opened.

0	Opened window is not used.
1	Opened window is used (only if it belongs to the same jobrun).

Jobs_ProjectSetTags

Description

 Jobs_ProjectSetTags(
   int64  ProjDbKey,
   char *Tag
);

Sets tags in Jobs.

Parameters

int64 ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

char *Tag

Tag name.

Jobs_RefreshDb

This function runs the HCA/JOBS > Database > Refresh command.

Description

 Jobs_RefreshDb();

This function reloads the currently opened database. If any changes are made to your database remotely (more users working on one database), use this function to promptly reload the database so that it is up to date.

Jobs_RestoreDb

Interactive command to this function: HCA/JOBS > Database > Restore

Description

 Jobs_RestoreDb(
   char *DbFolder,
   int  ImageFilesToo
);

Restores the database from the database folder.

ImageFilesToo parameter restores images together with the database.

Parameters

char *DbFolder

Name of the database folder.

int ImageFilesToo

Include / exclude image files in the process.

0	Do not include images.
1	Include images.

Jobs_RunAnalysis

Description

 Jobs_RunAnalysis(
   int64  JobrunDbKey,
   char *Name,
   char *CaptureTaskName,
   char *Label,
   char *RecipeName
);

Executes the specified analysis. It can be used to run an analysis after the main job is finished, e.g. using the Macro task.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

char *Name

Name of the analysis defined by the user.

char *CaptureTaskName

Name of the capture task defined by the user.

If the job contains only one capture task, NULL can be used.

char *Label

Label name defined by the user in the Label Wells task.

Use this parameter to apply the analysis only on the chosen (labeled) wells, otherwise use NULL.

char *RecipeName

Name of the analysis recipe stored in the database.

Jobs_RunJob

Description

 Jobs_RunJob(
   int64  JobdefDbKey
);

Executes the specified job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

Jobs_RunJobByName

Description

 Jobs_RunJobByName(
   char *ProjDbName,
   char *ProjDbJobName
);

Runs the specified job.

Parameters

char *ProjDbName

Name of the Project containing the job. E.g.: “Project 1” (input value).

char *ProjDbJobName

Name of the Job. E.g.: “HCA Live Job” (input value).

Jobs_RunJobInitParam

Description

 Jobs_RunJobInitParam(
   int64  JobdefDbKey,
   char *JobParamJson
);

Sets any number of parameters for the JOB in a form of JSON.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

char *JobParamJson

Input parameters for the job in Json format.

Example 18. Jobs_RunJobInitParam example

Usage of a JSON file to select the Optical Configuration and the Storage location of a JOB:

// Macro:
int64 job_key;
char json[1000];
ReadFile("c:/jobs/params.json", json, 1000);
Jobs_GetJobKey("ProjectName", "JOBname", &job_key, NULL, 0);
Jobs_RunJobInitParam(job_key, json);

Example 19. params.json syntax

{
    "OCSel.OptConf": "iXon 897 - DIA:4x",
    "StoreToFsOnly.Folder": "c:/jobs/images"
}

Note

The JSON file must be Unicode or the raw data from file has to be converted by the MultiByteToWideChar function.
Forward slashes must be used for the path in the ReadFile function.
Correct JSON values can be retrieved via the System > Debug task within the JOB editor.

Jobs_RunJobPhase

Description

 Jobs_RunJobPhase(
   int64  JobdefDbKey,
   char *Name
);

Runs a job phase of the selected name.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

char *Name

Name.

Jobs_RunJobPhaseContinue

Description

 Jobs_RunJobPhaseContinue(
   int64  JobrunDbKey,
   char *Name
);

Executes a job phase of the specified name of the specified job run.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

char *Name

Name.

Jobs_SelectBinaryObjectsFromJobrun

Description

 Jobs_SelectBinaryObjectsFromJobrun(
   int64  JobrunDbKey,
   int  FrameIndex,
   char *BinLayerName,
   int *LpBinIds,
   int  Size,
   int  Reuse
);

Macro function which opens a particular job frame specified by the JobrunDbKey and FrameIndex and selects (displays in white colour in opened frame) the binary objects. Binary objects are specified by BinIds stored in the fourth parameter and by their count stored in the size parameter (size of the LpBinIds field). It is optional to reuse the currently opened jobrun window.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

int FrameIndex

Database value of the frame.

char *BinLayerName

Name of the binary layer (listed in the job results view as Object.Bin Layer).

int *LpBinIds

ID's of the binary objects - pointer to the field.

int Size

Size of the LpBinIds field.

int Reuse

Uses the result window which is already opened.

0	Opened window is not used.
1	Opened window is used (only if it belongs to the same jobrun).

Jobs_SetCloseJobViews

Description

 Jobs_SetCloseJobViews(
   int  CloseViews
);

Sets whether the job definition window is closed after the job is finished or remains open.

Parameters

int CloseViews

Specifies whether the job definition window is closed or remains open.

Jobs_SetFilenamePart

Description

 Jobs_SetFilenamePart(
   char *FilePart,
   int  FilePartEnabled,
   char *FilePartPrefix,
   char *FilePartInfo,
   int  FilePartWidth
);

In JOBS the filenames are made in such a way that each loop enclosing a task which produces the file adds its filename part. At the end a sequential index is added. This function can be used to customize this naming pattern. It modifies one part of the filename at a time. So it must be called for each filename part that has to be modified. It is effective only while a job is running. It should be called from the Macro task typically at the beginning of a JOB. Should the filename be non-unique a distinguishing numeric suffix is automatically added.

Parameters

char *FilePart

Which part (“prefix”, “plate”, “well”, “point”, “time”, ...).

Filename part	Role	Prefix	Info as available (digits)
Plate	loop	Plate	Barcode, Name, Index (3)
Well	loop	Well	Name, Index (4)
Point	loop	Point	StagePos, RelativePos, StagePosZ, RelativePosZ, Name, Index (4)
Time	loop	Time	Index (5)
ZStack	loop	ZStack	Index (4)
Count	loop	Count	Index (5)
Slide	loop	Slide	Barcode, Name, Index (3)
Region	loop	Region	Name, Index (4)
Channel	tiff files	Channel	Name
NDExp	ND Experiment	NDExp
Seq	uniqueness	Seq	Index (4)
Subdir	sub directory	subdir
Prefix	not used by default

int FilePartEnabled

Include. FALSE (removed) TRUE (included).

char *FilePartPrefix

Prefix. NULL (keep as is), “” (no prefix) or “any text”.

char *FilePartInfo

What is printed. NULL (keep as is), “barcode”, “name”, “index”.

int FilePartWidth

Number of digits. Applicable for index info.

Example 20. Example using the FilePart parameter

The following two macros placed into two separate timelapses set the paths to the result subfolders. Jobs_SetFilenamePart("Subdir", TRUE, "First", "", 0); saves the results to the “First” folder whereas Jobs_SetFilenamePart("Subdir", TRUE, "Second", "", 0); saves the results to the “Second” folder in the same parent directory.

Note

Filename parts are separated by an underscore (“_”).

Default file naming
Image filename is generated based on the current positions inside all loops: Left filename part is the outer loop with index and goes to the right towards inner loops. For ensuring uniqueness a sequential suffix (in form of SeqNNNNN) is added. Innermost loops (on the right side of the filename) are omitted if the loop is inside one file (does not split the file). Single TIFF file always splits all loops.

Resulting files:
WellA01_Seq0000.nd2
WellA02_Seq0000.nd2
WellB01_Seq0000.nd2
WellB02_Seq0000.nd2

Resulting files:
Seq0000.nd2

Customizing filename parts by a macro function
The “Macro” task must be at the beginning of the Job definition in order to be effective. The function Jobs_SetFilenamePart is called for each filename part separately. The function succeeds only when a job is running. Should the filename be non-unique a distinguishing numeric suffix is automatically added.

Example:
Make filenames so that they have plate barcode followed by well name.

Resulting files (default):
PlateBARCODE123_WellB02_Seq0002.nd2
PlateBARCODE123_WellB03_Seq0003.nd2
PlateBARCODE123_WellC02_Seq0005.nd2
PlateBARCODE123_WellC03_Seq0004.nd2
PlateBARCODE234_WellB02_Seq0006.nd2
PlateBARCODE234_WellB03_Seq0007.nd2
PlateBARCODE234_WellC02_Seq0009.nd2
PlateBARCODE234_WellC03_Seq0008.nd2

Use the macro function to specify the appearance of filename parts as desired: change how plate and well is formed and disable the sequence part at all.

Resulting files after customization:
BARCODE123_B02.nd2
BARCODE123_B03.nd2
BARCODE123_C02.nd2
BARCODE123_C03.nd2
BARCODE234_B02.nd2
BARCODE234_B03.nd2
BARCODE234_C02.nd2
BARCODE234_C03.nd2

Custom filenames
It is possible to create a custom filename from scratch.

Disable all used filename parts using Jobs_SetFilenamePart. It is sufficient to do it once at the beginning of a Job.
Format the new name into a text string using sprintf.
Use the text string for prefix filename part. This should be done before each capture.

Example
This is an example of a complex non-orthogonal acquisition into TIFFs. Prefix is taken from Custom Metadata, Multi-point, Time-lapse and Z-Stack filename parts are customized and suffix denotes the color. There are three Macro tasks to handle the names.

Resulting files:
Valeria_p0000_t00000_z000_green.tif
Valeria_p0000_t00000_z000_red.tif
Valeria_p0000_t00000_z001_green.tif
Valeria_p0000_t00000_z001_red.tif
Valeria_p0000_t00000_z002_green.tif
Valeria_p0000_t00000_z002_red.tif
Valeria_p0000_t00001_z000_red.tif
Valeria_p0000_t00001_z001_red.tif
Valeria_p0000_t00001_z002_red.tif
Valeria_p0001_t00000_z000_green.tif
Valeria_p0001_t00000_z000_red.tif
Valeria_p0001_t00000_z001_green.tif
Valeria_p0001_t00000_z001_red.tif
Valeria_p0001_t00000_z002_green.tif
Valeria_p0001_t00000_z002_red.tif
Valeria_p0001_t00001_z000_red.tif
Valeria_p0001_t00001_z001_red.tif
Valeria_p0001_t00001_z002_red.tif
Valeria_p0002_t00000_z000_green.tif
Valeria_p0002_t00000_z000_red.tif
Valeria_p0002_t00000_z001_green.tif
Valeria_p0002_t00000_z001_red.tif
Valeria_p0002_t00000_z002_green.tif
Valeria_p0002_t00000_z002_red.tif
Valeria_p0003_t00000_z000_red.tif
Valeria_p0003_t00000_z001_red.tif
Valeria_p0003_t00000_z002_red.tif
Valeria_p0004_t00000_z000_red.tif
Valeria_p0004_t00000_z001_red.tif
Valeria_p0004_t00000_z002_red.tif
Valeria_p0005_t00000_z000_red.tif
Valeria_p0005_t00000_z001_red.tif
Valeria_p0005_t00000_z002_red.tif

Jobs_SetHcaFixedRestriction

Description

 Jobs_SetHcaFixedRestriction(
   int64  JobdefDbKey,
   int  LoaderRequired,
   int  Enabled
);

Sets HCA Fixed restrictions to the selected job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

int LoaderRequired

This parameter defines whether the loader is required.

0	Loader is not required.
1	Loader is required.

int Enabled

0	Disabled.
1	Enabled.

Jobs_SetHcaLiveRestriction

Description

 Jobs_SetHcaLiveRestriction(
   int64  JobdefDbKey,
   int  Enabled
);

Sets HCA Live restrictions to the selected job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

int Enabled

0	Disabled.
1	Enabled.

Jobs_SetJobrunState

Description

 Jobs_SetJobrunState(
   char *DbFilename,
   int64  JobrunDbKey,
   char *JobrunDbState
);

This macro function sets the jobrun state of the jobrun specified by its jobrunKey in the database specified by its filename (including full path).

Parameters

char *DbFilename

Name of the database (including the full path).

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

char *JobrunDbState

Database value of the jobrun state. Use in case of upload/download to “server DB” context otherwise fill with NULL.

Jobs_SetParallelDeviceMovement

This function runs the HCA/JOBS > Acquisition > Parallelize Device Movement command.

Description

 Jobs_SetParallelDeviceMovement(
   int  Enabled
);

Turns on/off the hardware speed optimisation of a job (parallel movement of devices).

Parameters

int Enabled

0	Disabled.
1	Enabled.

Jobs_ShowGeneralAnalysis3Results

Description

 Jobs_ShowGeneralAnalysis3Results(
   int64  JobrunDbKey
);

Opens the Analysis Results of the specified General Analysis 3.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

Jobs_StitchLargeImage

Description

 Jobs_StitchLargeImage(
   int64  JobrunDbKey
);

Stitches a large image from images in the specified job run.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

Jobs_StitchLargeImageOnWholeJob

Description

 Jobs_StitchLargeImageOnWholeJob(
   int64  JobdefDbKey
);

Runs large image stitching on the selected job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

Jobs_TestRunJob

Description

 Jobs_TestRunJob(
   int64  JobdefDbKey
);

Executes Test Run on the specified Job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

Jobs_ToggleCloseJobViews

This function runs the HCA/JOBS > JOBS > Close Job Results upon Job Start command.

Description

 Jobs_ToggleCloseJobViews();

Toggles between the state when the job definition window is closed after the job is finished and the state when the window remains open.

Jobs_UpdateNd2Files

Description

 Jobs_UpdateNd2Files();

Edits all ND2 files present in the JOBs database by adding the well plate/slide definitions and their alignments.

Jobs_UpdateProject

Description

 Jobs_UpdateProject(
   int64  ProjDbKey,
   char *ProjDbName,
   char *ProjDbDesc
);

Updates the specified project.

Parameters

int64 ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

char *ProjDbName

Name of the Project containing the job. E.g.: “Project 1” (input value).

char *ProjDbDesc

Text description of the project.

Jobs_UploadDb

Description

 Jobs_UploadDb(
   char *DbFilename,
   char *SelectedJobsPattern,
   int  DeleteJobMergeOption,
   int  OverwriteJobMergeOption
);

This macro function uploads selected jobs specified by the SelectedJobsPattern parameter from the currently opened JOB database to the target database.

Parameters

char *DbFilename

Name of the database (including the full path).

char *SelectedJobsPattern

Regular expression (Wildcard syntax) specifying job names to be uploaded. Job name is considered in the “projectName/jobdefName” format. If null or empty, all jobs are selected.

int DeleteJobMergeOption

Equals the drop-down menu options in the JOBs UPLOAD dialog (see _Jobs_ShowUploadDialog).

0	Keep Remote
1	Delete from Remote

int OverwriteJobMergeOption

Equals the drop-down menu options in the JOBs UPLOAD dialog (see _Jobs_ShowUploadDialog).

0	Keep Remote
1	Overwrite Using Local

See Also

Jobs_UploadJobrun

Description

 Jobs_UploadJobrun(
   char *DbFilename,
   int  ImageFilesToo,
   int64  JobrunDbKey,
   char *JobrunDbState
);

This macro function uploads the jobrun specified by its jobrunkey from the current NIS database to the target database specified by its filename (including full path). It is optional to include captured images to the upload procedure using the ImageFilesToo parameter. If the value of the parameter JobrunDbState is not NULL, the jobrun is “marked” in the target database with the string value JobrunState (for example “uploaded”, “processed”).

Parameters

char *DbFilename

Name of the database (including the full path).

int ImageFilesToo

Include / exclude image files in the process.

0	Do not include images.
1	Include images.

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

char *JobrunDbState

Database value of the jobrun state. Use in case of upload/download to “server DB” context otherwise fill with NULL.

Jobs_ViewJobrunImage

Description

 Jobs_ViewJobrunImage(
   int64  JobdefDbKey
);

This function opens an image created during a job run, specified by the JobrunDbKey parameter. If the parameter value is set to “0”, all images captured during a job run are opened in one window.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_AdvancedImportFiles

Description

 _Jobs_AdvancedImportFiles();

Opens the Advanced Import Files into Current Project dialog window.

_Jobs_AlignSlide

This function runs the HCA/JOBS > Slide Holder > Align Slide Holder command.

Description

 _Jobs_AlignSlide();

Opens the Align Slide Holder dialog window.

_Jobs_AlignWellplate

This function runs the HCA/JOBS > Well Plate > Align Well Plate Holder command.

Description

 _Jobs_AlignWellplate();

This function opens the Align Well Plate window.

_Jobs_BackgroundDetection_Setup

This function runs the HCA/JOBS > Background Detection > Teach Background/Specimen Detection command.

Description

 _Jobs_BackgroundDetection_Setup();

Opens the Background Detection dialog window.

See: HCA/JOBS > Background Detection > Teach Background/Specimen Detection.

_Jobs_BackupDb

This function runs the HCA/JOBS > Database > Backup command.

Description

 _Jobs_BackupDb();

This function displays a pop-up window containing Database Backup settings.

See Also
Jobs_BackupDb

_Jobs_ContinueJobOrWizard

Description

 _Jobs_ContinueJobOrWizard(
   int64  JobdefDbKey
);

Opens an information dialog and starts the specified job directly (without wizard) after clicking Continue.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_CopyJobToProject

Description

 _Jobs_CopyJobToProject(
   int64  JobdefDbKey
);

Copies the selected job into a project selected from the Projects dialog window which is automatically opened.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_CopyRunsIntoJob

Description

 _Jobs_CopyRunsIntoJob(
   int64 *LpJobrunDbKeys,
   int  Count
);

Copies job runs into a job selected in the dialog window.

Parameters

int64 *LpJobrunDbKeys

Database value of the specified jobrun (output value).

int Count

Number of iterations.

_Jobs_CreateDb

This function runs the HCA/JOBS > Database > Create New Empty command.

Description

 _Jobs_CreateDb();

Opens the Create Database File dialog window.

_Jobs_CreateDbFromCurrent

This function runs the HCA/JOBS > Database > Create New Based on Current command.

Description

 _Jobs_CreateDbFromCurrent();

Opens the Create New Database dialog window enabling to select which items will be copied into the newly created database.

_Jobs_CreateJob

This function runs the HCA/JOBS > JOBS > Create New JOB command.

Description

 _Jobs_CreateJob(
   int64  ProjDbKey
);

Opens the Job Definition window containing a blank job.

Parameters

int64 ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

_Jobs_CreateJobFromTemplate

Description

 _Jobs_CreateJobFromTemplate(
   int64 *ProjDbKey
);

This function opens the pop-up window with pre-defined Job Templates.

Parameters

int64 *ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

_Jobs_CreateProject

Description

 _Jobs_CreateProject(
   int64 *LpProjDbKey
);

Creates a new project. The Project window opens, where the project name and description should be entered.

Parameters

int64 *LpProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

_Jobs_DefinitionWizard

Description

 _Jobs_DefinitionWizard(
   int64  JobdefDbKey
);

Opens the Job Wizard of the specified job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_DefinitionWizardLastState

Description

 _Jobs_DefinitionWizardLastState(
   int64  JobdefDbKey
);

Specified job is executed with its tasks set to their default state.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_DeleteAllGA3Runs

Description

 _Jobs_DeleteAllGA3Runs(
   int64  JobdefDbKey
);

Deletes all runs of the specified General Analysis 3.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_DeleteAllJobTestRuns

Description

 _Jobs_DeleteAllJobTestRuns(
   int64  JobdefDbKey
);

Deletes all test runs of the specified job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_DeleteAllLargeImageRuns

Description

 _Jobs_DeleteAllLargeImageRuns(
   int64  JobdefDbKey
);

Deletes all Large Image Runs of the specified job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_DeleteAllMaxIPRuns

Description

 _Jobs_DeleteAllMaxIPRuns(
   int64  JobdefDbKey
);

Deletes all Maximum Intensity Projection Runs of the specified job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_DeleteAllReconstructedRuns

Description

 _Jobs_DeleteAllReconstructedRuns(
   int64  JobdefDbKey
);

Deletes all reconstructed runs of the specified job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_DeleteJob

Description

 _Jobs_DeleteJob(
   int64  JobdefDbKey
);

Deletes the specified job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_DeleteProject

Description

 _Jobs_DeleteProject(
   int64  ProjDbKey
);

Deletes the specified project.

Parameters

int64 ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

_Jobs_EditJavaScript

This function runs the HCA/JOBS > JavaScript > New command.

Description

 _Jobs_EditJavaScript(
   char *JavaFilename
);

Opens the Run Script dialog window enabling to edit and run the JavaScript code.

Parameters

char *JavaFilename

Specifies path to the file containing the JavaScript code.

_Jobs_ErrorNotification

This function runs the HCA/JOBS > Presets > Error Notification command.

Description

 _Jobs_ErrorNotification();

This function opens the Error notification dialog window where you can choose a method how to receive runtime error notifications.

_Jobs_ExportJobDef

Description

 _Jobs_ExportJobDef(
   int64  JobdefDbKey
);

Exports the job definition of the selected job into a *.BIN file.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_ImportBioCtFiles

Description

 _Jobs_ImportBioCtFiles();

Opens the Import Biostation CT files into Current Project enabling to import biostation .CT files.

_Jobs_ImportFiles

Description

 _Jobs_ImportFiles();

Opens the Import Files into Current Project dialog window enabling to import image files as job runs. Each imported file gets a record as a job run and can be displayed in the result view.

_Jobs_ImportJobDef

Description

 _Jobs_ImportJobDef();

Imports a job definition from a *.BIN file.

_Jobs_InsertCustomPlate

Description

 _Jobs_InsertCustomPlate();

Opens the Open dialog window to select a custom wellplate XML file.

_Jobs_JobDefinitionOptions

This function runs the HCA/JOBS > JOBS > JOBS Editor Options command.

Description

 _Jobs_JobDefinitionOptions();

Opens the Job Options window.

_Jobs_MakeMaxIP

Description

 _Jobs_MakeMaxIP(
   int64  JobrunDbKey
);

Creates Maximum Intensity Projection of the specified job run on the selected dimension.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

_Jobs_ManageCategories

This function runs the HCA/JOBS > Presets > Manage Custom Metadata command.

Description

 _Jobs_ManageCategories();

Opens the Manage Custom Metadata dialog window.

See: HCA/JOBS > Presets > Manage Custom Metadata.

_Jobs_ManageCustomSlides

This function runs the HCA/JOBS > Slide Holder > Manage Custom Slides command.

Description

 _Jobs_ManageCustomSlides();

Opens the Manage Custom Slides dialog window.

See: HCA/JOBS > Slide Holder > Manage Custom Slides.

_Jobs_ManageCustomWellplates

This function runs the HCA/JOBS > Well Plate > Manage Custom Well Plates command.

Description

 _Jobs_ManageCustomWellplates();

This function displays a pop-up window where you can search for previously saved well plates, create new ones, delete them or import / export them from / to a .BIN file.

_Jobs_ManageDbs

Description

 _Jobs_ManageDbs();

Opens the Manage Quick Databases dialog window.

_Jobs_ManageJavaScriptFiles

This function runs the HCA/JOBS > JavaScript > Edit > Manage command.

Description

 _Jobs_ManageJavaScriptFiles();

Opens the Manage JavaScript Files which is used for integrating the selected files into the menu.

_Jobs_ManageLabels

This function runs the HCA/JOBS > Presets > Manage Labels command.

Description

 _Jobs_ManageLabels();

Opens the Labeling Tags window.

_Jobs_ManageQuantities

Description

 _Jobs_ManageQuantities();

Opens the Quantities window.

_Jobs_ManageRecipes

This function runs the HCA/JOBS > Presets > Manage Recipes command.

Description

 _Jobs_ManageRecipes();

Opens the Manage Recipes window.

_Jobs_OpenAndEditJavaScript

This function runs the HCA/JOBS > JavaScript > Edit > Browse command.

Description

 _Jobs_OpenAndEditJavaScript();

Opens the JavaScript file (.js, .txt) in the JavaScript editor.

_Jobs_OpenAndRunJavaScript

This function runs the HCA/JOBS > JavaScript > Run > Browse command.

Description

 _Jobs_OpenAndRunJavaScript();

Opens the JavaScript file (.js, .txt) and executes it.

_Jobs_OpenDb

This function runs the HCA/JOBS > Database > Open Existing command.

Description

 _Jobs_OpenDb();

Opens the Open Database File dialog window.

_Jobs_PropertiesDialog

This function runs the HCA/JOBS > Database > Properties command.

Description

 _Jobs_PropertiesDialog();

Opens the Database Properties window.

_Jobs_RenameDb

This function runs the HCA/JOBS > Database > Rename command.

Description

 _Jobs_RenameDb();

Opens the Database Rename dialog window which can be used to rename the currently opened database.

_Jobs_RestoreDb

This function runs the HCA/JOBS > Database > Restore command.

Description

 _Jobs_RestoreDb();

This function opens the Database Restore dialog window.

_Jobs_RunAnalysis

Description

 _Jobs_RunAnalysis(
   int64  JobdefDbKey
);

This function opens the Run Analysis dialog window where you can execute more analyses on captured frames.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_RunBatchAnalysis

Description

 _Jobs_RunBatchAnalysis(
   int64 *LpJobrunDbKeys,
   int  Count
);

This function opens the Run Analysis on... dialog window enabling to redefine or run the selected analysis.

To get all analysis runs from job runs with the specified key (JobRun ID's), you can use the following macro example for keys 5 and 7:

int64 keys[2]; // 2 is the field for JobRun ID
keys[0] = 5; 
keys[1] = 7;
_Jobs_RunBatchAnalysis(keys,2); // 2 is the field size

Parameters

int64 *LpJobrunDbKeys

Database value of the specified jobrun (output value).

int Count

Number of iterations.

_Jobs_RunGeneralAnalysis3OnJobdef

Description

 _Jobs_RunGeneralAnalysis3OnJobdef(
   int64  JobdefDbKey
);

Opens the Run General Analysis 3 on Job dialog window with the specified General Analysis 3 loaded.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_RunGeneralAnalysis3OnJobrun

Description

 _Jobs_RunGeneralAnalysis3OnJobrun(
   int64  JobrunDbKey
);

Opens the Run General Analysis 3 on Jobrun with the specified General Analysis 3 loaded.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

_Jobs_RunJobOrWizard

Description

 _Jobs_RunJobOrWizard(
   int64  JobdefDbKey
);

Runs the specified job in a standard manner.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_RunJobOrWizardByName

Description

 _Jobs_RunJobOrWizardByName(
   char *ProjDbName,
   char *ProjDbJobName
);

Runs a job specified by its name and the name of the project.

Parameters

char *ProjDbName

Name of the Project containing the job. E.g.: “Project 1” (input value).

char *ProjDbJobName

Name of the Job. E.g.: “HCA Live Job” (input value).

_Jobs_ShowDownloadDialog

This function runs the HCA/JOBS > Database > Download command.

Description

 _Jobs_ShowDownloadDialog();

Opens the Download dialog window for downloading a JOBS database from a remote server.

_Jobs_ShowInitErrorDlg

This function runs the HCA/JOBS > Database > Upgrade Database command.

Description

 _Jobs_ShowInitErrorDlg();

Checks for database errors and displays a dialog window describing database status.

_Jobs_ShowMostRecent

Description

 _Jobs_ShowMostRecent();

Opens the most recent job in the Job Definition window.

_Jobs_ShowUploadDialog

This function runs the HCA/JOBS > Database > Upload command.

Description

 _Jobs_ShowUploadDialog();

Opens the Upload dialog window for uploading the JOBS database to a remote server.

_Jobs_StitchLargeImage

Description

 _Jobs_StitchLargeImage(
   int64  JobrunDbKey
);

Opens the Stitching ND Options dialog window.

See: Image > ND Processing > Stitch Multipoint to Large Image).

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

_Jobs_StitchLargeImageOnWholeJob

Description

 _Jobs_StitchLargeImageOnWholeJob(
   int64  JobdefDbKey
);

Opens the Stitching ND Options dialog window (see: Image > ND Processing > Stitch Multipoint to Large Image).

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_UpdateProject

Description

 _Jobs_UpdateProject(
   int64  ProjDbKey
);

Opens the Project window where the current project name and description can be updated.

Parameters

int64 ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

_Jobs_ViewGA3Results

Description

 _Jobs_ViewGA3Results(
   int64  JobdefDbKey,
   int  Reuse
);

Opens the image results of the specified General Analysis 3.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

int Reuse

Uses the result window which is already opened.

0	Opened window is not used.
1	Opened window is used (only if it belongs to the same jobrun).

_Jobs_ViewJobDefinition

Description

 _Jobs_ViewJobDefinition(
   int64  JobdefDbKey
);

Opens the Job Definition window containing the specified job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

_Jobs_ViewJobResults

Description

 _Jobs_ViewJobResults(
   int64  JobdefDbKey,
   int  Reuse
);

This function opens results of the specified job.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

int Reuse

Uses the result window which is already opened.

0	Opened window is not used.
1	Opened window is used (only if it belongs to the same jobrun).

See Also
Jobs_GetJobKey

_Jobs_ViewJobrunImage

Description

 _Jobs_ViewJobrunImage(
   int64  JobrunDbKey
);

Opens the acquired image of the specified job run.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

_Jobs_ViewJobrunResults

Description

 _Jobs_ViewJobrunResults(
   int64  JobdefDbKey,
   int  Reuse
);

Opens results of the specified job run.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

int Reuse

Uses the result window which is already opened.

0	Opened window is not used.
1	Opened window is used (only if it belongs to the same jobrun).

See Also
Jobs_GetJobKey

_Jobs_ViewJobrunResultsEx

Description

 _Jobs_ViewJobrunResultsEx(
   int64  JobrunDbKey,
   int  JobMode,
   int  JobSubmode,
   int  Reuse
);

Opens the job results view of the particular jobrun identified by the Jobrunkey. It enables the user to choose the view mode (Thumbnails, Wellplate, Grid) and the corresponding view sub-mode of the jobrun.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

int JobMode

Switches the result view between its viewing modes.

0	Thumbnails
1	Wellplate
2	List
3	XY

int JobSubmode

Switches the result view between its viewing sub-modes.

For grid mode:

0	Frames
1	Objects
2	Traces

For thumbnail/wellplate mode:

0	Image
1	Labels
2	Heatmap
3	Histogram

int Reuse

Uses the result window which is already opened.

0	Opened window is not used.
1	Opened window is used (only if it belongs to the same jobrun).

_Jobs_ViewLargeImageResults

Description

 _Jobs_ViewLargeImageResults(
   int64  JobrunDbKey,
   int  Reuse
);

Opens the job large image in the results window.

Parameters

int64 JobrunDbKey

Database key of a job run. You can get the key by the Jobs_GetJobKey function.

int Reuse

Uses the result window which is already opened.

0	Opened window is not used.
1	Opened window is used (only if it belongs to the same jobrun).

_Jobs_ViewMaxIPResults

Description

 _Jobs_ViewMaxIPResults(
   int64  JobdefDbKey,
   int  Reuse
);

Opens the job Maximal Intensity Projection image in the results window.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

int Reuse

Uses the result window which is already opened.

0	Opened window is not used.
1	Opened window is used (only if it belongs to the same jobrun).

_Jobs_ViewProjectResults

Description

 _Jobs_ViewProjectResults(
   int64  ProjDbKey,
   int  Reuse
);

Opens the project results.

Parameters

int64 ProjDbKey

Please see the Jobs_GetJobKey function which specifies this parameter.

int Reuse

Uses the result window which is already opened.

0	Opened window is not used.
1	Opened window is used (only if it belongs to the same jobrun).

See Also
Jobs_GetJobKey

_Jobs_ViewReconstructedResults

Description

 _Jobs_ViewReconstructedResults(
   int64  JobdefDbKey,
   int  Reuse
);

Opens the job reconstructed runs in the results window.

Parameters

int64 JobdefDbKey

Please see Jobs_GetJobKey which specifies this parameter.

int Reuse

Uses the result window which is already opened.

0	Opened window is not used.
1	Opened window is used (only if it belongs to the same jobrun).

Jobs🔗

Note

Note

Note

Note

Note

Jobs