2 What's New in This Release

This chapter contains the following sections:

• New APIs

• Modified APIs

• Removed APIs

New APIs

Table 2-1 lists the new application programming interfaces (APIs) in this release.

Table 2-1 List of New APIs in This Release

Operations	APIs
ITResource Instance	public HashMap getITResourceInstances(String psITResourceType) throws tcAPIException
Provisioning	public Date getProvisioingProcessOfflinedDate(long processInstanceKey) throws tcAPIException
Reconciliation	public long addDirectMultiAttributeData(long plReconciliationEventKey, String psFieldName, Map poData, String psDateFormat) throws tcAPIException, tcEventNotFoundException, tcEventDataReceivedException public long addDirectMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, String psFieldName, Map poData, String psDateFormat) throws tcAPIException, tcEventNotFoundException, tcAttributeNotFoundException, tcEventDataReceivedException, tcInvalidAttributeException public long addDirectMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, String psFieldName, Map poData) throws tcAPIException, tcEventNotFoundException, tcAttributeNotFoundException, tcEventDataReceivedException, tcInvalidAttributeException public long addDirectMultiAttributeData(long plReconciliationEventKey, String psFieldName, Map poData) throws tcAPIException, tcEventNotFoundException, tcEventDataReceivedException
Audit	public void reIssueAuditMessageByIdentifier(String auditor, String identifier) throws tcAPIException public void reIssueAuditMessage(int audJmsKey) throws tcAPIException

Modified APIs

Table 2-2 lists the modified user operation APIs in this release.

Note: OIU_OFFLINED_DATE, sch_offlined and XL.OfflineApprovals are reserved for internal use only.

Table 2-2 Modified User Operation APIs

Old API	New API	Comments
private tcDataSetData getObjectsData(long plUserKey) throws tcAPIException, tcUserNotFoundException	private tcDataSetData getObjectsData(long plUserKey) throws tcAPIException, tcUserNotFoundException	Modified the API to return an extra column OIU_OFFLINED_DATE. If this column value is not null, then the provisioned instance is off-lined at the date returned in that column and message is not yet processed by the JMS message handler and the off-lined message is still in the JMS queue.
public long setProxyForUser(long userKey, long proxyUserKey, Date startDate, Date endDate) throws tcAPIException, tcUserNotFoundException, tcRecursiveProxyException	public long setProxyForUser(long userKey, long proxyUserKey, Date startDate, Date endDate) throws tcAPIException, tcUserNotFoundException, tcRecursiveProxyException	Enhanced API to return error codes along with tcAPIException, if there are any errors in creating a proxy.
public void updateProxyForUser(long pxdKey, Map attribute) throws tcAPIException, tcUserNotFoundException, tcRecursiveProxyException	public void updateProxyForUser(long pxdKey, Map attribute) throws tcAPIException, tcUserNotFoundException, tcRecursiveProxyException	Enhanced API to return error codes along with tcAPIException, if there are any errors in updating a proxy.

Table 2-3 lists the modified form instance operation APIs in this release.

Table 2-3 Modified Form Instance Operation APIs

Old API	New API	Comments
private void setProcessFormData(long plProcessInstanceKey, tcMapping[] phAttributeList) throws tcAPIException, tcInvalidValueException, tcNotAtomicProcessException, tcFormNotFoundException, tcRequiredDataMissingException, tcProcessNotFoundException	private void setProcessFormData(long plProcessInstanceKey, tcMapping[] phAttributeList) throws tcAPIException, tcInvalidValueException, tcNotAtomicProcessException, tcFormNotFoundException, tcRequiredDataMissingException, tcProcessNotFoundException	If a message submitted for provisioning process offline and message is still in queue, then calling process form save sets off-lined date value to null so that message handler ignores the message as saving form would have already started provisioning process instantiation.

Table 2-4 lists the modified provisioning operation APIs in this release.

Table 2-4 Modified Provisioning Operation APIs

Old API	New API	Comments
private tcDataSetData getProcessDetailData(long plProcessInstanceKey) throws tcAPIException, tcNotAtomicProcessException	private tcDataSetData getProcessDetailData(long plProcessInstanceKey) throws tcAPIException, tcNotAtomicProcessException	A new column value, sch_offlined, is returned along with all other task information. If the task approval is off-lined and a JMS message is in queue for this task, then a positive integer is returned indicating that the message is submitted and is yet to be processed by the JMS handler.
public void updateTask(long plTaskInstanceKey, Map phAttributeList) throws tcTaskNotFoundException, tcAPIException, tcAwaitingObjectDataCompletionException, tcAwaitingApprovalDataCompletionException	public void updateTask(long plTaskInstanceKey, Map phAttributeList) throws tcTaskNotFoundException, tcAPIException, tcAwaitingObjectDataCompletionException, tcAwaitingApprovalDataCompletionException	If the API is called to set the task status or a response code, then the API checks if the XL.OfflineApprovals property is true or not. If it is set to true, then the task status/response code setting is off-lined so that the perceived performance seen by a user is enhanced when acting on the task.
public tcResultSet getAssignedProvisioningTasks(long userKey, Map attributeList, String[] statuses) throws tcAPIException, tcUserNotFoundException, tcAttributeNotFoundException	public tcResultSet getAssignedProvisioningTasks(long userKey, Map attributeList, String[] statuses) throws tcAPIException, tcUserNotFoundException, tcAttributeNotFoundException	A new column value, sch_offlined, is returned along with all other task information. If the task approval is off-lined and a JMS message is in queue for this task, then a positive integer is returned indicating that the message is submitted and is yet to be processed by the JMS handler.
public tcResultSet getProvisioningTasksAssignedToManagedUsers( long userKey, Map attributeList, String[] statuses) throws tcAPIException, tcUserNotFoundException, tcAttributeNotFoundException	public tcResultSet getProvisioningTasksAssignedToManagedUsers( long userKey, Map attributeList, String[] statuses) throws tcAPIException, tcUserNotFoundException, tcAttributeNotFoundException	A new column value, sch_offlined, is returned along with all other task information. If the task approval is off-lined and a JMS message is in queue for this task, then a positive integer is returned indicating that the message is submitted and is yet to be processed by the JMS handler.

Table 2-5 lists the modified reconciliation operation APIs in this release.

Table 2-5 Modified Reconciliation Operation APIs

Old API	New API	Comments
public boolean ignoreEvent(String psObjName, Map poData) throws tcAPIException, tcObjectNotFoundException	public boolean ignoreEvent(String psObjName, Map poData) throws tcAPIException, tcObjectNotFoundException	Modified API so that the reconciliation attribute passed to the map need not be case-sensitive.
public Boolean ignoreEventAttributeData(String psObjName, Map poData,String psFieldName, Map[] paoAttributeDataList) throws tcAPIException, tcObjectNotFoundException	public Boolean ignoreEventAttributeData(String psObjName, Map poData,String psFieldName, Map[] paoAttributeDataList) throws tcAPIException, tcObjectNotFoundException	Modified API so that the reconciliation attribute passed to the map need not be case-sensitive.
public boolean ignoreEvent(String psObjName, Map poData, String psDateFormat) throws tcAPIException, tcObjectNotFoundException	public boolean ignoreEvent(String psObjName, Map poData, String psDateFormat) throws tcAPIException, tcObjectNotFoundException	Modified API so that the reconciliation attribute passed to the map need not be case-sensitive.
public Boolean ignoreEventAttributeData(String psObjName, Map poData, String psFieldName, Map[] paoAttributeDataList, String psDateFormat) throws tcAPIException, tcObjectNotFoundException	public Boolean ignoreEventAttributeData(String psObjName, Map poData, String psFieldName, Map[] paoAttributeDataList, String psDateFormat) throws tcAPIException, tcObjectNotFoundException	Modified API so that the reconciliation attribute passed to the map need not be case-sensitive.
public void linkEventToResourceInstanceForUser( long plReconciliationEventKey, long objectInstanceForUserKey) throws tcAPIException, tcEventNotFoundException	public void linkEventToResourceInstanceForUser( long plReconciliationEventKey, long objectInstanceForUserKey) throws tcAPIException, tcEventNotFoundException	Fixed the issue so that when reconciliation event is manually linked to a process by calling this API, process form data gets updated.

Table 2-6 lists the modified request operation APIs in this release.

Table 2-6 Modified Request Operation APIs

Old API	New API	Comments
public void setRequestResponse(long plRequestKey, long plUserKey, String psResponse) throws tcAPIException, tcInvalidResponseException, tcAwaitingObjectDataCompletionException, tcAwaitingApprovalDataCompletionException	public void setRequestResponse(long plRequestKey, long plUserKey, String psResponse) throws tcAPIException, tcInvalidResponseException, tcAwaitingObjectDataCompletionException, tcAwaitingApprovalDataCompletionException	API checks if the XL.OfflineApprovals property is true or not. If it is set to true, then the task is off-lined so that the perceived performance seen by a user is enhanced when acting on tasks.
public void setResourceResponse(long plUserKey, long plObjectInstanceKey, String psResponse) throws tcAPIException, tcInvalidResponseException	public void setResourceResponse(long plUserKey, long plObjectInstanceKey, String psResponse) throws tcAPIException, tcInvalidResponseException	API checks if the XL.OfflineApprovals property is true or not. If it is set to true, then the task is off-lined so that the perceived performance seen by a user is enhanced when acting on tasks.
public tcResultSet getApprovalTasksAssignedToUser( long userKey, Map attributeList) throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException	public tcResultSet getApprovalTasksAssignedToUser( long userKey, Map attributeList) throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException	A new column value, sch_offlined, is returned along with all other task information. If the task approval is off-lined and a JMS message is in queue for this task, then a positive integer is returned indicating that the message is submitted and is yet to be processed by the JMS handler.
public tcResultSet getApprovalTasksAssigned( Map attributeList) throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException	public tcResultSet getApprovalTasksAssigned( Map attributeList) throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException	A new column value, sch_offlined, is returned along with all other task information. If the task approval is off-lined and a JMS message is in queue for this task, then a positive integer is returned indicating that the message is submitted and is yet to be processed by the JMS handler.
public tcResultSet getApprovalTasksAssignedToManagedUsers( long userKey, Map attributeList) throws tcAPIException, tcUserNotFoundException, tcAttributeNotFoundException	public tcResultSet getApprovalTasksAssignedToManagedUsers( long userKey, Map attributeList) throws tcAPIException, tcUserNotFoundException, tcAttributeNotFoundException	A new column value, sch_offlined, is returned along with all other task information. If the task approval is off-lined and a JMS message is in queue for this task, then a positive integer is returned indicating that the message is submitted and is yet to be processed by the JMS handler.
public tcResultSet getProvisioningDetail( long requestID) throws tcAPIException	public tcResultSet getProvisioningDetail( long requestID) throws tcAPIException	Modified the API to return an extra column OIU_OFFLINED_DATE. If this column value is not null, then it indicates that the provisioned instance is off-lined at the date returned in that column and is not yet processed by the JMS message handler and the off-lined message is still in the JMS queue.

Table 2-7 lists the modified workflow operation APIs in this release.

Table 2-7 Modified Workflow Operation APIs

Old API	New API	Comments
public WorkflowDefinition getWorkflowDefinition( long workflowDefKey) throws tcAPIException	public WorkflowDefinition getWorkflowDefinition( long workflowDefKey) throws tcAPIException	API is modified so that task assignment rules are returned correctly.

Table 2-8 lists the modified report operation APIs in this release.

Table 2-8 Modified Report Operation APIs

Old API	New API	Comments
public tcResultSet getPagedReportData( ReportInput reportInput) throws tcAPIException	public tcResultSet getPagedReportData( ReportInput reportInput) throws tcAPIException	Added support to handle special input characters. If special characters are provided, then tcAPIException is thrown. Characters that are not allowed as input are: ; # / % = | + , \ ' " < >

Table 2-9 lists the modified audit operation APIs in this release.

Table 2-9 Modified Audit Operation APIs

Old API	New API	Comment
public tcResultSet getUserProfile(long upa) throws tcAPIException	public tcResultSet getUserProfile(long upa) throws tcAPIException	Modified API so that it does not return a user updated date.

Removed APIs

No APIs have been removed in this release.