Skip to main content

Navigate your integration

Tom Santiago
  • Updated

When you open an integration, you can use the tools available from the following tabs to track the status of flows in your integration.

Contents

Settings tab

You can access this JSON settings resource from many places throughout the user interface. Use this field to create parameter logic for the integration. You can incorporate the integration settings you define here during runtime for all flows running within the integration. Click Launch form builder to create a custom form to expose and manage your settings fields, so that less technical users do not need to work with raw JSON.

Flows tab

The Flows tab allows you to monitor the status of all flows within your integration. 

flowsTab.png
  1. Name: This column lists the name of each flow in the integration. Click the column label to sort the flows alphabetically.
  2. Last updated: the time at which the flow was last modified.
  3. Last run: the time at which the flow was last run.
  4. Mapping: click the mappings icon to view and modify the flow’s import mappings.
  5. Schedule: click the calendar icon to set a schedule for the flow.
  6. Run: click the run to run the flow.
  7. Off/On: Click the toggle button to turn a flow on or off.
  8. Actions: Click the overflow (...) menu for a flow to access the following options:
    • Edit flow: Opens the flow in Flow Builder.
    • View audit log: Opens an audit log that lists all changes made to the flow.
    • Used by: Opens a list of all integrations throughout the integrator.io environment that use this flow.
    • Download flow: Downloads a ZIP file that contains the flow’s settings.
    • Clone flow: Creates an identical duplicate of the flow for use in another integration.
    • Detach flow: Removes the flow from the integration and relocates it to the Standalone flows integration tile. 
    • Delete flow: Deletes the flow from the integrator.io environment.

Dashboard tab

You can evaluate the status of one or more flows run within the past 30 days using the Dashboard tab.

Open an integration tile from the home page and click Dashboard.

dashboard.png
  1. Retry: You can run a flow again if it fails or if there were errors that you had to address. The drop-down menu displays the following options:
    • All jobs: Retry all of the jobs in the dashboard.
    • Select [#] jobs: Select a specific number of jobs to retry. Check the box on to the left of any job to select it.
  2. Resolve: After you’ve addressed any errors in a flow, you can mark the error(s) as resolved. You would usually use this if you solved the error outside of the integration or if you received duplicate errors and want to resolve them in bulk to clear them from your dashboard. Once you have marked a record error as resolved, you will no longer be able to retry that record. Thus, if there is a particular error that you don’t want anyone to be able to retry, you would mark it as resolved. Once an error is resolved, it will no longer be included in your error count, but you can still see the error to enable you to track post errors. The drop-down menu displays the following options:
    • All jobs: You can mark all jobs as resolved.
    • Select [#] jobs: You can select a specific number to mark as resolved. To select certain jobs, on the left of the job, check the box.
  3. Select flow: Use this drop-down menu to filter the dashboard results by flow. Only the flows within this integration display in this menu.
  4. Select status: You can filter the flows in the dashboard to only display jobs of a specific status type. Choose one of the following options to filter your results:
    • Contains error: Jobs that have errors.
    • Contains resolved: Jobs where the errors have been resolved.
    • In progress: Flows that are in progress.
    • Retrying: Jobs that are being retried.
    • Waiting in Queue: All the jobs that you have queued.
    • Canceled: All canceled jobs.
    • Completed: All complete jobs.
    • Failed: Jobs that have failed to run.
  5. Select range: You can filter the dashboard to only display jobs that ran during a specific period of time. Select one of the following options:
    • Today: Jobs from today.
    • Yesterday: Jobs from yesterday.
    • Last 15 days: Jobs from the last 15 days.
    • Last 30 days: Jobs from the last 30 days.
    • Custom range: Create a custom date range for the jobs you want to see.
  6. Hide empty jobs: You can hide jobs that do not have any records.

Status column

When a flow runs, integrator.io creates a set of jobs to complete the tasks configured at each step of the flow. integrator.io stacks these jobs in a queue for processing until the flow is complete. If a flow is scheduled to run while one or more of its connections are still in use by another active flow, the Dashboard tab displays the message, Waiting in queue next to the flow awaiting processing. integrator.io finishes the active flow before moving on to the next flow in the queue.

When flows are processing, the Status column on the Dashboard tab displays an In progress message for the flow currently in processing. All other scheduled flows show a status of Waiting in queue. You can click the message in the Status column to open the Queued jobs window. From here you can view all flows and associated messages currently processing (or queued to run) and cancel jobs in progress.

Note: Permissions to cancel a job are based on the connection. You can cancel a job in queue or in progress if you are an account owner, an administrator, or a user with manager permissions for the connections the flow is using.

Actions column

The Actions column allows you to take actions on your flow. Click the Actions overflow (...) menu for a flow to select one of the following options.

  • Edit flow: select this option to open the flow in Flow Builder.
  • Run flow: After you have addressed any errors, use this button to run your flow.
  • Retry all: Retry all failed records.
  • Mark resolved: If the job had errors, you can mark them as resolved.
  • Download diagnostics: Downloads a zip of the flow and a list of errors. You and share it with others in your organization or with Celigo support to resolve an issue. The zip can also be used to install the flow in another integrator.io account.

Errors column

When there’s an error in your flow, the number of errors displays in the Errors column. Hover your mouse on the error number, and click View to review a list errors the job encountered.

viewErrors.png

For more information on resolving errors, see Handle errors in integrator.io.

Connections tab

All of the connections you’ve created for your flow are listed in the Connections tab. You can use the connections dashboard to edit a connection or debug errors caused by connectivity issues.

Open an integration tile from the home page and click Connections to access the connections dashboard.

ConnectionsTabunderstand.png
  1. Name: The name of each connection you’ve made for this flow, as you provided when you created  or edited each one.
  2. Status: See if your connection is on or offline.
  3. Type: The name of the application or system that you connected to.
  4. API: The API endpoint.
  5. Last updated: The last time the connection was modified.
  6. Queue size: The number of records in your connector’s queue. Note that, if the number continues to grow, then the data is moving into the connector faster than the destination app can receive them.
  7. Actions: The down arrows under Actions display the following options:
    • Edit connection: You can edit the connection. Change the name of the connection or reauthenticate if the connection is offline.
    • Debug Connection: Debug your connection or flow. Find out more about how to debug your flow.
    • View audit log: Track activity on your flow.
    • Used by: See all integrations currently using this connection.
    • Refresh metadata: Refresh the metadata for the connection if there were changes to your domain (like a new base URL).

Audit log tab

You can see specific kinds of activity in your flows. Find out the last time a record was updated or what changes a specific user made to a flow.

Open an integration tile from the home page and click Audit Log to access the audit log dashboard.

AuditLog_2.png
  1. Select resource type: This filter allows you to view changes made to specific resources:
    • Integration: Changes made in an integration.
    • Flow: Changes made in a flow.
    • Export: Changes made to an export record.
    • Import: Changes made to the import record.
    • Connection: Changes made to the connection.
    • Stack: Changes made in a stack.
    • Async helper: In the event that certain data is unavailable, an async helper has the app’s API ping integrator.io when the info is available. The flow will be paused until the data is received.
    • File definitions: Changes to the rules that define how integrator.io should parse or generate EDI or fixed width files.
  2. Select user: Filter results by a specific user.
  3. Select source: Filter results by a specific source:
    • UI: Changes were made from the user interface.
    • API: Changes were made in the API.
    • Stack: Changes were made from the stack
    • System: Any change made to a resource by integrator.io backend logic or a system process.

      Note: Filters are not applicable for a download. You can download up to 1,000 records from the past year.

  4. Action: This column displays the action that was taken.
  5. Field: This column displays the field in which the action took place.
  6. Old value: This column displays the field value before the change.
  7. New value: This column displays the field value after the change.

Users tab

Use this tab to view all users that have access to this integration along with their assigned permission levels. 

Users.png
  1. Name: The user’s name.
  2. Email: The user’s email address.
  3. Access level: The user’s permission level as assigned by an account owner or an administrator.
  4. Status: The status of the invitation sent to the user by an account owner or an administrator.

Admin tab

You can modify the name and description of the integration from this tab. You can also add a Readme file for users to reference when running flows within the integration.

Aliases tab

Use the Aliases tab to see all aliases that have been defined for an integration's flows, connections, imports, and exports. You can create a new alias or use the Actions menu to edit, copy, delete, or view details for an alias.

For more information on creating an alias, see Create and manage aliases.

Revisions tab

You can manage changes to an integrations using the Revisions tab.

Revisions.png
  1. Description: A brief description of a revision that perhaps includes changes made, the reason for the changes, or any important details.
  2. Date created: The date when the revision is created. Date format: DD-MM-YYYY hh:mm:ss
  3. Type: The type of revision created, such as snapshot, pull, or revert.
  4. Status: The status of the revision.
  5. User: The person who performs the revision.
  6. Actions: Actions that you can perform on a revision. The actions vary depending on the type of revision.

For more information on revisions, see Integration Lifecycle Management (ILM) overview and Integration Lifecycle Management (ILM) revisions guide.

Check out our community forum for more info on Flow Builder. You can ask questions and post tips.

Related articles

Comments

0 comments

Please sign in to leave a comment.