AgilePoint NX (Preview)

AgilePoint is a platform that opens up two-way communication to provide native support for flows within larger, more scalable cross-organizational automations. Now you can include important daily tasks performed within Microsoft ecosystem in the big picture processes housed in AgilePoint.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Name AgilePoint Support Team
URL https://helpdesk.agilepoint.com
Email helpdesk@agilepoint.com
Connector Metadata
Publisher AgilePoint Inc
Website https://agilepoint.com/
Privacy policy https://agilepoint.com/privacy-statement/
Categories Productivity;Business Management

The AgilePoint NX Power Automate connector is a bi-directional integration that gives users of both platforms the flexibility to:

  • Execute AgilePoint processes and perform various business process management actions from Power Automate flow or Logic Apps.
  • Launch Power Automate flows from AgilePoint.

With this new connector, AgilePoint customers can utilize Power Automate�s large ecosystem of connectors and triggers to enable many cloud events (including Internet of Things and Line of Business events) to interact with AgilePoint without code.

At the same time, Power Automate users have access to a more native support for AgilePoint NX�s enterprise-grade low-code business process management capabilities within the Power Automate flow designer. The partnership delivers a strong synergy and presents a massive opportunity for customers.

Prerequisites

AgilePoint NX Connector requires a subscription to AgilePoint NX App Development Platform, which runs in the cloud or in your on-premises system. A free, 30-day trial of AgilePoint NX App Development Platform is available. Ongoing use of AgilePoint NX requires an active subscription.

How to get credentials

If you do not have an active AgilePoint NX subscription, you could sign up for a free, 30-day trial of AgilePoint NX by filling up your information on https://agilepoint.com. You could also get a trial subscription by reaching out to sales@agilepoint.com. Once your trial subscription request has been approved, you would receive an email from AgilePoint which will have instruction on how to complete your trial signup. Please select AgilePoint ID authentication type while signing up for a new subscription which will allow you to specify your desired username and password.

Creating a connection

The connector supports the following authentication types:

Default Required parameters for creating connection. All regions

Default

Applicable: All regions

Required parameters for creating connection.

Name Type Description
Username securestring Enter username (domain\username) for agilepoint nx server.
Password securestring Enter password for agilepoint nx server.
AgilePoint NX Server URL (REST) string Enter agilepoint nx server URL.

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Complete Human Task

Completes the specified human task (manual work item), and changes its status to Completed in the database.

Complete System Task

Completes the specified system activity (automatic work item).

Generate New Guid

Retrieves the UUID generated by AgilePoint Server.

Get Data

Retrieves a process attribute (custom attribute) with the specified process attribute ID and process attribute name.

Get Process Instance

Retrieves information about a specified process instance.

Get Process Models

Retrieves all versions of all process models (process definitions).

Get User

Retrieves the profile information for the specified registered user.

Save Data

Sets a list of process attribute (custom attributes) to the specified values for a specified custom attribute ID.

Start Process Instance

Creates a process instance for a specified process instance ID and parameters.

Complete Human Task

Completes the specified human task (manual work item), and changes its status to Completed in the database.

Parameters

Name Key Required Type Description
Task ID
workItemID True string

Enter work item ID.

Client Data
clientData True string

Enter client data.

Returns

Name Path Type Description
Activity Instance ID
ActivityInstID string

The unique ID for an activity instance.

Auto Start
AutoStart boolean

Specifies whether the process starts immediately after it is created.

Variables
CustomAttributes string

Variables in XML format.

Diagnostic
Diagnostic boolean

Specifies if the process data will be deleted from the database after the process completes.

End Date
EndDate string

The completion date of the delegation.

Entries
Entries integer

Retrieves the relay time of the event.

Error
Error string

Retrieves and sets the error message of the event.

Event ID
EventID string

A unique ID for an event.

Event Name
EventName string

The name of the event.

High Priority
HighPriority boolean

Specifies that a task is marked as high priority.

XML Parameters
ParamsXml string

Retrieves and sets the parameters as XML.

Parent Process Instance ID
ParentProcInstID string

A process instance ID that acts as a parent process instance of the process instance that is intended to create.

Process Model ID
ProcDefID string

The unique ID of the process model.

Process Instance ID
ProcInstID string

The unique ID of a process instance.

Process Instance Name
ProcInstName string

A unique name that is associated with the process instance.

Sender
Sender string

The sender of the event.

Sent Date
SentDate string

The sent date of the event.

Source Task ID
SourceWorkItemID string

An ID that represents the original, or source, task.

Status
Status string

The status of the event.

Tenant ID
TenantID string

The unique ID of the AgilePoint NX tenant.

User ID
UserID string

The unique ID for a user.

Task ID
WorkItemID string

An unique ID that represents a task.

Work Object ID
WorkObjectID string

An ID for an object, such as a document, that is associated with the process instance.

Work Object Information
WorkObjectInfo string

Usually this parameter is used to hold supplemental information about the work object, such as a URL for a document, within the process instance.

Complete System Task

Completes the specified system activity (automatic work item).

Parameters

Name Key Required Type Description
Task ID
WORKITEMID True string

Enter work item ID.

Returns

Name Path Type Description
Activity Instance ID
ActivityInstID string

The unique ID for an activity instance.

Auto Start
AutoStart boolean

Specifies whether the process starts immediately after it is created.

Variables
CustomAttributes array of object

Variables in XML format.

Diagnostic
Diagnostic boolean

Specifies if the process data will be deleted from the database after the process completes.

End Date
EndDate string

The completion date of the delegation.

Entries
Entries integer

Retrieves the relay time of the event.

Error
Error string

Retrieves and sets the error message of the event.

Event ID
EventID string

A unique ID for an event.

Event Name
EventName string

The name of the event.

High Priority
HighPriority boolean

Specifies that a task is marked as high priority.

XML Parameters
ParamsXml string

Retrieves and sets the parameters as XML.

Parent Process Instance ID
ParentProcInstID string

A process instance ID that acts as a parent process instance of the process instance that is intended to create.

Process Model ID
ProcDefID string

The unique ID of the process model.

Process Instance ID
ProcInstID string

The unique ID of a process instance.

Process Instance Name
ProcInstName string

A unique name that is associated with the process instance.

Sender
Sender string

The sender of the event.

Sent Date
SentDate string

The sent date of the event.

Source Task ID
SourceWorkItemID string

An ID that represents the original, or source, task.

Status
Status string

The status of the event.

Tenant ID
TenantID string

The unique ID of the AgilePoint NX tenant.

User ID
UserID string

The unique ID for a user.

Task ID
WorkItemID string

An unique ID that represents a task.

Work Object ID
WorkObjectID string

An ID for an object, such as a document, that is associated with the process instance.

Work Object Information
WorkObjectInfo string

Usually this parameter is used to hold supplemental information about the work object, such as a URL for a document, within the process instance.

Generate New Guid

Retrieves the UUID generated by AgilePoint Server.

Returns

Name Path Type Description
Retrieve UUID Result
GetUUIDResult string

A UUID generated by Agilepoint Server.

Get Data

Retrieves a process attribute (custom attribute) with the specified process attribute ID and process attribute name.

Parameters

Name Key Required Type Description
ID
CUSTOMID True string

Enter custom ID.

Attribute Name
attrName True string

Enter attribute name.

Returns

Get Process Instance

Retrieves information about a specified process instance.

Parameters

Name Key Required Type Description
Process Instance ID
processInstanceID True string

Enter process instance ID.

Returns

Name Path Type Description
App Name
GetProcInstResult.ApplName string

The unique name of the app.

App Display Name
GetProcInstResult.ApplicationDisplayName string

The display name for an AgilePoint NX app.

Completed Date
GetProcInstResult.CompletedDate string

The date and time when the process instance was completed.

Process Model ID
GetProcInstResult.DefID string

The unique ID of the process model.

Process Model Name
GetProcInstResult.DefName string

The display name of the process model.

Due Data
GetProcInstResult.DueDate string

The date that the process instance is expected to be complete.

Last Modified By
GetProcInstResult.LastModifiedBy string

The user who last updated, or modified, the item.

Last Modified Date
GetProcInstResult.LastModifiedDate string

The date and time that the last modification was made to the process instance.

Last Running End Time
GetProcInstResult.LastRunningEndTime string

The date the process instance last stopped running.

Last Running Start Time
GetProcInstResult.LastRunningStartTime string

The date the process instance last started or resumed.

Last Swap Date
GetProcInstResult.LastSwapDate string

The last time the process instance was swapped out to free up resources.

Process Initiator
GetProcInstResult.ProcInitiator string

The user who starts (kicks off) a process.

Process Initiator Location
GetProcInstResult.ProcInitiatorLoc string

The IP address of the user who initiated the process instance.

Process Instance ID
GetProcInstResult.ProcInstID string

The unique ID of a process instance.

Process Instance Name
GetProcInstResult.ProcInstName string

A unique name that is associated with the process instance.

Process Model Display Name
GetProcInstResult.ProcessDefinitionDisplayName string

The name of the process model.

Process Initiator
GetProcInstResult.ProcessInitiator string

The user who starts (kicks off) a process.

Process Initiator Location
GetProcInstResult.ProcessInitiatorLocation string

The IP address of the user who initiated the process instance.

Source Process Instance ID
GetProcInstResult.SourceProcInstID string

The ID of the original, or source, process instance.

Started Date
GetProcInstResult.StartedDate string

The date and time when the process instance was started(kicked off).

Status
GetProcInstResult.Status string

The status of the process instance.

Parent Process Instance ID
GetProcInstResult.SuperProcInstID string

A process instance ID that acts as a parent process instance of the process instance that is intended to create.

Target Process Instance ID
GetProcInstResult.TargetProcInstID string

The ID of the target, or destination, process instance.

Top level Process Instance ID
GetProcInstResult.ToplevelProcInstID string

The ID of the process instance that is the top of the process hierarchy for a process-based app.

Version
GetProcInstResult.Version string

The version number of the process model.

Work Object ID
GetProcInstResult.WorkObjectID string

An ID for an object, such as a document, that is associated with the process instance.

Work Object Information
GetProcInstResult.WorkObjectInfo string

Usually this parameter is used to hold supplemental information about the work object, such as a URL for a document, within the process instance.

Get Process Models

Retrieves all versions of all process models (process definitions).

Returns

Name Path Type Description
GetProcDefsResult
GetProcDefsResult array of object

Result of all versions of all process models (process definitions).

App Name
GetProcDefsResult.ApplName string

The display name for an AgilePoint NX app.

Assembly Name
GetProcDefsResult.AssemblyName string

Gets and sets the full name of the assembly.

Audit Level
GetProcDefsResult.AuditLevel integer

Specifies the amount of process related data that is logged for a process. This property can be set at either the process level or at the individual activity level. This property allows you to control the level of granularity in terms of the amount of process related data that is recorded in the log.

Base Definition ID
GetProcDefsResult.BaseDefID string

The base process model ID with the specified process model name.

Checked Out By
GetProcDefsResult.CheckedOutBy string

The user who last checked out the app.

Checked Out Date
GetProcDefsResult.CheckedOutDate string

The date the app was last checked out.

Class Name
GetProcDefsResult.ClassName string

Gets and sets the class name, including the namespace.

Created By
GetProcDefsResult.CreatedBy string

The user's name who created the process model.

Created Date
GetProcDefsResult.CreatedDate string

The date when the process model was created.

Process Model ID
GetProcDefsResult.DefID string

The unique ID of the process model.

Process Model Name
GetProcDefsResult.DefName string

The display name of the process model.

Description
GetProcDefsResult.Description string

A description of the app.

Diagnostic
GetProcDefsResult.Diagnostic boolean

Specifies if the process data will be deleted from the database after the process is completes.

Document Reference
GetProcDefsResult.DocRef string

Specifies the URL of a document. This is typically used for internal documentation for a process designer.

Business Time
GetProcDefsResult.ExpectedTime.BusinessTime boolean

Specifies whether the system calculates the duration using your business time calendar.

Length
GetProcDefsResult.ExpectedTime.Length string

Specifies the length of time duration.

Value
GetProcDefsResult.ExpectedTime.Unit.Value integer

Value of the unit.

Process Initiated By
GetProcDefsResult.InitiateConstraint integer

Specifies whether the process instance was initiated by an eForm, Event Services, or another process instance.

Maximum Sessions Allowed
GetProcDefsResult.MaximumSessionAllowed integer

Configures the maximum number of sessions for an activity in a process instance. If an activity runs more times than the maximum sessions, the process is suspended.

OnComplete
GetProcDefsResult.OnComplete integer

The action to execute when a process instance completes.

Owner
GetProcDefsResult.Owner string

The user name of the app owner.

Previous Version
GetProcDefsResult.PreVersion string

The previous version number of the app.

Release Date
GetProcDefsResult.ReleaseDate string

Retrieves the date when the app was released.

GetProcDefsResult.Status string

The status of the process model.

Version
GetProcDefsResult.Version string

The version number of the app.

Get User

Retrieves the profile information for the specified registered user.

Parameters

Name Key Required Type Description
Username
userName True string

Enter username in (Domain\Username) format.

Returns

Name Path Type Description
Department
Department string

The user's department name.

Disabled
Disabled boolean

Specifies whether the user is disabled.

Email Address
EMailAddress string

The user's email address.

Full Name
FullName string

The user's full name.

Locale
Locale string

The locale of the client device.

Manager
Manager string

The full name of the user's manager.

Online Contact
OnlineContact string

Retrieves the online contact of the user.

Reference ID
RefID string

The reference ID for the user.

Registered Date
RegisteredDate string

Retrieves the date the user was registered in AgilePoint NX.

Supported Languages
SupportedLanguage string

Retrieves a list of the languages that are supported.

Time Zone
TimeZone string

The user's time zone.

Title
Title string

The user's job title.

User Session Expiration
UALExpirationDate string

The date and time the user session expires.

User Session Never Expires
UALNeverExpires boolean

Specifies whether user's session never expires (i.e., the user has a named license seat).

UserName
UserName string

A qualified user name of the instance.

User Organization Information
UserOrgInfo string

Retrieves information about the user's organization, such as a description.

Work Calendar ID
WorkCalendarID string

The unique ID of the work calendar for the organization.

Save Data

Sets a list of process attribute (custom attributes) to the specified values for a specified custom attribute ID.

Parameters

Name Key Required Type Description
ID
CUSTOMID True string

Enter custom ID.

Name
Name string

Enter attribute name.

Value
Value string

Enter attribute value.

Returns

Start Process Instance

Creates a process instance for a specified process instance ID and parameters.

Parameters

Name Key Required Type Description
Process Definition
ProcessID True string

Select process definition name.

Process Instance ID
ProcessInstID string

Enter process instance ID.

Process Instance Name
ProcInstName True string

Enter process instance name.

Work Object ID
WorkObjID True string

Enter work object ID.

Work Object Information
WorkObjInfo string

Enter object information.

Parent Process Instance ID
SuperProcInstID string

Enter parent process instance ID.

Process Initiator
Initiator True string

Enter process initiator name.

ID
CustomID string

Enter custom ID.

Start Immediately
blnStartImmediately boolean

Select value.

Name
Name string

Enter attribute name.

Value
Value string

Enter attribute value.

Returns

Name Path Type Description
Activity Instance ID
ActivityInstID string

The unique ID for an activity instance.

Auto Start
AutoStart boolean

Specifies whether the process starts immediately after it is created.

Variables
CustomAttributes array of object

Variables in XML format.

Diagnostic
Diagnostic boolean

Specifies if the process data will be deleted from the database after the process completes.

End Date
EndDate string

The completion date of the delegation.

Entries
Entries integer

Retrieves the relay time of the event.

Error
Error string

Retrieves and sets the error message of the event.

Event ID
EventID string

A unique ID for an event.

Event Name
EventName string

The name of the event.

High Priority
HighPriority boolean

Specifies that a task is marked as high priority.

XML Parameters
ParamsXml string

Retrieves and sets the parameters as XML.

Parent Process Instance ID
ParentProcInstID string

A process instance ID that acts as a parent process instance of the process instance that is intended to create.

Process Model ID
ProcDefID string

The unique ID of the process model.

Process Instance ID
ProcInstID string

The unique ID of a process instance.

Process Instance Name
ProcInstName string

A unique name that is associated with the process instance.

Sender
Sender string

The sender of the event.

Sent Date
SentDate string

The sent date of the event.

Source Task ID
SourceWorkItemID string

An ID that represents the original, or source, task.

Status
Status string

The status of the event.

Tenant ID
TenantID string

The unique ID of the AgilePoint NX tenant.

User ID
UserID string

The unique ID for a user.

Task ID
WorkItemID string

An unique ID that represents a task.

Work Object ID
WorkObjectID string

An ID for an object, such as a document, that is associated with the process instance.

Work Object Information
WorkObjectInfo string

Usually this parameter is used to hold supplemental information about the work object, such as a URL for a document, within the process instance.

Triggers

When a process instance is started

Trigger When AgilePoint Process Instance Started.

When a trigger flow process activity is executed

Trigger By AgilePoint Activity.

When a process instance is started

Trigger When AgilePoint Process Instance Started.

Parameters

Name Key Required Type Description
Name
Name True string

Enter webhook name.

Application Filter
TargetApplications string

Name of the Application for Trigger.

Returns

Name Path Type Description
Process Instance ID
Source.ProcInstID string

The unique ID of a process instance.

Process Instance Name
Source.ProcInstName string

A unique name that is associated with the process instance.

Process Initiator
Source.ProcessInitiator string

The user who starts (kicks off) a process.

Process Started Date
Source.StartedDate string

The date when the process instance started.

Process Model Name
Source.DefName string

The display name of the process model.

App Version
Source.Version string

The version number of the app.

Parent Process Instance ID
Source.SuperProcInstID string

A process instance ID that acts as a parent process instance of the process instance that is intended to create.

Work Object ID
Source.WorkObjectID string

An ID for an object, such as a document, that is associated with the process instance.

When a trigger flow process activity is executed

Trigger By AgilePoint Activity.

Parameters

Name Key Required Type Description
Name
Name string

Enter webhook name.

Name
Name string

Enter parameter name.

Type
Value string

Select parameter type.

Returns

Name Path Type Description
Is Asynchronous
needCallback boolean

Specifies whether to wait for the Flow to complete.

Process Instance ID
processInstanceID string

The unique ID of a process instance.

Task ID
workItemID string

An unique ID that represents a task.

Work Object ID
workObjectId string

An ID for an object, such as a document, that is associated with the process instance.

Activity Instance ID
activityInstanceid string

The unique ID for an activity instance.