Add Link Actions

Integration Catalog Owners can search for, view and create Link Actions for Company and Marketplace catalog. XTT Link Actions provide a generic, extensible framework for direct, automated communication between external systems (e.g. ERP, QMS, WMS) and TraceLink apps (e.g. Multienterprise Information Network Tower (MINT).

The Link Actions based on their accessibility can be categorized as follows:

  • Company Link Actions – Accessible to all the users for a specific company.
  • Marketplace Link Actions – Accessible to all the users on a specific network.

Add and update Link Actions

  1. Select the Main Menu icon.

  2. Select Integration Catalog.

  3. Select Link Actions in the side menu.

  4. Select Company.

  5. Select the New button.

  6. In the General section, fill in the following information:

    • Link Action Name field – Required. The unique name of the Link Action.

    • Direction drop-down – The direction of the message.

      • Inbound – A Link Action created to receive inbound B2B messages in TraceLink from external systems.

      • Outbound – A Link Action created to send B2B messages from TraceLink to external systems.

    • Link Action Description field – Required. A description explaining what the Link Action does.
  7. Select the Save button.

    The screen refreshes with the saved Company Link Action in the draft state and with the required sections populated.

  8. Select Edit button.

  9. In the General section, fill in the following fields:

    • Link Action Name field – Required. The unique name of the Link Action. This field retrieves the value entered in New Company Link Action screen.
    • Link Action Description field – Required. A description that provides a clear explanation of the purpose and functionality of the Link Action.
    • Link Action Version Description field – Required. A description that clearly explains the purpose and functionality of a specific version of a Link Action.

    • Direction drop-down – The direction of the message. This field retrieves the value entered in New Company Link Action screen.

      • Inbound – A Link Action created to receive inbound B2B messages in TraceLink from external systems.

      • Outbound – A Link Action created to send B2B messages from TraceLink to external systems.

    • Version field – The version number of the Link Action. This field is auto populated and is read-only.

      To create a new version of a Company Link Action, refer to Create a new version for Company Link Actions.

    • Created By field – The name of the user that created the Link Action. This field is auto populated and is read-only.

    • Date Created field – The date the Link Action is created in DD MMM YYYY MM:SS AM/PM format. This field is auto populated and is read-only.

    • Updated By field – The name of the user that updated the Link Action. This field is auto populated and is read-only.

    • Date Updated field – The date the Link Action is updated in DD MMM YYYY MM:SS AM/PM format. This field is auto populated and is read-only.

  10. In the Link Action Script section, upload the JavaScript file that contains the code to execute the Link Action. Only .js files are accepted in this field.

  11. Select the Move To button at the top of the screen to release the Link Action making it available to your company in all Opus environments.

    The submit status indicator circle is filled in with green to indicate the Link Action is in Released status.

  12. Select the Save button.

    The Link Action remains in Edit status until the Save button is selected after moving it to the Released status. If changes are not saved, the status automatically reverts to Edit.

    The Link Action is created with Version Number as 1.

  1. Select the Main Menu icon.

  2. Select Integration Catalog.

  3. Select Link Actions in the side menu.

  4. Select Company.

  5. On the Search Company Link Actions screen, select New version in the row for the Link Action.

  6. On the New Version side panel, select Apply.

    An incremented version of Link Action with the same Link Action name is created.

Tips

  • A version of the Link Action in Released status cannot be updated. To upgrade a Link Action, create a new version.

  • If you select a version and select New Version, the Integration Catalog uses the data from the selected version as the base and creates a new version on top of it. For example, if there are five versions of a Link Action and you select version 2, the Integration Catalog creates a new version based on version 2. The data from version 2 is used as the starting point.

  • A new version can only be created for Link Actions in Edit and Released status.

  • A new Link Action version is always created in Edit status.

  • On the Search Company Link Actions screen, the status of the incremented version always displays as Edit.

  1. Select the Main Menu icon.

  2. Select Integration Catalog.

  3. Select Link Actions in the side menu.

  4. Select Marketplace.

  5. Select the New button.

  6. In the General section, fill in the following fields:

    • Link Action Name field – Required. The unique name of the Link Action.

    • Direction drop-down – The direction of the message.

      • Inbound – A Link Action created to receive inbound B2B messages in TraceLink from external systems.

      • Outbound – A Link Action created to send B2B messages from TraceLink to external systems.

    • Link Action Description field – Required. A description explaining what the Link Action does.
  7. Select the Save button.

    The screen refreshes with the Marketplace Link Action in the draft state and with the required sections populated.

  8. Select the Edit button.

  9. In the General section, fill in the following information:

    • Link Action Name field – Required. The unique name of the Link Action. This field retrieves the value entered in New Company Link Action screen.
    • Link Action Description field – Required. A description that provides a clear explanation of the purpose and functionality of the Link Action.
    • Link Action Version Description field – Required. A description that clearly explains the purpose and functionality of a specific version of a Link Action.

    • Direction drop-down – The direction of the message. This field retrieves the value entered in New Company Link Action screen.

      • Inbound – A Link Action created to receive inbound B2B messages in TraceLink from external systems.

      • Outbound – A Link Action created to send B2B messages from TraceLink to external systems.

    • Version field – The version number of the Link Action. This field is auto populated and is read-only.

      To create a new version of a Company Link Action, refer to Create a new version for Company Link Actions.

    • Created By field – The name of the user that created the Link Action. This field is auto populated and is read-only.

    • Date Created field – The date the Link Action is created in DD MMM YYYY MM:SS AM/PM format. This field is auto populated and is read-only.

    • Updated By field – The name of the user that updated the Link Action. This field is auto populated and is read-only.

    • Date Updated field – The date the Link Action is updated in DD MMM YYYY MM:SS AM/PM format. This field is auto populated and is read-only.

  10. In the Link Action Script section, upload the JavaScript file that contains the code to execute the Link Action. Only .js files are accepted in this field.

  11. Select the Save button.

    The Link Action is created with Version Number as 1 in Edit state.

  12. Select the Promote button at the top of the screen to release the Link Action to be accessed by all the users in the network.

    The status of the Marketplace Link Action remains as Pending Review after promoting the Link Action. Contact TraceLink Support to request approval and promotion. Once approved, the Marketplace Link Action transitions to the Released state.

    The submit status indicator displays a filled in green circle when the Link Action reaches Released state.

  1. Select the Main Menu icon.

  2. Select Integration Catalog.

  3. Select Link Actions in the side menu.

  4. Select Marketplace.

  5. On the Search Marketplace Link Actions screen, select New version in the row for the Link Action.

  6. On the New Version side panel, select Apply.

    An incremented version of Link Action with the same Link Action name is created.

Tips

  • A version of the Link Action in Released state cannot be updated. To upgrade a Link Action, create a new version.

  • If you select a version and select New Version, the Integration Catalog uses the data from the selected version as the base and creates a new version on top of it. For example, if there are five versions of a Link Action and you select version 2, the Integration Catalog creates a new version based on version 2. The data from version 2 is used as the starting point.

  • A new version can only be created for Link Actions in Edit and Released state.

  • A new Link Action version is always created in Edit status.

  • After selecting the Promote button, the Link Action remains in Edit state and does not transition to Released state until it is approved by TraceLink.

  • On the Search Company Link Actions screen, the state of the incremented version always displays as Edit.

Search and view all Link Actions

  1. Select the Main Menu icon.

  2. Select Integration Manager.

  3. From the Link Actions drop-down, select All in the side menu.

  4. Select the Filter button.

    In the Filters panel, fill in one or more of the following fields to filter the results:

    • Link Action Name field – The name of the Link Action.

    • Version field – The version number of the Link Action.

    • Catalog Access Type drop-down – The type of Link Action based on the accessibility.

      • Select All – List of both Company and Marketplace Link Actions.

      • Marketplace – List of Marketplace Link Actions that are publicly accessible to whoever owns Integration Manager and XTT Link Actions.

      • Company – List of Company Link Actions that are private and have restricted access to the users of a particular company who creates the Link Actions.

    • Status drop-down – The status of the Link Action:

      • Edit – The creation of a Link Action is still in edit mode.

      • Pending_Review – The Link Action has been promoted and is currently pending approval from TraceLink.

      • Released – The Link Action is complete, released, and ready to be executed.

    • Direction drop-down – The direction of the Link Action.

      • Select All – List of both inbound and outbound Link Actions.

      • Inbound – List of inbound Link Actions.

      • Outbound – List of outbound Link Actions.

    • Last Updated Date/Time field – The date and time the Link Action is updated in DD MMM YYYY MM:SS AM/PM format.

      • Last 12 Hours – The Link Actions populated in the last 12 hours, from the current time.

      • Last 24 Hours – The Link Actions populated in the last 24 hours.

      • Last 72 Hours – The Link Actions populated in the last 72 hours.

      • Next 12 Hours – The Link Actions populated in the next 12 hours.

      • Next 24 Hours – The Link Actions populated in the next 24 hours.

      • Next 72 Hours – The Link Actions populated in the next 72 hours.

      • Custom Range – The Link Actions populated in the selected date and time range.

  5. Select Apply.

    The results display in a table based on the filter results.

  6. Select the link on the Link Action Name from the results table.

    • Link Action Name field – Required. The unique name of the Link Action. This field is auto populated.
    • Link Action Description field – Required. A description that provides a clear explanation of the purpose and functionality of the Link Action.
    • Link Action Version Description field – Required. A description that clearly explains the purpose and functionality of a specific version of a Link Action.

    • Direction drop-down – The direction of the message.

      • Inbound – A Link Action request sent to TraceLink.

      • Outbound – A Link Action request sent from TraceLink.

    • Version field – The version number of the Link Action. This field is auto populated and cannot be edited.

    • Catalog Access Type field – The type of Link Action. e.g. Marketplace, Company.

    • Date Created field – The date the Link Action is created in DD MMM YYYY MM:SS AM/PM format. This field is auto populated and cannot be edited.

    • Promotion Status field – Indicates whether the Link Action is being promoted. Possible statuses include NOT_SUBMITTED, PENDING_REVIEW, and PROMOTED.

    • Date Updated field The date the Link Action is updated in DD MMM YYYY MM:SS AM/PM format. This field is auto populated and cannot be edited.

    • Link Action Script section – The java script file that contains the code to execute the Link Action.

  1. Select the Main Menu icon.

  2. Select Integration Manager.

  3. From the Link Actions drop-down, select Company in the side menu.

  4. Select the Filter button.

    In the Filters panel, fill in one or more of the following fields to filter the results:

    • Link Action Name field – The name of the Link Action.

    • Version field – The version number of the Link Action.

    • Status drop-down – The status of the Link Action:

      • IN_PROGRESS – The creation of a Link Action is still in edit mode.

      • PENDING_REVIEW – The Link Action has been promoted and is currently pending approval from TraceLink.

      • RELEASED – The Link Action is complete, released, and ready to be executed.

    • Direction drop-down – The direction of the Link Action.

      • Select All – Gets data from the ERP system.

      • Inbound – Gets data from the ERP system.

      • Outbound – Sends data to the ERP system.

    • Last Updated Date/Time field – The date and time the Link Action is updated in DD MMM YYYY MM:SS AM/PM format.

      • Last 12 Hours – The Link Actions populated in the last 12 hours, from the current time.

      • Last 24 Hours – The Link Actions populated in the last 24 hours.

      • Last 72 Hours – The Link Actions populated in the last 72 hours.

      • Next 12 Hours – The Link Actions populated in the next 12 hours.

      • Next 24 Hours – The Link Actions populated in the next 24 hours.

      • Next 72 Hours – The Link Actions populated in the next 72 hours.

      • Custom Range – The Link Actions populated in the selected date and time range.

  5. Select Apply.

    The results display in a table based on the filter results.

  6. Select the link on the Link Action Name from the results table.

    • Link Action Name field – Required. The unique name of the Link Action. This field is auto populated.
    • Link Action Description field – Required. A description that provides a clear explanation of the purpose and functionality of the Link Action.
    • Link Action Version Description field – Required. A description that clearly explains the purpose and functionality of a specific version of a Link Action.

    • Direction drop-down – The direction of the message.

      • Inbound – A Link Action request sent to TraceLink.

      • Outbound – A Link Action request sent from TraceLink.

    • Version field – The version number of the Link Action. This field is auto populated and cannot be edited.

    • Catalog Access Type field – The type of Link Action. e.g. Marketplace, Company.

    • Date Created field – The date the Link Action is created in DD MMM YYYY MM:SS AM/PM format. This field is auto populated and cannot be edited.

    • Promotion Status field – Indicates whether the Link Action is being promoted. Possible statuses include NOT_SUBMITTED, PENDING_REVIEW, and PROMOTED.

    • Date Updated field The date the Link Action is updated in DD MMM YYYY MM:SS AM/PM format. This field is auto populated and cannot be edited.

    • Link Action Script section – The java script file that contains the code to execute the Link Action.

  1. Select the Main Menu icon.

  2. Select Integration Manager.

  3. From the Link Actions drop-down, select Marketplace in the side menu.

  4. Select the Filter button.

    In the Filters panel, fill in one or more of the following fields to filter the results:

    • Link Action Name field – The name of the Link Action.

    • Version field – The version number of the Link Action.

    • Status drop-down – The status of the Link Action:

      • IN_PROGRESS – The creation of a Link Action is still in edit mode.

      • RELEASED – The Link Action is complete, released, and ready to be executed.

    • Direction drop-down – The direction of the Link Action.

      • Select All – Gets data from the ERP system.

      • Inbound – Gets data from the ERP system.

      • Outbound – Sends data to the ERP system.

    • Last Updated Date/Time field – The date and time the Link Action is updated in DD MMM YYYY MM:SS AM/PM format.

      • Last 12 Hours – The Link Actions populated in the last 12 hours, from the current time.

      • Last 24 Hours – The Link Actions populated in the last 24 hours.

      • Last 72 Hours – The Link Actions populated in the last 72 hours.

      • Next 12 Hours – The Link Actions populated in the next 12 hours.

      • Next 24 Hours – The Link Actions populated in the next 24 hours.

      • Next 72 Hours – The Link Actions populated in the next 72 hours.

      • Custom Range – The Link Actions populated in the selected date and time range.

  5. Select Apply.

    The results will be displayed in a table based on the filter results.

  6. Select the link on the Link Action Name from the results table.

     

  • On the Search All Link Actions screen, selecting a Link Action name opens the Link Action Details screen. From this screen, users can modify Company or Marketplace Link Actions, based on the associated Catalog Type.