This is the documentation for SuperSTAR 9.8

SuperSTAR 9.9 is now available.
View this page in the SuperSTAR 9.9 documentation or visit the SuperSTAR 9.9 documentation home.

Skip to end of metadata
Go to start of metadata

The following functions allow client programmers to access details about the current job being processed, the user and client who initiated the job, and the API itself. These functions may be of use when writing logging code in a client implementation.

API Information

GetAPIVersionT()

Get the version of the Data Control API.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob
GetAPIVersionT() 
ReturnsThe API version number.

Job Identification

GetJobNameT()

Retrieve the name of the current job.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetJobNameT(PreJobInfoT* JobInfo)

PrepareJob, PerformJob or CleanUpJob:

GetJobNameT(JobInfoT* JobInfo)
Arguments
JobInfoInputInformation about the current job.
ReturnsA job name, or NULL on failure.

GetJobTypeT()

Retrieve the type name of the current job. Only the tabulation job type ("TABULATION") is currently supported by the API.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetJobTypeT(PreJobInfoT* JobInfo) 

PrepareJob, PerformJob or CleanUpJob:

GetJobTypeT(JobInfoT* JobInfo)
Arguments
JobInfoInputInformation about the current job.
ReturnsA job type, or NULL on failure.

GetJobOwnerIDT()

Retrieve the user ID of the current job's owner.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetJobOwnerIDT(PreJobInfoT* JobInfo) 

PrepareJob, PerformJob or CleanUpJob:

GetJobOwnerIDT(JobInfoT* JobInfo)
Arguments
JobInfoInputInformation about the current job.
ReturnsA user ID, or NULL on failure.

GetJobOwnerGroupsT()

Retrieve the group IDs that the job's owner belongs to.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetJobOwnerGroupsT(PreJobInfoT* JobInfo, const char*** Groups, int* Len) 

PrepareJob, PerformJob or CleanUpJob:

GetJobOwnerGroupsT(JobInfoT* JobInfo, const char*** Groups, int* Len)
Arguments
JobInfoInputInformation about the current job.
GroupsOutputIDs of the groups the job owner belongs to.
LenOutputThe number of group IDs returned.
Returns
1Group IDs were retrieved successfully.
0The user does not belong to any groups.

GetJobDBCatalogueIDT()

Retrieve the ID of the database that the job was submitted against.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetJobDBCatalogueIDT(PreJobInfoT* JobInfo)

PrepareJob, PerformJob or CleanUpJob:

GetJobDBCatalogueIDT(JobInfoT* JobInfo)
Arguments
JobInfoInputInformation about the current job.
ReturnsA database catalogue ID, or NULL on failure.

GetJobDBFileNameT()

Retrieve the filename of the database the job was submitted against.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetJobDBFileNameT(PreJobInfoT* JobInfo)

PrepareJob, PerformJob or CleanUpJob:

GetJobDBFileNameT(JobInfoT* JobInfo)
Arguments
JobInfoInputInformation about the current job.
ReturnsA database filename, or NULL on failure.

GetJobMethodIDT()

Retrieve the ID string of the currently executing method.

Available To
PrepareJob
PerformJob
CleanUpJob
GetJobMethodIDT(JobInfoT* jobInfo)
Arguments
JobInfoInputInformation about the current job.
ReturnsThe name of the current method, or NULL.

GetJobMethodListT()

Retrieve the list of methods that will be invoked in this tabulation request. This will be the actually executed list (non-selected table methods will be suppressed).

Available To
PrepareJob
PerformJob
CleanUpJob
GetJobMethodListT(JobInfoT* jobInfo, const MethodDefinitionT** definitions, int* length)
Arguments
JobInfoInputInformation about the current job.
definitionsOutputThe current method list.
lengthOutputThe length of the method list.

GetClientLanguageT()

Retrieve the language setting for the client.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetClientLanguageT(PreJobInfoT* JobInfo) 

PrepareJob, PerformJob or CleanUpJob:

GetClientLanguageT(JobInfoT* jobInfo)
Arguments
JobInfoInputInformation about the current job.
ReturnsThe requesting client's language string (if available), or an empty string otherwise.

Audit Functions

GetUserIdT()

Retrieve the user ID for the current request.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetUserIdT(PreJobInfoT* JobInfo) 

PrepareJob, PerformJob or CleanUpJob:

GetUserIdT(JobInfoT* jobInfo)
Arguments
JobInfoInputInformation about the current job.
ReturnsThe unique user ID used to initiate the cross tabulation request.

GetClientApplicationT()

Retrieve the client application ID for the current request.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetClientApplicationT(PreJobInfoT* JobInfo) 

PrepareJob, PerformJob or CleanUpJob:

GetClientApplicationT(JobInfoT* jobInfo)
Arguments
JobInfoInputInformation about the current job.
ReturnsThe client application ID used to initiate the cross tabulation request.

GetClientIpAddressT()

Retrieve the client IP address for the current request.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetClientIpAddressT(PreJobInfoT* JobInfo) 

PrepareJob, PerformJob or CleanUpJob:

GetClientIpAddressT(JobInfoT* jobInfo)
Arguments
JobInfoInputInformation about the current job.
Returns

The IPv4 address where the request originated, as a string.

  • For SuperCROSS or Production System this will be the host IP where the application was run.
  • For SuperWEB2 this will be the user's host IP (i.e., where the web browser was run).
  • No labels