Oracle® Enterprise Data Quality for Product Data COM API Interface Guide Release 5.6.2 Part Number E23724-02 |
|
|
View PDF |
The Transform Server object can also be used to retrieve information about the server. These types of information can be useful for applications where a selection list of maps and data lenses needs to be presented to the user.
Typically, processing is done with known Maps that are hard-coded into your application. In this case, this server information would not be needed.
A list of all the DSAs that are available to the server can be obtained.
Dim oProcessMaps As ProcessMaps Dim oProcessMap As ProcessMap Set oProcessMaps = oTransformServer.getProcessMaps() If oProcessMaps.IsError Then MsgBox ("Error Getting TMap information: " + oProcessMaps.errorMsg) Exit Sub End If For Each oProcessMap In oProcessMaps.Items m_tmpStatus = m_tmpStatus + oProcessMap.Name + vbCrLf Next
Details on individual DSAs can be obtained from the server. This includes:
Name
Description
Input Steps
Output Steps
Database Connections
Dim oDSA As ProcessMap Set oDSA = g_oTransformServer.getProcessMap(sPMapName) If oDSA.IsError Then MsgBox ("Error Getting DSA information: " + oPMap.errorMsg) Exit Sub End If
oPMap.Name
- This will return the DSA Name as a String
oPMap.Description
- This will return the description of the DSA
oPMap.inputSteps
- This returns a collection of jobStep objects
oPMap.outputSteps
- This returns a collection of jobStep objects.
oPMap.dbConnections
- This returns a collection of Strings with the connection name
oPMap.transformationMaps
- This returns a collection of Strings with the Transformation Map name
The server object can be used to return the list of Transform Maps used by the server. For Example:
Dim oTMaps As TransformMaps Dim oTMap As TransformMap Set oTMaps = g_oTransformServer.getTransformMaps() If oTMaps.IsError Then MsgBox ("Error Getting TMap information: " + oTMaps.errorMsg) Exit Sub End If For Each TMap In oTMaps.Items m_tmpStatus = m_tmpStatus + oTMap.Name + vbCrLf Next
Details on the individual Transform Maps can be obtained from the Transform Server object. This includes:
Name
Description
Input Columns
Output Columns
Database Connections
Data lenses Used
Output Maps
Dim oTMap As TransformMap Set oTMap = g_oTransformServer.getTransformMap(sTMapName) If oTMap.IsError Then MsgBox ("Error Getting TMap information: " + oTMap.errorMsg) Exit Sub End If
oTMap.Name Name
- This will return the Transform Map Name as a String
oTMap.Description
- This will return the description of the DSA
oTMap.isDecisionMap
- Boolean flag on the type of Transform Map
oTMap.hasDbDataSource
- Boolean flag on the data input. There will be no input Columns if the Db Data Source is true.
oTMap.inputColumns
- Returns a collection of column names as strings
oTMap.outputColumns
- Returns a collection of column names as strings
oTMap.dbConnections
- Returns a collection of database connections as strings
oTMap.kbNames
- Returns a collection of data lens names as strings
oTMap.outputMaps
- Returns a collection of output Transform Maps as strings
The Transform Server object can be used to return a list of data lenses that are in the server Repository.
Dim oDLs As KnowledgeBases Dim oDL As KnowledgeBase Set oDLs = g_oTransformServer.getKnowledgeBases If oDLs.IsError Then MsgBox ("Error Getting TMap information: " + oDLs.errorMsg) Exit Sub End If For Each oDL In oDLs.Items m_tmpStatus = m_tmpStatus + oDL.Name + vbCrLf Next
The only details that can be obtained on a data lens is the description.
Dim oDL As KnowledgeBase Set oDL = g_oTransformServer.getKnowledgeBase(Text_DLName) If oDL.IsError Then MsgBox ("Error Getting DSA information: " + oDL.errorMsg) Exit Sub End If
oDL.Name
- This will return the data lens name as a String.
oDL.Description
- This will return the description of the data lens.
Information on the DSA jobs that have been submitted to the server can be obtained from the Transform Server object.
All Jobs run on a particular server can be listed.
All Jobs run on all servers in the server group can be listed.
Jobs can be listed by date range from the current time.
Jobs can be filtered by the user that submitted the job.
Jobs can be filtered to just the jobs that were started on this particular Server.
Jobs can be filtered by the job status
Currently running jobs
Jobs awaiting user input
Completed, failed or cancelled jobs
Pending jobs
There are two calls that are used to get all this job information:
Dim oJobs As Jobs Set oJobs = g_oTransformServer.getJobsBySubmitter(user, bListAllServers, _ sinceSecs, bRefresh) Set oJobs = g_oTransformServer.getJobs(bListAllServers, sinceSecs, bRefresh)
These are the parameters used in the preceding call:
User
- The user that submitted the job
bListAllServers
- List all jobs on all servers, not just this particular server
sinceSecs
- Number of seconds to go back looking at the job history
bRefresh
- Refresh the job list since this Transform Server object was created
Following is a code example that shows the job information for the individual jobs.
Dim oJobs As Jobs For Each oJob In oJobs.Jobs Call displaySingleJob(oJob) Next Private Sub displaySingleJob(oJob As Job) m_tmpStatus = CStr(oJob.jobId) + vbTab m_tmpStatus = m_tmpStatus + CStr(oJob.priority) + vbTab m_tmpStatus = m_tmpStatus + oJob.getStatusDesc(oJob.Status) + vbTab m_tmpStatus = m_tmpStatus + oJob.runtimeLocale + vbTab m_tmpStatus = m_tmpStatus + oJob.createdBy + vbTab m_tmpStatus = m_tmpStatus + oJob.Description + vbTab m_tmpStatus = m_tmpStatus + oJob.definition + vbTab m_tmpStatus = m_tmpStatus + oJob.startTime + vbTab m_tmpStatus = m_tmpStatus + oJob.server + vbTab End Sub