Converse agora com nosso suporte
Chat com o suporte

Stat 6.3 - System Administration Guide

Overview of Stat Administration Administrative Utilities Stat Security General Maintenance Tables
System Maintenance Service Domain Maintenance Department Maintenance Issue Tracking Maintenance Country Maintenance Customer Maintenance Object Type Maintenance PeopleSoft Environment Connection Maintenance Pre/Post Migration Steps Parameters Oracle Applications Configuration Oracle Applications Connection Maintenance Generic Application Connection Maintenance Schema Object Parameters Maintenance Data Object Maintenance PeopleSoft Search Configurations Stat Report Definition Maintenance Version Control Management Connection Maintenance
Service Domain-Specific Maintenance Configuring the Stat Central Agent Email Configuration Object Security Appendix: Sample Service Domain Configuration Appendix: User Class Rights Appendix: Creating a Staging Database Appendix: Database Tuning Appendix: Oracle Applications File Type Directory Appendix: Ports and Firewalls Appendix: REST Web Services API Appendix: SOAP-Based Web Services API Appendix: Troubleshooting Chart Appendix: stat.conf Configuration Appendix: Custom Report Files

void disconnect( long connectId );

This method terminates an established connection through Web Services.

CSR Service

The URL for the wsdl file of this service is located at: http://hostname:port/stat/WSCsrService?wsdl

Save a New CSR

The server throws an exception if user does not have Add CSR or Add Attachment rights or if any of the fields in the csr bean is invalid.

Method

long saveNewCSR(long connectId, CSRType csr, List<AttachmentType> attachments) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
csr - A bean representing all the values in a CSR. (See Class Definitions, part 3 for CSRType definition)
•
attachments - List of attachments. For more information, see AttachmentType Bean .

Return Parameter

A long value representing the CSR Id of the new csr is returned.

Retrieve the Content of a CSR from Stat
 

Method

CSRType retrieveCSR(long connectId, String sdcd, long csrId) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id

Return Parameter

A csr bean representing the retrieved csr is returned. For more information, see CSRType Bean .

Update an Existing CSR in Stat

The csr parameter bean will contain all the original values in the CSR in addition to the updated values.

The server throws an exception in the following circumstances:

•
In the case of an invalid service domain, or CSR Id parameters.
•
If another user has the lock on the CSR.
•
If user has restriction to the Application.
•
If the CSR is in a Closed Status and user does not have proper rights.
•
If the CSR is assigned to another user and the current user does not have proper override rights.
•
If the user does not have change rights to any of the fields in CSR.
•
If any of the values in CSR are invalid.
•
If the CSR has objects and user is attempting to change to an Application that results in a change of Module.
•
If the CSR has objects and user is attempting to change to a CSR Type that invalidates the current Workflow.
•
If the CSR has objects and user is attempting to change to a Workflow that invalidates the current migration path.

Before updating the CSR, a row is inserted into CSR_LOCK_STATUS and is removed after the update.

CSR History records are inserted for the updated fields.

Method

void updateCSR(long connectId, CSRType csr) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
csr - A csr bean representing the retrieved csr is returned. For more information, see CSRType Bean .
Retrieve a CSR by Tracking Number

Query Stat for the CSR based on the Tracking Number field.

Method

List<CSRType> retrieveCSRByColumn(connectId, columnName, columnValue)

 

Input Parameters
•
connectId - a valid connection Id
•
columnName - valid values are TRACKING_NUMBER and ALTERNATE_NUMBER
•
columnValue - the value you are searching for

Return Parameter

List of CSRType records

Retrieve a List of Active Service Domains
 

Method

List<RecordType> getServiceDomainList( long connectId ) throws WSCsrFault;

Input Parameters

connectId - A valid connect Id obtained by calling WSLoginService.connect

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Service Domains the Current User Can Access

The connectId parameter has the information about the current user.

The server throws an exception in case of an empty return list.

Method

List<RecordType> getServiceDomainForUserList( long connectId ) throws WSCsrFault;

Input Parameters

connectId - A valid connect Id obtained by calling WSLoginService.connect

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Customers

The server throws an exception in case of an empty return list.

Method

List<RecordType> getCustomerList(long connectId) throws WSCsrFault;

Input Parameters

connectId - A valid connect Id obtained by calling WSLoginService.connect

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Projects for a Specific Service Domain

The server throws an exception in case of an invalid service domain parameter.

The server throws an exception in case of an empty return list.

Method

List<RecordType> getProjectList(long connectId, String sdcd) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Users for a Specific Service Domain

The server throws an exception in case of an invalid service domain parameter.

The server throws an exception in case of an empty return list.

Method

List<RecordType> getOpenedByList(long connectId, String sdcd) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Customer Priorities for a Specific Service Domain

The server throws an exception in case of an invalid service domain Parameter.

The server throws an exception in case of an empty return list.

The server throws an exception if Customer Priority is disabled at the service domain level.

Method

List<RecordType> getCustomerPriorityList(long connectId, String sdcd) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Applications for a Specific Service Domain

The server throws an exception in case of an invalid service domain parameter or an empty return list.

This method verifies any possible restricted access to applications for current user.

Method

List<RecordType> getApplicationList(long connectId, String sdcd) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Environments for a Specific Service Domain and Application

The server throws an exception in case of an invalid service domain or Application Code parameters or in case of an empty return list.

The server throws an exception if Application Environment is disabled at the service domain level.

Method

List<RecordType> getEnvironmentList(long connectId, String sdcd, String applicationCode) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
ApplicationCode - Application Code

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active CSR Types for a Specific Service Domain

The server throws an exception in case of an invalid service domain parameter or an empty return list.

Method

List<RecordType> getCSRTypeList(long connectId, String sdcd) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Priorities for a Specific Service Domain

The server throws an exception in case of an invalid service domain parameter or an empty return list.

Method

List<RecordType> getPriorityList(long connectId, String sdcd) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Users for a Queue in a Specific Service Domain

The server throws an exception in case of an invalid service domain or Queue Id parameters or in case of an empty return list.

Method

List<RecordType> getAssignedToList(long connectId, String sdcd, String queueId) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
queueId - Queue Id

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Workflows for an Application Code and a CSR

Type in a specific service domain.

The server throws an exception in case of an invalid service domain, Application Code or CSR Type Code parameters.

The server throws an exception in case of an empty return list.

Method

List<RecordType> getWorkflowList(long connectId, String sdcd, String applicationCode, String typeCode) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
applicationCode - Application Code
•
typeCode - CSR Type Code

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Status Records for a Workflow Id in a Specific Service Domain

If Workflow Id is a null value, a list of all Status records for the passed CSR Type is returned.

The server throws an exception in case of an invalid service domain, CSR Type Code, or Workflow Id parameters.

The server throws an exception in case of an empty return list.

Method

List<RecordType> getStatusList(long connectId, String sdcd, String typeCode, String workflowId) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
typeCode - CSR Type Code
•
workflowId - Workflow Id

Return Parameter

List of values. For more information, see RecordType Bean .

Retrieve a List of Active Queue Assignments for a Specific Service Domain.

If workflowId and statusCode are also passed, the method returns selected Queue Assignments on the particular Status of the passed Workflow.

If workflowId and statusCode are null values, the method returns all the Queue Assignments for the passwd service domain.

The server throws an exception in case of an invalid service domain, Workflow Id or Status Code parameters.

The server throws an exception in case of an empty return list.

Method

List<RecordType> getQueueList(long connectId, String sdcd, String workflowId, StatusCode) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
workflowId - Workflow Id
•
statusCode - Status Code

Return Parameter

List of values. For more information, see RecordType Bean .

Add attachments to an Existing CSR in Stat

The server throws an exception in the following circumstances:

•
In the case of an invalid service domain, or CSR Id parameters.
•
If another user has the lock on the CSR.
•
If the user has restrictions to the Application.
•
If the CSR is in a Closed Status and user does not have proper rights.
•
If the CSR is assigned to another user and the current user does not have proper override rights.
•
If the user does not have proper right to add Attachments.
•
If the attachment list is empty.

Before updating the CSR, a row is inserted into CSR_LOCK_STATUS and is removed after the update.

CSR History records are inserted for added attachments.

Method

void addCSRAttachments(long connectId, String sdcd, long csrId, List<AttachmentType> attachments) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id
•
attachments - List of attachments. For more information, see AttachmentType Bean .
Delete attachments from an Existing CSR in Stat.

File Ids may be retrieved by calling the retreiveCSRAttachments method.

The server throws an exception in the following circumstances:

•
In the case of an invalid service domain, or CSR Id parameters.
•
If another user has the lock on the CSR.
•
If the user has restrictions to the Application.
•
If the CSR is in a Closed Status and user does not have proper rights.
•
If the CSR is assigned to another user and the current user does not have proper override rights.
•
If the user does not have proper right to delete Attachments.
•
If the attachment list is empty.

Before updating the CSR, a row is inserted into CSR_LOCK_STATUS and is removed after the update.

CSR History records are inserted for deleted attachments.

Method

void deleteCSRAttachments(long connectId, String sdcd, long csrId, List<Long> fileIds) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id
•
fields - List of file Ids for attachments.
Retrieve a List of Attachments in a CSR

If there are no attachments in the CSR, a null value is returned. For more information, see AttachmentType Bean .

Method

List<AttachmentType> retrieveCSRAttachments(long connectId, String sdcd, long csrId) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id

Return Parameter

A list of attachments for the csr is returned. For a definition of AttachmentType refer to Class Definitions, part 2.

Retrieve any possible CSR Template Values for the Current User

If there are no CSR Template values, a null Object is returned.

Method

CSRType getCSRTemplateValues(long connectId, String sdcd) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id

Return Parameter

A csr bean representing the retrieved csr is returned. For more information, see CSRType Bean .

Retrieve any Possible Description Template for a Specific Application Code

If there are no Templates present, a null String is returned.

Method

String getApplicationDescriptionTemplate(long connectId, String sdcd, String code) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
code - Application Code

Return Parameter

A string of template is returned.

Retrieve any Possible Resolution Template for a Specific Application Code.

If there are no Templates present, a null String is returned.

Method

String getApplicationResolutionTemplate(long connectId, String sdcd, String code) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
code - Application Code

Return Parameter

A string of template is returned.

Retrieves any Possible Description Template for a Specific CSR Type Code

If there are no Templates present, a null String is returned.

Method

String getCSRTypeDescriptionTemplate(long connectId, String sdcd, String code) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
code - Application Code

Return Parameter

A string of template is returned.

Retrieve any Possible Resolution Template for a Specific CSR Type Code

If there are no Templates present, a null String will be returned.

Method

String getCSRTypeResolutionTemplate(long connectId, String sdcd, String code) throws WSCsrFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
code - Application Code

Return Parameter

A string of Resolution template is returned.

Add or Update a Log on a CSR
 

Method

List<CSRLogType> updateCSRLogs(long connectId, String sdcd, long csrId, CSRLogType detailLog)

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id
NOTE: This method is called for adding a new CSRlogs and updating an existing CSRlog. When adding a new CSRlog, logSequence of the CSRLogType record is zero. When updating an existing CSRlog, logSequence of the CSRLogType record is not zero. For more information, see CSRLogType Bean .
Retrieve the Logs for a CSR
 

Method

List<CSRLogType>retrieveCSRLogs(connectId, sdcd, csrId)

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id

Return Parameter

List of CSR logs

Retrieve a Log record by sequence ID for a CSR
 

Method

List<CSRLogType>retrieveCSRLog(connectId, sdcd, csrId)

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id
•
seqId - sequence Id

Return Parameter

A single CSR log record

Retrieve a List of CSR Log Topics for a Service Domain
 

Method

List<string>retrieveLogTopicList(connectId, sdcd)

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain

Return Parameter

List of CSR log topics for a service domain

Retrieve the Tasks (including times) for a CSR
 

Method

List<CSRTaskType>retrieveCSRTasks(connectId, sdcd, csrId)

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id

Return Parameter

List of CSR tasks and times. For more information, see CSRTaskType Bean .

Add or Update a Task on a CSR
 

Method

void updateCSRTasks(long connectId, String sdcd, long csrId, CSRTaskType taskType)

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id

Return Parameter
NOTE: This method is called for adding a new task and updating an existing task. When adding a new task, activitySeq of the CSRTaskType record is zero. When updating an existing task, activitySeq of the CSRTaskType record is not zero. The list of tasks should always be retrieved first before making any changes to the task or time records. CSRTimeType records have state field with the following values: Zero means unmodified, one means new, three means modified, 4 means deleted. For more information, see CSRType Bean .
Retrieve the list of Status available for Transfer for a CSR
 

Method

CSRWorkflowType retrieveWorkflowStatusList(connectId, sdcd, csrId)

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId – CSR Id

Return Parameter

List of available status based on the current state of the workflow in the CSR. The actual list can be accessed by calling the getTargetStatuses () method of CSRWorkflowType bean. For more information, see CSRType Bean .

 
Transfer the Status in Workflow
 

Method

void transferToStatus(connectId, sdcd, csrId, overrideComment, resolution, workflow, targetStatus)

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId – CSR Id
•
overrideComment – required comment in case of an override transfer
•
resoluiton – required resolution if needed
•
CSRWorkflowType – current workflow in the CSR
•
CSRWorkflowStatusType – target status that the workflow is being transferred to

Return Parameter
NOTE: If status does not need Queue and User, pass the status (CSRWorkflowStatusType) without any Queues. If status needs a Queue and User, add the target Queue to the status, and pass the status. In all cases, if you are overriding the transfer, pass a comment. For more information, see CSRWorkflowType Bean, CSRWorkflowStatusType Bean, CSRWorkflowStatusQueueType Bean, and CSRWorkflowStatusQueueMemberType Bean .

Approval Service

The URL for the wsdl file of this service is located at: http://hostname:port/stat/WSApprovalService?wsdl

Retrieve a List of all Transfer Approvals for CSRs that are Not Closed
 

Method

List<TransferApprovalType> getTransferApprovalList(long connectId) throws WSApprovalFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id

Return Parameter

List of all Transfer Approvals for CSRs that are not closed

Retrieve a List of all Transfer Approvals for a CSR
 

Method

List<TransferApprovalType> getTransferApprovalForCsrList(long connectId, String sdcd, long csrId) throws WSApprovalFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id

Return Parameter

List of all Transfer Approvals for a CSR

 
Retrieve a List of all Transfer Approvals for a CSR with Specific Status Code From to Status Code To
 

Method

List<TransferApprovalType> getTransferApprovalForCsrByStatusList(long connectId, String sdcd, long csrId, String statusCodeFrom, String statusCodeTo) throws WSApprovalFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id
•
statusCodeFrom - CSR status code
•
statusCodeTo - CSR status code

Return Parameter

List of all Transfer Approvals for a CSR with specific status code From to status code To

Change the Status of a Single Transfer Approval Record
 
* 
NOTE: Valid values for TransferApprovalType.status are Approved, Rejected, Pending.
Valid values for TransferApprovalType.approverType are Class, User, Queue.

Method

void submitTransferApproval(long connectId, TransferApprovalType approval) throws WSApprovalFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
TransferApprovalType approval - Transfer approval type
Retrieve a List of all Migration Approvals for CSRs that are Not Closed
 

Method

List<MigrationApprovalType> getMigrationApprovalList(long connectId) throws WSApprovalFault;

Input Parameters

connectId - A valid connect Id obtained by calling WSLoginService.connect

Return Parameter

List of all Migration Approvals for CSRs that are not closed

Retrieve a List of all Migration Approvals for a CSR
 

Method

List<MigrationApprovalType> getMigrationApprovalForCsrList(long connectId, String sdcd, long csrId) throws WSApprovalFault

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id

Return Parameter

List of all Migration Approvals for a CSR

Change the Status of a Single Migration Approval Record
 
* 
NOTE: Valid values for MigrationApprovalType.status are Approved, Rejected, Pending.

Method

void submitMigrationApproval(long connectId, MigrationApprovalType approval) throws WSApprovalFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
MigrationApprovalType approval - Transfer approval type
Retrieve a List of all Patch Approvals for CSRs that are Not Closed
 

Method

List<PatchApprovalType> getPatchApprovalList(long connectId) throws WSApprovalFault;

Input Parameters

connectId - A valid connect Id obtained by calling WSLoginService.connect

Return Parameter

List of all Patch Approvals for CSRs that are not closed

Retrieve a List of all Patch Approvals for a CSR
 

Method

List<PatchApprovalType> getPatchApprovalForCsrList(long connectId, String sdcd, long csrId) throws WSApprovalFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
sdcd - service domain
•
csrId - CSR Id

Return Parameter

List of all Patch Approvals for a CSR

Change the Status of a Single Patch Approval Record
 
* 
NOTE: Valid values for PatchApprovalType.status are Approved, Rejected, Pending.

Method

public void submitPatchApproval(long connectId, PatchApprovalType approval) throws WSApprovalFault;

Input Parameters
•
connectId - A valid connect Id obtained by calling WSLoginService.connect
•
PatchApprovalType approval - Transfer approval type

Class Definitions

RecordType Bean
public class RecordType {
protected String code;
protected String description;
}
Documentos relacionados

The document was helpful.

Selecione a classificação

I easily found the information I needed.

Selecione a classificação