Data Connector Categories

Manage your Data Connector Categories.

What is a Data Connector Category?

Use Data Connector Categories to organize your Data Connectors and their Resources. Organizing your Data Connectors into Categories makes it easier to search for a Data Connector based on its assigned Category. Assign multiple Data Connector Categories to a Data Connector as necessary. For example, assign a Data Connector that connects to an e-retailer's API to the "Third-Party APIs" and "E-Retailers" Data Connector Categories.

"Categories" tab on the "Data Connectors" page displays all Data Connector Categories

Data Connector Categories can be in active or inactive status. Following is a description of each status:

• Active: Active Data Connector Categories can have Data Connectors or Resources assigned to them.

• Inactive: Inactive Data Connector Categories cannot have Data Connectors or Resources assigned to them.

Permissions

ProcessMaker Platform has multiple Category types for different types of assets. Each Category type is distinct from the others and can only be used for its type of ProcessMaker Platform asset. Following is a description of each Category type:

• Project Categories: Organize your Projects.

• Process Categories: Organize your Processes.

• PM Block Categories: Organize your PM Blocks.

• Script Categories: Organize your Scripts.

• Screen Categories: Organize your Screens.

• Data Connector Categories: Organize your Data Connectors.

• Decision Table Categories: Organize your Decision Tables.

View Data Connector Categories

Permissions

Your user account or group membership must have the following permissions to view Data Connector Categories unless your user account has the Make this user a Super Admin setting selected:

• Data Connectors: View Data Connector Categories

• Data Connectors: View Data Connectors

See the Data Connectors permissions or ask your Administrator for assistance.

Follow these steps to view Data Connector Categories:

1. Log on to ProcessMaker Platform.

2. Click the Designer option from the top menu. The Designer Welcome Screen displays.

3. Click the Data Connectors iconfrom the left sidebar. The Data Connectors tab displays all Data Connectors in the Data Connectors page.
4. Click the Categories tab. The Data Connector Categories display.

"Categories" tab in the "Data Connectors" page

The Categories tab displays the following information in tabular format about Data Connector Categories:

• Name: The Name column displays the name of the Data Connector Category. The Data Connector Category named Generated is the default Category. Data Connectors that are automatically created when a Collection is created are assigned the Generated Category by default.

• Status: The Status column displays the status of the Data Connector Category. Below is a description of each status:

  • Active: Active Data Connector Categories can have Data Connectors assigned to them. The Data Connector Category named Generated is active by default.

  • Inactive: Inactive Data Connector Categories cannot have Data Connectors assigned to them.

• # Data Connectors: The # Data Connectors column displays how many Data Connectors in your organization have been assigned to that Data Connector Category.

• Modified: The Modified column displays the date and time the Data Connector Category was last modified. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.

• Created: The Created column displays the date and time the Data Connector Category was created. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.

No Data Connector Categories?

If no Data Connector Categories exist, the following message displays: No Results.

Search Data Connector Categories

Use the Search setting to filter Data Connector Categories by their names.

Display Information the Way You Want It

​Control how tabular information displays, including how to sort columns or how many items display per page.

Create a New Data Connector Category

Permissions

Your user account or group membership must have the following permissions to create a new Data Connector Category unless your user account has the Make this user a Super Admin setting selected:

• Data Connectors: Create Data Connector Categories

• Data Connectors: View Data Connector Categories

• Data Connectors: View Data Connectors

See the Data Connectors permissions or ask your Administrator for assistance.

Follow these steps to create a new Data Connector Category:

1. View your Data Connector Categories.

2. Click the +Category button. The Create Category screen displays.
3. In the Category Name setting, enter the name of the new Data Connector Category. The Data Connector Category name must be unique from all other Data Connector Category names in your organization and can only use apostrophe characters (') and spaces. This is a required setting.

4. From the Status drop-down menu, select one of the following options for the Data Connector Category's status:

   • Active: Active Data Connector Categories can have Data Connectors assigned to them.

   • Inactive: Inactive Data Connector Categories cannot have Data Connectors assigned to them.

   This is a required setting.

5. Click Save.

Search for a Data Connector Category

Permissions

Your user account or group membership must have the following permissions to search Data Connector Categories unless your user account has the Make this user a Super Admin setting selected:

• Data Connectors: View Data Connector Categories

• Data Connectors: View Data Connectors

See the Data Connectors permissions or ask your Administrator for assistance.

Follow these steps to search for a Data Connector Category:

1. View your Data Connector Categories.

2. Enter in the Search setting the text to filter Data Connector Categories by name.

As you enter text into the Search setting, Data Connector Categories display that match your entered text.

If there are no search results, the following message displays: No Results.

Edit a Data Connector Category

Permissions

Your user account or group membership must have the following permissions to edit a Data Connector Category unless your user account has the Make this user a Super Admin setting selected:

• Data Connectors: Edit Data Connector Categories

• Data Connectors: View Data Connector Categories

• Data Connectors: View Data Connectors

See the Data Connectors permissions or ask your Administrator for assistance.

Follow these steps to edit a Data Connector Category:

1. View your Data Connector Categories.

2. Click the menu, and then select the Edit Category option for the Data Connector Category to edit. The Edit Category screen displays.
3. Edit the following information about the Data Connector Category as necessary:

   • In the Category Name setting, edit the name of the new Data Connector Category. The Data Connector Category name must be unique from all other Data Connector Category names in your organization and can only use apostrophe characters (') and spaces. This is a required setting.

   • From the Status drop-down menu, select one of the following options for the Data Connector Category's status:

     • Active: Active Data Connector Categories can have Data Connectors assigned to them.

     • Inactive: Inactive Data Connector Categories cannot have Data Connectors assigned to them.

     This is a required setting.

4. Click Save.

Delete a Data Connector Category

Permissions

Your user account or group membership must have the following permissions to delete a Data Connector Category unless your user account has the Make this user a Super Admin setting selected:

• Data Connectors: Delete Data Connector Categories

• Data Connectors: View Data Connector Categories

• Data Connectors: View Data Connectors

See the Data Connectors permissions or ask your Administrator for assistance.

To delete a Data Connector Category, no Data Connectors can be assigned to it. If any Data Connectors are assigned to the Data Connector Category, its Delete icondoes not display. Reassign those Data Connectors to another Data Connector Category.

Deleting a Data Connector Category cannot be undone.

Follow these steps to delete a Data Connector Category:

1. View your Data Connector Categories.

2. Click the menu, and then select the Delete Category option for the Data Connector Category to delete. A message displays to confirm deletion of the Data Connector Category.
3. Click Confirm. The following message displays: The category was deleted.