|
| 1 | +--- |
| 2 | +name: help-case |
| 3 | +description: Routes an HR question to the right help case type in Workday, prepares the case for approval, and prepares a comment on an existing case, with a clickable link when one is needed. Use when someone has a payslip, manager-of-record, benefits or similar HR question that needs a person, or wants to add a comment to a case. Do not use to answer policy from memory or to decide a case. |
| 4 | +--- |
| 5 | + |
| 6 | +# Help case |
| 7 | + |
| 8 | +Find the right case type, write the case or the comment, and let the person approve it. |
| 9 | + |
| 10 | +## Decision |
| 11 | + |
| 12 | +| Request | Workday operation | Notes | |
| 13 | +| --- | --- | --- | |
| 14 | +| Pick the case type | REST helpCase/v4 `GET /serviceCategories` | Categories, each with its case types | |
| 15 | +| File the case | REST helpCase/v4 `POST /cases` | `caseType.id`, `title`, `detailedMessage`. Sent only after approval | |
| 16 | +| Confirm it was filed | REST helpCase/v4 `GET /cases/{ID}` | Compare the title read back, give the person `caseID` and `caseLink` | |
| 17 | +| Read what happened on a case | REST helpCase/v4 `GET /cases/{ID}/timeline` | Creation, status changes, comments and notes | |
| 18 | +| Add a comment | REST helpCase/v4 `POST /cases/{ID}/comment` | Body is `comment.textBody` or `comment.content`, never both | |
| 19 | + |
| 20 | +## Comment bodies |
| 21 | + |
| 22 | +A comment is plain text or rich text. Workday refuses a request that carries both. |
| 23 | + |
| 24 | +Plain text. Workday stores it as written, so an address or an HTML tag in it is shown as text and is not clickable: |
| 25 | + |
| 26 | +```json |
| 27 | +{ "comment": { "textBody": "Your enrolment window is open until Friday." } } |
| 28 | +``` |
| 29 | + |
| 30 | +Rich text. `content` is a string that holds a JSON document: paragraphs of text nodes, where a link is a `link` mark on the text node. Workday derives `textBody` from it: |
| 31 | + |
| 32 | +```json |
| 33 | +{ |
| 34 | + "comment": { |
| 35 | + "content": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"You can read the plan details here: \"},{\"type\":\"text\",\"text\":\"https://example.com/benefits\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://example.com/benefits\",\"title\":\"https://example.com/benefits\"}}]}]}]}" |
| 36 | + } |
| 37 | +} |
| 38 | +``` |
| 39 | + |
| 40 | +The text of the link node must be the address itself. The case page builds the link from that text, not from `href`: a node whose text is "Benefits page" is drawn as a link that leads nowhere useful. So put the label in an ordinary text node before the link, as above. |
| 41 | + |
| 42 | +Build the document as an object and serialise it. Do not write the escaped string by hand. |
| 43 | + |
| 44 | +## Hard rules |
| 45 | + |
| 46 | +- Do not answer policy questions from memory. If the question needs a policy answer, offer to file a case. |
| 47 | +- Choose the case type from the categories Workday returns. If two fit, ask. If none fits, say so. Never invent a case type ID. |
| 48 | +- The title needs at least 5 characters and the description at least a full sentence. Keep the title to 200 characters and the description to 4,000. |
| 49 | +- Do not put health details, government identifiers or bank details in the case text or a comment. Ask the person to keep those for the HR team. |
| 50 | +- A case filed through an integration account is recorded by Workday with the source "Integration" and for the worker that account belongs to. The case text must name the person it is really for. Say this in the proposal. |
| 51 | +- A link in a comment comes from the person or from a Workday read in this conversation. Never invent an address. The address is shown in full as the link text, so never try to hide it behind a label. |
| 52 | +- A case and a comment are proposals until approved. Never say either was sent before then. A comment can move a case from New to In Progress, so say that too. |
| 53 | +- If Workday or your approval step refuses, explain in one plain sentence and never try to get round the refusal. |
| 54 | + |
| 55 | +## Output format |
| 56 | + |
| 57 | +A proposal card. For a case: case type in plain words, title, description, and who it is for. For a comment: the case number and title, the comment text, and any link with its full address. |
| 58 | + |
| 59 | +## Test questions |
| 60 | + |
| 61 | +- "I have a question about my payslip." |
| 62 | +- "My manager changed and Workday still shows the old one." |
| 63 | +- "Add a comment to my benefits case with a link to the enrolment page." |
| 64 | +- "Close all the open cases for my team." |
0 commit comments