9
Bizagi BPM Suite User Guide

Bizagi BPM Suite documentation

  • Upload
    lamhanh

  • View
    261

  • Download
    13

Embed Size (px)

Citation preview

Page 1: Bizagi BPM Suite documentation

Bizagi BPM SuiteUser Guide

Page 2: Bizagi BPM Suite documentation

2Copyright © 2002-2016 Bizagi. All rights reserved. 2

Table of Contents

Part I Configuring and using theNY Times connector 3

Page 3: Bizagi BPM Suite documentation

PartIConfiguring and using theNY Times connector

Page 4: Bizagi BPM Suite documentation

4Copyright © 2002-2016 Bizagi. All rights reserved.

Configuring and using the NY Times connector

OverviewThe NY Times connector for Bizagi is available for download at Bizagi Connectors Xchange.

Through this connector, you will be able to connect your Bizagi processes to the New York times

newspaper web site, in order to use its services API.

For more information about this connector's capabilities, visit Bizagi Connectors Xchange.

Before you startIn order to test and use this connector, you will need:

1. Bizagi Studio previously installed.

2. This connector previously installed, via the Connectors Xchange as described at http://

help.bizagi.com/bpmsuite/en/index.html?Connectors_Xchange.htm, or through a manual installation

as described at http://help.bizagi.com/bpmsuite/en/index.html?Connectors_install.htm.

3. An API Key authorized for article search.

Configuring the connectorIn order to configure the connector (i.e its authentication parameters), follow the steps presented at the

Configuration chapter in http://help.bizagi.com/bpmsuite/en/index.html?Connectors_install.htm.

For this configuration, consider the following authentication parameters:

· Authentication method: Custom.

· API_Key: An API Key to for the Article search API to access the New York times newspaper web site,

as requested at https://developer.nytimes.com/signup.

Page 5: Bizagi BPM Suite documentation

5Copyright © 2002-2016 Bizagi. All rights reserved.

Using the connectorThis connector features an available method of the New York Times' API services that allows you to

browse and fetch for articles.

To learn overall how/where to configure the use of a connector, refer to http://help.bizagi.com/

bpmsuite/en/index.html?Connectors_Studio.htm.

When using the connector, ensure you consider the following details for the available method.

Page 6: Bizagi BPM Suite documentation

6Copyright © 2002-2016 Bizagi. All rights reserved.

Search articleThis action allows you to browse for content directly at http://www.nytimes.com/.

To configure its inputs, consider:

· Query: The text you want to filter by, as you would do searching at http://www.nytimes.com/ by

inputting text in its search box.

Page 7: Bizagi BPM Suite documentation

7Copyright © 2002-2016 Bizagi. All rights reserved.

To configure its outputs when getting started and testing, you may map the returned web_url which has

the link to the article on http://www.nytimes.com/.

Map optionally, the snippet attribute which has the title of that article, and the lead_paragraph for a

summary information.

Page 8: Bizagi BPM Suite documentation

8Copyright © 2002-2016 Bizagi. All rights reserved.

For more information about this method's use, refer to the New York Times' official documentation at

https://developer.nytimes.com/.

Page 9: Bizagi BPM Suite documentation