Set up template integrations 编辑

Note:

• Microapp integration templates are deprecated after May 16, 2022, and are unavailable after July 1, 2022.
• After this period, the integrations are end-of-life and no longer available for use.
• Integrations already deployed are unaffected and are still fully functional after the deprecation and maintenance dates.
• For more information and a list of deprecated integrations, see Deprecation.

You can set up a template integration and use the out-of-the-box microapps or build your own. Before you begin, make sure to review the best practices for configuring application integrations. For a comprehensive list of template integrations and their out-of-the-box microapps, see Template integrations and out-of-the-box microapps.

In addition to Citrix built template integrations, there are third party microapps. For a full list of these microapps, see Citrix Ready Marketplace.

If you want to build your own integration, see Deprecation.

Maintenance statement for Microapps integration templates

Citrix-provided integrations are templates. The developer of a template maintains it and ensures that it continues to work.

On release, new integration templates will typically be classified as Citrix Labs. This allows the functionality to mature as a result of initial customer feedback. For Citrix Labs templates, there is no commitment to support and support is provided by the developer on a best-effort basis. Citrix Labs integration templates are shared for the purpose of testing/validation. We do not advise deploying them in production environments. Refer to the listing of Citrix provided templates shown in the product when adding a new integration. Citrix Labs templates are listed in a separate section.

Customers can instantiate integration templates as integrations, and run them unchanged. Assuming the template has transitioned out of Citrix Labs, the developer of an integration will maintain it, keep it up-to-date, and fully working while the template is listed as Citrix-provided in the product. Reach out to the template developer to learn more about their support policies.

Customers can customize instantiated integrations. For Citrix’s integration templates, there is no commitment to support customization and support is provided on a best effort basis. Reach out to the template developer to learn more about their support policies.

Template developers can remove templates from the product at any time. This will not remove instantiations from customer deployments. For integration templates that have left Citrix Labs, the developer commits to giving a minimum of four-week notice before ceasing maintenance of an integration template. Reach out to the template developer to learn more about their support policies.

Updates to the template integrations are not automatically rolled-out to customers. Customers decide when to take new versions of the template from the catalog. If the customer made any customizations based on the old version, these will need to be merged into the new version by the customer.

Best practices for application integrations

Review the following best practices when you prepare to implement a new integration for Citrix Workspace Microapps:

Development

Review development considerations:

• Consider fees for API service calls. Define what rate of API calls the use case requires. This includes who pays the fees, fee tiers, and an estimation of what your use cases’ rate is.
• Ensure you have access to the target system.
• Verify that your app registration can be in your marketplace. Otherwise, every user has to create their own registration.
• Ensure that you are able to procure an instance of the target system.
• Do not use private APIs, and do not reverse engineer system-provided APIs.
• Continue to regression test connectors and track API agreement changes.
• Verify that data retention time periods that are required are compatible with the defaults for Citrix Cloud.
• If you use ad blocking software, disable it for Citrix Cloud and Workspace.

Legal

Review legal considerations:

• Review the user agreement.
• Review restrictions on use of service accounts.
• Review restrictions on distributions.
• Retain all agreements that you sign up for and review in a repository.
• For non-citrix microapps, read the microapp terms of service.

Security

Review security considerations:

• Review your organizations minimum security guidelines.
• Use encrypted communication (HTTPS), with at minimum Transport Layer Security (TLS) 1.2.
• Check your rate limits.
• Use a system account with minimum permissions to fetch data (bulk reads).
• Consider how long you retain data once the sync is not running.
• Use public APIs for production.
• OAuth2 is the preferred authentication protocol for this SaaS service.
• Always use OAuth2 for write-backs.
• Keep the integration updated. Verify it works and external APIs did not change.

Template integrations and their microapps

The following integrations are available for Citrix Microapps out-of-the-box. Select the target application to go to the details of setting up the integration:

Citrix Cloud Status

Incident: Receive Notifications for New Incidents and Incident updates. Also search for Incidents, and view their details.

Maintenance: Receive Notifications for New Maintenance schedules added to the Calendar, and when the Maintenance window starts and ends. Also search for Maintenance schedules, and view their details.

Citrix Podio

Broadcast: View all published (Status: Live) broadcasts that have a future End Date.

Create Broadcast: Create and publish new broadcasts.

Manage Broadcast: Administrators can view and update all created broadcasts. This view is not limited to published (Status: Live) broadcasts.

Citrix DaaS

My Desktops: Search for your Citrix Virtual desktops, and perform self-service actions from Citrix Workspace such as restarting.

My Sessions: Search for your Citrix Virtual sessions, and perform self-service actions from Citrix Workspace such as logging off and disconnecting.

Virtual Desktops (Admin Mode): Enables from Citrix Workspace CVAD Administrators to lookup machines, view their details, put machines into maintenance mode, and restart the machines.

Covid Self Certify

Self Certify: Submit your daily vaccination status response for covid-19 self-certification.

Employee Survey App

Survey Form: Provides notifications for new surveys and allows users to view and submit the survey forms.

Manage Survey: Allows survey app admin to manage the scheduled survey forms from Citrix Workspace. This microapp is only for Employee Survey App admin members.

Adobe Sign

Send Agreements: Send the template and upload an agreement to recipients for signature.

My Received Agreements: Provides a list of Adobe Sign agreements waiting for user’s signature. A user can sign the agreement form

In Progress Agreements: List of in-progress Adobe Sign agreements for signature. User can also cancel the sent Agreement.

Completed Agreements: List of completed Adobe Sign agreements and details. User can also Share the received Agreements.

Canceled Agreements: List of Canceled Adobe Sign agreements and details.

Manage Agreements: Manage and edit template agreements.

SAP Ariba

Requisition Approval: View requisitions with details that are pending approval. Includes an approval action.

SAP Ariba (Legacy)

Requisition Approval: View requisitions with details that are pending approval, and an action to approve.

Blackboard Learn

Course Registration: Register for a course.

Create Course Announcement: Allows instructors to an create announcement for a course.

Instructor View: Allows instructors to view course members and grades.

My Courses: View course announcements and attachments of a course

My Grades: Allows students to view course grades.

Canvas LMS

Create Course Announcement: Teachers create an announcement for a course.

My Courses: View course announcements, assignments, and course files.

My Grades: Students view their course grades.

Teacher’s View: Teachers view and add course members and view students.

Cherwell

Create Incident: Allows the user to create an incident.

Create Service Request: Create a new service request from the catalog or select predefined service requests templates.

My Open Incidents: View and manage open incidents that the workspace user owns.

My Open Serice Requests: View and manage open service requests that the workspace user owns.

SAP Concur

Approvals: Approve pending expense reports or send them back.

Expenses: Search and view expenses.

Itineraries: Search, view, and share itineraries.

Quick Expenses: Search and view quick expenses.

Reports: Search and view your submitted expense reports.

SAP Concur (Legacy)

Approvals: Approve pending expense reports or send them back.

Expenses: Search and view expenses.

Itineraries: Search, view, and share itineraries.

Quick Expenses: Search and view quick expenses.

Reports: Search and view your submitted expense reports.

Submit Quick Expense: Create a new quick expense report.

DocuSign

My Received Envelopes: View user’s received envelopes, which are awaiting signature. User can authenticate himself and view the Envelope in DocuSign.

Send a Template: Send an existing template for signature.

My Sent Envelopes: View a list of envelopes sent by the user. Users also can view the details of the envelope, and also add, edit, and delete recipients.

Google Analytics

Session Metrics: View sessions and session metrics.

User Metrics: View user metrics.

Google Calendar

Create Event: Schedule an event according to user preferences.

My Calendar (Current Month): View list of the upcoming current month’s one-time and recurring calendar events and the ability to edit the events.

My Office Hours: Create, edit, and view office hours.

Google Calendar (Legacy)

Calendar Events: Create and preview events.

Google Directory

Create User: Add a new user.

Directory Admin: Manage users and details.

Groups: View groups and details.

My Details: View your own details.

Users: View user details.

Google Directory (Legacy)

Directory Admin: Add a new user.

Directory Details: View details of teammates, including new employees and position changes.

Google Meet

Create Meeting: Schedule a meeting according to user preference.

Meeting Recordings: View list of all meeting recordings available for the user and watch the recorded videos.

GoToMeeting

Create a Meeting: This microapp is used to schedule a meeting according to user preference. The user has the option to select date, start time and end time, password, and co-organizers.

Ivanti

Agent Incidents: Self-service to manage incidents by an Agent. Subscribers must have agent access to Ivanti or resolutions will fail.

Create from Service Catalog: Create a service request based on the title of the microapp by using a deep link back to the self-service module of Ivanti.

Create Incident: Report a new incident in Ivanti. This is a quick create that can be submitted without an owner.

My Incidents: Self-service for my incidents.

My Service Requests: View existing service requests containing deep links to view the dynamic templates associated to the request.

Quick Service Request: Quickly create common service requests.

Jira

Create Epic: Create a new Jira epic with details.

Create Ticket: Create a new Jira ticket with details.

Tickets: View tickets, add comments, create subtasks, and change status and assignee.

Jira (Legacy)

Create ticket: Create a new Jira ticket with details.

Tickets: View tickets, add comments, create sub-tasks, and change status and assignee.

Kronos Workforce Central

My Accrual Balance: View accrual balance for different days instantly.

My Time Off History: Allows users to view their history of time off data available for current month.

Record Timestamp: Register their punch in and out date and time.

Request Time Off: Submit application for time off.

Request Vacation Approval: Receive notifications for all time off requests to managers and push notifications for all approved or refused time off requests back to the original requester.

Time Log: Receive notifications for all Work Time requested. Approve or refuse for the single user or group of users.

Microsoft Dynamics

Accounts: Search, view, and edit accounts.

Appointments: Search, view, and edit appointments.

Cases: Search, view, and edit cases.

Contacts: Search, view, and edit contacts.

Create Account: Create an account.

Create Appointment: Create an appointment.

Create Case: Create a case.

Create Contact: Create a contact.

Create Lead: Create a lead.

Create Opportunity: Create an opportunity.

Create Phone Call: Create a phone call.

Create Task: Create a task.

Leads: Search, view, and edit leads.

Opportunities: Search, view, and edit opportunities.

Phone Calls: Search, view, and edit phone calls.

Tasks: Search, view, and edit tasks.

Microsoft Dynamics (Legacy)

Accounts: Search, view, and edit accounts.

Appointments: Search, view, and edit appointments.

Cases: Search, view, and edit cases.

Contacts: Search, view, and edit contacts.

Create Account: Create an account.

Create Appointment: Create an appointment.

Create Case: Create a case.

Create Contact: Create a contact.

Create Lead: Create a lead.

Create Opportunity: Create an opportunity.

Create Phone Call: Create a phone call.

Create Task: Create a task.

Leads: Search, view, and edit leads.

Opportunities: Search, view, and edit opportunities.

Phone Calls: Search, view, and edit phone calls.

Tasks: Search, view, and edit tasks.

Microsoft Outlook

Create Event: Microapp is used to schedule an Event/Meeting as per the user preference.

My Calendar: Microapp is used to view and edit upcoming Events/Meetings.

My Office Hours: Microapp is used to create, view, and edit virtual office hours.

Microsoft Teams

Add Channel: Add a new channel to an existing team.

Create Meeting: Schedule an MS Teams meeting as per user preference.

Create Team: Create a team from scratch or based on an existing team as per user preference. Additionally, whenever a Channel is created for any team, the team owner will receive a notification.

Send Message: Send a message to a specific channel in any team.

Oracle HCM

Employee Directory: View and search employee directory.

Enter My Time: Enter daily time for selected entry types.

PTO: Create and submit absences.

Power BI

Dashboards: View details of Power BI dashboards.

Reports: View details of Power BI reports.

Qualtrics

My Surveys: Find all active surveys that are emailed to users. Notifications are sent when a survey is sent to a user and 24 hours before a survey expires.

Qualtrics Survey Statistics: For Brand Admins to manage surveys. Review statistics on active surveys. Notifications sent 24 hours before a survey expires with basic performance stats and the ability to deep link.

RSS

Item: Search for and view items.

Salesforce

Accounts: Search for, view, and edit accounts.

Cases: Search for, view, and edit cases that are assigned to you.

Contacts: Search for, view, and edit contacts.

Contracts: Search for, view, and edit contracts.

Create Account: Create a new account.

Create Case: Create a new case.

Create Contact: Create a new contact.

Create Contract: Create a new contract.

Create Event: Create a new event.

Create Lead: Create a new lead.

Create Opportunity: Create a new opportunity.

Create Task: Create a new task.

Events: Search for, view, and edit events.

Leads: Search for, view, edit, and convert leads.

Opportunities: Search for, view, and edit opportunities.

Tasks: Search for, view, and edit tasks.

Salesforce (Legacy)

Accounts: Search for, view, and edit accounts.

Cases: Search for, view, and edit cases that are assigned to you.

Contacts: Search for, view, and edit contacts.

Contracts: Search for, view, and edit contracts.

Create Account: Create a new account.

Create Case: Create a new case.

Create Contact: Create a new contact.

Create Contract: Create a new contract.

Create Event: Create a new event.

Create Lead: Create a new lead.

Create Opportunity: Create a new opportunity.

Create Task: Create a new task.

Events: Search for, view, and edit events.

Leads: Search for, view, edit, and convert leads.

Opportunities: Search for, view, and edit opportunities.

Pending Account Approvals: Search for and approve or reject accounts.

Pending Contact Approvals: Search for and approve or reject contacts.

Pending Contract Approvals: Search for and approve contracts.

Tasks: Search for, view, and edit tasks.

ServiceNow

Change Requests: Search for change requests, view their details, add comments, and update them.

Incidents: Search incidents, view their details, add comments, and update them.

Problems: Search for problems, view their details, add comments, and update them.

Request Approval: Search and view pending approvals, and approve or reject them.

Submit Change Request: Submit a new change request.

Submit Delegate: Submit a new delegate.

Submit Incident: Submit a new incident.

Submit Problem: Submit a new problem.

ServiceNow (Legacy)

Approvals: Search and view pending approvals, and approve or reject them.

Change Requests: Search for change requests, view their details, add comments, and update them.

Incidents: Search incidents, view their details, add comments, and update them.

Problems: Search for problems, view their details, add comments, and update them.

Submit Catalog Request: Select items and submit a new catalog request.

Submit Change Request: Submit a new change request.

Submit Delegate: Submit a new delegate.

Submit Incident: Submit a new incident.

Submit Problem: Submit a new problem.

Tasks: Search and view tasks including change requests, incidents, and problems.

Slack

My Favorite Channels: Receive notifications of activity in favorited channels.

Post to Slack: Post a message to the selected focused channel in slack.

Set My Slack Status: Set your slack status, create reminders, and enable Do Not Disturb for a set amount of time.

Smartsheet

Access Sheets: View sheets, share a sheet to a licensed or non-licensed user or group, add a sheet as favorite, and allow users to view their individual sheet.

Create a Sheet: Create a new sheet with fields and options such as sheet name, enter column title, select column type, and select primary column.

Discussion: Generate notifications to the discussion creator whenever there is a reply to theirs discussion thread.

My Update Requests: View sent and received update requests with details such as sent to, sent by, subject and status. Additionally, when a user sends an update request to recipients, the recipients receive a notification. Once the update request is complete,d the sender receive a completed notification.

Send Smartsheet as Attachment: Send Smartsheets as an attachment (PDF or Excel), with details such as To email, subject, and message.

Share with Admin: Used by Non-Admin users to share their sheets to admins with view only access, and to unlock other features such as Access sheets, My Update request, Discussions, and receive the respective notification. Share the sheet with Admin to unlock additional Smartsheet actions and notifications in Workspace for you, including: update request actions/notifications, discussion notifications, and viewing your sheets.

Start a Discussion: Start a discussion on sheet level.

SocialChorus

Important Communications: Search and view important communications from recommended channels that are posted within the last 7 days.

Latest Articles: Search and view content from subscribed channels that has been posted within the last 7 days.

Featured Content: Get recently featured communications from the subscribed channels with this microapp. Users can search, view images, and read content from Citrix Workspace.

SolarWinds

Create Ticket: Create a new incident.

Delete Ticket: Delete an incident.

My Assigned Tickets: View assigned tickets to update them and/or to change its status if needed.

My Open Tickets: Allows the user to see his requested incidents and update them if needed.

My Open Service Requests: Allows the user to see his service requests and update them if needed.

Service Catalog Request: Search for a service catalog item by name or create common service requests quickly.

SAP SuccessFactors EC

Directory: Search for employees and preview their details including skill set.

Skills: Search for skills and preview employees with corresponding skill set.

SAP SuccessFactors (Legacy)

Directory: Search, view, and edit employees with corresponding details.

Learning: Search, view, share, and register available learning courses.

Tableau

Reports: View details of Tableau reports.

Tableau (Legacy)

Reports: View details of Tableau reports.

Webex

Create a Meeting: Schedule a meeting with the option to select duration, time zones, invitees, and co-hosts.

Workday

Change Job: View and approve change job requests.

Create Change Job: Create a change job request.

Create Expense Report: Create an expense report.

Create Time Off Request: Submit a paid time-off (PTO) request.

My Time Off Request: View a personalized list of time-off requests.

Time Off Requests: View and approve paid time-off (PTO) requests.

Workday (Legacy)

Approval: Approve expense reports, time-off, and change job requests.

Create PTO Request: Submit a paid time-off (PTO) request.

My Expenses: View a personalized list of expense reports with report details and details of individual expense items.

My PTO Request: View a personalized list of time-off requests.

PTO Balance: View a personalized list of remaining time-off days.

Purchase Orders: View purchase orders with purchase order details.

Zendesk

Add Ticket: Submit Zendesk tickets.

Tickets: View Zendesk tickets with details.

Zendesk (Legacy)

Add Ticket: Submit Zendesk tickets.

Tickets: View Zendesk tickets with details.

Zoom

Create a Meeting: Schedule meetings according to your preference. User can choose the meeting title, duration, start date, co-organizers, and so forth.

Upcoming Meetings (Current Week): View all upcoming meetings for the current week. User can edit and start the meeting.

My Office Hours: Schedule Office Hours meeting according to preferences. User can choose the duration, start date, dial-in numbers, etc.

Meeting Recordings: View all the meeting recording for the last seven days. Also allows users to play recordings from any device.

End of Life process

This section describes the end of life (EOL) process for integrations that are replaced by newer HTTP integrations. When an integration is replaced with a newer HTTP integration, we refer to the older integration as legacy and the integration shows in the Legacy section of the admin console. Importantly:

• The legacy integration is available for three (3) months. After this period, the integration is no longer available for use.
• The legacy integration is supported for six (6) months. After this, there is no support for users running the integration.

Once an integration is replaced with a newer HTTP integration, we recommend migrating to the new integration. To migrate:

1. Set up the new HTTP integration.
2. Test the new integration and promote to production when ready.
3. Stop syncing old integration. For more information, see Set data synchronization.
4. Mark microapps of old integration as EOL.
5. Move over subscriptions. For more information, see Assign subscribers.

If no action is taken, the legacy integration continues functioning as-is. There will be a warning that the integration is no longer supported.

Verify needed entities

After you set up your template integration, use Table to verify your current list of tables stored in the cache and filters that are applied to those tables.

For template integrations, a large quantity of data can be pulled from your integrated applications to the Microapps platform. To better control and limit this amount of data, use the Table page to filter entities for your data synchronization to speed up synchronization.

1. From the Manage Microapps page, select the menu next to the integration that you want to verify entities for.
2. Select Edit and then Table.

3. Select Edit Schema.

   The entities to sync for this integration, and filters that are applied to those tables, are listed. Entities with an information icon are required and cannot be edited.

4. You can unselect any entities that you do not require.
5. Select Save.

You are now ready to set and run your first data synchronization.

Set data synchronization

Pull data from your integrated applications to the Microapps platform so that a comparison can be made to the cache. As a best practice, full synchronization is performed every 24 hours and incremental syncs can be configured to pull every five minutes.

1. From the Manage Microapps page, select the menu next to the integration for which you want to set synchronization.

2. Select Synchronization.

   

3. Set Full and Incremental data synchronization values.

   • Full Drops the local cache and pulls all data from the source system.

     Important:

     Running full synchronization can take a long time. We recommend running full synchronization at night or generally during off hours. You can cancel a data synchronization that is in progress at any time by selecting the X icon.

   • Incremental Pulls only changed (new and updated) records. Does not load deleted data.

     Important:

     Not all APIs support incremental synchronization.

     When you define daily or weekly synchronization, synchronization occurs randomly within the timeslot you select. For example, selecting 00-04 daily full synchronize will run a full synchronize at a randomly selected time in that period.

4. Select Save.

Note:

You can also select the arrow icons to run the integrations on demand if necessary.

Trusted certificate authority

Trusted certificates are used to create secure connections to a server. A certificate authority (CA) certifies the ownership of a public key by the named subject of the certificate. CAs acts as a trusted third-party, being trusted both by the owner of the certificate and by the party relying upon the certificate.

For a list of trusted certificate authorities, see Trusted CA list.

Where to go next

If you want a quick start guide to onboarding Citrix Workspace Microapps, see Getting started.

If you want to build your own integration, see Build a custom application integration.

If you want to find out more about working with microapps, see Create microapps.