Welcome to the WorkPoint Implementation & Best Practice Guide. This resource is designed to be the go-to reference for partners at all levels. Whether you are a new partner configuring your very first WorkPoint 365 solution or an experienced consultant looking for our latest enterprise-grade best practices on governance and scaling, this guide covers the essential stages of a successful lifecycle.
๐ Phase 0: Project Estimation & Scoping
Estimation is often the most challenging part of a WorkPoint project. To provide accurate quotes and manage customer expectations, use the following framework to break down the configuration tasks.
1. Analysis & Workshops
- The Workshop Tool: Use the WorkPoint Scoping Workshop Guide to steer these sessions. It provides the structured questions needed to uncover the actual requirements and secure a solid foundation for your estimate.
- The "Why" Factor: Use this time to challenge the customerโs existing processes. It takes longer to analyze a process than to build it, but it saves time in reconfiguration later.
2. Configuration Blocks
- Module Setup: Estimate time for creating fields, views, and parent/child relations.
- Master Site Design: Designing the "perfect" master site (web parts, navigation, list structures) typically takes 20-30% of the configuration time.
- Managed Properties: Don't forget to budget time for mapping Managed Properties in SharePoint to ensure search works as planned (see Phase 5).
3. Security & Automation (The Variables)
- Security Model: A "Keep it Simple" model (Phase 3) is fast. Granular, item-level security or complex inheritance breaks can double the estimation for security setup.
-
WorkPoint Automate: Categorize processes as Low, Medium, or High complexity.
- Low: Simple field updates or email notifications.
- Medium: Document generation with metadata mapping.
- High: Complex loops, external API calls (Custom Endpoints), or multi-stage logic.
4. User Adoption & Deployment
- WorkPoint Express: Budget time for coordination with IT (Phase 1) and targeted deployment.
- Testing (UAT): Always budget at least 10-15% of the total project time for User Acceptance Testing and subsequent minor adjustments.
๐๏ธ Phase 1: Foundation & Best Practices
Before technical configuration, establish a solid framework. Consistency early on prevents technical debt and ensures long-term maintainability for both small and large solutions.
1. Administrative Best Practices
-
Naming Conventions: Always use prefixes for custom fields (e.g.,
cc[Module][Field]). Create site columns before adding them to business modules to maintain central management. -
WorkPoint System Fields (The
wpPrefix): Be aware that all WorkPoint system fields are prefixed withwp.- Do not modify or delete any fields using this prefix, as they are critical for core system functionality.
-
Do not use the
wpprefix for your own custom fields or columns. Using the reserved system prefix can lead to conflicts during updates or cause unexpected behavior in the solution.
- Documentation & Change Logs: Keep a detailed log of structural changes. Knowing the why behind a rule is invaluable for long-term support and knowledge sharing within your team.
- Managed Properties Planning: Plan your SharePoint Managed Properties early. Consistent mapping of metadata to searchable/filterable properties is essential for a high-performance search experience.
2. Installation & IT Alignment
Preparation is key to avoiding roadblocks during the setup of the core engine.
- Engage IT Early: IT must be aware that installation requires a Global Administrator to grant mandatory consents for Enterprise Applications and API permissions. Early alignment prevents roadblocks caused by internal security policies.
- Installation Guide: Refer to the Official WorkPoint 365 Installation Guide.
-
Choosing a Model: Select the most appropriate model based on the organization's governance requirements:
- Standard Model: WorkPoint handles the creation and management of site collections automatically.
- Limited Model: This model requires manual intervention and registration of site collections in the WorkPoint system.
- Registration (Limited Model Only): Use the WorkPoint API to register your site collections. Refer to the Official API Documentation for detailed steps.
- Critical Check: Double-verify the URL during installation; it is bound to the license and cannot be changed later.
- Root Site Permissions: (Crucial Step): Remember to verify that you are assigned as a Site Collection Administrator on the root site before starting any configuration. Missing this crucial access right is a common pitfall that will completely block the initial setup.
3. Deploying WorkPoint Express 365
WorkPoint Express is the primary interface for most users, making it a critical component for adoption.
- Early IT Coordination: Coordination with IT is required to deploy the add-in via the Microsoft 365 admin center.
- Targeted Deployment: Avoid the "Mass Deployment" pitfall. Limit the deployment to the specific business units or user groups that will actually utilize the solution to avoid cluttering Outlook for others.
- Permissions & Consents: Verify that the necessary permissions and consents are granted for features like email journaling and document management.
- Deployment Guide: See Deploying WorkPoint Express 365.
โ๏ธ Phase 2: Architecture & Performance
4. Business Module Design
- Architecture & Hierarchy: Plan Parent-Child relationships early. This hierarchy is the backbone of the solution and determines how data moves through your modules.
- Data Inheritance: Plan your metadata flow. Data inheritance allows child entities (e.g., a Project) to automatically inherit information from parent entities (e.g., a Company).
- Data Aggregation: Use aggregation to roll up data from child entities to a parent level. This is crucial for reporting and high-level overview.
- Scalability: Plan metadata fields to support reporting needs without over-complicating the data model.
๐ Deep Dive: Business Module Architecture | Data Inheritance | Data Aggregation
5. Master Site Synchronization & Provisioning
- Master Site Sync Optimization: Only synchronize the exact elements you need. Unnecessary synchronization increases the load and consumes Resource Units (RU).
- Content Type Hub Strategy: Utilize the SharePoint Content Type Hub to manage and deploy your content types centrally. This is significantly more efficient and saves Resource Units (RU) during site provisioning.
- The "One Entity per Site Collection" Rule: If your solution is configured for one entity per site collection, always delete the master site collection template before performing a synchronization to ensure a clean state and correct propagation.
- Verification Strategy: Before performing a mass synchronization, always sync to a single entity first. Verify that all elements (views, web parts, columns) are behaving as expected before rolling out globally.
- Scheduling: Move large sync jobs to weekends or nights using the Webjob Queue Manager to avoid throttling.
-
Buffer Sites: Set levels based on expected daily volume.
- Configuration Phase: Keep levels low to speed up testing.
- Production Phase: High-volume solutions require higher buffer levels to avoid bottlenecks and stay within "Resource Unit" per-minute limits.
๐ Deep Dive: Master Site Synchronization Guide
6. Environment Strategy & Resource Isolation
- Tenant-Level Separation: For larger customers, maintain a separate Microsoft 365 tenant for testing. SharePoint resources and throttling limits are shared at the tenant level, so heavy testing can impact production stability.
๐ก๏ธ Phase 3: Security & Scaling Architecture
7. The "Keep it Simple" Security Model
- Challenge the Customer: Group roles by permission needs, not job titles. If a customer requests 20+ roles, they are likely building a maintenance nightmare that will slow down site provisioning.
-
Example (The 80/20 Rule):
- The Cluttered Way: Creating roles for "Junior Consultant," "Senior Consultant," "Partner," and "Assistant"โall of whom simply need to edit documents.
- The WorkPoint Way: Create one functional role called "Project Contributor".
-
Use SharePoint Groups for Permissions: * Avoid Direct User Sync: Use SharePoint groups (e.g., "Project Manager Group") to minimize the load on background jobs.
- Static Rules at Creation: Predefined groups make security a static rule set, reducing the load during site provisioning.
- Solve the "Broken Inheritance" Trap: Using a Group ensures continuity when personnel changes (e.g., a new PM joining a project).
๐ Deep Dive: WorkPoint 365 Security - Best Practices
8. Scaling Beyond SharePoint Limits
- Scaling Security for High-Volume Business Modules (Optional): This feature can be activated per business module. When dealing with a large number of entities (such as thousands of projects), it allows you to safely bypass SharePoint's 5,000 unique permission limit by automatically grouping items with identical permissions into folders, ensuring your security model scales seamlessly.
๐ Deep Dive: Scaling Security for High-Volume Business Modules
๐ Phase 4: Automation, Logic & Events
9. WorkPoint Automate Processes
-
Configure Connections (Mandatory): Before building any logic, you must establish and configure WorkPoint Automate Connections.
The Foundation of All Logic: Connections are required for even the most basic process functions to ensure that actions are executed with the correct permissions and within the right security context.
Configuration Guide: Ensure these are set up correctly by following the official documentation: WorkPoint Automate Connections.
-
Custom Endpoints (Webhooks): For integrations where external systems (e.g., ERP or CRM) need to "push" data to WorkPoint, use Custom Endpoints.
- Trigger Input: Endpoints allow for receiving a JSON payload, which is mapped directly to process variables.
- Security: It is critical to configure endpoint security (tokens and validation) to protect against unauthorized access.
- Creating Processes: Start with a clear trigger (manual, event-based, scheduled, or via endpoint). Build your logic using established connections.
- Optimization: Don't just digitizeโimprove. Challenge existing manual processes to find a more automated path.
๐ Deep Dive: WorkPoint Automate Connections | Creating a New Process | Implementing HTTP Endpoints
๐ Phase 5: Search & Findability
10. Configure Search Scopes & Filters
- Search Scopes: Define appropriate scopes and filters for relevant results.
- Security First: Correctly configure permissions BEFORE migrating data. Proper security trimming in search depends on a clean permission structure from the start.
๐ Deep Dive: Search Configuration
๐ Phase 6: Monitoring, Logs & Maintenance
11. Proactive Monitoring via WorkPoint Administration
- Log Access & Alerting: Access logs directly in the admin portal and configure alerts for failed jobs or process errors.
- The Exception Log: Pay close attention to the Exception Log. This is where server-side errors and stack traces are recorded, which are critical for identifying issues not immediately visible in the UI.
12. Utilizing Logs for Troubleshooting
To help WorkPoint Support identify the root cause of issues, providing detailed logs and context is essential. Follow the Guidelines for submitting tickets.
Highlighting Business Impact
When creating a case, it is critical to describe the business impact. Providing clear information on how many users are affected and the severity of the disruption (e.g., "blocking a critical tender deadline" or "entire department unable to journalize emails") allows the support team to prioritize and resolve the issue effectively. A technical bug is one thing, but understanding the real-world consequence is what drives urgency.
Capturing UI and Network Issues
If a problem occurs within the UI, provide the browser's Network and Console logs:
Microsoft Edge & Google Chrome (Chromium-based):
- Open Developer Tools: Press F12.
-
Gather Console Logs:
- Click Console > Gear icon > Check Preserve log > Ensure 'All levels' is selected > Clear.
- Reproduce the issue, then right-click > Save as.
-
Gather Network Logs:
- Click Network > Check Preserve Log > Clear.
- Reproduce the issue, then right-click > Save all as HAR with content.
๐ Need Help?
-
Knowledge Base & Documentation: support.workpoint.dk
Access our full library of deep-dives, step-by-step guides, and technical documentation.
-
Support, Guidance & Feedback: Submit a Request
Reach out for technical assistance, configuration guidance, or share ideas for product improvements.
WorkPoint 365 Implementation Guide - Building for the future.
Comments
0 comments
Please sign in to leave a comment.