PowerSteering – Partner operation
The PowerSteering – Partner operation defines how to interact with your PowerSteering account and represents a specific action (Get and Query) to perform against a specific PowerSteering resource.
Create a separate operation component for each action and object combination that your integration requires.
The PowerSteering – Partner operation uses the XML format and supports the following actions:
-
Inbound: Get, Query
-
Outbound: None
Options tab
Click Import Operation, then use the Import wizard to select the object to integrate. The following table describes the fields for each action type:
Object - Displays the object type that you selected in the Import Operation wizard.
Tracking Direction - Select the document tracking direction for the operation, either Input Documents or Output Documents. This setting enables you to choose which document appears in Process Reporting. Start steps always track output documents regardless of your selection.
If the tracking direction is read-only, the feature to change the direction is either unavailable or the developer set the configuration to read-only. The default value you see shows you which document appears in Process Reporting.
Response Profile - Select or add an XML profile component that represents the structure received by the connector.
Return Application Error Responses - This setting controls whether an application error prevents an operation from completing:
- If you clear the setting, the process stops and reports the error on the Process Reporting page.
- If you select the setting, processing continues and passes the error response to the next component processed as the connection output.
Options tab, Get action
Get is an inbound action to retrieve data from PowerSteering. You must specify the ID parameter to retrieve data in the configuration of the connector step. The returned data can be a single item or a list, depending on the operation.
| Object | Description | Parameters (ID) |
|---|---|---|
| Project | Returns a project by its ID. | Project ID |
| Project Children | Returns the secondary work items for the specified project. | Project ID |
| Project Children ID | Returns a list of secondary ID, name, and type for the specified project. | Project ID |
| Organization | Find an organization by its ID. | Organization ID |
| Organizations | Returns a list of root organizations. | <Empty> |
| Discussion | Finds a discussion item instance by its ID. | Discussion item ID |
| Discussions | Finds discussion item instances by their work ID. | Work ID |
| Issue | Finds an issue item instance by its ID. | Issue item ID |
| Issues | Finds issue item instances by their work ID. | Work ID |
| Issue Item Thread | Finds an issue item's thread by its discussion ID. | Discussion ID |
| Timesheet | Find a timesheet entry by its ID. | Timesheet entry ID |
| User | Finds a user by their ID. | User ID |
| Current User | Returns the current user. | <Empty> |
| Active Users | Finds all active users. | <Empty> |
| Online Users | Finds all online users. | <Empty> |
| Person Rates | Returns a rate list for the specified person. | User ID |
| All Rate Tables | Returns all rate tables. | <Empty> |
| Rate Codes | Returns a rate code list. | <Empty> |
| Rate Table By ID | Returns a specified rate table. | Rate table ID |
| Rate List by Rate Table | Returns a rate list for the specified rate table. | Rate table ID |
| Action Item By ID | Finds an action item by its ID. | Action Item ID |
| Action Items By Work ID | Finds action items by their work ID. | Work ID |
| Costs by Project ID | Returns all costs (actual + estimated) by project ID. | Project ID |
| Actual costs by Project ID | Returns actual costs by project ID. | Project ID |
| Estimated costs by Project ID | Returns estimated costs by project ID. | Project ID |
| Template | Finds a template instance by its ID. | Template ID |
| Template By Name | Finds a template instance by its name. | Template name |
| Templates | Lists template instances. | <Empty> |
| Portfolio | Looks for the specified portfolio by portfolio ID. | Portfolio ID |
| Portfolio Work Items | Returns a list of work items in the specified portfolio. | Project ID |
| Group Members By Group ID | Finds a group by its ID and returns the group’s members. | Group ID |
| Group | Finds a group instance by its ID. | Group ID |
| Groups | Provides a list of all user groups. | <Empty> |
| Task | Finds a task instance by its ID. | Task ID |
| Tasks By Project ID | Finds tasks instances by their parent project ID. | Parent project ID |
| Metric | Returns metric by ID. | Metric instance ID |
| Metric Template | Finds a metric template by ID. | Metric template ID |
| Metric Template By Name | Finds a metric template by its name. | Metric template name |
| Metric Templates | Returns all metric templates. | <Empty> |
| Resource Pool | Finds a resource pool by its ID. | Resource pool ID |
| Resource Pool Managers | Finds all managers for the specified resource pool. | Resource pool ID |
| Resource Pool Members | Finds all members for the specified resource pool. | Resource pool ID |
| Resource Pools | Finds all resource pools. | <Empty> |
| Resource Assignment | Finds a resource assignment by master ID. | Resource assignment ID |
| Events | Finds all events. | <Empty> |
| Role | Returns a role instance by its ID. | Role ID |
| Roles | Returns all roles. | <Empty> |
| Reports | Find information about all reports. | <Empty> |
| Report Status | Requests the status of a running report. | The report run ID. |
Options tab, Query action
Query is an inbound action to retrieve a list of data filtered by specific fields or date ranges.
| Object | Description | Parameters |
|---|---|---|
| Projects | Returns a list of projects with the specified name. If you do not specify a name, it returns all root projects. | name: Project name |
| Project Download | Returns a paged list of projects changed in a specific period. |
|
| Project Download All Works | Returns a paged list of works changed in a specific period. Includes works of all object types, including projects. |
|
| Download Organizations | Returns a paged list of organizations changed in a specific period. |
|
| Timesheets | Finds a user's timesheets for a week. |
|
| Users | Finds all users with the specified name. | usersName: User name |
| Download Users | Returns a paged list of users changed in a specific period. |
|
| Rates History | Returns historical rates of a specified rate. |
|
| Group Members | Finds a group by its name and returns the group’s members. | name: Group name |
| Tasks | Finds task instances by their name. | name: Task name |
| Download Tasks | Returns a paged list of tasks changed in a specific period. |
|
| Metric Data | Returns measurements data from metric instance by ID. |
|
| Metrics | Returns all metrics associated with a work item ID and metric template. |
|
| Resource Allocations | Gets a resource assigned to a specific project or a task for a specific period. |
|
| Resource Demands | Gets resource demanded but assigned on a project or task for a specific period. |
|
| Run Report | Runs a specified report. |
|
Archiving tab
See the topic Connector operation’s Archiving tab for more information.
Tracking tab
See the topic Connector operation’s Tracking tab for more information.
Caching tab
See the topic Connector operation’s Caching tab for more information.
