Set up template integrations
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 Build a custom application integration.
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 Preview. This allows the functionality to mature as a result of initial customer feedback. While in Preview, there is no commitment to support and support is provided by the developer on a best-effort basis. Preview 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. Preview 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 preview, 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 Preview, 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:
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.
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.
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:
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.
Service Calendar: View all events (Incidents and Maintenance), and event details of a month (current and past).
Service Status: Receive Notifications for Platform Alerts (multiple Incidents at once affecting multiple Services), and get the current state of all services.
Requisition Approval: View requisitions with details that are pending approval, and an action to approve.
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.
Calendar Events: Create and preview events.
Directory Admin: Add a new user.
Directory Details: View details of teammates, including new employees and position changes.
Session Metrics: View sessions and session metrics.
User Metrics: View user metrics.
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.
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.
Create ticket: Create a new Jira ticket with details.
Tickets: View tickets, add comments, create sub-tasks, and change status and assignee.
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.
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.
Dashboards: View details of Power BI dashboards.
Reports: View details of Power BI reports.
Item: Search for and view items.
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.
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.
Directory: Search, view, and edit employees with corresponding details.
Learning: Search, view, share, and register available learning courses.
Reports: View details of Tableau reports.
Create a Meeting: Schedule a meeting with the option to select duration, time zones, invitees, and co-hosts.
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.
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.
Add Ticket: Submit Zendesk tickets.
Tickets: View Zendesk tickets with details.
Create a Meeting: Schedule meetings according to your preference. User can choose the meeting title, duration, start date, co-organizers, and so forth.
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:
- Set up the new HTTP integration.
- Test the new integration and promote to production when ready.
- Stop syncing old integration. For more information, see Set data synchronization.
- Mark microapps of old integration as EOL.
- 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.
- From the Manage Microapps page, select the menu next to the integration that you want to verify entities for.
- Select Edit and then Table.
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.
- You can unselect any entities that you do not require.
- 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.
- From the Manage Microapps page, select the menu next to the integration for which you want to set synchronization.
Set Full and Incremental data synchronization values.
Full Drops the local cache and pulls all data from the source system.
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.
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.
- Select Save.
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.