{"id":6589,"date":"2025-04-29T14:10:55","date_gmt":"2025-04-29T14:10:55","guid":{"rendered":"\/agile\/?post_type=ht_kb&#038;p=6589"},"modified":"2025-04-29T14:11:00","modified_gmt":"2025-04-29T14:11:00","slug":"integration-partner-employee-sync","status":"publish","type":"ht_kb","link":"\/agile\/knowledge-base\/integration-partner-employee-sync\/","title":{"rendered":"Integration Partner- Employee Sync"},"content":{"rendered":"\n<p>\n  Under Employee Sync, user can\n<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>View Configurations and set default settings<br>      <\/li>\n\n\n\n<li>Test Department Interface<br>      <\/li>\n\n\n\n<li>Test Employee Interface<br>      <\/li>\n\n\n\n<li>Run Employee Interface<br>      <\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading has-blue-color has-text-color has-link-color wp-elements-27dd66e166cda3eb774903128e855a9e\">View Configuration<\/h2>\n\n\n\n<p>\n  View Configuration allows user to view the all configurations- Work rule, Period Selection, Holiday Group, Accrual Group, and ESS Group. \n<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1911\" height=\"913\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-41.png\" alt=\"A screenshot of a computer\n\nAI-generated content may be incorrect.\" class=\"wp-image-6590\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-41.png 1911w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-41-300x143.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-41-1024x489.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-41-768x367.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-41-50x24.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-41-1536x734.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-41-60x29.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-41-100x48.png 100w\" sizes=\"auto, (max-width: 1911px) 100vw, 1911px\" \/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Default Settings<\/h3>\n\n\n\n<p>\n  If user has not set the configuration, it will show a warning message for the configurations that are not set. User can click on the gear icon to set the default settings.\n<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1919\" height=\"927\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-42.png\" alt=\"A screenshot of a computer\n\nAI-generated content may be incorrect.\" class=\"wp-image-6592\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-42.png 1919w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-42-300x145.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-42-1024x495.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-42-768x371.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-42-50x24.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-42-1536x742.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-42-60x29.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-42-100x48.png 100w\" sizes=\"auto, (max-width: 1919px) 100vw, 1919px\" \/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p><strong>Set Default Settings:<\/strong>\n<\/p>\n\n\n\n<p>\n  To set default settings, user\n<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Clicks on the \u201c<strong>View Configuration<\/strong>\u201d button<br>    <\/li>\n\n\n\n<li>Clicks on the <strong>gear icon<\/strong> <br>    <\/li>\n\n\n\n<li>Clicking on gear icon will open the \u201c<strong>Default Settings<\/strong>\u201d side drawer.<br>    <\/li>\n\n\n\n<li>User can select the settings for each group from the drop-down menu.<br>    <\/li>\n\n\n\n<li>Clicking on \u201c<strong>Save<\/strong>\u201d will update the default settings for the groups.<br>    <\/li>\n<\/ul>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1917\" height=\"909\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-43.png\" alt=\"A screenshot of a computer\n\nAI-generated content may be incorrect.\" class=\"wp-image-6594\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-43.png 1917w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-43-300x142.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-43-1024x486.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-43-768x364.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-43-50x24.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-43-1536x728.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-43-60x28.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-43-100x47.png 100w\" sizes=\"auto, (max-width: 1917px) 100vw, 1917px\" \/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<h2 class=\"wp-block-heading has-blue-color has-text-color has-link-color wp-elements-294b99b82fb007ab8a75253b26f84872\">Test Department Interface<\/h2>\n\n\n\n<p>\n  When user clicks on \u201cTest Department Interface\u201d, it fetches the list of all departments including child departments and show the tree structure to the user. \n<\/p>\n\n\n\n<p>\n  Follow the below steps to Test Department Interface\n<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Navigate to the <strong>Integration Partner<\/strong> option under Admin menu.<br><\/li>\n\n\n\n<li>Select a <strong>Provider<\/strong> <strong>name<\/strong> from the Provider drop-down menu.<br><\/li>\n\n\n\n<li>Employee Sync tab is Auto Selected.<br><\/li>\n\n\n\n<li>Click on &#8220;<strong>Test Department Interface<\/strong>&#8220;<br><\/li>\n\n\n\n<li>This displays a preview of the department structure available from the selected provider.<br><\/li>\n\n\n\n<li>View Department Tree Structure<br><\/li>\n\n\n\n<li>A tree view appears, displaying the main departments along with any child departments. <br><\/li>\n<\/ol>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1901\" height=\"876\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-44.png\" alt=\"A screenshot of a computer\n\nAI-generated content may be incorrect.\" class=\"wp-image-6596\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-44.png 1901w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-44-300x138.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-44-1024x472.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-44-768x354.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-44-50x23.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-44-1536x708.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-44-60x28.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-44-100x46.png 100w\" sizes=\"auto, (max-width: 1901px) 100vw, 1901px\" \/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p><strong><em>NOTE: <\/em><\/strong>\n<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong><em>When user run \u201cTest Department Interface\u201d, it only fetches the list of departments, not store them in the database. To save the departments in the system, user must click on \u201cTest Employee Interface\u201d.<\/em><\/strong><br><\/li>\n\n\n\n<li><strong><em>If the \u201cAutoCreateDepartment\u201d setting is set to False in the XML file, a clear message should be displayed to the user, and the department tree view should not be shown.<\/em><\/strong><br><\/li>\n<\/ol>\n\n\n\n<h2 class=\"wp-block-heading has-blue-color has-text-color has-link-color wp-elements-957397b84fb5084ddc7010aec758b8e3\">Test Employee Interface<\/h2>\n\n\n\n<p>\n  Button \u201cTest Employee Interface\u201d allows user to view the employee information along with employee sync errors (if any). User  can view the employee information grid.\n<\/p>\n\n\n\n<p>\n  Follow the below steps to Test Employee Interface\n<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Navigate to the <strong>Integration Partner<\/strong> option under Admin menu.<br><\/li>\n\n\n\n<li>Select a <strong>Provider name<\/strong> from the Provider drop-down menu.<br><\/li>\n\n\n\n<li>Employee Sync tab is Auto Selected.<br><\/li>\n\n\n\n<li>Click on &#8220;<strong>Test Employee Interface<\/strong>&#8220;<br><\/li>\n\n\n\n<li>This displays a grid with employee information along with employee sync errors (if any).<br><\/li>\n\n\n\n<li>It will also display the summary of employee sync above the grid which includes total records and total records with errors.<br><\/li>\n<\/ol>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1483\" height=\"898\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-45.png\" alt=\"A screenshot of a computer\n\nAI-generated content may be incorrect.\" class=\"wp-image-6598\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-45.png 1483w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-45-300x182.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-45-1024x620.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-45-768x465.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-45-50x30.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-45-60x36.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/a-screenshot-of-a-computer-ai-generated-content-m-45-100x61.png 100w\" sizes=\"auto, (max-width: 1483px) 100vw, 1483px\" \/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p><strong><em>NOTE: <\/em><\/strong>\n<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong><em>When the Test Employee Interface is clicked (after running the interface), the API will return the LastChangedDate along with a message to be displayed on the UI.<\/em><\/strong><br><\/li>\n\n\n\n<li><strong><em>If the system setting \u201cEmployeeSync.ShowDifferencesInPreview\u201d is enabled, an additional column should be shown to highlight the differences, displaying both the previous and updated values.<\/em><\/strong><br><\/li>\n\n\n\n<li><strong><em>Test Employee interface saves the departments in the system (provided the AutoCreateDepartments setting is set to true in the XML). These departments are then used to assign the home department for incoming employees. However, employees will be saved in the system only after user clicks on the \u201cRun Employee Interface\u201d.<\/em><\/strong><br><\/li>\n<\/ol>\n\n\n\n<h2 class=\"wp-block-heading\">Run Employee Interface<\/h2>\n\n\n\n<p>Button \u201cRun Employee Interface\u201d allows user to import &nbsp;the employees in the system.<\/p>\n\n\n\n<p>Follow the below steps to Run Employee Interface<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Navigate to the <strong>Integration Partner<\/strong> option under Admin menu.<\/li>\n\n\n\n<li>Select a <strong>Provider name<\/strong> from the Provider drop-down menu.<\/li>\n\n\n\n<li>Employee Sync tab is Auto Selected.<\/li>\n\n\n\n<li>Click on &#8220;<strong>Run Employee Interface<\/strong>&#8220;<\/li>\n\n\n\n<li>It will show a confirmation dialog, click on \u201c<strong>Run<\/strong>\u201d<\/li>\n\n\n\n<li>It will display the summary of employee sync \u2013 Total imported, ignored and with errors.<\/li>\n<\/ol>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1178\" height=\"732\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.08.49-AM.png\" alt=\"\" class=\"wp-image-6608\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.08.49-AM.png 1178w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.08.49-AM-300x186.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.08.49-AM-1024x636.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.08.49-AM-768x477.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.08.49-AM-50x31.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.08.49-AM-60x37.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.08.49-AM-100x62.png 100w\" sizes=\"auto, (max-width: 1178px) 100vw, 1178px\" \/><\/figure>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1184\" height=\"644\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.09.14-AM.png\" alt=\"\" class=\"wp-image-6610\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.09.14-AM.png 1184w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.09.14-AM-300x163.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.09.14-AM-1024x557.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.09.14-AM-768x418.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.09.14-AM-50x27.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.09.14-AM-60x33.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2025\/04\/Screenshot-2025-04-29-at-10.09.14-AM-100x54.png 100w\" sizes=\"auto, (max-width: 1184px) 100vw, 1184px\" \/><\/figure>\n\n\n\n<p><strong><em>NOTE: &nbsp;\u201cRun Employee interface\u201d saves the employees info in the system.<\/em><\/strong><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Under Employee Sync, user can View Configuration View Configuration allows user to view the all configurations- Work rule, Period Selection, Holiday Group, Accrual Group, and ESS Group. Default Settings If user has not set the configuration, it will show a warning message for the configurations that are not set. User&#8230;<\/p>\n","protected":false},"author":4,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"ht-kb-category":[280],"ht-kb-tag":[215,116],"class_list":["post-6589","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-integration-partner","ht_kb_tag-admin","ht_kb_tag-mss"],"_links":{"self":[{"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb\/6589","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/comments?post=6589"}],"version-history":[{"count":1,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb\/6589\/revisions"}],"predecessor-version":[{"id":6612,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb\/6589\/revisions\/6612"}],"wp:attachment":[{"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/media?parent=6589"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb-category?post=6589"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb-tag?post=6589"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}