מדיניות AssignMessage

תחביר

הרכיב <AssignMessage> משתמש בתחביר הבא:

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <!-- All AssignMessage child elements are optional -->
  <Add>
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Add>

  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">destination_variable_name</AssignTo>

  <AssignVariable>
    <Name>variable_name</Name>
    <Ref>source_variable</Ref>
    <Template>message_template</Template>
    or
    <Template ref='template_variable'></Template>
    <Value>variable_value</Value>
  </AssignVariable>

  <Copy source="[request|response]">
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <Path>[false|true]</Path>
    <Payload>[false|true]</Payload>
    <!-- Can also be an empty array (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
    <ReasonPhrase>[false|true]</ReasonPhrase>
    <StatusCode>[false|true]</StatusCode>
    <Verb>[false|true]</Verb>
    <Version>[false|true]</Version>
  </Copy>

  <DisplayName>policy_display_name</DisplayName>

  <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>

  <Remove>
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <Payload>[false|true]</Payload>
    <!-- Can also be an empty array (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Remove>

  <Set>
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <Path>path</Path>
    <Payload contentType="content_type" variablePrefix="prefix"
        variableSuffix="suffix">new_payload</Payload>
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
    <ReasonPhrase>reason_for_error or {variable}</ReasonPhrase>
    <StatusCode>HTTP_status_code or {variable}</StatusCode>
    <Verb>[GET|POST|PUT|PATCH|DELETE|{variable}]</Verb>
    <Version>[1.0|1.1|{variable}]</Verb>
  </Set>

</AssignMessage>

מדיניות ברירת המחדל

הדוגמה הבאה מציגה את הגדרות ברירת המחדל כשמוסיפים מדיניות AssignMessage בממשק המשתמש של Edge:

<AssignMessage continueOnError="false" enabled="true" name="assign-message-default">
  <DisplayName>Assign Message-1</DisplayName>
  <Properties/>
  <Copy source="request">
    <Headers/>
    <QueryParams/>
    <FormParams/>
    <Payload/>
    <Verb/>
    <StatusCode/>
    <ReasonPhrase/>
    <Path/>
  </Copy>
  <Remove>
    <Headers>
      <Header name="h1"/>
    </Headers>
    <QueryParams>
      <QueryParam name="q1"/>
    </QueryParams>
    <FormParams>
      <FormParam name="f1"/>
    </FormParams>
    <Payload/>
  </Remove>
  <Add>
    <Headers/>
    <QueryParams/>
    <FormParams/>
  </Add>
  <Set>
    <Headers/>
    <QueryParams/>
    <FormParams/>
    <!-- <Verb>GET</Verb> -->
    <Path/>
  </Set>
  <AssignVariable>
    <Name>name</Name>
    <Value/>
    <Ref/>
  </AssignVariable>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

כשמוסיפים מדיניות AssignMessage חדשה לממשק המשתמש של Edge, התבנית מכילה stubs לכל פעולות אפשריות. בדרך כלל, אתה בוחר אילו פעולות ברצונך לבצע עם המדיניות הזו ומסירים את שאר הרכיבים של הצאצא. לדוגמה, כדי לבצע פעולת העתקה, השתמשו <Copy> ולהסיר את <Add>, <Remove> ורכיבי צאצא אחרים כדי להפוך אותה לקריאה יותר.

1: הוספת כותרת

הדוגמה הבאה מוסיפה כותרת לבקשה עם המאפיין רכיב <Add>:

<AssignMessage continueOnError="false" enabled="true" name="add-headers-1">
  <Add>
    <Headers>
      <Header name="user-agent">{request.user.agent}</Header>
    </Headers>
  </Add>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

2: הסרת מטען ייעודי (payload)

בדוגמה הבאה נמחק המטען הייעודי (Payload) מהתשובה עם <Remove>. רכיב:

<AssignMessage continueOnError="false" enabled="true" name="remove-1">
  <DisplayName>remove-1</DisplayName>
  <Remove>
    <Payload>true</Payload>
  </Remove>
  <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

3: שינוי התשובה

הדוגמה הבאה משנה אובייקט תשובה קיים על ידי הוספת כותרת אליו:

<AssignMessage name="modify-response">
  <Set>
    <Headers>
      <Header name="Cache-Hit">{lookupcache.LookupCache-1.cachehit}</Header>
    </Headers>
  </Set>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" type="response"></AssignTo>
</AssignMessage>

בדוגמה הזו לא נוצרת הודעה חדשה. במקום זאת, הוא משנה הודעת תגובה קיימת על ידי הוספת כותרת HTTP.

כי בדוגמה הזו לא מופיע שם משתנה ברכיב <AssignTo>, ומציין type כ'תגובה', המדיניות הזו משנה את אובייקט התגובה שמוחזר על ידי היעד השרת.

כותרת ה-HTTP שנוספה להודעת התגובה באמצעות המדיניות הזו נגזרת ממשתנה מאוכלס על ידי המדיניות LookupCache. לכן הודעת התשובה שונתה על ידי מדיניות הקצאת ההודעות מכילה כותרת HTTP שמציינת אם התוצאות שנשלפה מהמטמון או לא. הגדרת כותרות בתגובה יכולה להיות שימושית לניפוי באגים לפתרון בעיות.

4: הגדרת תוכן דינמי

תוכלו להשתמש ב'הקצאת הודעה' כדי להטמיע תוכן דינמי במטען הייעודי (payload) של התגובה. הודעות בקשה.

כדי להטמיע משתני זרימה של Edge במטען ייעודי (payload) של XML, צריך לארוז את המשתנה הייעודי בצורת מסולסל סוגריים מסולסלים, כמו: {prefix.name}.

בדוגמה הבאה מוטמע הערך של משתנה הזרימה של כותרת ה-HTTP user-agent ברכיב XML בשם User-agent:

<AssignMessage name="set-dynamic-content">
  <AssignTo createNew="false" type="response"></AssignTo>
  <Set>
    <Payload contentType="text/xml">
      <User-agent>{request.header.user-agent}</User-agent>
    </Payload>
  </Set>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</AssignMessage>

במטענים ייעודיים (payloads) של JSON, אפשר להוסיף משתנים באמצעות variablePrefix ו מאפייני variableSuffix עם תווים מפרידים כמו שמתואר בהמשך דוגמה:

<AssignMessage name="set-payload">
  <Payload contentType="application/json" variablePrefix="@" variableSuffix="#">
  {
     "user-agent": "@request.header.user-agent#"
  }
  </Payload>
</AssignMessage>

רשימה מלאה של משתני הזרימה זמינה בחומר העזר בנושא משתני זרימה.

החל מגרסה 16.08.17 של ענן אפשר גם להשתמש בסוגריים מסולסלים כדי להוסיף משתנים.

5: הסרת פרמטר שאילתה

הדוגמה הבאה מסירה את פרמטר השאילתה apikey מהבקשה:

<AssignMessage name="remove-query-param">
  <Remove>
    <QueryParams>
      <QueryParam name="apikey"/>
    </QueryParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

מומלץ להסיר מהבקשה את פרמטר השאילתה apikey כאשר משתמשים במדיניות VerifyAPIKey לצורך אימות משתמשים. עושים זאת כדי למנוע מידע רגיש חשוב מהעברה ליעד העורפי.

6: הגדרה/אחזור של משתנים

הדוגמה הבאה משתמשת בשלושה כללי מדיניות של הקצאת הודעות:

1. יצירת שלושה משתני זרימה בבקשה, עם ערכים סטטיים
2. קבלה של משתני הזרימה באופן דינמי במדיניות שנייה בתהליך הבקשה
3. מגדיר אותן במטען הייעודי (payload) של התשובה.

<!-- Policy #1: Set variables in the request -->
<AssignMessage continueOnError="false" enabled="true" name="set-variables">
    <!-- Create a variable named myAppSecret -->
    <AssignVariable>
        <Name>myAppSecret</Name>
        <Value>42</Value>
    </AssignVariable>
    <!-- Create a variable named config.environment -->
    <AssignVariable>
        <Name>config.environment</Name>
        <Value>test</Value>
    </AssignVariable>
    <!-- Create a variable named config.protocol -->
    <AssignVariable>
        <Name>config.protocol</Name>
        <Value>gopher</Value>
    </AssignVariable>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

במדיניות הראשונה, הרכיב <AssignVariable> יוצר ומגדיר שלושה מהמשתנים בבקשה. כל רכיב <Name> מציין שם של משתנה, והמשתנה <Value> מציין את הערך.

המדיניות השנייה משתמשת ברכיב <AssignVariable> כדי לקרוא את הערכים, ויוצרת שלושה משתנים חדשים:

<!-- Policy #2: Get variables from the request -->
<AssignMessage continueOnError="false" enabled="true" name="get-variables">
  <AssignTo createNew="false" transport="http" type="request"/>
  <!-- Get the value of myAppSecret and create a new variable, secret -->
  <AssignVariable>
    <Name>secret</Name>
    <Ref>myAppSecret</Ref>
    <Value>0</Value>
  </AssignVariable>
  <!-- Get the value of config.environment and create a new variable, environment -->
  <AssignVariable>
    <Name>environment</Name>
    <Ref>config.environment</Ref>
    <Value>default</Value>
  </AssignVariable>
  <!-- Get the value of config.protocol and create a new variable, protocol -->
  <AssignVariable>
    <Name>protocol</Name>
    <Ref>config.protocol</Ref>
    <Value>default</Value>
  </AssignVariable>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</AssignMessage>

במדיניות השנייה, הרכיב <Ref> מפנה למשתנה המקור, ו-<Name> מציינים את השמות של המשתנים החדשים. אם המשתנה אין הפניה לרכיב <Ref>, אפשר להשתמש בערך שצוין על ידי הרכיב <Value>.

כדי לנסות את קבוצת כללי המדיניות הזו:

1. מוסיפים את מדיניות 1 ו-2 לתהליך הבקשה. חשוב להוסיף את מדיניות מספר 1 לפני המדיניות 2.
2. מוסיפים את המדיניות השלישית בתהליך התגובה.
3. המדיניות השלישית משתמשת ברכיב <Set> כדי להוסיף את המשתנים לתשובה. בדוגמה הבאה בונים מטען ייעודי (payload) של XML בתגובה ש-Edge מחזיר ללקוח:

   <!-- Policy #3: Add variables to the response -->
   <AssignMessage continueOnError="false" enabled="true" name="put-em-in-the-payload">
     <DisplayName>put-em-in-the-payload</DisplayName>
     <Set>
       <Payload contentType="application/xml">
         <wrapper>
           <secret>{secret}</secret>
           <config>
             <environment>{environment}</environment>
             <protocol>{protocol}</protocol>
           </config>
         </wrapper>
       </Payload>
     </Set>
     <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
     <AssignTo createNew="false" transport="http" type="response"/>
   </AssignMessage>
   

   חשוב לשים לב שהתחביר לגישה למשתני זרימה ב-<Set> צריך לכלול אותם בסוגריים מסולסלים.

   חשוב להגדיר את המאפיין contentType של הרכיב <Payload> כך: 'application/xml'.

4. לשלוח בקשה לשרת ה-proxy ל-API. לדוגמה:

   curl -vL https://ahamilton-eval-test.apigee.net/myproxy

   לחלופין, ניתן להעביר את התוצאות דרך כלי שירות כמו xmllint, ה-XML מוצג במבנה תקין:

   curl -vL https://ahamilton-eval-test.apigee.net/myproxy | xmllint --format -

   גוף התגובה אמור להיראות כך:

   <wrapper>
     <secret>42</secret>
     <config>
       <environment>test</environment>
       <protocol>gopher</protocol>
     </config>
   </wrapper>

7: קבלת כותרות תגובה של יתרונות מרכזיים לשירות

בדוגמה הבאה, נניח שמדיניות ServiceCallout נמצאת בבקשה לשרת ה-proxy ל-API: ותגובת היתרונות המרכזיים מכילה כמה כותרות עם אותו שם. (Set-Cookie). בהנחה שמשתנה התגובה של נכס היתרונות המרכזיים הוא ברירת המחדל calloutResponse, המדיניות הבאה מקבלת את Set-Cookie השני ערך הכותרת.

<AssignMessage continueOnError="false" enabled="true" name="get-header">
  <Set>
    <Payload contentType="application/json">
      {"Cookies from Service Callout":" {calloutResponse.header.Set-Cookie.2}"}
    </Payload>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

כדי להציג רשימה של כל ערכי הכותרות, משתמשים במשתנה הבא במקום זאת:

{calloutResponse.header.Set-Cookie.values}

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Add>
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Add>
</AssignMessage>

דוגמה 1

בדוגמה הבאה נעשה שימוש ברכיב <FormParams> כדי לקבל את הערכים של שלושה פרמטרים של מחרוזת שאילתה מהבקשה הראשונית ולהגדיר אותם כפרמטרים של טופס בקשה לנקודת קצה (endpoint):

<AssignMessage continueOnError="false" enabled="true" name="add-formparams-3">
  <Add>
    <FormParams>
      <FormParam name="name">{request.queryparam.name}</FormParam>
      <FormParam name="zip">{request.queryparam.zipCode}</FormParam>
      <FormParam name="lang">{request.queryparam.lang}</FormParam>
    </FormParams>
  </Add>
  <AssignTo transport="http" type="request"/>
</AssignMessage>

דוגמה 2

בדוגמה הבאה נשתמש ברכיב <Headers> כדי להוסיף את הרכיב הכותרת User-Agent לבקשת היעד של נקודת הקצה:

<AssignMessage continueOnError="false" enabled="true" name="add-headers-1">
  <Add>
    <Headers>
      <Header name="user-agent">{request.user.agent}</Header>
    </Headers>
  </Add>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

דוגמה 3

הדוגמה הבאה משתמשת ברכיב <QueryParams> כדי להוסיף שאילתה יחידה עם ערך סטטי לבקשה:

<AssignMessage continueOnError="false" enabled="true" name="add-queryparams-1">
  <Add>
    <QueryParams>
      <QueryParam name="myParam">42</QueryParam>
    </QueryParams>
  </Add>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

בדוגמה הזו נעשה שימוש ב-<Add> בתהליך המקדים של הבקשה. אם בוחנים את התוצאות בכלי כמו כלי המעקב, הבקשה ל-"http://httpbin.org/get" הופך ל- "http://httpbin.org/get?myParam=42".

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Add>
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">destination_variable_name</AssignTo>
  </Add>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מוסיפה פרמטר טופס יחיד ("answer") וערך סטטי ('42') ל- הבקשה:

<AssignMessage continueOnError="false" enabled="true" name="add-formparams-1">
  <Add>
    <FormParams>
      <FormParam name="answer">42</FormParam>
    </FormParams>
  </Add>
  <AssignTo transport="http" type="request"></AssignTo>
</AssignMessage>

דוגמה 2

הדוגמה הבאה מקבלת את הערך של הפרמטר name של מחרוזת השאילתה ו מוסיף אותו לבקשה כפרמטר של טופס:

<AssignMessage continueOnError="false" enabled="true" name="add-formparams-2">
  <Add>
    <FormParam name="name">{request.queryparam.name}</FormParam>
  </Add>
</AssignMessage>

שימו לב שבדוגמה הזו לא צוין יעד עם <AssignTo>. המדיניות הזו מוסיפה את המדיניות לבקשה בלבד.

דוגמה 3

הדוגמה הבאה מוסיפה לבקשה כמה פרמטרים של טופס:

<AssignMessage continueOnError="false" enabled="true" name="add-formparams-3">
  <Add>
    <FormParams>
      <FormParam name="name">{request.queryparam.name}</FormParam>
      <FormParam name="zip">{request.queryparam.zipCode}</FormParam>
      <FormParam name="lang">{request.queryparam.lang}</FormParam>
    </FormParams>
  </Add>
  <AssignTo transport="http" type="request"/>
</AssignMessage>

בדוגמה הזו מקבלים את הפרמטרים של מחרוזת השאילתה מבקשת המקור ומוסיפה אותם בתור פרמטרים של טופס לבקשה שנשלחה לנקודת הקצה של היעד.

אתם יכולים להשתמש בכלי המעקב כדי לבחון את הזרימה. גוף הבקשה יופיע מכיל את נתוני הטופס בקידודי תווים שמתאימים לכתובות URL, שהועברו במקור כמחרוזת שאילתה :

%7Busername%7D=nick&%7Bzip_code%7D=90210&%7Bdefault_language%7D=en

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Add>
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
  </Add>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מוסיפה את הכותרת user-agent להודעת הבקשה, ו- מקצה את הערך של משתנה הזרימה request.user.agent לכותרת הזו.

<AssignMessage continueOnError="false" enabled="true" name="add-headers-1">
  <Add>
    <Headers>
      <Header name="user-agent">{request.user.agent}</Header>
    </Headers>
  </Add>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Add>
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Add>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מוסיפה את פרמטר השאילתה "myParam" לבקשה ומקצה את הערך '42' אליו:

<AssignMessage continueOnError="false" enabled="true" name="add-queryparams-1">
  <Add>
    <QueryParams>
      <QueryParam name="myParam">42</QueryParam>
    </QueryParams>
  </Add>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">destination_variable_name</AssignTo>
</AssignMessage>

דוגמה 1

בדוגמה הבאה היעד הוא הבקשה המקורית שתישלח אל נקודת קצה ליעד:

<AssignMessage name="assignto-1">
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

על ידי הגדרת הערך של createNew ל-"false" (ברירת המחדל), הדוגמה הזו לא יוצרת בקשה חדשה. כל הפעולות במדיניות הזו משפיעות על הבקשה המקורית.

דוגמה 2

הדוגמה הבאה יוצרת אובייקט בקשה חדש:

<AssignMessage name="assignto-2">
  <AssignTo createNew="true" transport="http" type="request"/>
</AssignMessage>

כשיוצרים בקשה או אובייקט תשובה חדשים, הרכיבים האחרים של מדיניות AssignMessage (כמו <Add>, <Set> ו-<Set>) תפעל בהתאם של בקשת אובייקט.

אפשר לגשת לאובייקט הבקשה החדש בכללי מדיניות אחרים בשלב מאוחר יותר בתהליך, או לשלוח את האובייקט החדש לבקש אובייקט לשירות חיצוני באמצעות מדיניות ServiceCallout.

דוגמה 3

הדוגמה הבאה יוצרת אובייקט בקשה חדש בשם "MyRequestObject":

<AssignMessage name="assignto-2">
  <AssignTo createNew="true" transport="http" type="request"&gt;MyRequestObject&lt;/AssignTo>
</AssignMessage>

כשיוצרים בקשה או אובייקט תשובה חדשים, הרכיבים האחרים של מדיניות AssignMessage (כמו <Add>, <Set> ו-<Set>) תפעל בהתאם של בקשת אובייקט.

אפשר לגשת לאובייקט הבקשה החדש בכללי מדיניות אחרים בשלב מאוחר יותר בתהליך, או לשלוח את האובייקט החדש לבקש אובייקט לשירות חיצוני באמצעות מדיניות ServiceCallout.

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignVariable>
    <Name>variable_name</Name>
    <Ref>source_variable</Ref>
    <Template>message_template</Template>
    or
    <Template ref='template_variable'></Template>
    <Value>variable_value</Value>
  </AssignVariable>
</AssignMessage>

משתמשים ברכיב <Ref> כדי לציין את משתנה המקור. אם אין גישה למשתנה שהפנייה <Ref> מפנה אליו, Edge משתמש בערך שצוין על ידי הרכיב <Value>. אם תגדיר <Template>, הוא מקבל עדיפות על פני רכיבי הצאצא האחרים.

דוגמה 1

בדוגמה הבאה נקבע הערך של משתנה חדש, myvar, כליטרל. ערך "42":

<AssignMessage name="assignvariable-1">
  <AssignVariable>
    <Name>myvar</Name>
    <Value>42</Value>
  </AssignVariable>
</AssignMessage>

דוגמה 2

הדוגמה הבאה מקצה את הערך של משתנה הזרימה request.header.user-agent למשתנה של תהליך היעד myvar והערך של פרמטר השאילתה country למשתנה זרימת היעד Country:

<AssignMessage name="assignvariable-2">
  <AssignVariable>
    <Name>myvar</Name>
    <Ref>request.header.user-agent</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
  <AssignVariable>
    <Name>Country</Name>
    <Ref>request.queryparam.country</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
</AssignMessage>

אם אחת מההקצאות נכשלה, Edge יקצה את הערך 'ErrorOnCopy' במקום זאת. אל משתנה של זרימת יעד.

אם משתני הזרימה myvar או Country לא קיימים, <AssignVariable> יוצר אותן.

דוגמה 3

הדוגמה הבאה משתמשת בפונקציה <Template> רכיב צאצא כדי לשרשר שני משתני הקשר עם מחרוזת מילולית (מקף) ביניהן:

<AssignMessage name='template-1'>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignVariable>
    <Name>my_destination_variable</Name>
    <Value>BADDBEEF</Value>
    <Template>{system.uuid}-{messageid}</Template>
  </AssignVariable>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignVariable>
    <Name>variable_name</Name>
  </AssignVariable>
</AssignMessage>

דוגמה 1

בדוגמה הבאה משתנה היעד כ-myvar ומגדיר אותו. לליטרל "42":

<AssignMessage name="assignvariable-1">
  <AssignVariable>
    <Name>myvar</Name>
    <Value>42</Value>
  </AssignVariable>
</AssignMessage>

אם myvar לא קיים, <AssignVariable> יוצר אותו.

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignVariable>
    <Name>variable_name</Name>
    <Ref>source_variable</Ref>
  </AssignVariable>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מקצה את הערך של משתנה הזרימה request.header.user-agent למשתנה myvar של זרימת היעד הערך של פרמטר השאילתה country למשתנה Country:

<AssignMessage name="assignvariable-4">
  <AssignVariable>
    <Name>myvar</Name>
    <Ref>request.header.user-agent</Ref>
  </AssignVariable>
  <AssignVariable>
    <Name>Country</Name>
    <Ref>request.queryparam.country</Ref>
  </AssignVariable>
</AssignMessage>

בדוגמה הזו, לא צוין ערך ברירת מחדל (או ערך חלופי) ל-Edge מטלות.

דוגמה 2

הדוגמה הבאה מקצה את הערך של משתנה הזרימה request.header.user-agent למשתנה 'נתיב יעד' myvar ולערך של פרמטר השאילתה country למשתנה Country:

<AssignMessage name="assignvariable-2">
  <AssignVariable>
    <Name>myvar</Name>
    <Ref>request.header.user-agent</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
  <AssignVariable>
    <Name>Country</Name>
    <Ref>request.queryparam.country</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
</AssignMessage>

בדוגמה הזו, אם הערכים של משתנה הזרימה request.header.user-agent או שפרמטר השאילתה Country ריק, לא קריא או לא תקין, Edge מקצה הערך 'ErrorOnCopy' למשתנים החדשים.

דוגמה 3

תרחיש נפוץ לדוגמה של <AssignVariable> הוא הגדרת ערך ברירת המחדל של שאילתה פרמטר, כותרת או ערך אחר שניתן להעביר עם הבקשה. לדוגמה, ניתן ליצור שרת Proxy של weather API שבו הבקשה לוקחת פרמטר שאילתה יחיד שנקרא 'w'. הזה מכיל את מזהה העיר שבה רוצים לקבל את מזג האוויר. כתובת ה-URL של הבקשה כוללת הטופס:

http://myCO.com/v1/weather/forecastrss?w=city_ID

כדי להגדיר ערך ברירת מחדל ל-'w', יוצרים מדיניות AssignMessage כמו הבאים:

<AssignMessage continueOnError="false" enabled="true" name="assignvariable-3">
  <AssignTo createNew="false" transport="http" type="request"/>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignVariable>
    <Name>request.queryparam.w</Name>
    <Ref>request.queryparam.w</Ref>
    <Value>12797282</Value>
  </AssignVariable>
</AssignMessage>

בדוגמה הזו, <AssignVariable> מקבל את הערך של request.queryparam.w ומקצים אותו לעצמו. אם משתנה הזרימה הוא null, כלומר 'w' פרמטר השאילתה היה שהושמט מהבקשה, דוגמה זו משתמשת בערך ברירת המחדל <Value>. לכן אפשר לשלוח בקשה ל-API הזה שרת proxy שמשמיט את ה-W פרמטר של שאילתה:

http://myCO.com/v1/weather/forecastrss

...ועדיין אפשר לגרום ל-Proxy ל-API להחזיר תוצאה חוקית.

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignVariable>
    <Template>message_template</Template>
    or
    <Template ref='template_variable'></Template>
  </AssignVariable>
</AssignMessage>

דוגמה 1

הדוגמה הבאה משתמשת בתחביר של תבניות הודעה כדי לשרשר שני משתני הקשר עם מחרוזת מילולית (מקף) ביניהן:

<AssignMessage name='template-1'>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignVariable>
    <Name>my_destination_variable</Name>
    <Value>BADDBEEF</Value>
    <Template>{system.uuid}-{messageid}</Template>
  </AssignVariable>
</AssignMessage>

דוגמה 2

הדוגמה הבאה מציינת משתנה זרימה, שבו הערך של המשתנה היא תבנית הודעה מוגדרת מראש. משתמשים באפשרות הזו אם רוצים להחדיר תבנית שהוגדרה מראש ללא צורך בשינוי המדיניות:

<AssignMessage name='template-2'>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignVariable>
    <Name>my_destination_variable</Name>
    <Value>BADDBEEF</Value>
    <Template ref='my_template_variable'/>

  </AssignVariable>
</AssignMessage>

דוגמה 3

הדוגמה הבאה מציינת משתנה זרימה וערך טקסט. במקרה הזה, אם המשתנה שאליו מתבצעת ההפניה אינו null, הערך הזה משמש כתבנית. אם ההפניה הערך הוא null, ואז ערך הטקסט (במקרה הזה, {system.uuid}-{messageid}) משמש כתבנית. הדפוס הזה שימושי כדי לציין "ביטול" בערך, כאשר במקרים מסוימים תרצו לשנות את הערכים של תבנית ברירת המחדל (חלק הטקסט) שמוגדרות באופן דינמי. לדוגמה, הצהרה מותנית עשויה להחזיר ערך ממפה של מפתח-ערך, ומגדירים את המשתנה המפנה לערך הזה:

<AssignMessage name='template-2'>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignVariable>
    <Name>my_destination_variable</Name>
    <Value>BADDBEEF</Value>
    <Template ref='my_variable'>{system.uuid}-{messageid}</Template>
  </AssignVariable>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignVariable>
    <Name>variable_name</Name>
    <Value>variable_value</Value>
  </AssignVariable>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מגדירה את הערך של משתנה זרימת היעד, myvar, לליטרל "42":

<AssignMessage name="assignvariable-1">
  <AssignVariable>
    <Name>myvar</Name>
    <Value>42</Value>
  </AssignVariable>
</AssignMessage>

דוגמה 2

הדוגמה הבאה מקצה את הערך של משתנה הזרימה request.header.user-agent למשתנה הזרימה myvar ולערך של פרמטר השאילתה country למשתנה Country:

<AssignMessage name="assignvariable-2">
  <AssignVariable>
    <Name>myvar</Name>
    <Ref>request.header.user-agent</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
  <AssignVariable>
    <Name>Country</Name>
    <Ref>request.queryparam.country</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
</AssignMessage>

אם אחת מההקצאות תיכשל, המערכת של <AssignVariable> תקצה במקום זאת את הערך 'ErrorOnCopy'. אל משתנה של זרימת יעד.

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
    <Copy source="[request|response]">
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <Path>[false|true]</Path>
    <Payload>[false|true]</Payload>
    <!-- Can also be an empty array (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
    <ReasonPhrase>[false|true]</ReasonPhrase>
    <StatusCode>[false|true]</StatusCode>
    <Verb>[false|true]</Verb>
    <Version>[false|true]</Version>
  </Copy>
  <!-- Used as the destination for the <Copy> values -->
  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">destination_variable_name</AssignTo>
</AssignMessage>
  

דוגמה 1

בדוגמה הבאה מתבצעת העתקה של כותרת, שלושה פרמטרים של טופס, הנתיב וכל השאילתות פרמטרים מהבקשה לבקשה חדשה ומותאמת אישית:

<AssignMessage continueOnError="false" enabled="true" name="copy-1">
  <Copy source="request">
    <Headers>
      <Header name="Header_Name_1">Header value 1</Header>
    </Headers>
    <FormParams>
      <FormParam name="Form_Param_Name_1">Form param value 1</FormParam>
      <FormParam name="Form_Param_Name_2">Form param value 1</FormParam>
      <FormParam name="Form_Param_Name_3">Form param value 1</FormParam>
    </FormParams>
    <Payload>false</Payload>
    <Path>true</Path>
    <QueryParams/>
    <ReasonPhrase>false</ReasonPhrase>
    <StatusCode>false</StatusCode>
    <Verb>false</Verb>
    <Version>false</Version>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
  </Copy>
</AssignMessage>

דוגמה 1

בדוגמה הבאה מתבצעת העתקה של פרמטר טופס יחיד מהבקשה אל בקשה מותאמת אישית "MyCustomRequest":

<AssignMessage name="copy-formparams-1">
  <Copy source="request">
    <FormParams>
      <FormParam name="paramName">Form param value 1</FormParam>
    </FormParams>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

דוגמה 2

בדוגמה הבאה מועתקים כל הפרמטרים של הטופס לבקשה המותאמת אישית "MyCustomRequest":

<AssignMessage name="copy-formparams-2">
  <Copy source="request">
    <FormParams/>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

דוגמה 3

בדוגמה הבאה מועתקים שלושה פרמטרים של טופס לבקשה המותאמת אישית "MyCustomRequest":

<AssignMessage name="copy-formparams-3">
  <Copy source="request">
    <FormParams>
      <FormParam name="paramName1"/>
      <FormParam name="paramName2"/>
      <FormParam name="paramName3"/>
    </FormParams>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

דוגמה 4

אם יש כמה פרמטרים של טפסים בעלי שם זהה, משתמשים בתחביר הבא:

<AssignMessage name="copy-formparams-4">
  <Copy source="request">
    <FormParams>
      <FormParam name="f1"/>
      <FormParam name="f2"/>
      <FormParam name="f3.2"/>
    </FormParams>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

בדוגמה הזו מועתקים f1, f2 והערך השני של f3. אם 'f3' יש רק אחד ולאחר מכן הוא לא יועתק.

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
  </Copy>
</AssignMessage>

דוגמה 1

בדוגמה הבאה מתבצעת העתקה של הכותרת user-agent מהבקשה אל אובייקט בקשה חדש בהתאמה אישית:

<AssignMessage name="copy-headers-1">
  <Copy source="request">
    <Headers>
      <Header name="user-agent"/>
    </Headers>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

דוגמה 2

כדי להעתיק את כל הכותרות, צריך להשתמש ברכיב <Headers> ריק, כמו בדוגמה הבאה מציג:

<AssignMessage name="copy-headers-2">
  <Copy source="request">
    <Headers/>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

דוגמה 3

אם יש כמה כותרות עם אותו שם, צריך להשתמש בתחביר הבא:

<AssignMessage name="copy-headers-3">
  <Copy source="request">
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

בדוגמה הזו מתבצעת העתקה של h1, h2 והערך השני של h3. אם 'h3' יש רק אחד ולאחר מכן הוא לא יועתק.

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <Path>[false|true]</Path>
  </Copy>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מציינת שמדיניות AssignMessage צריכה להעתיק את הנתיב מהמקור בקשה לאובייקט הבקשה החדש המותאם אישית:

<AssignMessage name="copy-path-1">
  <Copy source="request">
    <Path>true</Path>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <Payload>[false|true]</Payload>
  </Copy>
</AssignMessage>

דוגמה 1

בדוגמה הבאה הערך של <Payload> מוגדר כ-'true'. כך שהמטען הייעודי (Payload) של הבקשה מועתק מהבקשה לתגובה:

<AssignMessage name="copy-payload-1">
  <Copy source="request">
    <Payload>true</Payload>
  </Copy>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <!-- Can also be an empty array (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Copy>
</AssignMessage>

דוגמה 1

בדוגמה הבאה מעתיקה את 'my_param' של שאילתה מהבקשה לקובץ חדש, אובייקט בקשה בהתאמה אישית:

<AssignMessage name="copy-queryparams-1">
  <Copy source="request">
    <QueryParams>
      <QueryParam name="my_param"/>
    </QueryParams>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

דוגמה 2

בדוגמה הבאה מתבצעת העתקה של כל הפרמטרים של השאילתה מהבקשה למשתנה חדש, אובייקט בקשה:

<AssignMessage name="copy-queryparams-2">
  <Copy source="request">
    <QueryParams/>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

דוגמה 3

אם יש כמה פרמטרים של שאילתות שיש להם את אותו שם, צריך להשתמש בתחביר הבא:

<AssignMessage name="copy-queryparams-3">
  <Copy source="request">
    <QueryParams>
      <QueryParam name="qp1"/>
      <QueryParam name="qp2"/>
      <QueryParam name="qp3.2"/>
    </QueryParams>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

בדוגמה הזו מועתקים qp1, qp2 והערך השני של qp3. אם 'qp3' כולל רק ערך אחד, הוא לא יועתק.

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <ReasonPhrase>[false|true]</ReasonPhrase>
  </Copy>
</AssignMessage>

דוגמה 1

בדוגמה הבאה הערך של <ReasonPhrase> הוא 'true', וכתוצאה מכך <Copy> כדי להעתיק את ביטוי הסיבה מתגובת ברירת המחדל לאובייקט של תשובה מותאמת אישית:

<AssignMessage name="copy-reasonphrase-1">
  <Copy source="response">
    <ReasonPhrase>true</ReasonPhrase>
  </Copy>
  <AssignTo createNew="trie" transport="http" type="response">MyCustomResponse</AssignTo>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <StatusCode>[false|true]</StatusCode>
  </Copy>
</AssignMessage>

דוגמה 1

בדוגמה הבאה הערך של <StatusCode> הוא True, קוד הסטטוס מועתק. מאובייקט התשובה שמוגדר כברירת מחדל לאובייקט תשובה חדש בהתאמה אישית:

<AssignMessage name="copy-statuscode-1">
  <Copy source="response">
    <StatusCode>true</StatusCode>
  </Copy>
  <AssignTo createNew="true" transport="http" type="response">MyCustomResponse</AssignTo>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <Verb>[false|true]</Verb>
  </Copy>
</AssignMessage>

דוגמה 1

בדוגמה הבאה הערך של <Verb> הוא 'true', והפעולה הזו מעתיקה את פועל ברירת מחדל לבקשה חדשה מותאמת אישית:

<AssignMessage name="copy-verb-1">
  <Copy source="request">
    <Verb>true</Verb>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <Version>[false|true]</Version>
  </Copy>
</AssignMessage>

דוגמה 1

בדוגמה הבאה הערך של <Version> מוגדר כ-'true'. בבקשה, שמעתיקה את גרסה מאובייקט הבקשה שמוגדר כברירת מחדל לאובייקט בקשה חדש בהתאמה אישית:

<AssignMessage name="copy-version-1">
  <Copy source="request">
    <Version>true</Version>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

תחביר

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

דוגמה

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מגדירה את <IgnoreUnresolvedVariables> כ-"true":

<AssignMessage name="ignoreunresolvedvariables">
  <Copy source="response">
    ...
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  </Copy>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Remove>
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <Payload>[false|true]</Payload>
    <!-- Can also be an empty array (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Remove>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מסירה את גוף ההודעה מהתשובה:

<AssignMessage continueOnError="false" enabled="true" name="remove-1">
  <DisplayName>remove-1</DisplayName>
  <Remove>
    <Payload>true</Payload>
  </Remove>
  <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

בתהליך התשובה, המדיניות הזו מסירה את גוף התשובה ומחזירה רק HTTP אל הלקוח.

דוגמה 2

בדוגמה הבאה מסירים את כל הפרמטרים של הטופס ופרמטר של שאילתה מקובץ בקשה:

<AssignMessage continueOnError="false" enabled="true" name="remove-2">
  <Remove>
    <!-- Empty (<FormParams/>) removes all form parameters -->
    <FormParams/>
    <QueryParams>
      <QueryParam name="qp1"/>
    </QueryParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Remove>
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
  </Remove>
</AssignMessage>

דוגמה 1

בדוגמה הבאה מסירים מהבקשה שלושה פרמטרים של טופס:

<AssignMessage name="remove-formparams-1">
  <Remove>
    <FormParams>
      <FormParam name="form_param_1"/>
      <FormParam name="form_param_2"/>
      <FormParam name="form_param_3"/>
    </FormParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="application/x-www-form-urlencoded"/>
</AssignMessage>

דוגמה 2

בדוגמה הבאה מסירים מהבקשה את כל הפרמטרים של הטופס:

<AssignMessage name="remove-formparams-2">
  <Remove>
    <FormParams/>
  </Remove>
  <AssignTo createNew="false" transport="http" type="application/x-www-form-urlencoded"/>
</AssignMessage>

דוגמה 3

אם יש כמה פרמטרים של טפסים בעלי שם זהה, משתמשים בתחביר הבא:

<AssignMessage name="remove-formparams-3">
  <Remove>
    <FormParams>
      <FormParam name="f1"/>
      <FormParam name="f2"/>
      <FormParam name="f3.2"/>
    </FormParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="application/x-www-form-urlencoded"/>
</AssignMessage>

בדוגמה הזו מסירים את 'f1', 'f2' ואת הערך השני של 'f3'. אם 'f3' יש רק אחד ערך מסוים, הוא לא יוסר.

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Remove>
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
  </Remove>
</AssignMessage>

דוגמה 1

בדוגמה הבאה מסירים את הכותרת user-agent מהבקשה:

<AssignMessage name="remove-headers-1">
  <Remove>
    <Headers>
      <Header name="user-agent"/>
    </Headers>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

דוגמה 2

הדוגמה הבאה מסירה את כל הכותרות מהבקשה:

<AssignMessage name="remove-headers-2">
  <Remove>
    <Headers/>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

דוגמה 3

אם יש כמה כותרות עם אותו שם, צריך להשתמש בתחביר הבא:

<AssignMessage name="remove-headers-3">
  <Remove>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

בדוגמה הזו מסירים את 'h1', 'h2' ואת הערך השני של 'h3' מהבקשה. אם 'h3' יש רק ערך אחד, והוא לא יוסר.

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Remove>
    <Payload>[false|true]</Payload>
  </Remove>
</AssignMessage>

דוגמה 1

בדוגמה הבאה הערך של <Payload> מוגדר כ-'true'. כך שהמטען הייעודי (Payload) של הבקשה הוסר:

<AssignMessage name="remove-payload-1">
  <Remove>
    <Payload>true</Payload>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Remove>
    <!-- Can also be an empty array (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Remove>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מסירה מהבקשה פרמטר שאילתה יחיד:

<AssignMessage name="remove-queryparams-1">
  <Remove>
      <QueryParams>
        <QueryParam name="qp1"/>
      </QueryParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

דוגמה 2

בדוגמה הבאה מסירים מהבקשה את כל הפרמטרים של השאילתה:

<AssignMessage name="remove-queryparams-2">
  <Remove>
      <QueryParams/>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

דוגמה 3

אם יש כמה פרמטרים של שאילתות שיש להם את אותו שם, צריך להשתמש בתחביר הבא:

<AssignMessage name="remove-queryparams-3">
  <Remove>
      <QueryParams>
        <QueryParam name="qp1"/>
        <QueryParam name="qp2"/>
        <QueryParam name="qp3.2"/>
      </QueryParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

בדוגמה הזו מסירים את 'qp1', 'qp2' ואת הערך השני של 'qp3' מהבקשה. אם המיקום 'qp3' יש רק ערך אחד, והוא לא יוסר.

דוגמה 4

הדוגמה הבאה מסירה את פרמטר השאילתה apikey מהבקשה:

<AssignMessage name="remove-query-param">
  <Remove>
    <QueryParams>
      <QueryParam name="apikey"/>
    </QueryParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <Path>path</Path>
    <Payload contentType="content_type" variablePrefix="prefix"
        variableSuffix="suffix">new_payload</Payload>
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
    <ReasonPhrase>reason_for_error or {variable}</ReasonPhrase>
    <StatusCode>HTTP_status_code or {variable}</StatusCode>
    <Verb>[GET|POST|PUT|PATCH|DELETE|{variable}]</Verb>
    <Version>[1.0|1.1|{variable}]</Verb>
  </Set>
</AssignMessage>

דוגמה 1

בדוגמה הבאה מוצג הרכיב <Set>:

<AssignMessage continueOnError="false" enabled="true" name="set-1">
  <Set>
    <FormParams>
      <FormParam name="myparam">{request.header.myparam}</FormParam>
    </FormParams>
    <Headers>
        <Header name="user-agent">{request.header.user-agent}</Header>
    </Headers>
    <QueryParams>
      <QueryParam name="name">{request.header.name}</QueryParam>
      <QueryParam name="address">{request.header.address}</QueryParam>
    </QueryParams>
    <!-- <Verb>GET</Verb> -->
    <Payload contentType="text/plain">42</Payload>
    <Path/>
    <ReasonPhrase>Bad request</ReasonPhrase>
    <StatusCode>400</StatusCode>
    <Verb>POST</Verb>
    <Verb>{my_variable}</Verb>
    <Version>1.1</Version>
  </Set>
  <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
  </Set>
</AssignMessage>

דוגמה 1

בדוגמה הבאה מוגדר פרמטר טופס בשם 'myparam' לערך של משתנה request.header.myparam בבקשה חדשה ומותאמת אישית:

<AssignMessage name="set-formparams-1">
  <Set>
    <FormParams>
      <FormParam name="myparam">{request.header.myparam}</FormParam>
    </FormParams>
  </Set>
    <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
  </Set>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מגדירה את הכותרת user-agent לערך של משתנה request.header.user-agent:

<AssignMessage name="set-headers-1">
  <Set>
    <Headers>
      <Header name="user-agent">{request.header.user-agent}</Header>
    </Headers>
  </Set>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <Payload contentType="content_type" variablePrefix="prefix"
        variableSuffix="suffix">new_payload</Payload>
  </Set>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מגדירה מטען ייעודי (payload) של טקסט פשוט:

<AssignMessage name="set-payload-1">
  <Set>
    <Payload contentType="text/plain">42</Payload>
  </Set>
</AssignMessage>

דוגמה 2

הדוגמה הבאה מגדירה מטען ייעודי (payload) של JSON:

<AssignMessage name="set-payload-2">
  <Set>
    <Payload contentType="application/json">
      {"name":"foo", "type":"bar"}
    </Payload>
  </Set>
</AssignMessage>

דוגמה 3

בדוגמה הבאה מתווספים ערכי משתנים למטען הייעודי (Payload) על ידי גלישת שמות של משתנים. בסוגריים מסולסלים:

<AssignMessage name="set-payload-3">
  <Set>
    <Payload contentType="application/json">
      {"name":"foo", "type":"{variable_name}"}
    </Payload>
  </Set>
</AssignMessage>

בגרסאות ישנות יותר של Apigee Edge — לדוגמה, לפני השקת הגרסה 16.08.17 לענן — אפשר לא להשתמש בסוגריים מסולסלים כדי לציין הפניות למשתנים בתוך מטענים ייעודיים (payloads) של JSON. בגרסאות האלה, צריך להשתמש במאפיינים variablePrefix ו-variableSuffix כדי לציין תווי הפרדה, ולהשתמש בהם כדי לכלול שמות של משתנים, כמו:

<AssignMessage name="set-payload-3b">
  <Set>
    <Payload contentType="application/json" variablePrefix="@" variableSuffix="#">
      {"name":"foo", "type":"@variable_name#"}
    </Payload>
  </Set>
</AssignMessage>

התחביר הישן הזה עדיין פועל.

דוגמה 4

התוכן של <Payload> נחשב כתבנית של הודעה. המשמעות היא המדיניות AssignMessage מחליפה משתנים העטופים בסוגריים מסולסלים בערך של בפני משתנים בזמן הריצה.

הדוגמה הבאה משתמשת בתחביר של סוגריים מסולסלים כדי להגדיר חלק מהמטען הייעודי (Payload) לערך של ערך המשתנה:

<AssignMessage name="set-payload-4">
  <Set>
    <Payload contentType="text/xml">
      <root>
        <e1>sunday</e1>
        <e2>funday</e2>
        <e3>{var1}</e3>
      </root>
    </Payload>
  </Set>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Set>
</AssignMessage>

דוגמה 1

בדוגמה הבאה המערכת מגדירה את הערך בשדה 'כתובת' של השאילתה לערך משתנה אחד (request.header.address):

<AssignMessage continueOnError="false" enabled="true" name="set-queryparams-1">
  <Set>
    <QueryParams>
      <QueryParam name="address">{request.header.address}</QueryParam>
    </QueryParams>
  </Set>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <ReasonPhrase>reason_for_error or {variable}</ReasonPhrase>
  </Set>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מגדירה ביטוי פשוט של סיבה:

<AssignMessage name="set-reasonphrase-1">
  <Set>
    <ReasonPhrase>Bad medicine</ReasonPhrase>
  </Set>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

דוגמה 2

התוכן של <ReasonPhrase> נחשב כתבנית של הודעה. כלומר שם משתנה שמוקף בסוגריים מסולסלים יוחלף בזמן הריצה בערך של בהפניה אוטומטית, כפי שאפשר לראות בדוגמה הבאה:

<AssignMessage name="set-reasonphrase-2">
  <Set>
    <ReasonPhrase>{calloutresponse.reason.phrase}</ReasonPhrase>
  </Set>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <StatusCode>HTTP_status_code or {variable}</StatusCode>
  </Set>
</AssignMessage>

דוגמה 1

בדוגמה הבאה מוגדר קוד סטטוס פשוט:

<AssignMessage name="set-statuscode-1">
  <Set>
    <StatusCode>404</StatusCode>
  </Set>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

דוגמה 2

התוכן של <StatusCode> נחשב כתבנית של הודעה. כלומר שם משתנה שמוקף בסוגריים מסולסלים יוחלף בזמן הריצה בערך של בהפניה אוטומטית, כפי שאפשר לראות בדוגמה הבאה:

<AssignMessage name="set-statuscode-2">
  <Set>
    <StatusCode>{calloutresponse.status.code}</StatusCode>
  </Set>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <Verb>[GET|POST|PUT|PATCH|DELETE|{variable}]</Verb>
  </Set>
</AssignMessage>

דוגמה 1

בדוגמה הבאה מוגדר פועל פשוט לבקשה:

<AssignMessage name="set-verb-1">
  <Set>
    <Verb>POST</Verb>
  </Set>
  <AssignTo createNew="true" transport="http" type="request"/>
</AssignMessage>

דוגמה 2

התוכן של <Verb> נחשב כתבנית של הודעה. כלומר שם המשתנה בתוך סוגריים מסולסלים, המערכת תוחלף בזמן הריצה בערך של ההפניה מותאם אישית.

בדוגמה הבאה משתמשים במשתנה כדי לאכלס פועל:

<AssignMessage name="set-verb-2">
  <Set>
    <Verb>{my_variable}</Verb>
  </Set>
  <AssignTo createNew="true" transport="http" type="request"/>
</AssignMessage>

תחביר

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <Version>[1.0|1.1|{variable}]</Verb>
  </Set>
</AssignMessage>

דוגמה 1

הדוגמה הבאה מגדירה את מספר הגרסה כ-"1.1":

<AssignMessage name="set-version-1">
  <Set>
    <Version>1.1</Version>
  </Set>
  <AssignTo createNew="true" transport="http" type="request"/>
</AssignMessage>

דוגמה 2

הדוגמה הבאה משתמשת במשתנה בסוגריים מסולסלים כדי להגדיר את מספר הגרסה:

<AssignMessage name="set-version-2">
  <Set>
    <Version>{my_version}</Version>
  </Set>
  <AssignTo createNew="true" transport="http" type="request"/>
</AssignMessage>

התוכן של <Version> נחשב כתבנית של הודעה. כלומר שם משתנה שמוקף בסוגריים מסולסלים יוחלף בזמן הריצה בערך של ההפניה מותאם אישית.

דוגמה 1

הדוגמה הבאה יוצרת אובייקט בקשה בהתאמה אישית באמצעות Assign Message (הקצאת הודעה):

<AssignMessage name="AssignMessage-3">
  <AssignTo createNew="true" type="request">MyCustomRequest</AssignTo>
  <Copy>
    <Headers>
     <Header name="user-agent"/>
    </Headers>
  </Copy>
  <Set>
    <QueryParams>
      <QueryParam name="address">{request.queryparam.addy}</QueryParam>
    </QueryParams>
    <Verb>GET</Verb>
  </Set>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</AssignMessage>

הדוגמה הזו:

• יצירת אובייקט חדש של הודעת בקשה בשם "MyCustomRequest".
• ב-MyCustomRequest, המדיניות הזו:
  • העתקת הערך של כותרת ה-HTTP user-agent מהקובץ הנכנס להודעה החדשה. כי <Copy> משתמש בהפניה מוחלטת אל משתנה זרימה user-agent, אין צריך לציין את המאפיין source ל-<Copy>.
  • מגדיר את פרמטר השאילתה address בהודעה המותאמת אישית לערך של פרמטר השאילתה addy של הבקשה הנכנסת.
  • מגדיר את פועל ה-HTTP כ-GET.
• הפרמטר <IgnoreUnresolvedVariables> מגדיר את הערך 'false'. כאשר <IgnoreUnresolvedVariables> הערך 'false' הוא 'false'. אם אחד מהמשתנים שהמדיניות מנסה להוסיף לא קיים, Edge יפסיק בתהליך ה-API.

דוגמה 2

דוגמה נוספת שממחישה איך ליצור אובייקט בקשה בהתאמה אישית באמצעות הקצאה הודעה:

<AssignMessage name="AssignMessage-2">
  <AssignTo createNew="true" type="request">partner.request</AssignTo>
  <Set>
    <Verb>POST</Verb>
    <Payload contentType="text/xml">
      <request><operation>105</operation></request>
    </Payload>
  </Set>
</AssignMessage>

בדוגמה הזו נוצרת בקשה חדשה בהתאמה אישית בשם 'partner.request'. לאחר מכן היא מגדירה <Verb> ו-<Payload> בבקשה החדשה.